Skip to content

Commit

Permalink
update k8s versions
Browse files Browse the repository at this point in the history
Signed-off-by: Bettygogo2021 <[email protected]>
  • Loading branch information
Bettygogo2021 committed Nov 1, 2022
1 parent a50825c commit 3c8d470
Show file tree
Hide file tree
Showing 55 changed files with 118 additions and 120 deletions.
106 changes: 52 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,45 @@
# KubeSphere Website

This repository contains two branches that we are working on: master and release-3.0.
This repository contains branches that we are working on.

The master branch contains KubeSphere Doc 3.1 which has been released together with KubeSphere 3.1. The frontend website currently displays content based on the master branch. If the pull request you submit applies to both the master branch and the release-3.0 branch, use the command `cherry-pick` to submit the same pull request.
The master branch contains KubeSphere Doc 3.3 which has been released together with KubeSphere 3.3. The frontend website currently displays content based on the master branch. If the pull request you submit applies to both the master branch and other branches, use the command `cherry-pick` to submit the same pull request.

This project uses [Hugo](https://gohugo.io/) to build the KubeSphere website.

## Contribute
## Contribute to the project

Contributions of any kind are welcome! Thanks goes to these wonderful contributors, they made our community and product grow fast.
Contributions of any kind are welcome! Thanks goes to these wonderful contributors, they made our community and product grow fast.

<a href="https://github.com/kubesphere/website/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=kubesphere/website" />
</a>

### Fork and clone the repo
### Fork and clone the repository

First, create your own fork of the repository.
1. Fork the repository.

Then, clone your fork and enter into it:
2. Clone the repository to a local path and access it:

```
git clone https://github.com/<username>/website
cd website
```
```
git clone https://github.com/<username>/website
cd website
```

### Compiling and preview the website
### Compile and preview the website

You will need to build the website in order to **publish it as static content.**
You need to build the website to **publish it as static content.**

#### Install Hugo extended

Go to the [Hugo releases place](https://github.com/gohugoio/hugo/releases) and download the `hugo_extended` version that better suits your OS (version 0.70+).

**EXTENDED version is MANDATORY to properly build the static content!**

Note: If you install Hugo on Windows, you need to add environment variables for the exe file of Hugo. For example, you place the exe file in the path `C:\Hugo\bin`. You have to add this path in environment variables. Execute `hugo version` to view if the installation is successful.
Note: If you install Hugo on Windows, you need to add environment variables for the .exe file of Hugo. For example, you place the .exe file in the path `C:\Hugo\bin`. You have to add this path in environment variables. Execute `hugo version` to view if the installation is successful.

### Running the website locally
### Run the website locally

hugo version: hugo_extended_0.70.0+, you can install Hugo from [hugo releases](https://github.com/gohugoio/hugo/releases)

When you have installed Hugo, then run:
After you have installed Hugo, run the following command:

```
hugo server -D
Expand All @@ -51,70 +49,70 @@ Now you can preview the website in your browser using `http://localhost:1313/`.

### Open a pull request

Open a [pull request (PR)](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request#creating-a-new-pull-request) to add a localization to the repository. Please use DCO sign-off when you submit a pr. Refer to the command below (add `-s`):
Open a [pull request (PR)](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request#creating-a-new-pull-request) to make contributions to the repository. Please use DCO sign-off when you submit a pull request. Refer to the command below (add `-s`):

```bash
git commit -s -m "xxx"
```

### Preview a pull request

Go to **Files changed** tab. Click the three dots of the md file you want to preview as shown below. Please note that this method can only give you a preview on the GitHub instead of on the website.
Go to the **Files changed** tab. Click the three dots of the .md file you want to preview, and then click **View file**. Please note that this method can only give you a preview on the GitHub instead of on the website.

![view-file](https://ap3.qingstor.com/kubesphere-website/docs/view-file-github.png)
![view-file](static/images/common/view-file.png)

### Cherry Pick a Commit
### Cherry pick a commit

The command `cherry-pick` allows you to pick a commit in a branch and integrate it into another branch. For example, we are working on both the master branch and the release-3.0 branch. If the pull request you submit to the master branch applies to the release-3.0 branch as well:
The command `cherry-pick` allows you to pick a commit in a branch and integrate it into another branch. For example, we are working on both the master branch and the release-3.2 branch. If the pull request you submit to the master branch applies to the release-3.2 branch as well, perform the following steps:

In the master branch, find and copy the commit ID of your pull request.
1. In the master branch, find and copy the commit ID of your pull request.

```
git log
```
```
git log
```

Checkout to the release-3.0 branch:
2. Switch to the release-3.2 branch:

```
git checkout release-3.0
```
```
git checkout release-3.2
```

Rebase first:
3. Rebase first:

```bash
git pull --rebase upstream release-3.0
```
```bash
git pull --rebase upstream release-3.2
```

Use the branch release-3.0 to checkout a new branch:
4. Use the branch release-3.2 to switch to a new branch:

```bash
git checkout -b test
```
```bash
git checkout -b test
```

Cherry pick:
5. Cherry pick the commit:

```bash
git cherry-pick <CommitID>
```
```bash
git cherry-pick <CommitID>
```

Push it:
5. Push the commit:

```bash
git push -u origin test
```
```bash
git push -u origin test
```

When you submit the pull request, make sure you submit it to the release-3.0 branch.
When you submit the pull request, make sure you submit it to the release-3.2 branch.

## Localizing
## Localization

You are welcome to help the KubeSphere community to support more languages, join us to contribute to the localization, see [Localizing the website](localize-website.md) for the instruction.
You are welcome to join the KubeSphere community to contribute to the localization. Please refer to [Localizing the website](localize-website.md) for instructions.

## Build and Publish the website (Optional)
## Build and publish the website (optional)

### Config your domain
### Configure your domain

Edit the file `config\_default\config.toml` and modify the var `baseURL` (at the
first line) in order to set your own domain. It will be hardcoded in the static
first line) to set your own domain. It will be hardcoded in the static
files.

```
Expand Down Expand Up @@ -142,6 +140,6 @@ hugo
Total in 2396 ms
```

#### Get the already built static content
#### Get the generated static content

You will find the previously generated content in the `public` directory.
4 changes: 2 additions & 2 deletions content/en/common/kubernetes-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ _build:

| Installation Tool | KubeSphere version | Supported Kubernetes versions |
| ----------------- | ------------------ | ------------------------------------------------------------ |
| KubeKey | 3.2.0 | v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental) |
| ks-installer | 3.2.0 | v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental) |
| KubeKey | 3.3.1 | v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), v1.23.x (experimental support) |
| ks-installer | 3.3.1 | v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), v1.23.x (experimental support) |

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 3.3: v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support).
These Kubernetes clusters can be hosted across different cloud providers and their Kubernetes versions can also vary. Recommended Kubernetes versions for KubeSphere 3.3: v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support).

