在已有k8s集群中部署KubeCube

v1.4.x

在 Kubernetes 集群中部署 KubeCube

开始安装

在 Linux 机器上执行部署脚本

  1. KUBECUBE_VERSION=v1.4
  1. export CUSTOMIZE="true";curl -fsSL https://kubecube.nos-eastchina1.126.net/kubecube-installer/${KUBECUBE_VERSION}/entry.sh | bash

设置安装脚本参数

该安装模式下，需要修改以下参数：

  1. # if install kubecube on pivot cluster
  2. INSTALL_KUBECUBE_PIVOT="true"
  4. # if install k8s
  5. INSTALL_KUBERNETES="false"
  7. # k8s cni, support now is calico only
  8. CNI="calico"
  10. # there are four node mode below:
  11. # "master" : node will be installed as a master of cluster
  12. # "node-join-master" : node will be install as a worker of cluster to join master
  13. # "control-plane-master" : node will be installed as a master to control plane of cluster
  14. # "node-join-control-plane" : node will be installed as a master to join control plane
  15. NODE_MODE="master"
  17. # zone has two choice
  18. # 1. "cn" : in mainland
  19. # 2. "others" : out of mainland
  20. ZONE="cn"
  22. # k8s version you want to install
  23. # support now is: 1.19.13, 1.20.9, 1.21.2, 1.22.2, 1.23.5
  24. KUBERNETES_VERSION="1.23.5"
  26. # +optional
  27. # must be set when NODE_MODE="control-plane-master"
  28. # or "node-join-control-plane"
  29. CONTROL_PLANE_ENDPOINT="" #{ip}:{port} , dns
  31. # +optional
  32. # KUBERNETES_BIND_ADDRESS generally is node_ip
  33. # can be set when NODE_MODE="master" ot "control-plane-master"
  34. # default value is $(hostname -I |awk '{print $1}')
  35. KUBERNETES_BIND_ADDRESS="" #{node_ip}
  37. #######################################################################
  38. # member cluster config
  39. # used when INSTALL_KUBECUBE_MEMBER="true"
  40. #######################################################################
  42. # if install kubecube on member cluster
  43. INSTALL_KUBECUBE_MEMBER="false"
  45. # +optional
  46. # KUBECUBE_HOST must be set when as a member cluster to
  47. # join pivot cluster, the value is pivot node ip
  48. KUBECUBE_HOST=""
  50. # +optional
  51. # must be set when INSTALL_KUBECUBE_MEMBER="true"
  52. # this value is the name of member cluster you
  53. # want to take over
  54. MEMBER_CLUSTER_NAME=""
  56. #######################################################################
  57. # ssh config
  58. # used when NODE_MODE="node-join-master" or node-join-control-plane
  59. #######################################################################
  61. # +optional
  62. # master ip means master node ip of cluster
  63. MASTER_IP=""
  65. # +optional
  66. # the user who can access master node, it can be empty
  67. SSH_USER="root"
  69. # +optional
  70. # the port specified to access master node, it can be empty
  71. SSH_PORT=22
  73. # +optional
  74. # must be empty when ACCESS_PRIVATE_KEY_PATH set
  75. # password for master user to access master node
  76. ACCESS_PASSWORD=""
  78. # +optional
  79. # must be empty when ACCESS_PASSWORD set
  80. # ACCESS_PRIVATE_KEY for master user to access master node
  81. ACCESS_PRIVATE_KEY_PATH="/root/.ssh/id_rsa"
  83. #######################################################################
  84. # offline config
  85. # used when offline install choose, must lift offline pkg first
  86. #######################################################################
  88. OFFLINE_INSTALL="false"
  90. OFFLINE_PKG_PATH=""
  92. #######################################################################
  93. # container runtime config
  94. # if value is docker, then use docker as container runtime
  95. # else if value is containerd, then use containerd as container runtime
  96. #######################################################################
  97. CONTAINER_RUNTIME="docker"

等待部署完成

KubeCube 部署完成后，请根据提示信息登陆 console 管理页面

complete-deploy

使用 admin 账户登陆 console

⚠️请在登陆后修改 admin 用户的密码

login-console

v1.2.x

在 Kubernetes 集群中部署 KubeCube

开始安装

