配置 ob-operator

本文介绍 ob-operator 的启动参数和使用到的环境变量以及修改方法。用户可通过改变启动参数和环境变量影响 ob-operator 的行为。

启动参数

参数名	含义	默认值	deploy 配置
namespace	监听的命名空间，留空表示监听所有命名空间	空	空
manager-namespace	ob-operator 运行的命名空间	oceanbase-system	oceanbase-system
metrics-bind-address	ob-operator 提供 Prometheus 指标的服务端口	:8080	127.0.0.1:8080
health-probe-bind-address	ob-operator 进程健康探针绑定端口	:8081	:8081
leader-elect	启动 ob-operator 时是否采用选主流程	false	true
log-verbosity	日志输出量，为 0 输出关键信息，为 1 输出调试信息，为 2 输出溯源信息	0	0

环境变量

环境变量名	含义	deploy 配置
TELEMETRY_REPORT_HOST	遥测采集数据收集端	https://openwebapi.oceanbase.com
TELEMETRY_DEBUG	设置为 true 可开启遥测采集调试模式	空
DISABLE_WEBHOOKS	设置为 true 可禁用 webhooks 校验	空
DISABLE_TELEMETRY	设置为 true 可禁用遥测采集模块，遥测采集模块会采集集群环境和事件信息脱敏后发送给 OceanBase，期望通过这些数据帮助改善 ob-operator	空

修改方法

使用 deploy/operator.yaml 中的配置文件，找到名为 oceanbase-controller-manager 的 Deployment 资源，在其容器列表中修改名为 manager 容器的启动参数和环境变量，下面截取 deploy/operator.yaml 中该部分为例。

      # 原本的配置
      containers:
      - args:
        - --health-probe-bind-address=:8081
        - --metrics-bind-address=:8080
        - --leader-elect
        - --manager-namespace=oceanbase-system
        - --log-verbosity=0
        command:
        - /manager
        env:
        - name: TELEMETRY_REPORT_HOST
          value: https://openwebapi.oceanbase.com

示例：增大日志输出量

如果用户希望增加 ob-operator 的日志输出量，可增大 log-verbosity 参数到 1 或者 2，值越大输出的日志越多。

      # 修改后的配置
      containers:
      - args:
        - --health-probe-bind-address=:8081
        - --metrics-bind-address=:8080
        - --leader-elect
        - --manager-namespace=oceanbase-system
        - --log-verbosity=2 # 日志输出量增大到 2 
        command:
        - /manager
        env:
        - name: TELEMETRY_REPORT_HOST
          value: https://openwebapi.oceanbase.com

示例：指定资源命名空间

      # 修改后的配置
      containers:
      - args:
        - --health-probe-bind-address=:8081
        - --metrics-bind-address=:8080
        - --leader-elect
        - --manager-namespace=oceanbase-system
        - --log-verbosity=0
        - --namespace=oceanbase # 限定 ob-operator 只监听命名空间为 oceanbase 内的资源
        command:
        - /manager
        env:
        - name: TELEMETRY_REPORT_HOST
          value: https://openwebapi.oceanbase.com

应用到集群中

修改完成后通过 kubectl apply -f deploy/operator.yaml 将配置文件应用到集群中即可生效。环境变量的配置方法与启动参数相同，本文不再赘述。