release-v1.1.0:install-guide

kubecube-io · Dec 20, 2021 · 5f0c959 · 5f0c959
1 parent 2f81e38
commit 5f0c959
Show file tree

Hide file tree

Showing 7 changed files with 900 additions and 31 deletions.
diff --git a/content/zh/docs/installation-guide/add-k8s-node.md b/content/zh/docs/installation-guide/add-k8s-node.md
@@ -3,25 +3,229 @@ title: "添加节点"
 weight: 5
 ---
 
-KubeCube 提供为已有集群添加节点的能力
+KubeCube 提供为已有集群添加节点的能力，同时也支持使用 kubeadm 的原生方式添加节点
 
-⚠️ 注意 node 机器需要能够通过 ssh 访问 master 机器，支持公钥和密码两种 ssh 方式，执行脚本前可以在 node 上 ssh 到 master 测试连通性
+⚠️ 注意通过 KubeCube 的脚本添加节点时，node 机器需要能够通过 ssh 访问 master 机器，支持公钥和密码两种 ssh 方式，执行脚本前可以在 node 上 ssh 到 master 测试连通性
 
-## 向集群添加工作节点
+## v1.1.x
+
+### 向集群添加工作节点
 
 在新节点上执行部署脚本
 
 ```bash
-KUBECUBE_VERSION=v1.0
+KUBECUBE_VERSION=v1.1
+```
+```bash
+export CUSTOMIZE="true";curl -fsSL https://kubecube.nos-eastchina1.126.net/kubecube-installer/${KUBECUBE_VERSION}/entry.sh | bash
+```
+
+> tip: 你可以通过预先下载离线包和镜像来减少部署时间 `export PRE_DOWNLOAD="true";curl -fsSL https://kubecube.nos-eastchina1.126.net/kubecube-installer/${KUBECUBE_VERSION}/entry.sh | bash`
+
+设置脚本参数，并按照提示继续运行安装脚本并等待新节点加入集群
+
+- MASTER_IP 为 master 节点 ip
+
+```bash
+# if install kubecube on pivot cluster
+INSTALL_KUBECUBE_PIVOT="false"
+
+# if install k8s
+INSTALL_KUBERNETES="true"
+
+# there are four node mode below:
+# "master" : node will be installed as a master of cluster
+# "node-join-master" : node will be install as a worker of cluster to join master
+# "control-plane-master" : node will be installed as a master to control plane of cluster
+# "node-join-control-plane" : node will be installed as a master to join control plane
+NODE_MODE="node-join-master"
+
+# zone has two choice
+# 1. "cn" : in mainland
+# 2. "others" : out of mainland
+ZONE="cn"
+
+# k8s version you want to install
+# support now is: 1.20.9, 1.19.13, 1.18.20, 1.21.2
+KUBERNETES_VERSION="1.20.9"
+
+# +optional
+# must be set when NODE_MODE="control-plane-master"
+# or "node-join-control-plane"
+CONTROL_PLANE_ENDPOINT="" #{ip}:{port} , dns
+
+#######################################################################
+# member cluster config
+# used when INSTALL_KUBECUBE_MEMBER="true"
+#######################################################################
+
+# if install kubecube on member cluster
+INSTALL_KUBECUBE_MEMBER="false"
+
+# +optional
+# KUBECUBE_HOST must be set when as a member cluster to
+# join pivot cluster, the value is pivot node ip
+KUBECUBE_HOST=""
+
+# +optional
+# must be set when INSTALL_KUBECUBE_MEMBER="true"
+# this value is the name of member cluster you
+# want to take over
+MEMBER_CLUSTER_NAME=""
+
+#######################################################################
+# ssh config
+# used when NODE_MODE="node-join-master" or node-join-control-plane
+#######################################################################
+
+# +optional
+# master ip means master node ip of cluster
+MASTER_IP="y.y.y.y"
+
+# +optional
+# the user who can access master node, it can be empty
+SSH_USER="root"
+
+# +optional
+# the port specified to access master node, it can be empty
+SSH_PORT=22
+
+# +optional
+# must be empty when ACCESS_PRIVATE_KEY_PATH set
+# password for master user to access master node
+ACCESS_PASSWORD=""
+
+# +optional
+# must be empty when ACCESS_PASSWORD set
+# ACCESS_PRIVATE_KEY for master user to access master node
+ACCESS_PRIVATE_KEY_PATH="/root/.ssh/id_rsa"
+
+#######################################################################
+# offline config
+# used when offline install choose, must lift offline pkg first
+#######################################################################
+
+OFFLINE_INSTALL="false"
+
+OFFLINE_PKG_PATH=""
+```
+
+### 向集群的 control-plane 添加 master 节点
+
+在新节点上执行部署脚本
+
+```bash
+KUBECUBE_VERSION=v1.1
 ```
 ```bash
 export CUSTOMIZE="true";curl -fsSL https://kubecube.nos-eastchina1.126.net/kubecube-installer/${KUBECUBE_VERSION}/entry.sh | bash
 ```
 