在 Linux 机器上执行部署脚本

  1. KUBECUBE_VERSION=v1.2
  1. export CUSTOMIZE="true";curl -fsSL https://kubecube.nos-eastchina1.126.net/kubecube-installer/${KUBECUBE_VERSION}/entry.sh | bash

设置安装脚本参数

该安装模式下，需要修改以下参数：

  1. # if install kubecube on pivot cluster
  2. INSTALL_KUBECUBE_PIVOT="true"
  4. # if install k8s
  5. INSTALL_KUBERNETES="false"
  7. # k8s cni, support now is calico only
  8. CNI="calico"
  10. # there are four node mode below:
  11. # "master" : node will be installed as a master of cluster
  12. # "node-join-master" : node will be install as a worker of cluster to join master
  13. # "control-plane-master" : node will be installed as a master to control plane of cluster
  14. # "node-join-control-plane" : node will be installed as a master to join control plane
  15. NODE_MODE="master"
  17. # zone has two choice
  18. # 1. "cn" : in mainland
  19. # 2. "others" : out of mainland
  20. ZONE="cn"
  22. # k8s version you want to install
  23. # support now is: 1.19.13, 1.20.9, 1.21.2, 1.22.2, 1.23.5
  24. KUBERNETES_VERSION="1.23.5"
  26. # +optional
  27. # must be set when NODE_MODE="control-plane-master"
  28. # or "node-join-control-plane"
  29. CONTROL_PLANE_ENDPOINT="" #{ip}:{port} , dns
  31. # +optional
  32. # KUBERNETES_BIND_ADDRESS generally is node_ip
  33. # can be set when NODE_MODE="master" ot "control-plane-master"
  34. # default value is $(hostname -I |awk '{print $1}')
  35. KUBERNETES_BIND_ADDRESS="" #{node_ip}
  37. #######################################################################
  38. # member cluster config
  39. # used when INSTALL_KUBECUBE_MEMBER="true"
  40. #######################################################################
  42. # if install kubecube on member cluster
  43. INSTALL_KUBECUBE_MEMBER="false"
  45. # +optional
  46. # KUBECUBE_HOST must be set when as a member cluster to
  47. # join pivot cluster, the value is pivot node ip
  48. KUBECUBE_HOST=""
  50. # +optional
  51. # must be set when INSTALL_KUBECUBE_MEMBER="true"
  52. # this value is the name of member cluster you
  53. # want to take over
  54. MEMBER_CLUSTER_NAME=""
  56. #######################################################################
  57. # ssh config
  58. # used when NODE_MODE="node-join-master" or node-join-control-plane
  59. #######################################################################
  61. # +optional
  62. # master ip means master node ip of cluster
  63. MASTER_IP=""
  65. # +optional
  66. # the user who can access master node, it can be empty
  67. SSH_USER="root"
  69. # +optional
  70. # the port specified to access master node, it can be empty
  71. SSH_PORT=22
  73. # +optional
  74. # must be empty when ACCESS_PRIVATE_KEY_PATH set
  75. # password for master user to access master node
  76. ACCESS_PASSWORD=""
  78. # +optional
  79. # must be empty when ACCESS_PASSWORD set
  80. # ACCESS_PRIVATE_KEY for master user to access master node
  81. ACCESS_PRIVATE_KEY_PATH="/root/.ssh/id_rsa"
  83. #######################################################################
  84. # offline config
  85. # used when offline install choose, must lift offline pkg first
  86. #######################################################################
  88. OFFLINE_INSTALL="false"
  90. OFFLINE_PKG_PATH=""
  92. #######################################################################
  93. # container runtime config
  94. # if value is docker, then use docker as container runtime
  95. # else if value is containerd, then use containerd as container runtime
  96. #######################################################################
  97. CONTAINER_RUNTIME="containerd"

等待部署完成

KubeCube 部署完成后，请根据提示信息登陆 console 管理页面

complete-deploy

使用 admin 账户登陆 console

⚠️请在登陆后修改 admin 用户的密码

login-console

v1.1.x

在 Kubernetes 集群中部署 KubeCube

开始安装

在 Linux 机器上执行部署脚本

  1. KUBECUBE_VERSION=v1.1
  1. export CUSTOMIZE="true";curl -fsSL https://kubecube.nos-eastchina1.126.net/kubecube-installer/${KUBECUBE_VERSION}/entry.sh | bash

