KubeBlocks实例模板应用指南：以RisingWave集群为例-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00873/article/details/148783841

KubeBlocks实例模板应用指南：以RisingWave集群为例

kubeblocks KubeBlocks is an open-source control plane that runs and manages databases, message queues and other data infrastructure on K8s. 项目地址: https://gitcode.com/gh_mirrors/ku/kubeblocks

前言

在云原生数据库管理领域，KubeBlocks作为一个强大的工具，提供了丰富的集群管理功能。其中实例模板（Instance Template）功能尤为重要，它允许用户对集群中的不同实例进行差异化配置。本文将深入探讨如何在KubeBlocks中应用实例模板，并以RisingWave集群为例进行详细说明。

实例模板概述

实例模板是KubeBlocks中一种强大的配置机制，它允许用户：

为同一组件中的不同实例提供差异化配置
动态注入环境变量等配置信息
灵活管理集群实例的生命周期

RisingWave集群配置案例

RisingWave是一种流处理数据库，它需要依赖外部存储（如AWS S3或阿里云OSS）作为状态后端。在创建RisingWave集群时，必须配置外部存储的凭证信息，这些信息通常因集群而异。

默认模板分析

在RisingWave的默认组件定义中，已经配置了一些基础环境变量：

apiVersion: apps.kubeblocks.io/v1alpha1
kind: ComponentDefinition
spec:
  runtime:
    containers:
      - name: compute
        env:
        - name: RUST_BACKTRACE
          value: "1"
        - name: RW_CONFIG_PATH
          value: /risingwave/config/risingwave.toml
        - name: RW_LISTEN_ADDR
          value: 0.0.0.0:5688
        # 其他基础环境变量...

这些基础配置确保了RisingWave的基本运行，但缺少存储相关的关键配置。

实例模板应用

通过实例模板，我们可以为每个集群注入特定的存储配置：

apiVersion: apps.kubeblocks.io/v1
kind: Cluster
spec:
  componentSpecs:
  - componentDef: compute
    name: compute
    instances:
    - name: instance
      env:
      - name: RW_STATE_STORE
        value: "hummock+s3://my-bucket"
      - name: AWS_REGION
        value: "us-west-1"
      - name: AWS_ACCESS_KEY_ID
        value: "AKIAXXXXXXXXXXXXXXXX"
      - name: AWS_SECRET_ACCESS_KEY
        value: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

当这个模板应用后，KubeBlocks会将其与默认模板合并，最终生成的实例将包含所有必要的环境变量。

实例模板核心功能详解

命名与副本控制

名称字段：每个组件可以定义多个实例模板，名称必须唯一
副本字段：控制基于该模板创建的实例数量
- 所有模板副本数总和 ≤ 组件副本数
- 不足部分使用默认模板创建

实例命名遵循模式：$(集群名)-$(组件名)-$(模板名)-序号

配置覆盖机制

实例模板支持多种配置项的覆盖：

Annotations和Labels：
- 同名Key：使用模板中的值
- 新Key：添加到最终配置中
- 系统保留的注解和标签不会被覆盖
镜像配置：
- 覆盖默认模板中第一个容器的镜像
- 注意：数据库类应用需谨慎变更镜像版本
调度相关配置：
- NodeName：直接覆盖
- NodeSelector：直接覆盖
- Tolerations：相同配置会被忽略，不同则添加
资源与环境变量：
- Resources：最高优先级覆盖
- Env：同名变量使用模板值，不同名则添加
存储配置：
- Volumes：同名Volume使用模板配置
- VolumeMounts：同名挂载使用模板配置
- VolumeClaimTemplates：覆盖组件定义的持久卷声明