Skip to content

Commit eba8551

Browse files
JacieChaoJacieChao
committed
feat(docs): update docs for v0.9.3
1 parent 95742d2 commit eba8551

14 files changed

Lines changed: 376 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ Scenario 1 - Run with docker:
5555
```bash
5656
# The commands will start autok3s daemon with an interactionable UI.
5757
# Standard Linux (Recommended)
58-
$ docker run -itd --restart=unless-stopped --net=host -v /var/run/docker.sock:/var/run/docker.sock cnrancher/autok3s:v0.9.2
58+
$ docker run -itd --restart=unless-stopped --net=host -v /var/run/docker.sock:/var/run/docker.sock cnrancher/autok3s:v0.9.3
5959

6060
# MacOS
61-
$ docker run -itd --restart=unless-stopped -p 8080:8080 -v /var/run/docker.sock:/var/run/docker.sock -e DOCKER_HOST="" cnrancher/autok3s:v0.9.2
61+
$ docker run -itd --restart=unless-stopped -p 8080:8080 -v /var/run/docker.sock:/var/run/docker.sock -e DOCKER_HOST="" cnrancher/autok3s:v0.9.3
6262
```
6363

6464
Scenario 2 - Run with docker-compose

‎docker-compose.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ services:
77
volumes:
88
- /var/run/docker.sock:/tmp/docker.sock:ro
99
autok3s:
10-
image: cnrancher/autok3s:v0.9.2
10+
image: cnrancher/autok3s:v0.9.3
1111
init: true
1212
ports:
1313
- 8080

‎docs/assets/alibaba/custom-create-cluster-k3s.png‎

-935 KB
Loading

‎docs/i18n/en_us/alibaba/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,41 @@ Run the command below and create an HA K3s cluster with an external database:
163163
autok3s -d create -p alibaba --name myk3s --master 2 --datastore "mysql://<user>:<password>@tcp(<ip>:<port>)/<db>"
164164
```
165165

166+
### Advanced Settings
167+
168+
The AutoK3s supports more advanced settings to customize your K3s cluster.
169+
170+
#### Installation Environments
171+
172+
If you want to add more installation environments, please set the args below:
173+
174+
```bash
175+
--install-env INSTALL_K3S_SKIP_SELINUX_RPM=true --install-env INSTALL_K3S_FORCE_RESTART=true
176+
```
177+
178+
> We recommend you to only use INSTALL_* parameters for this case because this is a global setting to your K3s cluster. If you want to set the K3S_* environments, please use the K3s configuration file args.
179+
180+
#### Server/Agent Configuration File
181+
182+
In addition to configuring K3s with environment variables and CLI arguments, K3s can also use a config file.
183+
184+
If you want to do more customize and complex configurations for your K3s cluster, such as etcd snapshot or datastore. This arg is what you need.
185+
186+
Here's an example of a K3s server configuration with etcd snapshot information and change the node port range.
187+
```yaml
188+
etcd-snapshot-schedule-cron: "* * * * *"
189+
etcd-snapshot-retention: 15
190+
service-node-port-range: "20000-30000"
191+
```
192+
193+
Save this yaml file to your local path, such as `myk3s-server-config.yaml`. Then pass this file by the following arg:
194+
195+
```bash
196+
--server-config-file /your/path/myk3s-server-config.yaml
197+
```
198+
199+
If you want to set the configuration file to your agent node, use the arg `--agent-config-file /your/path/agent-config.yaml`
200+
166201
## Join K3s Nodes
167202

168203
Please use `autok3s join` command to add one or more nodes for an existing K3s cluster.

‎docs/i18n/en_us/aws/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,41 @@ Run the command below and create an HA K3s cluster with an external database:
117117
autok3s -d create -p aws --name myk3s --master 2 --datastore "mysql://<user>:<password>@tcp(<ip>:<port>)/<db>"
118118
```
119119

120+
### Advanced Settings
121+
122+
The AutoK3s supports more advanced settings to customize your K3s cluster.
123+
124+
#### Installation Environments
125+
126+
If you want to add more installation environments, please set the args below:
127+
128+
```bash
129+
--install-env INSTALL_K3S_SKIP_SELINUX_RPM=true --install-env INSTALL_K3S_FORCE_RESTART=true
130+
```
131+
132+
> We recommend you to only use INSTALL_* parameters for this case because this is a global setting to your K3s cluster. If you want to set the K3S_* environments, please use the K3s configuration file args.
133+
134+
#### Server/Agent Configuration File
135+
136+
In addition to configuring K3s with environment variables and CLI arguments, K3s can also use a config file.
137+
138+
If you want to do more customize and complex configurations for your K3s cluster, such as etcd snapshot or datastore. This arg is what you need.
139+
140+
Here's an example of a K3s server configuration with etcd snapshot information and change the node port range.
141+
```yaml
142+
etcd-snapshot-schedule-cron: "* * * * *"
143+
etcd-snapshot-retention: 15
144+
service-node-port-range: "20000-30000"
145+
```
146+
147+
Save this yaml file to your local path, such as `myk3s-server-config.yaml`. Then pass this file by the following arg:
148+
149+
```bash
150+
--server-config-file /your/path/myk3s-server-config.yaml
151+
```
152+
153+
If you want to set the configuration file to your agent node, use the arg `--agent-config-file /your/path/agent-config.yaml`
154+
120155
## Join K3s Nodes
121156

122157
Please use `autok3s join` command to add one or more nodes for an existing K3s cluster.

‎docs/i18n/en_us/google/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,41 @@ Run the command below and create an HA K3s cluster with an external database:
8080
autok3s -d create -p google --name myk3s --master 2 --datastore "mysql://<user>:<password>@tcp(<ip>:<port>)/<db>"
8181
```
8282

83+
### Advanced Settings
84+
85+
The AutoK3s supports more advanced settings to customize your K3s cluster.
86+
87+
#### Installation Environments
88+
89+
If you want to add more installation environments, please set the args below:
90+
91+
```bash
92+
--install-env INSTALL_K3S_SKIP_SELINUX_RPM=true --install-env INSTALL_K3S_FORCE_RESTART=true
93+
```
94+
95+
> We recommend you to only use INSTALL_* parameters for this case because this is a global setting to your K3s cluster. If you want to set the K3S_* environments, please use the K3s configuration file args.
96+
97+
#### Server/Agent Configuration File
98+
99+
In addition to configuring K3s with environment variables and CLI arguments, K3s can also use a config file.
100+
101+
If you want to do more customize and complex configurations for your K3s cluster, such as etcd snapshot or datastore. This arg is what you need.
102+
103+
Here's an example of a K3s server configuration with etcd snapshot information and change the node port range.
104+
```yaml
105+
etcd-snapshot-schedule-cron: "* * * * *"
106+
etcd-snapshot-retention: 15
107+
service-node-port-range: "20000-30000"
108+
```
109+
110+
Save this yaml file to your local path, such as `myk3s-server-config.yaml`. Then pass this file by the following arg:
111+
112+
```bash
113+
--server-config-file /your/path/myk3s-server-config.yaml
114+
```
115+
116+
If you want to set the configuration file to your agent node, use the arg `--agent-config-file /your/path/agent-config.yaml`
117+
83118
## Join K3s Nodes
84119

85120
Please use `autok3s join` command to add one or more nodes for an existing K3s cluster.

‎docs/i18n/en_us/native/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,41 @@ autok3s -d create \
8686
--datastore "mysql://<user>:<password>@tcp(<ip>:<port>)/<db>"
8787
```
8888

89+
### Advanced Settings
90+
91+
The AutoK3s supports more advanced settings to customize your K3s cluster.
92+
93+
#### Installation Environments
94+
95+
If you want to add more installation environments, please set the args below:
96+
97+
```bash
98+
--install-env INSTALL_K3S_SKIP_SELINUX_RPM=true --install-env INSTALL_K3S_FORCE_RESTART=true
99+
```
100+
101+
> We recommend you to only use INSTALL_* parameters for this case because this is a global setting to your K3s cluster. If you want to set the K3S_* environments, please use the K3s configuration file args.
102+
103+
#### Server/Agent Configuration File
104+
105+
In addition to configuring K3s with environment variables and CLI arguments, K3s can also use a config file.
106+
107+
If you want to do more customize and complex configurations for your K3s cluster, such as etcd snapshot or datastore. This arg is what you need.
108+
109+
Here's an example of a K3s server configuration with etcd snapshot information and change the node port range.
110+
```yaml
111+
etcd-snapshot-schedule-cron: "* * * * *"
112+
etcd-snapshot-retention: 15
113+
service-node-port-range: "20000-30000"
114+
```
115+
116+
Save this yaml file to your local path, such as `myk3s-server-config.yaml`. Then pass this file by the following arg:
117+
118+
```bash
119+
--server-config-file /your/path/myk3s-server-config.yaml
120+
```
121+
122+
If you want to set the configuration file to your agent node, use the arg `--agent-config-file /your/path/agent-config.yaml`
123+
89124
## Join K3s Nodes
90125

91126
Please use `autok3s join` command to add one or more nodes for an existing K3s cluster.