{{</ notice >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You need to select:

{{< notice note >}}

- To install KubeSphere 3.3 on Kubernetes, your Kubernetes version must be v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support).
- To install KubeSphere 3.3 on Kubernetes, your Kubernetes version must be v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support).
- 2 nodes are included in this example. You can add more nodes based on your own needs, especially in a production environment.
- The machine type Standard / 4 GB / 2 vCPUs is for minimal installation. If you plan to enable several pluggable components or use the cluster for production, you can upgrade your nodes to a more powerful type (such as CPU-Optimized / 8 GB / 4 vCPUs). It seems that DigitalOcean provisions the control plane nodes based on the type of the worker nodes, and for Standard ones the API server can become unresponsive quite soon.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This guide walks you through the steps of deploying KubeSphere on [Google Kubern

{{< notice note >}}

- To install KubeSphere 3.3 on Kubernetes, your Kubernetes version must be v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support).
- To install KubeSphere 3.3 on Kubernetes, your Kubernetes version must be v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support).
- 3 nodes are included in this example. You can add more nodes based on your own needs especially in a production environment.
- The machine type e2-medium (2 vCPU, 4GB memory) is for minimal installation. If you want to enable pluggable components or use the cluster for production, please select a machine type with more resources.
- For other settings, you can change them as well based on your own needs or use the default value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This guide walks you through the steps of deploying KubeSphere on [Huaiwei CCE](

First, create a Kubernetes cluster based on the requirements below.

- To install KubeSphere 3.3 on Kubernetes, your Kubernetes version must be v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support).
- To install KubeSphere 3.3 on Kubernetes, your Kubernetes version must be v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support).
- Ensure the cloud computing network for your Kubernetes cluster works, or use an elastic IP when you use **Auto Create** or **Select Existing**. You can also configure the network after the cluster is created. Refer to [NAT Gateway](https://support.huaweicloud.com/en-us/productdesc-natgateway/en-us_topic_0086739762.html).
- Select `s3.xlarge.2` `4-core|8GB` for nodes and add more if necessary (3 and more nodes are required for a production environment).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This guide walks you through the steps of deploying KubeSphere on [Oracle Kubern

{{< notice note >}}

- To install KubeSphere 3.3 on Kubernetes, your Kubernetes version must be v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support).
- To install KubeSphere 3.3 on Kubernetes, your Kubernetes version must be v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support).
- It is recommended that you should select **Public** for **Visibility Type**, which will assign a public IP address for every node. The IP address can be used later to access the web console of KubeSphere.
- In Oracle Cloud, a Shape is a template that determines the number of CPUs, amount of memory, and other resources that are allocated to an instance. `VM.Standard.E2.2 (2 CPUs and 16G Memory)` is used in this example. For more information, see [Standard Shapes](https://docs.cloud.oracle.com/en-us/iaas/Content/Compute/References/computeshapes.htm#vmshapes__vm-standard).
- 3 nodes are included in this example. You can add more nodes based on your own needs especially in a production environment.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Create an example configuration file with default configurations. Here Kubernete

{{< notice note >}}

- Recommended Kubernetes versions for KubeSphere 3.3: v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support). If you do not specify a Kubernetes version, KubeKey will install Kubernetes v1.23.7 by default. For more information about supported Kubernetes versions, see [Support Matrix](../../../installing-on-linux/introduction/kubekey/#support-matrix).
- Recommended Kubernetes versions for KubeSphere 3.3: v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support). If you do not specify a Kubernetes version, KubeKey will install Kubernetes v1.23.7 by default. For more information about supported Kubernetes versions, see [Support Matrix](../../../installing-on-linux/introduction/kubekey/#support-matrix).

- If you do not add the flag `--with-kubesphere` in the command in this step, KubeSphere will not be deployed unless you install it using the `addons` field in the configuration file or add this flag again when you use `./kk create cluster` later.
- If you add the flag `--with-kubesphere` without specifying a KubeSphere version, the latest version of KubeSphere will be installed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Create an example configuration file with default configurations. Here Kubernete

{{< notice note >}}

- Recommended Kubernetes versions for KubeSphere 3.3: v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support). If you do not specify a Kubernetes version, KubeKey will install Kubernetes v1.23.7 by default. For more information about supported Kubernetes versions, see [Support Matrix](../../../installing-on-linux/introduction/kubekey/#support-matrix).
- Recommended Kubernetes versions for KubeSphere 3.3: v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support). If you do not specify a Kubernetes version, KubeKey will install Kubernetes v1.23.7 by default. For more information about supported Kubernetes versions, see [Support Matrix](../../../installing-on-linux/introduction/kubekey/#support-matrix).
- If you do not add the flag `--with-kubesphere` in the command in this step, KubeSphere will not be deployed unless you install it using the `addons` field in the configuration file or add this flag again when you use `./kk create cluster` later.
- If you add the flag `--with-kubesphere` without specifying a KubeSphere version, the latest version of KubeSphere will be installed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ Create an example configuration file with default configurations. Here Kubernete

{{< notice note >}}

- Recommended Kubernetes versions for KubeSphere 3.3: v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support). If you do not specify a Kubernetes version, KubeKey will install Kubernetes v1.23.7 by default. For more information about supported Kubernetes versions, see [Support Matrix](../../../installing-on-linux/introduction/kubekey/#support-matrix).
- Recommended Kubernetes versions for KubeSphere 3.3: v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support). If you do not specify a Kubernetes version, KubeKey will install Kubernetes v1.23.7 by default. For more information about supported Kubernetes versions, see [Support Matrix](../../../installing-on-linux/introduction/kubekey/#support-matrix).

- If you do not add the flag `--with-kubesphere` in the command in this step, KubeSphere will not be deployed unless you install it using the `addons` field in the configuration file or add this flag again when you use `./kk create cluster` later.
- If you add the flag `--with-kubesphere` without specifying a KubeSphere version, the latest version of KubeSphere will be installed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,11 @@ If you want to use KubeKey to install both Kubernetes and KubeSphere 3.3, see th

| KubeSphere version | Supported Kubernetes versions |
| ------------------ | ------------------------------------------------------------ |
| v3.3.1 | v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support) |
| v3.3.1 | v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support) |

