diff --git a/docs/op/config_guide.md b/docs/op/config_guide.md new file mode 100644 index 0000000..bac3a4d --- /dev/null +++ b/docs/op/config_guide.md @@ -0,0 +1,19 @@ +# 个性化集群参数配置 + +`kubeasz`创建集群主要在以下两个地方进行配置: + +- ansible hosts 文件(模板在examples目录):集群主要节点定义和主要参数配置 +- roles/xxx/vars/main.yml 文件:其他参数配置或者部分组件参数配置 + +这些文件都在.gitignore忽略范围,因此修改后项目目录能够保持`git status | clean` + +## ansible hosts + +项目尽量保持`ansible hosts`简单、灵活,在[快速指南](../quickStart.md)或者[集群规划与安装概览](../00-集群规划和基础参数设定.md)已经介绍过,主要包括集群节点定义和集群范围的主要参数配置;目前提供三种集群部署模板。 + +尽量保持配置项稳定。 + +## roles/xxx/vars/main.yml + +主要包括集群某个具体组件的个性化配置,具体组件的配置项可能会不断增加;项目初始时该配置与 roles/xxx/defaults/main.yml 一致,确保在不做任何配置情况下可以使用默认值创建集群;因 ansilbe 变量优先级关系,后续如果对 roles/xxx/vars/main.yml变量修改,那么它将覆盖默认配置。 + diff --git a/tools/init_vars.yml b/tools/init_vars.yml new file mode 100644 index 0000000..b732a71 --- /dev/null +++ b/tools/init_vars.yml @@ -0,0 +1,32 @@ +# [可选]初始化集群设置脚本,使用请参考docs/op/config_guide.md +# 如果创建集群时需要修改项目roles中默认配置,请执行本脚本后,编辑roles/xxx/vars/main.yml修改 + +- hosts: deploy + tasks: + - name: 创建变量配置目录 roles/xxx/vars + file: name={{ base_dir }}/roles/{{ item }}/vars state=directory + with_items: + - calico + - cluster-addon + - cluster-restore + - flannel + - helm + - kube-node + - kube-router + - lb + + - name: 复制默认配置以备修改 + copy: + src: "{{ base_dir }}/roles/{{ item }}/defaults/main.yml" + dest: "{{ base_dir }}/roles/{{ item }}/vars/main.yml" + force: "no" + with_items: + - calico + - cluster-addon + - cluster-restore + - flannel + - helm + - kube-node + - kube-router + - lb +