Chart installation options

本文档描述 Rainbond Helm Chart 的安装配置选项

Operator 配置

配置项默认值说明
operator.namerainbond-operatoroperator 的 deployment 资源名称
operator.image.nameregistry.cn-hangzhou.aliyuncs.com/goodrain/rainbond-operatoroperator 镜像名称
operator.image.tagv5.17.2-releaseoperator 镜像tag
operator.image.pullPolicyIfNotPresentoperator 镜像拉取策略
operator.logLevel4operator 的日志输出级别
operator.env[0].nameCONTAINER_RUNTIME选择集群容器运行时
operator.env[0].value自动选择 docker / containerddocker / containerd

Values.yaml 示例配置

  1. operator:
  2.   name: rainbond-operator
  3.   image:
  4.     name: registry.cn-hangzhou.aliyuncs.com/goodrain/rainbond-operator
  5.     tag: v5.17.2-release
  6.     pullPolicy: IfNotPresent
  7.   logLevel: 4
  8.   env:
  9.   - name: CONTAINER_RUNTIME
  10.     value: docker

Cluster 配置

高可用安装

高可用模式下必须提供外部数据库、外部 Etcd 、外部共享存储(RWX)

配置项默认值说明
Cluster.enableHAfalse启用高可用模式

配置外部镜像仓库

配置项默认值类型说明
Cluster.imageHub.enablefalseBool启用外部镜像仓库
Cluster.imageHub.domain“”String镜像仓库地址
Cluster.imageHub.namespace“”String镜像仓库命名空间
Cluster.imageHub.password“”String镜像仓库密码
Cluster.imageHub.username“”String镜像仓库用户名

配置外部ETCD

配置项默认值类型说明
Cluster.etcd.enablefalseBool启用外部ETCD
Cluster.etcd.endpoints“”ArrayETCD 集群列表
Cluster.etcd.secretName“”StringETCD 集群的证书 secret 文件，需在 rbd-system 命名空间下创建

配置外部存储

如果使用阿里云 NAS 存储，需要配置 Cluster.RWX.type=aliyun Cluster.RWX.config.server=<SERVER>:/，Rainbond 会自动安装阿里云 NAS CSI 并对接使用。

配置项默认值类型说明
Cluster.RWX.enablefalseBool开启外部共享存储RWX
Cluster.RWX.typenoneString公有云存储类型，目前支持aliyun
Cluster.RWX.config.storageClassName“”StringStorageClass 名称
Cluster.RWX.config.server“”String阿里云NAS存储地址
Cluster.RWO.enablefalseBool开启外部共享存储RWO
Cluster.RWO.storageClassName“”StringStorageClass 名称

配置 Rainbond 集群端数据库

配置项默认值类型说明
Cluster.regionDatabase.enablefalseBool启用外部集群端数据库
Cluster.regionDatabase.host“”String数据库地址
Cluster.regionDatabase.name“”String数据库名称
Cluster.regionDatabase.password“”String数据库密码
Cluster.regionDatabase.port“”String数据库端口
Cluster.regionDatabase.username“”String数据库用户

配置 Rainbond 控制台数据库

配置项默认值类型说明
Cluster.uiDatabase.enablefalseBool启用外部控制台数据库
Cluster.uiDatabase.host“”String数据库地址
Cluster.uiDatabase.name“”String数据库名称
Cluster.uiDatabase.password“”String数据库密码
Cluster.uiDatabase.port“”String数据库端口
Cluster.uiDatabase.username“”String数据库用户

配置集群对外 IP

设置 SLB 或 VIP 来保障 Rainbond 网关的高可用

配置项默认值类型说明
Cluster.gatewayIngressIPs“”Array配置网关负责均衡IP

配置网关节点

配置项默认值类型说明
Cluster.nodesForGateway.externalIP“”Array运行网关服务的 Kubernetes 节点外部 IP
Cluster.nodesForGateway.internalIP“”Array运行网关服务的 Kubernetes 节点内部 IP
Cluster.nodesForGateway.name“”Array运行网关服务的 Kubernetes 节点名称

配置构建节点

配置项默认值类型说明
Cluster.nodesForChaos.name“”Array运行集群构建服务的 Kubernetes 节点名称

配置集群端镜像获取地址

配置项默认值类型说明
Cluster.rainbondImageRepositoryregistry.cn-hangzhou.aliyuncs.com/goodrainString集群端安装拉取的镜像地址

