From c6d04f2007ce616d0c464c614cdeb0ffe0e10267 Mon Sep 17 00:00:00 2001 From: kubevela-bot Date: Fri, 30 Apr 2021 11:56:16 +0000 Subject: [PATCH] sync commit 0d264c16f7711fe34c5f7e4f1cc1bfa95a458400 from kubevela-refs/heads/release-1.0 --- docusaurus.config.js.bak | 174 ------------------ .../version-v1.0/end-user/terraform.md | 2 +- .../platform-engineers/terraform.md | 15 +- .../version-v1.0/roadmap/template.md | 2 +- .../version-v1.0/rollout/rollout.md | 1 + 5 files changed, 13 insertions(+), 181 deletions(-) delete mode 100644 docusaurus.config.js.bak diff --git a/docusaurus.config.js.bak b/docusaurus.config.js.bak deleted file mode 100644 index 30f3b551..00000000 --- a/docusaurus.config.js.bak +++ /dev/null @@ -1,174 +0,0 @@ -/** @type {import('@docusaurus/types').DocusaurusConfig} */ -module.exports = { - title: 'KubeVela', - tagline: 'Make shipping applications more enjoyable.', - url: 'https://kubevela.io', - baseUrl: '/', - onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', - favicon: 'img/favicon.ico', - organizationName: 'oam-dev', // Usually your GitHub org/user name. - projectName: 'kubevela.io', // Usually your repo name. - i18n: { - defaultLocale: 'en', - locales: ['en', 'zh'], - localeConfigs: { - en: { - label: 'English', - }, - zh: { - label: '简体中文', - }, - }, - }, - themeConfig: { - announcementBar: { - id: 'start', - content: - '⭐️ If you like KubeVela, give it a star on GitHub! ⭐️', - }, - navbar: { - title: 'KubeVela', - logo: { - alt: 'KubeVela', - src: 'img/logo.svg', - srcDark: 'img/logoDark.svg', - }, - items: [ - { - type: 'docsVersionDropdown', - position: 'right', - }, - { - to: 'docs/', - activeBasePath: 'docs', - label: 'Documentation', - position: 'left', - }, - { - to: 'blog', - label: 'Blog', - position: 'left' - }, - { - type: 'localeDropdown', - position: 'right', - dropdownItemsAfter: [ - { - to: '/blog/kubevela-official-documentation-translation-event', - label: 'Help Us Translate', - }, - ], - }, - { - href: 'https://github.com/oam-dev/kubevela', - className: 'header-githab-link', - position: 'right', - }, - ], - }, - footer: { - links: [ - { - title: 'Documentation', - items: [ - { - label: 'Getting Started', - to: '/docs/install', - }, - { - label: 'Platform Builder Guide', - to: '/docs/platform-engineers/overview', - }, - { - label: 'Developer Experience Guide', - to: '/docs/quick-start-appfile', - }, - ], - }, - { - title: 'Community', - items: [ - { - label: 'CNCF Slack ( #kubevela channel )', - href: 'https://slack.cncf.io/' - }, - { - label: 'Gitter', - href: 'https://gitter.im/oam-dev/community', - }, - { - label: 'DingTalk (23310022)', - href: '.', - } - ], - }, - { - title: 'More', - items: [ - { - label: 'GitHub', - href: 'https://github.com/oam-dev/kubevela', - }, - { - label: 'Blog', - to: 'blog', - }, - ], - }, - ], - copyright: ` -
- © KubeVela Authors ${new Date().getFullYear()} | Documentation Distributed under CC-BY-4.0 | Powered by Netlify -
- `, - }, - prism: { - theme: require('prism-react-renderer/themes/dracula'), - }, - }, - plugins: [ - [ - require.resolve("@easyops-cn/docusaurus-search-local"), - { - hashed: true, - language: ["en", "zh"], - indexBlog: true, - }, - ], - ], - presets: [ - [ - '@docusaurus/preset-classic', - { - docs: { - sidebarPath: require.resolve('./sidebars.js'), - editUrl: function ({ - locale, - docPath, - }) { - return `https://github.com/oam-dev/kubevela/edit/master/docs/${locale}/${docPath}`; - }, - showLastUpdateAuthor: true, - showLastUpdateTime: true, - includeCurrentVersion: true, - lastVersion: 'v1.0', - // versions: { - // current: { - // label: 'master', - // path: '/', - // }, - // }, - }, - blog: { - showReadingTime: true, - editUrl: - 'https://github.com/oam-dev/kubevela.io/tree/main/blog', - }, - theme: { - customCss: require.resolve('./src/css/custom.css'), - }, - }, - ], - ], -}; diff --git a/versioned_docs/version-v1.0/end-user/terraform.md b/versioned_docs/version-v1.0/end-user/terraform.md index 1d0ebd7c..48d78534 100644 --- a/versioned_docs/version-v1.0/end-user/terraform.md +++ b/versioned_docs/version-v1.0/end-user/terraform.md @@ -2,7 +2,7 @@ title: Provision and Consume Cloud Resources by Terraform --- -> ⚠️ This section requires your platform builder has already installed the [Terraform related capabilities](../platform-engineers/terraform.md). +> ⚠️ This section requires your platform builder has already installed the [Terraform related capabilities](../platform-engineers/terraform). Check the parameters of cloud resource components and trait. diff --git a/versioned_docs/version-v1.0/platform-engineers/terraform.md b/versioned_docs/version-v1.0/platform-engineers/terraform.md index f6880673..18b580e2 100644 --- a/versioned_docs/version-v1.0/platform-engineers/terraform.md +++ b/versioned_docs/version-v1.0/platform-engineers/terraform.md @@ -2,14 +2,14 @@ title: Terraform --- -In addition to provisioning and consuming cloud resources by [Crossplane](./cloud-services.md), we can also use Terraform, +In addition to provisioning and consuming cloud resources by [Crossplane](./cloud-services), we can also use Terraform, which is one of four ComponentDefinition schematic types `cue`, `kube`, `helm` and `terraform`. To enable end users to be able to create application by Terraform, please follow these steps. -## Install Terraform Controller chart +## Install Terraform Controller -Download the latest chart, like `terraform-controller-chart-0.1.4.tgz`, from the latest [releases](https://github.com/oam-dev/terraform-controller/releases) and install it. +Download the latest chart, like `terraform-controller-chart-0.1.4.tgz`, from the latest [releases list](https://github.com/oam-dev/terraform-controller/releases) and install it. ```shell $ helm install terraform-controller terraform-controller-0.1.2.tgz @@ -21,7 +21,12 @@ REVISION: 1 TEST SUITE: None ``` -For more detailed instruction, please refer to [Terraform controller getting started](https://github.com/oam-dev/terraform-controller/blob/master/getting-started.md). +## Apply Provider credentials + +By applying Terraform Provider credentials, Terraform controller can be authenticated to deploy and manage cloud resources. + +Please refer to [Terraform controller getting started](https://github.com/oam-dev/terraform-controller/blob/master/getting-started.md) on how to apply Provider for Alibaba Cloud or AWS. + ## Register ComponentDefinition and TraitDefinition @@ -145,4 +150,4 @@ For more detailed introduction, please refer to [Crossplane](https://kubevela.io ## Next -Now You can refer to [Terraform for end users](../end-user/terraform.md) to provision and consume cloud resource by Terraform. \ No newline at end of file +Now You can refer to [Terraform for end users](../end-user/terraform) to provision and consume cloud resource by Terraform. diff --git a/versioned_docs/version-v1.0/roadmap/template.md b/versioned_docs/version-v1.0/roadmap/template.md index b8a21a53..5acf3767 100644 --- a/versioned_docs/version-v1.0/roadmap/template.md +++ b/versioned_docs/version-v1.0/roadmap/template.md @@ -4,7 +4,7 @@ title: Roadmap Date: 2021-01-01 to 2021-03-30 -> Note: add roadmap entry to to `roadmap/README.md` +> Note: add roadmap entry to `roadmap/README.md` ## Core Platform diff --git a/versioned_docs/version-v1.0/rollout/rollout.md b/versioned_docs/version-v1.0/rollout/rollout.md index 19fd69dd..bd3c44c4 100644 --- a/versioned_docs/version-v1.0/rollout/rollout.md +++ b/versioned_docs/version-v1.0/rollout/rollout.md @@ -97,6 +97,7 @@ test-rolling-v1 9s - replicas: 10% - replicas: 40% - replicas: 50% + targetSize: 5 ``` Use can check the status of the ApplicationRollout and wait for the rollout to complete.