-tip: 你可以通过预先下载离线包和镜像来减少部署时间
+设置脚本参数，并按照提示继续运行安装脚本并等待新节点加入 control-plane
+
+-  MASTER_IP 需要填已有的 master 节点 ip
+-  NODE_MODE 当该模式为 node-join-control-plane 时，需要指定 master 节点们的 CONTROL_PLANE_ENDPOINT(vip)
+-  CONTROL_PLANE_ENDPOINT 为高可用 vip
+-  可以根据需要选择适合自己的 ssh 方式
+
 ```bash
-export PRE_DOWNLOAD="true";curl -fsSL https://kubecube.nos-eastchina1.126.net/kubecube-installer/${KUBECUBE_VERSION}/entry.sh | bash
+# if install kubecube on pivot cluster
+INSTALL_KUBECUBE_PIVOT="false"
+
+# if install k8s
+INSTALL_KUBERNETES="true"
+
+# there are four node mode below:
+# "master" : node will be installed as a master of cluster
+# "node-join-master" : node will be install as a worker of cluster to join master
+# "control-plane-master" : node will be installed as a master to control plane of cluster
+# "node-join-control-plane" : node will be installed as a master to join control plane
+NODE_MODE="node-join-master"
+
+# zone has two choice
+# 1. "cn" : in mainland
+# 2. "others" : out of mainland
+ZONE="cn"
+
+# k8s version you want to install
+# support now is: 1.20.9, 1.19.13, 1.18.20, 1.21.2
+KUBERNETES_VERSION="1.20.9"
+
+# +optional
+# must be set when NODE_MODE="control-plane-master"
+# or "node-join-control-plane"
+CONTROL_PLANE_ENDPOINT="" #{ip}:{port} , dns
+
+#######################################################################
+# member cluster config
+# used when INSTALL_KUBECUBE_MEMBER="true"
+#######################################################################
+
+# if install kubecube on member cluster
+INSTALL_KUBECUBE_MEMBER="false"
+
+# +optional
+# KUBECUBE_HOST must be set when as a member cluster to
+# join pivot cluster, the value is pivot node ip
+KUBECUBE_HOST=""
+
+# +optional
+# must be set when INSTALL_KUBECUBE_MEMBER="true"
+# this value is the name of member cluster you
+# want to take over
+MEMBER_CLUSTER_NAME=""
+
+#######################################################################
+# ssh config
+# used when NODE_MODE="node-join-master" or node-join-control-plane
+#######################################################################
+
+# +optional
+# master ip means master node ip of cluster
+MASTER_IP="y.y.y.y"
+
+# +optional
+# the user who can access master node, it can be empty
+SSH_USER="root"
+
+# +optional
+# the port specified to access master node, it can be empty
+SSH_PORT=22
+
+# +optional
+# must be empty when ACCESS_PRIVATE_KEY_PATH set
+# password for master user to access master node
+ACCESS_PASSWORD=""
+
+# +optional
+# must be empty when ACCESS_PASSWORD set
+# ACCESS_PRIVATE_KEY for master user to access master node
+ACCESS_PRIVATE_KEY_PATH="/root/.ssh/id_rsa"
+
+#######################################################################
+# offline config
+# used when offline install choose, must lift offline pkg first
+#######################################################################
+
+OFFLINE_INSTALL="false"
+
+OFFLINE_PKG_PATH=""
+```
+
+## v1.0.x
+
+### 向集群添加工作节点
+
+在新节点上执行部署脚本
+
+```bash
+KUBECUBE_VERSION=v1.0
 ```
+```bash
+export CUSTOMIZE="true";curl -fsSL https://kubecube.nos-eastchina1.126.net/kubecube-installer/${KUBECUBE_VERSION}/entry.sh | bash
+```
+
+> tip: 你可以通过预先下载离线包和镜像来减少部署时间 `export PRE_DOWNLOAD="true";curl -fsSL https://kubecube.nos-eastchina1.126.net/kubecube-installer/${KUBECUBE_VERSION}/entry.sh | bash`
 
 设置脚本参数，并按照提示继续运行安装脚本并等待新节点加入集群
 
@@ -92,7 +296,7 @@ ACCESS_PASSWORD=""
 ACCESS_PRIVATE_KEY_PATH="/root/.ssh/id_rsa"
 ```
 
-## 向集群的 control-plane 添加 master 节点
+### 向集群的 control-plane 添加 master 节点
 
 在新节点上执行部署脚本