配置安装版本

配置项默认值类型说明
Cluster.installVersionlatestString集群安装拉取镜像 tag

配置集群端镜像拉取策略

配置项默认值类型说明
Cluster.imagePullPolicyIfNotPresentString集群镜像拉取策略

配置集群副本

配置项默认值类型说明
Cluster.replicas2int集群POD副本数

配置集群环境检测

配置项默认值类型说明
Cluster.enableEnvChecktrueBool是否开启环境检测

配置 rbd-api 参数

配置项默认值类型说明
Component.rbd_api.argslistrbd-api Component 参数

配置 rbd-gateway 参数

配置项默认值类型说明
Component.rbd_gateway.argslistrbd-api Component 参数

使用 K3s Containerd

配置项默认值类型说明
useK3sContainerdfalsebool使用 K3s Containerd

Values.yaml 示例配置

Helm Chart value.yaml 完整示例

values.yaml

  1. #############################################
  2. # 
  3. # Copyright 2023 Goodrain Co., Ltd.
  4. # 
  5. # This version of the GNU Lesser General Public License incorporates
  6. # the terms and conditions of version 3 of the GNU General Public License.
  7. # 
  8. #############################################
  11. # Default values for mychart.
  12. # This is a YAML-formatted file.
  13. # Declare variables to be passed into your templates.
  15. ## Install Default RBAC roles and bindings
  16. rbac:
  17.   create: true
  18.   apiVersion: v1
  20. ## Service account name and whether to create it
  21. serviceAccount:
  22.   create: true
  23.   name: rainbond-operator
  25. # Use K3s Containerd
  26. useK3sContainerd: false
  28. # rainbondOperator
  29. operator:
  30.   name: rainbond-operator
  31. ##    env:
  32. ##      variable_name: variable
  33.   image:
  34.     name: registry.cn-hangzhou.aliyuncs.com/goodrain/rainbond-operator
  35.     tag: v5.12.0-release
  36.     pullPolicy: IfNotPresent
  37.   logLevel: 4
  39. #############################################
  40. # Rainbondcluster install Configuration
  41. #############################################
  42. Cluster:
  44.   # Enable the HA installation
  45.   enableHA: false
  47.   # Enable cluster environment detectio
  48.   enableEnvCheck: true
  50.   # Use an external image repository
  51.   imageHub:
  52.     enable: false
  53.     domain: registry.cn-hangzhou.aliyuncs.com
  54.     namespace: rainbond
  55.     password: admin
  56.     username: admin
  58.   # external ETCD, ref: https://www.rainbond.com/docs/installation/install-with-ui/ha#etcd
  59.   etcd:
  60.     enable: false
  61.     endpoints: 
  62.     - 192.168.0.1:2379 
  63.     - 192.168.0.2:2379
  64.     - 192.168.0.3:2379
  65.     secretName: "rbd-etcd-secret"
  67.   # External storage, fill storageClassName, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config#%E9%85%8D%E7%BD%AE%E5%A4%96%E9%83%A8%E5%AD%98%E5%82%A8
  68.   RWX:
  69.     enable: false
  70.     type: none
  71.     config:
  72.       storageClassName: glusterfs-simple
  73.       server: 
  75.   # External storage, fill storageClassName, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config#%E9%85%8D%E7%BD%AE%E5%A4%96%E9%83%A8%E5%AD%98%E5%82%A8
  76.   RWO:
  77.     enable: false
  78.     storageClassName: glusterfs-simple
  80.   # Rainbond region database, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config/#%E9%85%8D%E7%BD%AE-rainbond-%E9%9B%86%E7%BE%A4%E7%AB%AF%E6%95%B0%E6%8D%AE%E5%BA%93
  81.   regionDatabase:
  82.     enable: false
  83.     host: 192.168.0.1
  84.     name: region
  85.     password: password
  86.     port: 3306
  87.     username: admin
  89.   # Rainbond Console database, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config/#%E9%85%8D%E7%BD%AE-rainbond-%E6%8E%A7%E5%88%B6%E5%8F%B0%E6%95%B0%E6%8D%AE%E5%BA%93
  90.   uiDatabase:
  91.     enable: false
  92.     host: 192.168.0.1
  93.     name: console
  94.     password: password
  95.     port: 3306
  96.     username: admin 
  98.   # External gateway IP address
  99.   # gatewayIngressIPs: 192.168.0.1
  101.   # rbd-chaos configuration，ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config/#%E9%85%8D%E7%BD%AE%E6%9E%84%E5%BB%BA%E8%8A%82%E7%82%B9
  102.   # nodesForChaos:
  103.   # - name: node1
  104.   # - name: node2
  106.   # rbd-gateway configuration, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config/#%E9%85%8D%E7%BD%AE%E7%BD%91%E5%85%B3%E8%8A%82%E7%82%B9
  107.   # nodesForGateway:
  108.   # - externalIP: 192.168.0.1
  109.   #   internalIP: 192.168.0.1
  110.   #   name: node1
  111.   # - externalIP: 192.168.0.2
  112.   #   internalIP: 192.168.0.2
  113.   #   name: node2
  115.   # Component unified image repository and namespace, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config/#%E9%85%8D%E7%BD%AE%E9%9B%86%E7%BE%A4%E7%AB%AF%E9%95%9C%E5%83%8F%E8%8E%B7%E5%8F%96%E5%9C%B0%E5%9D%80
  116.   rainbondImageRepository: registry.cn-hangzhou.aliyuncs.com/goodrain
  118.   # Component image version, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config/#%E9%85%8D%E7%BD%AE%E5%AE%89%E8%A3%85%E7%89%88%E6%9C%AC
  119.   installVersion: v5.12.0-release
  121.   # Component image pull policy, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config/#%E9%85%8D%E7%BD%AE%E9%9B%86%E7%BE%A4%E7%AB%AF%E9%95%9C%E5%83%8F%E6%8B%89%E5%8F%96%E7%AD%96%E7%95%A5
  122.   imagePullPolicy: IfNotPresent
  124.   # Number of component copies, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config/#%E9%85%8D%E7%BD%AE%E9%9B%86%E7%BE%A4%E5%89%AF%E6%9C%AC
  125.   replicas: 2
  129. ############################################
  130. # Rainbond Component Configuration
  131. ############################################
  132. Component:
  134.   # rbd-api component configuration, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config#%E9%85%8D%E7%BD%AE-rbd-api-%E5%8F%82%E6%95%B0
  135.   rbd_api:
  136.     args:
  137.     # - --api-addr-ssl 0.0.0.0:8443
  138.     # - --ws-addr 0.0.0.0:6060
  140.   # rbd-gateway component configuration, ref: https://www.rainbond.com/docs/installation/install-with-helm/vaules-config#%E9%85%8D%E7%BD%AE-rbd-gateway-%E5%8F%82%E6%95%B0
  141.   rbd_gateway:
  142.     args:
  143.     # - --service-http-port 80
  144.     # - --service-https-port 443
  146.   # rbd-node component configuration
  147.   rbd_node:
  148.     args:
  150.   # rbd-hub component configuration
  151.   rbd_hub:
  152.     args:
  154.   # rbd-mq component configuration
  155.   rbd_mq:
  156.     args:
  158.   # rbd-resource-proxy component configuration  
  159.   rbd_resource_proxy:
  160.     args:
  162.   # rbd-webcli component configuration  
  163.   rbd_webcli:
  164.     args:
  166.   # rbd-monitor component configuration    
  167.   rbd_monitor:
  168.     args:
  170.   # rbd-db component configuration
  171.   rbd_db:
  172.     args:
  174.   # rbd-chaos component configuration
  175.   rbd_chaos:
  176.     args:
  178.   # rbd-worker component configuration
  179.   rbd_worker:
  180.     args:
  182.   # rbd-eventlog component configuration
  183.   rbd_eventlog:
  184.     args:
  186.   # rbd-app-ui component configuration
  187.   rbd_app_ui:
  188.     enable: true
  189.     args:
  191.   # nfs-provisioner component configuration
  192.   nfs_provisioner:
  193.     image:
  195.   # rbd-etcd component configuration
  196.   rbd_etcd:
  197.     image:
  199.   # metrics-server component configuration
  200.   metrics_server:
  201.     image:
  203.   # dashboard-metrics-scraper component configuration
  204.   dashboard_metrics_scraper:
  205.     image:
  208.   # kubernetes-dashboard component configuration
  209.   kubernetes_dashboard:
  210.     image:
  212. ## Enable nfs chart, default is false
  213. nfs-client-provisioner:
  214.   childChart:
  215.     enable: false
  216.   nfs:
  217.     server: 
  218.     path: