Skip to content

Commit

Permalink
Update upgrade docs and download links.
Browse files Browse the repository at this point in the history
Signed-off-by: serenashe <[email protected]>
  • Loading branch information
serenashe authored and Felixnoo committed Nov 1, 2021
1 parent c16415d commit 6ec5831
Show file tree
Hide file tree
Showing 101 changed files with 322 additions and 367 deletions.
2 changes: 1 addition & 1 deletion KubeSphere Documentation Style Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ When describing the UI, you can use the following prepositions.
```bash
# Assume your original Kubernetes cluster is v1.17.9
./kk create config --with-kubesphere --with-kubernetes v1.17.9
./kk create config --with-kubesphere --with-kubernetes v1.20.4
```

- If the comment is used for all the code (for example, serving as a header for explanations), put the comment at the beginning above the code. For example:
Expand Down
2 changes: 1 addition & 1 deletion content/en/blogs/aws-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ sudo systemctl restart sshd
Download KubeKey from the [Github Release Page](https://github.com/kubesphere/kubekey/releases) or run the following command:

```
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.1.1 sh -
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.2.0 sh -
```

## Use KubeKey to Deploy a Kubernetes Cluster
Expand Down
2 changes: 1 addition & 1 deletion content/en/blogs/install-kubernetes-using-kubekey.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ You can use KubeKey to install a specified Kubernetes version. The dependency th
The default Kubernetes version is v1.17.9. For more information about supported Kubernetes versions, see this [file](https://github.com/kubesphere/kubekey/blob/master/docs/kubernetes-versions.md). Execute the following command as an example:

```bash
./kk create config --with-kubernetes v1.17.9
./kk create config --with-kubernetes v1.20.4
```

4. A default file `config-sample.yaml` will be created if you do not customize the name. Edit the file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ Now that we have our server machine ready, we need to install `nfs-common` on al
3. Specify a Kubernetes version and a KubeSphere version that you want to install. For more information about supported Kubernetes versions, see [this list](https://github.com/kubesphere/kubekey/blob/master/docs/kubernetes-versions.md).

```bash
./kk create config --with-kubernetes v1.17.9 --with-kubesphere v3.0.0
./kk create config --with-kubernetes v1.20.4 --with-kubesphere v3.0.0
```

4. A default file `config-sample.yaml` will be created if you do not customize the name. Edit the file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ Before you start to create your Kubernetes cluster, make sure you have tested th
3. Create a configuration file to specify cluster information. The Kubernetes version I am going to install is `v1.17.9`.

```bash
./kk create config --with-kubernetes v1.17.9
./kk create config --with-kubernetes v1.20.4
```

4. A default file `config-sample.yaml` will be created. Edit the file and here is my configuration for your reference:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ See the table below for the role of each cluster.

{{< notice note >}}

These Kubernetes clusters can be hosted across different cloud providers and their Kubernetes versions can also vary. Recommended Kubernetes versions for KubeSphere v3.1.0: v1.17.9, v1.18.8, v1.19.8 and v1.20.4.
These Kubernetes clusters can be hosted across different cloud providers and their Kubernetes versions can also vary. Recommended Kubernetes versions for KubeSphere v3.2.0: v1.19.x, v1.20.x, v1.21.5, and v1.22.1.

{{</ notice >}}

Expand Down
21 changes: 0 additions & 21 deletions content/en/docs/faq/access-control/cannot-login.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,24 +139,3 @@ You need to restore Redis and make sure it is running normally with good network
```
kubectl -n kubesphere-system rollout restart deploy ks-console
```


## Unable to Log in through a Third Party Account after Upgrading

![forbidden](/images/docs/faq/access-control-and-account-management/cannot-login/forbidden.jpg)

```js
{
code: 403,
kind: 'Status',
apiVersion: 'v1',
metadata: {},
status: 'Failure',
message: 'users.iam.kubesphere.io is forbidden: User "system:pre-registration" cannot create resource "users" in API group "iam.kubesphere.io" at the cluster scope',
reason: 'Forbidden',
details: { group: 'iam.kubesphere.io', kind: 'users' },
statusText: 'Forbidden'
}
```

This is a bug in the process of upgrading from V3.0.0 to v3.1.0. For more information about related issues and solutions, see https://github.com/kubesphere/kubesphere/issues/3850.
6 changes: 3 additions & 3 deletions content/en/docs/faq/installation/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ Telemetry is enabled by default when you install KubeSphere, while you also have

### Disable Telemetry before installation

When you install KubeSphere on an existing Kubernetes cluster, you need to download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml) for cluster settings. If you want to disable Telemetry, do not run `kubectl apply -f` directly for this file.
When you install KubeSphere on an existing Kubernetes cluster, you need to download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/cluster-configuration.yaml) for cluster settings. If you want to disable Telemetry, do not run `kubectl apply -f` directly for this file.

{{< notice note >}}

If you install KubeSphere on Linux, see [Disable Telemetry After Installation](../telemetry/#disable-telemetry-after-installation) directly.

{{</ notice >}}

1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml) and edit it:
1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/cluster-configuration.yaml) and edit it:

```bash
vi cluster-configuration.yaml
Expand All @@ -57,7 +57,7 @@ If you install KubeSphere on Linux, see [Disable Telemetry After Installation](.
3. Save the file and run the following commands to start installation.

```bash
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/kubesphere-installer.yaml
kubectl apply -f cluster-configuration.yaml
```
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/faq/upgrade/qingcloud-csi-upgrade.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Upgrade QingCloud CSI"
keywords: "Kubernetes, upgrade, KubeSphere, v3.0.0"
keywords: "Kubernetes, upgrade, KubeSphere, v3.2.0"
description: "Upgrade the QingCloud CSI after you upgrade KubeSphere."
linkTitle: "Upgrade QingCloud CSI"
weight: 16210
Expand All @@ -19,7 +19,7 @@ cd qingcloud-csi/
```

```
git checkout v1.1.1
git checkout v1.2.0
```

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ All the other Resources will be placed in `MC_KubeSphereRG_KuberSphereCluster_we
To start deploying KubeSphere, use the following commands.

```bash
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/kubesphere-installer.yaml

kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/cluster-configuration.yaml
```

You can inspect the logs of installation through the following command:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ Now that the cluster is ready, you can install KubeSphere following the steps be
- Install KubeSphere using kubectl. The following commands are only for the default minimal installation.

```bash
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/kubesphere-installer.yaml

kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/cluster-configuration.yaml
```

- Inspect the logs of installation:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,9 @@ We will use the kubectl command-line utility for communicating with the cluster
- Install KubeSphere using kubectl. The following commands are only for the default minimal installation.

```bash
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/kubesphere-installer.yaml

kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/cluster-configuration.yaml
```

- Inspect the logs of installation:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ This guide walks you through the steps of deploying KubeSphere on [Google Kubern
- Install KubeSphere using kubectl. The following commands are only for the default minimal installation.

```bash
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/kubesphere-installer.yaml

kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/cluster-configuration.yaml
```

- Inspect the logs of installation:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ For how to set up or cancel a default StorageClass, refer to Kubernetes official
Use [ks-installer](https://github.com/kubesphere/ks-installer) to deploy KubeSphere on an existing Kubernetes cluster. Execute the following commands directly for a minimal installation:
```bash
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/kubesphere-installer.yaml

kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/cluster-configuration.yaml
```

Go to **Workload** > **Pod**, and check the running status of the pod in `kubesphere-system` of its namespace to understand the minimal deployment of KubeSphere. Check `ks-console-xxxx` of the namespace to understand the availability of KubeSphere console.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ This guide walks you through the steps of deploying KubeSphere on [Oracle Kubern
- Install KubeSphere using kubectl. The following commands are only for the default minimal installation.

```bash
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/kubesphere-installer.yaml

kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/cluster-configuration.yaml
```

- Inspect the logs of installation:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ After you make sure your existing Kubernetes cluster meets all the requirements,
1. Execute the following commands to start installation:

```bash
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/kubesphere-installer.yaml

kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/cluster-configuration.yaml
```

2. Inspect the logs of installation:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ As you install KubeSphere in an air-gapped environment, you need to prepare an i
1. Download the image list file `images-list.txt` from a machine that has access to the Internet through the following command:

```bash
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/images-list.txt
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/images-list.txt
```

{{< notice note >}}
Expand All @@ -101,7 +101,7 @@ As you install KubeSphere in an air-gapped environment, you need to prepare an i
2. Download `offline-installation-tool.sh`.

```bash
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/offline-installation-tool.sh
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/offline-installation-tool.sh
```

3. Make the `.sh` file executable.
Expand Down Expand Up @@ -161,8 +161,8 @@ Similar to installing KubeSphere on an existing Kubernetes cluster in an online
1. Execute the following commands to download these two files and transfer them to your machine that serves as the taskbox for installation.

```bash
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/cluster-configuration.yaml
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/kubesphere-installer.yaml
```

2. Edit `cluster-configuration.yaml` to add your private image registry. For example, `dockerhub.kubekey.local` is the registry address in this tutorial, then use it as the value of `.spec.local_registry` as below:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ You must create a load balancer in your environment to listen (also known as lis
Download KubeKey from its [GitHub Release Page](https://github.com/kubesphere/kubekey/releases) or use the following command directly.

```bash
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.1.1 sh -
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.2.0 sh -
```

{{</ tab >}}
Expand All @@ -64,7 +64,7 @@ export KKZONE=cn
Run the following command to download KubeKey:

```bash
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.1.1 sh -
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.2.0 sh -
```

{{< notice note >}}
Expand All @@ -79,7 +79,7 @@ After you download KubeKey, if you transfer it to a new machine also with poor n

{{< notice note >}}

The commands above download the latest release (v1.1.1) of KubeKey. You can change the version number in the command to download a specific version.
The commands above download the latest release (v1.2.0) of KubeKey. You can change the version number in the command to download a specific version.

{{</ notice >}}

Expand All @@ -92,7 +92,7 @@ chmod +x kk
Create an example configuration file with default configurations. Here Kubernetes v1.20.4 is used as an example.

```bash
./kk create config --with-kubesphere v3.1.1 --with-kubernetes v1.20.4
./kk create config --with-kubesphere v3.2.0 --with-kubernetes v1.20.4
```

{{< notice note >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ Before you start to create your Kubernetes cluster, make sure you have tested th
Download KubeKey from its [GitHub Release Page](https://github.com/kubesphere/kubekey/releases) or use the following command directly.

```bash
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.1.1 sh -
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.2.0 sh -
```

{{</ tab >}}
Expand All @@ -284,7 +284,7 @@ export KKZONE=cn
Run the following command to download KubeKey:

```bash
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.1.1 sh -
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.2.0 sh -
```

{{< notice note >}}
Expand All @@ -299,7 +299,7 @@ After you download KubeKey, if you transfer it to a new machine also with poor n

{{< notice note >}}

The commands above download the latest release (v1.1.1) of KubeKey. You can change the version number in the command to download a specific version.
The commands above download the latest release (v1.2.0) of KubeKey. You can change the version number in the command to download a specific version.

{{</ notice >}}

Expand All @@ -312,7 +312,7 @@ chmod +x kk
Create an example configuration file with default configurations. Here Kubernetes v1.20.4 is used as an example.

```bash
./kk create config --with-kubesphere v3.1.1 --with-kubernetes v1.20.4
./kk create config --with-kubesphere v3.2.0 --with-kubernetes v1.20.4
```

{{< notice note >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ docker run -d \

## Step 3: Download KubeKey

Similar to installing KubeSphere on Linux in an online environment, you also need to [download KubeKey v1.1.1](https://github.com/kubesphere/kubekey/releases) first. Download the `tar.gz` file, and transfer it to your local machine which serves as the taskbox for installation. After you uncompress the file, execute the following command to make `kk` executable:
Similar to installing KubeSphere on Linux in an online environment, you also need to [download KubeKey v1.2.0](https://github.com/kubesphere/kubekey/releases) first. Download the `tar.gz` file, and transfer it to your local machine which serves as the taskbox for installation. After you uncompress the file, execute the following command to make `kk` executable:

```bash
chmod +x kk
Expand All @@ -162,7 +162,7 @@ As you install KubeSphere and Kubernetes on Linux, you need to prepare an image
1. Download the image list file `images-list.txt` from a machine that has access to the Internet through the following command:

```bash
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/images-list.txt
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/images-list.txt
```

{{< notice note >}}
Expand All @@ -174,7 +174,7 @@ As you install KubeSphere and Kubernetes on Linux, you need to prepare an image
2. Download `offline-installation-tool.sh`.

```bash
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/offline-installation-tool.sh
curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/offline-installation-tool.sh
```

3. Make the `.sh` file executable.
Expand Down Expand Up @@ -204,13 +204,13 @@ As you install KubeSphere and Kubernetes on Linux, you need to prepare an image
5. Download the Kubernetes binary file.

```bash
./offline-installation-tool.sh -b -v v1.17.9
./offline-installation-tool.sh -b -v v1.21.5
```

If you cannot access the object storage service of Google, run the following command instead to add the environment variable to change the source.

```bash
export KKZONE=cn;./offline-installation-tool.sh -b -v v1.17.9
export KKZONE=cn;./offline-installation-tool.sh -b -v v1.21.5
```

{{< notice note >}}
Expand Down Expand Up @@ -262,7 +262,7 @@ Execute the following command to generate an example configuration file for inst
For example:

```bash
./kk create config --with-kubernetes v1.17.9 --with-kubesphere v3.1.1 -f config-sample.yaml
./kk create config --with-kubernetes v1.21.5 --with-kubesphere v3.2.0 -f config-sample.yaml
```

{{< notice note >}}
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/installing-on-linux/introduction/kubekey.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ With the configuration file in place, you execute the `./kk` command with varied
Download KubeKey from its [GitHub Release Page](https://github.com/kubesphere/kubekey/releases) or use the following command directly.

```bash
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.1.1 sh -
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.2.0 sh -
```

{{</ tab >}}
Expand All @@ -54,7 +54,7 @@ export KKZONE=cn
Run the following command to download KubeKey:

```bash
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.1.1 sh -
curl -sfL https://get-kk.kubesphere.io | VERSION=v1.2.0 sh -
```

{{< notice note >}}
Expand All @@ -69,7 +69,7 @@ After you download KubeKey, if you transfer it to a new machine also with poor n

{{< notice note >}}

The commands above download the latest release (v1.1.1) of KubeKey. You can change the version number in the command to download a specific version.
The commands above download the latest release (v1.2.0) of KubeKey. You can change the version number in the command to download a specific version.

{{</ notice >}}

Expand Down
Loading

0 comments on commit 6ec5831

Please sign in to comment.