‎docs/i18n/en_us/tencent/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,41 @@ Run the command below and create an HA K3s cluster with an external database:
132132
autok3s -d create -p tencent --name myk3s --master 2 --datastore "mysql://<user>:<password>@tcp(<ip>:<port>)/<db>"
133133
```
134134

135+
### Advanced Settings
136+
137+
The AutoK3s supports more advanced settings to customize your K3s cluster.
138+
139+
#### Installation Environments
140+
141+
If you want to add more installation environments, please set the args below:
142+
143+
```bash
144+
--install-env INSTALL_K3S_SKIP_SELINUX_RPM=true --install-env INSTALL_K3S_FORCE_RESTART=true
145+
```
146+
147+
> We recommend you to only use INSTALL_* parameters for this case because this is a global setting to your K3s cluster. If you want to set the K3S_* environments, please use the K3s configuration file args.
148+
149+
#### Server/Agent Configuration File
150+
151+
In addition to configuring K3s with environment variables and CLI arguments, K3s can also use a config file.
152+
153+
If you want to do more customize and complex configurations for your K3s cluster, such as etcd snapshot or datastore. This arg is what you need.
154+
155+
Here's an example of a K3s server configuration with etcd snapshot information and change the node port range.
156+
```yaml
157+
etcd-snapshot-schedule-cron: "* * * * *"
158+
etcd-snapshot-retention: 15
159+
service-node-port-range: "20000-30000"
160+
```
161+
162+
Save this yaml file to your local path, such as `myk3s-server-config.yaml`. Then pass this file by the following arg:
163+
164+
```bash
165+
--server-config-file /your/path/myk3s-server-config.yaml
166+
```
167+
168+
If you want to set the configuration file to your agent node, use the arg `--agent-config-file /your/path/agent-config.yaml`
169+
135170
## Join K3s Nodes
136171

137172
Please use `autok3s join` command to add one or more nodes for an existing K3s cluster.

‎docs/i18n/zh_cn/README.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ AutoK3s 可以支持以下云厂商，我们会根据社区反馈添加更多支
3232
您可以通过以下 Docker 命令，一键启动 AutoK3s 本地 UI，快速体验相关功能。
3333

3434
```bash
35-
docker run -itd --restart=unless-stopped -p 8080:8080 cnrancher/autok3s:v0.9.2
35+
docker run -itd --restart=unless-stopped -p 8080:8080 cnrancher/autok3s:v0.9.3
3636
```
3737

3838
如果您想要在 docker 中使用 K3d provider，那么您需要使用宿主机网络启动 AutoK3s 镜像。
3939

4040
```bash
41-
docker run -itd --restart=unless-stopped --net host -v /var/run/docker.sock:/var/run/docker.sock cnrancher/autok3s:v0.9.2
41+
docker run -itd --restart=unless-stopped --net host -v /var/run/docker.sock:/var/run/docker.sock cnrancher/autok3s:v0.9.3
4242
```
4343

4444
如果您是 MacOS 或者 Linux 系统，您也可以使用以下安装命令，一键安装 AutoK3s（Windows用户请前往 [Releases](https://github.com/cnrancher/autok3s/releases) 页面下载对应的程序）。
@@ -81,19 +81,19 @@ autok3s -d create -p aws --name myk3s --master 1 --worker 1
8181

8282
## 升级
8383

84-
如果您使用 Docker 命令一键启动 AutoK3s 本地 UI，从 `v0.4.0` 升级到 `v0.9.2` 需要进行如下操作以保证历史数据的迁移。
84+
如果您使用 Docker 命令一键启动 AutoK3s 本地 UI，从 `v0.4.0` 升级到 `v0.9.3` 需要进行如下操作以保证历史数据的迁移。
8585

8686
```bash
8787
docker cp <old-container>:/root/.autok3s .
8888
docker rm -f <old-container>
89-
docker run -itd --restart=unless-stopped -p 8080:8080 -v $PWD/.autok3s:/root/.autok3s cnrancher/autok3s:v0.9.2
89+
docker run -itd --restart=unless-stopped -p 8080:8080 -v $PWD/.autok3s:/root/.autok3s cnrancher/autok3s:v0.9.3
9090
```
9191

9292
在 `v0.4.1` 以后的版本，可以直接通过 `--volumes-from` 来保证历史数据的迁移。
9393

9494
```bash
9595
docker stop <old-container>
96-
docker run -itd --restart=unless-stopped -p 8080:8080 --volumes-from <old-container> cnrancher/autok3s:v0.9.2
96+
docker run -itd --restart=unless-stopped -p 8080:8080 --volumes-from <old-container> cnrancher/autok3s:v0.9.3
9797
```
9898

9999
## 开发者指南
@@ -114,9 +114,11 @@ AutoK3s是 100% 开源的软件，该项目相关的源码包括：
114114
- https://github.com/cnrancher/autok3s-ui
115115
- https://github.com/cnrancher/kube-explorer
116116

117+
由 SUSE(Rancher E&I) Team 贡献
118+
117119
# License
118120

119-
Copyright (c) 2023 [Rancher Labs, Inc.](http://rancher.com)
121+
Copyright (c) 2024 [SUSE](https://www.suse.com/)
120122

121123
Licensed under the Apache License, Version 2.0 (the "License");
122124
you may not use this file except in compliance with the License.

‎docs/i18n/zh_cn/alibaba/README.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,10 +212,13 @@ K3s 参数配置项主要对 K3s 集群进行设置，例如是否部署 HA 模
212212
| Datastore CA File | 数据源 CA 文件，如果数据源设置了 TLS 需要配置此项 |
213213
| Datastore Cert File | 数据源 Cert 文件，如果数据源设置了 TLS 需要配置此项 |
214214
| Datastore Key File | 数据源 Key 文件，如果数据源设置了 TLS 需要配置此项 |
215+
| Install Env | K3s 集群安装时环境变量参数设置，例如在 centos 上安装 K3s 需要设置 `INSTALL_K3S_SKIP_SELINUX_RPM=true` 来禁用 selinux |
215216
| Master | Master 节点数量 |
216217
| Master Extra Args | Master 节点额外参数设置，例如 `--no-deploy traefik` |
218+
| Server Config File | Server 节点额外参数设置，以 config.yaml 文件格式进行一些复杂选项的配置，例如 `etcd-snapshot-schedule-cron` 等 |
217219
| Worker | Worker 节点数量 |
218220
| Worker Extra Args | Worker 节点额外参数设置，例如 `--node-taint key=value:NoExecute` |
221+
| Agent Config File | Agent 节点额外参数设置，以 config.yaml 文件格式进行一些复杂选项的配置 |
219222
| Token | 用于将server或agent加入集群的共享secret，如果不设置，会自动生成一个Token |
220223
| Manifests | 自动部署应用清单目录，这里支持设置某个manifest文件或者包含多个manifest文件的目录路径（仅支持一层目录），具体功能可查看[这里](http://docs.rancher.cn/docs/k3s/advanced/_index/#%E8%87%AA%E5%8A%A8%E9%83%A8%E7%BD%B2%E6%B8%85%E5%8D%95) |
221224
| TLS Sans | 在 TLS 证书中添加其他主机名或 IP 作为主题备用名称，具体功能可查看[这里](https://docs.rancher.cn/docs/k3s/installation/install-options/server-config/_index#%E7%9B%91%E5%90%AC) |
@@ -382,6 +385,41 @@ autok3s -d create -p alibaba --name myk3s --master 3 --cluster
382385
autok3s -d create -p alibaba --name myk3s --master 2 --datastore "mysql://<user>:<password>@tcp(<ip>:<port>)/<db>"
383386
```
384387

