update version and fix mermaid diagram (#1105)

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com> Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
2023-01-04 17:33:46 +08:00 · 2023-01-04 17:33:46 +08:00 · 95dc99445f
parent b0defe4533
commit 95dc99445f
9 changed files with 65 additions and 37 deletions
--- a/docs/platform-engineers/system-operation/migration-from-old-version.md
+++ b/docs/platform-engineers/system-operation/migration-from-old-version.md
@ -41,25 +41,25 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.6/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.6.1 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.6.6 --wait
 ```

 3. Download and upgrade to the corresponding CLI

 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.6.1
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.6.6
 ```

 4. Upgrade VelaUX or other addon

 ```
-vela addon upgrade velaux --version 1.6.1
+vela addon upgrade velaux --version 1.6.6
 ```

 ## From v1.4.x to v1.5.x

 :::caution
-Note: Please upgrade to v1.5.7+ to avoid application workflow rerun when controller upgrade.
+Note: Please upgrade to v1.5.10+ to avoid application workflow rerun when controller upgrade.
 :::

 1. Upgrade the CRDs, please make sure you upgrade the CRDs first before upgrade the helm chart.
@ -77,13 +77,13 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.5/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.7 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.10 --wait
 ```

 3. Download and upgrade to the corresponding CLI

 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.7
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.10
 ```

 4. Upgrade VelaUX or other addon
@ -113,12 +113,12 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.4/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.4.11 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.4.14 --wait
 ```

 3. Download and upgrade to the corresponding CLI
 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.11
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.14
 ```

 4. Upgrade VelaUX or other addon
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@ -21,12 +21,16 @@ module.exports = {
      },
    },
  },
