Skip to content

Commit

Permalink
Merge pull request #909 from lvillis/master
Browse files Browse the repository at this point in the history
docs: Update kk upgrade parameters
  • Loading branch information
ks-ci-bot committed Dec 21, 2021
2 parents 5a3d6c4 + 435d2f8 commit 2fb0649
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ You have more control to customize parameters or create a multi-node cluster usi
1. First, create an example configuration file

```shell script
./kk create config [--with-kubernetes version] [--with-kubesphere version] [(-f | --file) path]
./kk create config [--with-kubernetes version] [--with-kubesphere version] [(-f | --filename) path]
```

**examples:**
Expand Down Expand Up @@ -225,7 +225,7 @@ Upgrading cluster with a specified version.
#### Multi-nodes
Upgrading cluster with a specified configuration file.
```shell script
./kk upgrade [--with-kubernetes version] [--with-kubesphere version] [(-f | --file) path]
./kk upgrade [--with-kubernetes version] [--with-kubesphere version] [(-f | --filename) path]
```
* If `--with-kubernetes` or `--with-kubesphere` is specified, the configuration file will be also updated.
* Use `-f` to specify the configuration file which was generated for cluster creation.
Expand All @@ -234,7 +234,7 @@ Upgrading cluster with a specified configuration file.
Getting cluster info and generating kubekey's configuration file (optional).
```shell script
./kk create config [--from-cluster] [(-f | --file) path] [--kubeconfig path]
./kk create config [--from-cluster] [(-f | --filename) path] [--kubeconfig path]
```
* `--from-cluster` means fetching cluster's information from an existing cluster.
* `-f` refers to the path where the configuration file is generated.
Expand Down
6 changes: 3 additions & 3 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ KubeKey 可以同时安装 Kubernetes 和 KubeSphere。根据 KubeSphere 所安
1. 首先,创建一个示例配置文件

```shell script
./kk create config [--with-kubernetes version] [--with-kubesphere version] [(-f | --file) path]
./kk create config [--with-kubernetes version] [--with-kubesphere version] [(-f | --filename) path]
```

**例子:**
Expand Down Expand Up @@ -225,7 +225,7 @@ KubeSphere 有多个可插拔功能组件,功能组件的介绍可参考 [配
#### 多节点集群
通过指定配置文件对集群进行升级。
```shell script
./kk upgrade [--with-kubernetes version] [--with-kubesphere version] [(-f | --file) path]
./kk upgrade [--with-kubernetes version] [--with-kubesphere version] [(-f | --filename) path]
```
* `--with-kubernetes` 指定kubernetes目标版本。
* `--with-kubesphere` 指定kubesphere目标版本。
Expand All @@ -235,7 +235,7 @@ KubeSphere 有多个可插拔功能组件,功能组件的介绍可参考 [配
Getting cluster info and generating kubekey's configuration file (optional).
```shell script
./kk create config [--from-cluster] [(-f | --file) path] [--kubeconfig path]
./kk create config [--from-cluster] [(-f | --filename) path] [--kubeconfig path]
```
* `--from-cluster` 根据已存在集群信息生成配置文件.
* `-f` 指定生成配置文件路径.
Expand Down

0 comments on commit 2fb0649

Please sign in to comment.