Skip to content

Commit

Permalink
Update migration doc
Browse files Browse the repository at this point in the history
Signed-off-by: Jianbo Sun <[email protected]>
  • Loading branch information
wonderflow committed Jul 28, 2023
1 parent f647710 commit d694f49
Show file tree
Hide file tree
Showing 11 changed files with 44 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/developers/references/devex/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Image Hub | "hub.kubevela.net" | "docker.io" or "ghcr.io/kubevela"
Helm charts | https://charts.kubevela.net/core | https://kubevela.github.io/charts
Official Addon Registry | https://addons.kubevela.net | https://kubevela.github.io/catalog/official
Experimental Addon Registry | - | https://kubevela.github.io/catalog/experimental
CLI | https://kubevela.net/script/install.sh | download from [release page](https://github.com/kubevela/kubevela/releases)
CLI | https://kubevela.io/script/install.sh | download from [release page](https://github.com/kubevela/kubevela/releases)
VelaD | - | migrating

### You have reached rate limit for Docker Image Registry
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,32 @@ This doc aims to provide a migration guide from old versions to the new ones wit

KubeVela has [release cadence](../../contributor/release-process) for every 2-3 months, we'll only maintain for the last 2 releases. As a result, you're highly recommended to upgrade along with the community. We'll strictly align with the [semver version rule](https://semver.org/) for compatibility.

## From v1.8.x to v1.9.x

:::caution
1. Legacy code removal. Basically you will not be able to use EnvBinding, HealthScope, ScopeDefinition and other objects in old KubeVela (<1.0), like ApplicationConfiguration.
2. Registry migrated from kubevela.net OSS storage to GitHub pages.
> Notice: the "hub.kubevela.net", "charts.kubevela.net" and "addons.kubevela.net" will not be served in the future.
> 1. For docker images in "hub.kubevela.net", replace it with "docker.io" or "ghcr.io/kubevela".
> 2. For helm charts in "charts.kubevela.net", replace it with "kubevela.github.io/charts".
> 3. For addons in "addons.kubevela.net", replace it with "kubevela.github.io/catalog/official".
>
> You can run the following command to update your addon registry.
> ```shell
> vela addon registry delete KubeVela
> vela addon registry add KubeVela --type helm --endpoint=https://kubevela.github.io/catalog/official
> vela addon registry add experimental --type helm --endpoint=https://kubevela.github.io/catalog/experimental
> ```
:::
1. Upgrade your kubevela chart
```
helm repo add kubevela https://kubevela.github.io/charts
helm repo update
helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.9.5 --wait
```
## From v1.7.x to v1.8.x

These isn't too much work to be done for upgrading from v1.7.x to v1.8.x for usage.
Expand All @@ -15,7 +41,7 @@ These isn't too much work to be done for upgrading from v1.7.x to v1.8.x for usa
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.8.0 --wait
helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.8.2 --wait
```

## From v1.6.x to v1.7.x
Expand Down Expand Up @@ -55,7 +81,7 @@ Since we have migrated some workflow step definitions and views from workflow ad
You can execute this script to solve it before upgrade helm chart:

```
curl -fsSl https://kubevela.net/script/checklegacy.sh | bash
curl -fsSl https://kubevela.io/script/checklegacy.sh | bash
```

The script will just help patch helm annotations for you, you can also do that manually one by one like:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ KubeVela CLI 提供了常用的集群和应用管理能力。
** MacOS/Linux **

```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
curl -fsSl https://kubevela.io/script/install.sh | bash
```

**Windows**

```shell script
powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"
powershell -Command "iwr -useb https://kubevela.io/script/install.ps1 | iex"
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.7.
你可以执行下列脚本修复:

```
curl -fsSl https://kubevela.net/script/checklegacy.sh | bash
curl -fsSl https://kubevela.io/script/checklegacy.sh | bash
```

这个脚本就是在帮你自动添加 Helm 的注解,你也可以通过如下命令手动修复:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ KubeVela CLI 提供了常用的集群和应用管理能力。
** MacOS/Linux **

```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
curl -fsSl https://kubevela.io/script/install.sh | bash
```

**Windows**

```shell script
powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"
powershell -Command "iwr -useb https://kubevela.io/script/install.ps1 | iex"
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.7.
你可以执行下列脚本修复:

```
curl -fsSl https://kubevela.net/script/checklegacy.sh | bash
curl -fsSl https://kubevela.io/script/checklegacy.sh | bash
```

这个脚本就是在帮你自动添加 Helm 的注解,你也可以通过如下命令手动修复:
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-v1.8/installation/kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ KubeVela CLI provides an easy way to engage and manage your application delivery
** MacOS/Linux **

```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
curl -fsSl https://kubevela.net/script/install.sh | bash -s v1.8.0
```

**Windows**
Expand Down Expand Up @@ -134,7 +134,7 @@ Refer to [using Vela CLI docker image](../platform-engineers/system-operation/ve
<TabItem value="vela">

```shell script
$ vela install
$ vela install --version=v1.8.0
```
<details>
<summary> check out the outcome </summary>
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-v1.8/installation/standalone.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ You may be required for root privilege during the installation process if not us
If you don't need the automation with root access, you can download from the [release page](https://github.com/kubevela/velad/releases) and uncompress manually.

```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash -s 1.8.2
```

Check `velad` installed in `/usr/local/bin/`
Expand Down Expand Up @@ -265,7 +265,7 @@ so you may be required for root privilege during the installation process.
If you don't need the automation with root access, you can download from the [release page](https://github.com/kubevela/velad/releases) and uncompress manually.
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash -s 1.8.2
```
Check `velad` installed in `/usr/local/bin/`
Expand Down Expand Up @@ -416,7 +416,7 @@ Then you need to copy this kubeconfig to your local machine. Let's say you savin
To access the cluster, you also need to install `vela` CLI in your local machine.
```shell
curl -fsSl https://static.kubevela.net/script/install.sh | bash
curl -fsSl https://static.kubevela.net/script/install.sh | bash -s 1.8.2
```
#### Access KubeVela
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ These isn't too much work to be done for upgrading from v1.7.x to v1.8.x for usa
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.8.0 --wait
helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.8.2 --wait
```

## From v1.6.x to v1.7.x
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Image Hub | "hub.kubevela.net" | "docker.io" or "ghcr.io/kubevela"
Helm charts | https://charts.kubevela.net/core | https://kubevela.github.io/charts
Official Addon Registry | https://addons.kubevela.net | https://kubevela.github.io/catalog/official
Experimental Addon Registry | - | https://kubevela.github.io/catalog/experimental
CLI | https://kubevela.net/script/install.sh | download from [release page](https://github.com/kubevela/kubevela/releases)
CLI | https://kubevela.io/script/install.sh | download from [release page](https://github.com/kubevela/kubevela/releases)
VelaD | - | migrating

### You have reached rate limit for Docker Image Registry
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ These isn't too much work to be done for upgrading from v1.7.x to v1.8.x for usa
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.8.0 --wait
helm upgrade -n vela-system --install kubevela kubevela/vela-core --version 1.8.2 --wait
```

## From v1.6.x to v1.7.x
Expand Down Expand Up @@ -55,7 +55,7 @@ Since we have migrated some workflow step definitions and views from workflow ad
You can execute this script to solve it before upgrade helm chart:

```
curl -fsSl https://kubevela.net/script/checklegacy.sh | bash
curl -fsSl https://kubevela.io/script/checklegacy.sh | bash
```

The script will just help patch helm annotations for you, you can also do that manually one by one like:
Expand Down

0 comments on commit d694f49

Please sign in to comment.