+  markdown: {
+    mermaid: true,
+  },
+  themes: ['@docusaurus/theme-mermaid'],
  themeConfig: {
    announcementBar: {
      id: 'start',
      content:
        '<div class="header-item">⭐️ If you like KubeVela, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela">GitHub</a>!⭐️</div>' +
-        '<div class="header-item"><span>KubeVela v1.6.3 is now available.(2022-11-09)</span> <a target="_blank" style="color: var(--ifm-color-primary)" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela/releases/v1.6.3">Read Release Note</a></div>',
+        '<div class="header-item"><span>KubeVela v1.6.6 is now available.(2023-01-04)</span> <a target="_blank" style="color: var(--ifm-color-primary)" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela/releases/v1.6.6">Read Release Note</a></div>',
    },
    algolia: {
      appId: 'PXMFHFWUGZ',
--- a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/system-operation/migration-from-old-version.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/system-operation/migration-from-old-version.md
@ -41,25 +41,25 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.6/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.6.0 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.6.6 --wait
 ```

 3. 下载并升级对应的CLI

 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.6.0
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.6.6
 ```

 4. 升级 VelaUX 或其他插件

 ```
-vela addon upgrade velaux --version 1.6.0
+vela addon upgrade velaux --version 1.6.6
 ```

 ## 从 v1.4.x 版本 到 v1.5.x 版本

 :::caution
-注意: 升级到 v1.5.6 及以前的版本可能会触发应用重启，升级到 v1.5.7+ 可以保证已经正常运行的应用不受影响。
+注意: 升级到 v1.5.6 及以前的版本可能会触发应用重启，升级到 v1.5.10+ 可以保证已经正常运行的应用不受影响。
 :::

 1. 升级 CRD，请确保在升级 helm chart 之前先升级 CRD。
@ -77,19 +77,19 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.5/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.7 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.10 --wait
 ```

 3. 下载并升级对应的CLI

 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.7
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.10
 ```

 4. 升级 VelaUX 或其他插件

 ```
-vela addon upgrade velaux --version 1.5.7
+vela addon upgrade velaux --version 1.5.6
 ```

 ## 从 v1.3.x 版本 到 v1.4.x 版本
@ -113,13 +113,13 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.4/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.4.11 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.4.14 --wait
 ```

 3. 下载并升级对应的CLI

 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.11
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.14
 ```

 4. 升级 VelaUX 或其他插件
--- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/platform-engineers/system-operation/migration-from-old-version.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/platform-engineers/system-operation/migration-from-old-version.md
@ -41,25 +41,25 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.6/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.6.0 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.6.6 --wait
 ```

 3. 下载并升级对应的CLI

 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.6.0
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.6.6
 ```

 4. 升级 VelaUX 或其他插件

 ```
-vela addon upgrade velaux --version 1.6.0
+vela addon upgrade velaux --version 1.6.6
 ```

 ## 从 v1.4.x 版本 到 v1.5.x 版本

 :::caution
-注意: 升级到 v1.5.6 及以前的版本可能会触发应用重启，升级到 v1.5.7+ 可以保证已经正常运行的应用不受影响。
+注意: 升级到 v1.5.6 及以前的版本可能会触发应用重启，升级到 v1.5.10+ 可以保证已经正常运行的应用不受影响。
 :::

 1. 升级 CRD，请确保在升级 helm chart 之前先升级 CRD。
@ -77,19 +77,19 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.5/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.7 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.10 --wait
 ```

 3. 下载并升级对应的CLI

 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.7
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.10
 ```

 4. 升级 VelaUX 或其他插件

 ```
-vela addon upgrade velaux --version 1.5.7
+vela addon upgrade velaux --version 1.5.6
 ```

 ## 从 v1.3.x 版本 到 v1.4.x 版本
@ -113,13 +113,13 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.4/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.4.11 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.4.14 --wait
 ```

 3. 下载并升级对应的CLI

 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.11
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.14
 ```

 4. 升级 VelaUX 或其他插件
--- a/package.json
+++ b/package.json
@ -20,6 +20,7 @@
    "@docusaurus/plugin-content-pages": "2.2.0",
    "@docusaurus/plugin-sitemap": "2.2.0",
    "@docusaurus/preset-classic": "2.2.0",
+    "@docusaurus/theme-mermaid": "^2.2.0",
    "@mdx-js/react": "1.6.22",
    "asciinema-player": "^3.0.1",
    "clsx": "^1.2.1",
--- a/versioned_docs/version-v1.6/platform-engineers/policy/custom-policy.md
+++ b/versioned_docs/version-v1.6/platform-engineers/policy/custom-policy.md
@ -69,7 +69,7 @@ template: {
 }
 ```

-Apply to our control plane to make this trait work:
+Apply to our control plane to make this Policy work:

 ```
 vela def apply myroute.cue
--- a/versioned_docs/version-v1.6/platform-engineers/system-operation/enable-addon-offline.md
+++ b/versioned_docs/version-v1.6/platform-engineers/system-operation/enable-addon-offline.md
@ -90,3 +90,12 @@ $ helm pull https://charts.kubevela.net/addons/terraform-controller-0.3.5.tgz
 3. Extract the chart and modify the `values.yaml` change `image.repository` to your own image registry.Then push it to your helm chart museum.
 4. Modify the addon file `terraform/resources/terraform-controller.cue` change `output.properties.url` to your chart museum's url.

+### 5. Rollout
+
+1. Sync the image `oamdev/vela-rollout:v1.6.4` to your own images registry.
+2. Dowload the rollout helm chart.
+```yaml
+$ helm pull https://charts.kubevela.net/core/vela-rollout-1.3.0.tgz
+```
+3. Extract the chart and modify the `values.yaml` change `image.repository` to your own image registry.Then push it to your helm chart museum.
+4. Modify the addon file `rollout/resources/rollout-controller.cue` change `output.properties.url` to your chart museum's url.
--- a/versioned_docs/version-v1.6/platform-engineers/system-operation/migration-from-old-version.md
+++ b/versioned_docs/version-v1.6/platform-engineers/system-operation/migration-from-old-version.md
@ -41,25 +41,25 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.6/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.6.1 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.6.6 --wait
 ```

 3. Download and upgrade to the corresponding CLI

 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.6.1
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.6.6
 ```

 4. Upgrade VelaUX or other addon

 ```
-vela addon upgrade velaux --version 1.6.1
+vela addon upgrade velaux --version 1.6.6
 ```

 ## From v1.4.x to v1.5.x

 :::caution
-Note: Please upgrade to v1.5.7+ to avoid application workflow rerun when controller upgrade.
+Note: Please upgrade to v1.5.10+ to avoid application workflow rerun when controller upgrade.
 :::

 1. Upgrade the CRDs, please make sure you upgrade the CRDs first before upgrade the helm chart.
@ -77,13 +77,13 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.5/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.7 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.10 --wait
 ```

 3. Download and upgrade to the corresponding CLI

 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.7
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.10
 ```

 4. Upgrade VelaUX or other addon
@ -113,12 +113,12 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.4/
 ```
 helm repo add kubevela https://charts.kubevela.net/core
 helm repo update
-helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.4.11 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.4.14 --wait
 ```

 3. Download and upgrade to the corresponding CLI
 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.11
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.14
 ```

 4. Upgrade VelaUX or other addon
--- a/yarn.lock
+++ b/yarn.lock
@ -2679,6 +2679,20 @@
    tslib "^2.4.0"
    utility-types "^3.10.0"

+"@docusaurus/theme-mermaid@^2.2.0":
+  version "2.2.0"
+  resolved "https://registry.yarnpkg.com/@docusaurus/theme-mermaid/-/theme-mermaid-2.2.0.tgz#0dc9bb7013c0280726a0c7a26419b1f5e79755f3"
+  integrity sha512-rEhVvWyZ9j9eABTvJ8nhfB5NbyiThva3U9J7iu4RxKYymjImEh9MiqbEdOrZusq6AQevbkoHB7n+9VsfmS55kg==
+  dependencies:
+    "@docusaurus/core" "2.2.0"
+    "@docusaurus/module-type-aliases" "2.2.0"
+    "@docusaurus/theme-common" "2.2.0"
+    "@docusaurus/types" "2.2.0"
+    "@docusaurus/utils-validation" "2.2.0"
+    "@mdx-js/react" "^1.6.22"
+    mermaid "^9.1.1"
+    tslib "^2.4.0"
+
 "@docusaurus/theme-search-algolia@2.2.0":
  version "2.2.0"
  resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-2.2.0.tgz#77fd9f7a600917e6024fe3ac7fb6cfdf2ce84737"
@ -6822,7 +6836,7 @@ merge2@^1.3.0, merge2@^1.4.1:
  resolved "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz"
  integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==

-mermaid@^9.3.0:
+mermaid@^9.1.1, mermaid@^9.3.0:
  version "9.3.0"
  resolved "https://registry.yarnpkg.com/mermaid/-/mermaid-9.3.0.tgz#8bd7c4a44b53e4e85c53a0a474442e9c273494ae"
  integrity sha512-mGl0BM19TD/HbU/LmlaZbjBi//tojelg8P/mxD6pPZTAYaI+VawcyBdqRsoUHSc7j71PrMdJ3HBadoQNdvP5cg==