update docs

pull/1226/head
gjmzj 2023-01-19 13:54:56 +08:00
parent c3ddb38eba
commit 79a65031fb
6 changed files with 10 additions and 41 deletions

View File

@ -107,7 +107,7 @@
## 贡献&致谢 ## 贡献&致谢
请阅读[项目分支说明](docs/mixes/branch.md), 欢迎提[Issues](https://github.com/easzlab/kubeasz/issues)和[PRs](docs/mixes/HowToContribute.md)参与维护项目!感谢您的关注与支持! 欢迎提[Issues](https://github.com/easzlab/kubeasz/issues)和[PRs](docs/mixes/HowToContribute.md)参与维护项目!感谢您的关注与支持!
- [如何 PR](docs/mixes/HowToContribute.md) - [如何 PR](docs/mixes/HowToContribute.md)
- [如何捐赠](docs/mixes/donate.md) - [如何捐赠](docs/mixes/donate.md)

View File

@ -1,30 +0,0 @@
# 项目分支说明
为减小维护压力,避免产生混淆,精简项目分支为:`master`, `dev3`, `dev2`, `dev1`, `dev0`, `closed`; 分别对应发布版本如下:
- master 最新版本稳定分支目前对应dev3
- dev3 对应 kubeasz 3.x 版本的开发分支
- dev2 对应 kubeasz 2.x 版本的开发分支仅bugfix
- dev1 对应 kubeasz 1.x 版本的开发分支(已停止更新)
- dev0 对应 kubeasz 0.x 版本的开发分支(已停止更新)
- closed 对应更老的版本分支(仅留档保存)
## 更新频率和内容
- `master` 为最新稳定分支,更新相对频繁:**相关文档****功能特性**BUG修复组件更新
- `dev` 为开发测试分支,不一定稳定,更新频繁:**相关文档****功能特性**BUG修复组件更新
- `closed` 分支已停止更新:留档保存使用
## 安装架构变化
项目 0.x 1.x 与 2.x 版本的主要区别在于安装集群高可用架构不同;
- ha-1x 架构是之前k8s社区推荐的高可用方式也是最早实践的稳定方案
![ha-1x](../../pics/ha-1x.gif)
- ha-2x 架构是更方便、兼容性(云上云下)更好,是目前项目推荐的方案
![ha-2x](../../pics/ha-2x.gif)
因基础架构差异,用户对于已有集群,**切勿更新 kubeasz 不同版本**不能从0.x 升级 1.x或者 1.x 升级 2.x可以根据当时安装集群时所用的 kubeasz 版本进行 k8s 版本的升级;比如:使用版本 kubeasz 1.2.0 安装了 k8s v1.11.5 集群,可以按照文档把 k8s 升级到 v1.13.6,但是建议不要去升级 kubeasz 版本,特别不能升级 kubeasz 1.2.0 至 kubeasz 2.0.0。

View File

@ -2,7 +2,7 @@
### HA architecture ### HA architecture
![ha-2x](../../pics/ha-2x.gif) <img alt="ha-3x" width="500" height="380" src="../../pics/ha-3x.svg">
- 注意1确保各节点时区设置一致、时间同步。 如果你的环境没有提供NTP 时间同步,推荐集成安装[chrony](../guide/chrony.md) - 注意1确保各节点时区设置一致、时间同步。 如果你的环境没有提供NTP 时间同步,推荐集成安装[chrony](../guide/chrony.md)
- 注意2确保在干净的系统上开始安装不要使用曾经装过kubeadm或其他k8s发行版的环境 - 注意2确保在干净的系统上开始安装不要使用曾经装过kubeadm或其他k8s发行版的环境
@ -59,10 +59,10 @@ ssh $IP ln -s /usr/bin/python3 /usr/bin/python
- 4.1 下载项目源码、二进制及离线镜像 - 4.1 下载项目源码、二进制及离线镜像
下载工具脚本ezdown举例使用kubeasz版本3.3.1 下载工具脚本ezdown举例使用kubeasz版本3.5.0
``` bash ``` bash
export release=3.3.1 export release=3.5.0
wget https://github.com/easzlab/kubeasz/releases/download/${release}/ezdown wget https://github.com/easzlab/kubeasz/releases/download/${release}/ezdown
chmod +x ./ezdown chmod +x ./ezdown
``` ```
@ -110,9 +110,8 @@ docker exec -it kubeasz ezctl new k8s-01
如果你对集群安装流程不熟悉,请阅读项目首页 **安装步骤** 讲解后分步安装,并对 **每步都进行验证** 如果你对集群安装流程不熟悉,请阅读项目首页 **安装步骤** 讲解后分步安装,并对 **每步都进行验证**
``` bash ``` bash
#建议配置命令alias方便执行 #建议使用alias命令查看~/.bashrc 文件应该包含alias dk='docker exec -it kubeasz'
echo "alias dk='docker exec -it kubeasz'" >> /root/.bashrc source ~/.bashrc
source /root/.bashrc
# 一键安装等价于执行docker exec -it kubeasz ezctl setup k8s-01 all # 一键安装等价于执行docker exec -it kubeasz ezctl setup k8s-01 all
dk ezctl setup k8s-01 all dk ezctl setup k8s-01 all

View File

@ -12,10 +12,10 @@
### 2.下载文件 ### 2.下载文件
- 下载工具脚本ezdown举例使用kubeasz版本3.3.1 - 下载工具脚本ezdown举例使用kubeasz版本3.5.0
``` bash ``` bash
export release=3.3.1 export release=3.5.0
wget https://github.com/easzlab/kubeasz/releases/download/${release}/ezdown wget https://github.com/easzlab/kubeasz/releases/download/${release}/ezdown
chmod +x ./ezdown chmod +x ./ezdown
``` ```
@ -68,9 +68,8 @@ docker exec -it kubeasz ezctl start-aio
### 4.验证安装 ### 4.验证安装
如果提示kubectl: command not found退出重新ssh登录一下环境变量生效即可
``` bash ``` bash
$ source ~/.bashrc
$ kubectl version # 验证集群版本 $ kubectl version # 验证集群版本
$ kubectl get node # 验证节点就绪 (Ready) 状态 $ kubectl get node # 验证节点就绪 (Ready) 状态
$ kubectl get pod -A # 验证集群pod状态默认已安装网络插件、coredns、metrics-server等 $ kubectl get pod -A # 验证集群pod状态默认已安装网络插件、coredns、metrics-server等

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

1
pics/ha-3x.svg 100644

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 28 KiB