Merge pull request kubevela#981 from wonderflow/v1.5.5

upgrade migration doc
jxs1211 · Sep 20, 2022 · edbdcb2 · edbdcb2
2 parents fd2ab68 + 312f5ac
commit edbdcb2
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 18 deletions.
diff --git a/docs/platform-engineers/system-operation/migration-from-old-version.md b/docs/platform-engineers/system-operation/migration-from-old-version.md
@@ -8,6 +8,8 @@ KubeVela has [release cadence](../../contributor/release-process) for every 2-3
 
 ## From v1.4.x to v1.5.x
 
+> ⚠️ Note: Please upgrade to v1.5.5+ 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.
 
 ```
@@ -23,24 +25,24 @@ 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.4 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.5 --wait
 ```
 
 3. Download and upgrade to the corresponding CLI
 
 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.4
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.5
 ```
 
 4. Upgrade VelaUX or other addon
 
 ```
-vela addon upgrade velaux --version 1.5.4
+vela addon upgrade velaux --version 1.5.5
 ```
 
 ## From v1.3.x to v1.4.x
 
-> ⚠️ Note: You must upgrade to v1.3.x first before you upgrade to v1.4.x from version v1.2.x or older.
+> ⚠️ Note: It may cause application workflow rerun when controller upgrade.
 
 1. Upgrade the CRDs, please make sure you upgrade the CRDs first before upgrade the helm chart.
 
@@ -81,6 +83,8 @@ Please note if you're using terraform addon, you should upgrade the `terraform`
 
 ## From v1.2.x to v1.3.x
 
+> ⚠️ Note: It may cause application workflow rerun when controller upgrade.
+
 1. Upgrade the CRDs, please make sure you upgrade the CRDs first before upgrade the helm chart.
 
 ```
@@ -119,6 +123,8 @@ Please note if you're using terraform addon, you should upgrade the `terraform`
 
 ## From v1.1.x to v1.2.x
 