设置安装脚本参数

该安装模式下，需要修改以下参数：

INSTALL_KUBECUBE_MEMBER=“false”

MASTER_IP=”${node ip}”

${node ip} 表示你运行脚本所在 node 机器的 ip，该 node 需要可操作 kubectl

  1. # if install kubecube on pivot cluster
  2. INSTALL_KUBECUBE_PIVOT="true"
  4. # if install k8s
  5. INSTALL_KUBERNETES="false"
  7. # there are four node mode below:
  8. # "master" : node will be installed as a master of cluster
  9. # "node-join-master" : node will be install as a worker of cluster to join master
  10. # "control-plane-master" : node will be installed as a master to control plane of cluster
  11. # "node-join-control-plane" : node will be installed as a master to join control plane
  12. NODE_MODE="master"
  14. # zone has two choice
  15. # 1. "cn" : in mainland
  16. # 2. "others" : out of mainland
  17. ZONE="cn"
  19. # k8s version you want to install
  20. # support now is: 1.20.9, 1.19.13, 1.18.20, 1.21.2
  21. KUBERNETES_VERSION="1.20.9"
  23. # +optional
  24. # must be set when NODE_MODE="control-plane-master"
  25. # or "node-join-control-plane"
  26. CONTROL_PLANE_ENDPOINT="" #{ip}:{port} , dns
  28. #######################################################################
  29. # member cluster config
  30. # used when INSTALL_KUBECUBE_MEMBER="true"
  31. #######################################################################
  33. # if install kubecube on member cluster
  34. INSTALL_KUBECUBE_MEMBER="false"
  36. # +optional
  37. # KUBECUBE_HOST must be set when as a member cluster to
  38. # join pivot cluster, the value is pivot node ip
  39. KUBECUBE_HOST=""
  41. # +optional
  42. # must be set when INSTALL_KUBECUBE_MEMBER="true"
  43. # this value is the name of member cluster you
  44. # want to take over
  45. MEMBER_CLUSTER_NAME=""
  47. #######################################################################
  48. # ssh config
  49. # used when NODE_MODE="node-join-master" or node-join-control-plane
  50. #######################################################################
  52. # +optional
  53. # master ip means master node ip of cluster
  54. MASTER_IP=""
  56. # +optional
  57. # the user who can access master node, it can be empty
  58. SSH_USER="root"
  60. # +optional
  61. # the port specified to access master node, it can be empty
  62. SSH_PORT=22
  64. # +optional
  65. # must be empty when ACCESS_PRIVATE_KEY_PATH set
  66. # password for master user to access master node
  67. ACCESS_PASSWORD=""
  69. # +optional
  70. # must be empty when ACCESS_PASSWORD set
  71. # ACCESS_PRIVATE_KEY for master user to access master node
  72. ACCESS_PRIVATE_KEY_PATH="/root/.ssh/id_rsa"
  74. #######################################################################
  75. # offline config
  76. # used when offline install choose, must lift offline pkg first
  77. #######################################################################
  79. OFFLINE_INSTALL="false"
  81. OFFLINE_PKG_PATH=""

等待部署完成

KubeCube 部署完成后，请根据提示信息登陆 console 管理页面

complete-deploy

使用 admin 账户登陆 console

⚠️请在登陆后修改 admin 用户的密码

login-console

v1.0.x

在 Kubernetes 集群中部署 KubeCube

⚠️修改 Kubernetes API-Server 配置

必要性

  1. KubeCube 对多集群提供统一的认证和鉴权服务，需要使用 k8s api-server 的 auth-webhook 能力来做拓展。

  2. KubeCube 提供对 k8s-apiserver 日志进行审计的能力，这需要为 k8s api-server 指定审计服务后端。

修改操作

