values.yaml 详解

本文档对基于 Helm 安装 Rainbond 集群支持的所有参数进行说明,并说明如何变更已安装 Rainbond 集群配置

变更配置项

对于支持动态变更的配置项,可通过以下命令进行动态变更,变更文件内需要指定创建时的所有配置项,如不指定则会被默认值覆盖,对于不支持变更的配置项请勿随意修改,避免造成数据丢失等问题

  1. helm upgrade rainbond ./rainbond-chart -f value_change.yaml -n rbd-system

Operator 配置

以下配置项均支持动态变更

  • name:operator 的 deployment 资源名称
  • image:
    • name:operator 的镜像下载地址,默认为 registry.cn-hangzhou.aliyuncs.com/goodrain/rainbond-operator
    • tag:operator 的镜像 tag ,默认为 v2.0.0
    • pullPolicy:operator 镜像拉取策略,默认为 IfNotPresent
  • logLevel:operator 的日志输出级别,默认为 4

示例文件:

  1. operator:
  2. name: rainbond-operator
  3. image:
  4. name: registry.cn-hangzhou.aliyuncs.com/yangkaa/rainbond-operator
  5. tag: v2.2.0-dev
  6. pullPolicy: IfNotPresent
  7. logLevel: 4

Cluster 配置

  • enableHA:是否启用高可用模式,默认为 false ,设置为 true 则启用高可用安装,高可用模式下必须提供外部数据库、外部 Etcd 、外部共享存储(RWX)
  • imageHub:此配置项不支持动态变更
    • enable:是否启用外部镜像仓库,默认为 false ,设置为 true 则启用
    • domain:外部镜像仓库的访问地址
    • namespace:外部镜像仓库的名称空间
    • password:外部镜像仓库的访问密码
    • username:外部镜像仓库的访问用户
  • etcd:此配置项不支持动态变更
    • enable:是否启用外部ETCD,默认为 false ,设置为 true 则启用
    • endpoints:外部 ETCD 集群访问列表
    • secretName:访问 ETCD 集群的证书 secret 文件,创建时需要指定和 rainbond 集群相同的 namespace
  • RWX:搭建外部存储请参考 Glusterfs分布式存储文档,此配置项不支持动态变更
    • enable:是否开启外部共享存储,默认为 false ,设置为 true 则启用
    • storageClassName:外部共享存储的 storageClass 名称
  • RWO:此配置项不支持动态变更
    • enable:是否开启外部块存储,默认为 false ,设置为 true 则启用
    • storageClassName:外部块存储的 storageClass 名称
  • regionDatabase:此配置项不支持动态变更
    • enable:是否启用外部集群数据库,默认为 false ,设置为 true 则启用
    • host:外部集群数据库访问地址
    • name:外部集群数据库库名称
    • password:外部集群数据库访问密码
    • port:外部集群数据库访问端口
    • username:外部集群数据库访问用户
  • uiDatabase:此配置项不支持动态变更
    • enable:是否启用外部控制台数据库,默认为 false ,设置为 true 则启用
    • host:外部控制台数据库访问地址
    • name:外部控制台数据库库名称
    • password:外部控制台数据库访问密码
    • port:外部控制台数据库访问端口
    • username:外部控制台数据库访问用户
  • gatewayIngressIPs:集群对外IP,必须填写
  • nodesForChaos:此配置项支持动态变更
    • name:运行集群构建服务的 Kubernetes 节点名称
  • nodesForGateway:此配置项支持动态变更
    • externalIP:运行网关服务的 Kubernetes 节点外部 IP
    • internalIP:运行网关服务的 Kubernetes 节点内部 IP
    • name:运行网关服务的 Kubernetes 节点名称
  • rainbondImageRepository:集群服务镜像拉取地址,默认为 registry.cn-hangzhou.aliyuncs.com/goodrain,此配置项不支持动态变更
  • installVersion:集群服务镜像拉取 tag,默认为 v5.6.0-release,此配置项不支持动态变更
  • imagePullPolicy:集群服务镜像拉取策略,默认为 IfNotPresent,此配置项不支持动态变更
  • replicas:集群服务组件副本数,启用高可用的情况下生效,默认为2,此配置项不支持动态变更

示例配置

  1. #Rainbondcluster
  2. Cluster:
  3. ## 定义是否开启高可用,true为开,false为关
  4. enableHA: false
  5. ## 定义是否使用外部镜像镜像仓库,true为开,false为关
  6. imageHub:
  7. enable: false
  8. domain: registry.cn-hangzhou.aliyuncs.com
  9. namespace: rainbond
  10. password: admin
  11. username: admin
  12. ## 外部ETCD,对应填写IP,证书,true为开,false为关
  13. etcd:
  14. enable: false
  15. endpoints:
  16. - 192.168.0.1:2379
  17. - 192.168.0.2:2379
  18. - 192.168.0.3:2379
  19. secretName: "rbd-etcd-secret"
  20. ## 外部存储,直接填写storageClassName,true为开,false为关
  21. RWX:
  22. enable: false
  23. config:
  24. storageClassName: glusterfs-simple
  25. ## 外部存储,直接填写storageClassName,true为开,false为关
  26. RWO:
  27. enable: false
  28. storageClassName: glusterfs-simple
  29. ## region数据库,true为开,false为关
  30. regionDatabase:
  31. enable: false
  32. host: 192.168.0.1
  33. name: region
  34. password: password
  35. port: 3306
  36. username: admin
  37. ## ui数据库,true为开,false为关
  38. uiDatabase:
  39. enable: false
  40. host: 192.168.0.1
  41. name: console
  42. password: password
  43. port: 3306
  44. username: admin
  45. ## 对外网关,填写IP
  46. gatewayIngressIPs: 192.168.0.1
  47. ## chaos对应配置,name为Chaos节点node名称
  48. nodesForChaos:
  49. - name: node1
  50. - name: node2
  51. ## 网关节点对应配置,externalIP为网关节点外部IP,internalIP为网关节点内部IP,name为网关节点node名称
  52. nodesForGateway:
  53. - externalIP: 192.168.0.1
  54. internalIP: 192.168.0.1
  55. name: node1
  56. - externalIP: 192.168.0.2
  57. internalIP: 192.168.0.2
  58. name: node2
  59. ## 系统组件统一镜像仓库拉取地址及名称空间
  60. rainbondImageRepository: registry.cn-hangzhou.aliyuncs.com/goodrain
  61. ## 系统组件统一镜像版本
  62. installVersion: v5.6.0-release
  63. ## 系统组件统一镜像拉取策略
  64. imagePullPolicy: IfNotPresent
  65. ## 高可用安装模式下,系统组件副本数
  66. replicas: 2