+> ⚠️ Note: It will cause application workflow rerun when controller upgrade.
+
 1. Check the service running normally
 
 Make sure all your services are running normally before migration.

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -26,7 +26,7 @@ module.exports = {
       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.5.4 is now available.(2022-09-02)</span> <a target="_blank" style="color: var(--ifm-color-primary)" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela/releases/v1.5.4">Read Release Note</a></div>',
+        '<div class="header-item"><span>KubeVela v1.5.5 is now available.(2022-09-20)</span> <a target="_blank" style="color: var(--ifm-color-primary)" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela/releases/v1.5.5">Read Release Note</a></div>',
     },
     algolia: {
       appId: 'PXMFHFWUGZ',
@@ -153,7 +153,7 @@ module.exports = {
     },
     prism: {
       theme: require('prism-react-renderer/themes/dracula'),
-      additionalLanguages: ['cue','powershell'],
+      additionalLanguages: ['cue', 'powershell'],
     },
     zoom: {
       selector: '.markdown :not(em) > img',

diff --git a/...-docs/current/platform-engineers/system-operation/migration-from-old-version.md b/...-docs/current/platform-engineers/system-operation/migration-from-old-version.md
@@ -8,6 +8,8 @@ KubeVela 的[发布周期](../../contributor/release-process)定为每隔 2-3
 
 ## 从 v1.4.x 版本 到 v1.5.x 版本
 
+> ⚠️ 注意: 升级到 v1.5.4 及以前的版本可能会触发应用重启，升级到 v1.5.5 可以保证已经正常运行的应用不受影响。
+
 1. 升级 CRD，请确保在升级 helm chart 之前先升级 CRD。
 
 ```
@@ -23,24 +25,24 @@ 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.4 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.5 --wait
 ```
 
 3. 下载并升级对应的CLI
 
 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.4
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.5
 ```
 
 4. 升级 VelaUX 或其他插件
 
 ```
-vela addon upgrade velaux --version 1.5.4
+vela addon upgrade velaux --version 1.5.5
 ```
 
 ## 从 v1.3.x 版本 到 v1.4.x 版本
 
-> ⚠️ 注意: 在从 v1.2.x 或更早版本升级到 v1.4.x 之前，你必须先升级到 v1.3.x。
+> ⚠️ 注意: 升级到该版本可能会触发应用重启。
 
 1. 升级 CRD，请确保在升级 helm chart 之前先升级 CRD。
 
@@ -81,6 +83,8 @@ vela addon upgrade velaux --version 1.4.7
 
 ## 从 v1.2.x 版本 到 v1.3.x 版本
 
+> ⚠️ 注意: 升级到该版本可能会触发应用重启。
+
 1. 升级 CRD，请确保在升级 helm chart 之前先升级 CRD。
 
 ```
@@ -119,6 +123,8 @@ vela addon upgrade velaux --version 1.3.6
 
 ## 从 v1.1.x 版本到 v1.2.x 版本
 
+> ⚠️ 注意: 升级到该版本会触发应用重启。
+
 1. 检查服务是否正常运行
 
 迁移前请确保你的所有服务都正常运行。

diff --git a/.../version-v1.5/platform-engineers/system-operation/migration-from-old-version.md b/.../version-v1.5/platform-engineers/system-operation/migration-from-old-version.md
@@ -8,6 +8,8 @@ KubeVela 的[发布周期](../../contributor/release-process)定为每隔 2-3
 
 ## 从 v1.4.x 版本 到 v1.5.x 版本
 
+> ⚠️ 注意: 升级到 v1.5.4 及以前的版本可能会触发应用重启，升级到 v1.5.5 可以保证已经正常运行的应用不受影响。
+
 1. 升级 CRD，请确保在升级 helm chart 之前先升级 CRD。
 
 ```
@@ -23,24 +25,24 @@ 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.4 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.5 --wait
 ```
 
 3. 下载并升级对应的CLI
 
 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.4
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.5
 ```
 
 4. 升级 VelaUX 或其他插件
 
 ```
-vela addon upgrade velaux --version 1.5.4
+vela addon upgrade velaux --version 1.5.5
 ```
 
 ## 从 v1.3.x 版本 到 v1.4.x 版本
 
-> ⚠️ 注意: 在从 v1.2.x 或更早版本升级到 v1.4.x 之前，你必须先升级到 v1.3.x。
+> ⚠️ 注意: 升级到该版本可能会触发应用重启。
 
 1. 升级 CRD，请确保在升级 helm chart 之前先升级 CRD。
 
@@ -81,6 +83,8 @@ vela addon upgrade velaux --version 1.4.7
 
 ## 从 v1.2.x 版本 到 v1.3.x 版本
 
+> ⚠️ 注意: 升级到该版本可能会触发应用重启。
+
 1. 升级 CRD，请确保在升级 helm chart 之前先升级 CRD。
 
 ```
@@ -119,6 +123,8 @@ vela addon upgrade velaux --version 1.3.6
 
 ## 从 v1.1.x 版本到 v1.2.x 版本
 
+> ⚠️ 注意: 升级到该版本会触发应用重启。
+
 1. 检查服务是否正常运行
 
 迁移前请确保你的所有服务都正常运行。

diff --git a/.../version-v1.5/platform-engineers/system-operation/migration-from-old-version.md b/.../version-v1.5/platform-engineers/system-operation/migration-from-old-version.md
@@ -8,6 +8,8 @@ KubeVela has [release cadence](../../contributor/release-process) for every 2-3
 
 ## From v1.4.x to v1.5.x
 
+> ⚠️ Note: Please upgrade to v1.5.5+ 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.
 
 ```
@@ -23,24 +25,24 @@ 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.4 --wait
+helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.5.5 --wait
 ```
 
 3. Download and upgrade to the corresponding CLI
 
 ```
-curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.4
+curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.5.5
 ```
 
 4. Upgrade VelaUX or other addon
 
 ```
-vela addon upgrade velaux --version 1.5.4
+vela addon upgrade velaux --version 1.5.5
 ```
 
 ## From v1.3.x to v1.4.x
 
-> ⚠️ Note: You must upgrade to v1.3.x first before you upgrade to v1.4.x from version v1.2.x or older.
+> ⚠️ Note: It may cause application workflow rerun when controller upgrade.
 
 1. Upgrade the CRDs, please make sure you upgrade the CRDs first before upgrade the helm chart.
 
@@ -81,6 +83,8 @@ Please note if you're using terraform addon, you should upgrade the `terraform`
 
 ## From v1.2.x to v1.3.x
 
+> ⚠️ Note: It may cause application workflow rerun when controller upgrade.
+
 1. Upgrade the CRDs, please make sure you upgrade the CRDs first before upgrade the helm chart.
 
 ```
@@ -119,6 +123,8 @@ Please note if you're using terraform addon, you should upgrade the `terraform`
 
 ## From v1.1.x to v1.2.x
 
+> ⚠️ Note: It will cause application workflow rerun when controller upgrade.
+
 1. Check the service running normally
 
 Make sure all your services are running normally before migration.