388+
### 高级选项
389+
390+
AutoK3s 支持更多的高级选项来自定义你的 K3s 集群
391+
392+
#### 安装环境变量设置
393+
394+
如果你想要在安装集群时设置环境变量，可以使用一下的参数：
395+
396+
```bash
397+
--install-env INSTALL_K3S_SKIP_SELINUX_RPM=true --install-env INSTALL_K3S_FORCE_RESTART=true
398+
```
399+
400+
> 由于这是一个全局的设置选项，我们建议你**只**使用 INSTALL_* 类型的环境变量。如果你想要使用 K3S_* 的环境变量对集群进行自定义配置，请使用下面描述的 configuration file 参数的设置方式。
401+
402+
#### Server/Agent Configuration File
403+
404+
K3s 集群可以使用环境变量或者 CLI 参数进行设置，也可以通过配置文件进行设置。
405+
406+
如果你想要对集群进行更多更复杂的自定义配置，例如 etcd snapshot 或 datastore，你可以使用以下参数。
407+
408+
这里时一个 K3s server 配置了 etcd snapshot 和 node port 范围的配置文件示例。
409+
```yaml
410+
etcd-snapshot-schedule-cron: "* * * * *"
411+
etcd-snapshot-retention: 15
412+
service-node-port-range: "20000-30000"
413+
```
414+
415+
将以上文件保存到本地，例如保存到名称为 `myk3s-server-config.yaml` 的文件中，然后通过以下参数将此文件传给 AutoK3s:
416+
417+
```bash
418+
--server-config-file /your/path/myk3s-server-config.yaml
419+
```
420+
421+
如果你想要对 agent 节点进行设置，可以通过 `--agent-config-file /your/path/agent-config.yaml` 参数来进行传值。
422+
385423
### 添加 K3s 节点
386424

387425
请使用`autok3s join`命令为已有集群添加 K3s 节点。

0 commit comments

Comments
 (0)