如果您的 k8s api-server 服务是以 deployment 形式运行的，请直接修改 deployment ；如果您的 k8s api-server 服务是以 static pod 形式运行的，您需要修改对应的 manifest 文件，它的文件路径通常为 /etc/kubernetes/manifests/kube-apiserver.yaml ，修改内容如下：

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4.   name: kube-apiserver
  5.   namespace: kube-system
  6. spec:
  7.   containers:
  8.     - command:
  9.         - kube-apiserver
  10.         - --audit-log-format=json
  11.         - --audit-log-maxage=10
  12.         - --audit-log-maxbackup=10
  13.         - --audit-log-maxsize=100
  14.         - --audit-log-path=/var/log/audit
  15.         - --audit-policy-file=/etc/cube/audit/audit-policy.yaml
  16.         - --audit-webhook-config-file=/etc/cube/audit/audit-webhook.config
  17.         - --authentication-token-webhook-config-file=/etc/cube/warden/webhook.config
  18.       name: kube-apiserver
  19.       volumeMounts:
  20.         - mountPath: /var/log/audit
  21.           name: audit-log
  22.         - mountPath: /etc/cube
  23.           name: cube
  24.           readOnly: true
  25.   volumes:
  26.     - hostPath:
  27.         path: /var/log/audit
  28.         type: DirectoryOrCreate
  29.       name: audit-log
  30.     - hostPath:
  31.         path: /etc/cube
  32.         type: DirectoryOrCreate
  33.       name: cube

开始安装

在 Linux 机器上执行部署脚本

  1. KUBECUBE_VERSION=v1.0
  1. export CUSTOMIZE="true";curl -fsSL https://kubecube.nos-eastchina1.126.net/kubecube-installer/${KUBECUBE_VERSION}/entry.sh | bash

设置安装脚本参数

该安装模式下，需要修改以下参数：

INSTALL_KUBECUBE_MEMBER=“false”

MASTER_IP=”${node ip}”

${node ip} 表示你运行脚本所在 node 机器的 ip，该 node 需要可操作 kubectl

  1. # if install kubecube on pivot cluster
  2. INSTALL_KUBECUBE_PIVOT="true"
  4. # if install kubecube on member cluster
  5. INSTALL_KUBECUBE_MEMBER="false"
  7. # if install k8s
  8. INSTALL_KUBERNETES="false"
  10. # there are four node mode below:
  11. # "master" : node will be installed as a master of cluster
  12. # "node-join-master" : node will be install as a worker of cluster to join master
  13. # "control-plane-master" : node will be installed as a master to control plane of cluster
  14. # "node-join-control-plane" : node will be installed as a master to join control plane
  15. NODE_MODE="master"
  17. # +optional
  18. # must be set when INSTALL_KUBECUBE_MEMBER="true"
  19. # this value is the name of member cluster you
  20. # want to take over
  21. MEMBER_CLUSTER_NAME=""
  23. # +optional
  24. # must be set when NODE_MODE="control-plane-master"
  25. # or "node-join-control-plane"
  26. CONTROL_PLANE_ENDPOINT="" #{ip}:{port} , dns
  28. # master ip means master node ip of cluster
  29. MASTER_IP="x.x.x.x"
  31. # +optional
  32. # KUBECUBE_HOST must be set when as a member cluster to
  33. # join pivot cluster, the value is pivot node ip
  34. KUBECUBE_HOST=""
  36. # zone has two choice
  37. # 1. "cn" : in mainland
  38. # 2. "others" : out of mainland
  39. ZONE="cn"
  41. # k8s version you want to install
  42. KUBERNETES_VERSION="1.20.9"
  44. # +optional
  45. # the user who can access master node, it can be empty
  46. # when NODE_MODE="master" or "control-plane-master"
  47. SSH_USER="root"
  49. # +optional
  50. # the port specified to access master node, it can be empty
  51. # when NODE_MODE="master" or "control-plane-master"
  52. SSH_PORT=22
  54. # +optional
  55. # must be empty when ACCESS_PRIVATE_KEY_PATH set
  56. # password for master user to access master node
  57. ACCESS_PASSWORD=""
  59. # +optional
  60. # must be empty when ACCESS_PASSWORD set
  61. # ACCESS_PRIVATE_KEY for master user to access master node
  62. ACCESS_PRIVATE_KEY_PATH="/root/.ssh/id_rsa"

等待部署完成

KubeCube 部署完成后，请根据提示信息登陆 console 管理页面

complete-deploy

使用 admin 账户登陆 console

⚠️请在登陆后修改 admin 用户的密码

login-console

最后修改 September 14, 2022 : add v1.4 doc (a99524bf)