{{< notice note >}}

- You can also run `./kk version --show-supported-k8s` to see all supported Kubernetes versions that can be installed by KubeKey.
- The Kubernetes versions that can be installed using KubeKey are different from the Kubernetes versions supported by KubeSphere 3.3. If you want to [install KubeSphere 3.3 on an existing Kubernetes cluster](../../../installing-on-kubernetes/introduction/overview/), your Kubernetes version must be v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support).
- If you want to use KubeEdge, you are advised to install Kubernetes v1.22.x or earlier to prevent compatability issues.
- The Kubernetes versions that can be installed using KubeKey are different from the Kubernetes versions supported by KubeSphere 3.3. If you want to [install KubeSphere 3.3 on an existing Kubernetes cluster](../../../installing-on-kubernetes/introduction/overview/), your Kubernetes version must be v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support).
- If you want to use KubeEdge, you are advised to install Kubernetes v1.21.x or earlier to prevent compatability issues.
{{</ notice >}}
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Command:

{{< notice note >}}

- Recommended Kubernetes versions for KubeSphere 3.3: v1.19.x, v1.20.x, v1.21.x, v1.22.x, and v1.23.x (experimental support). If you do not specify a Kubernetes version, KubeKey will install Kubernetes v1.23.7 by default. For more information about supported Kubernetes versions, see [Support Matrix](../kubekey/#support-matrix).
- Recommended Kubernetes versions for KubeSphere 3.3: v1.19.x, v1.20.x, v1.21.x, v1.22.x (experimental support), and v1.23.x (experimental support). If you do not specify a Kubernetes version, KubeKey will install Kubernetes v1.23.7 by default. For more information about supported Kubernetes versions, see [Support Matrix](../kubekey/#support-matrix).

- If you do not add the flag `--with-kubesphere` in the command in this step, KubeSphere will not be deployed unless you install it using the `addons` field in the configuration file or add this flag again when you use `./kk create cluster` later.
- If you add the flag `--with-kubesphere` without specifying a KubeSphere version, the latest version of KubeSphere will be installed.
Expand Down
Loading

0 comments on commit 3c8d470

Please sign in to comment.