genusbiz/genus-bootstrap

genus-bootstrap Docker镜像文档

镜像概述

genus-bootstrap是Genus生态系统中的集群引导与配置管理工具镜像，旨在简化Genus相关Kubernetes集群的初始化配置、Helm参数维护及版本升级流程。通过容器内预定义脚本，可自动化执行命名空间创建、Helm配置更新、Genus应用发布版本升级及operator组件升级等关键操作，需依赖外部挂载的证书文件、Helm配置文件及Kubernetes集群配置文件，并通过环境变量注入必要参数。

核心功能与特性

• 命名空间引导：通过bootstrap_ns_from_valuefile.sh脚本，基于挂载的Helm配置文件（/helm-values目录）自动化创建或配置Genus相关命名空间。
• Helm配置更新：通过update_helm_values.sh脚本，更新Helm部署参数，确保配置与集群需求一致。
• Genus发布版本升级：通过upgrade_genus_release.sh <release version number>脚本，指定目标版本号升级Genus应用的Helm发布版本。
• operator版本升级：通过upgrade_operator.sh <operator version number>脚本，指定目标版本号升级Genus operator组件版本。

使用场景

• Genus相关Kubernetes集群的初始化部署，需自动创建必要命名空间及基础配置。
• 日常维护中Helm部署参数的调整与更新，确保配置实时生效。
• Genus应用发布版本的迭代升级，需指定版本号完成自动化升级。
• Genus operator组件的版本更新，保障operator功能与集群版本兼容。

使用方法与配置说明

前提条件

• 本地需准备Helm证书文件（路径记为<path-to-helm-certificates>）、Helm配置文件（路径记为<path-to-helm-values>）及Kubernetes集群配置文件（通常位于~/.kube/config，路径记为<path-to-kube>）。
• 需获取目标集群名称（<clustername>）、Helm仓库用户名（<helm_username>）及密码（<helm_password>）。

启动容器

使用以下命令启动genus-bootstrap容器，挂载必要文件并配置环境变量：

bash
# 启动bootstrap容器
docker run -t -i \
  -v <path-to-helm-certificates>:/certificates \  # 挂载Helm证书文件到容器内/certificates目录
  -v <path-to-helm-values>:/helm-values \          # 挂载Helm配置文件到容器内/helm-values目录
  -v <path-to-kube>:/kube \                        # 挂载Kubernetes配置文件到容器内/.kube目录
  -e CLUSTER_NAME=<clustername> \                  # 环境变量：目标集群名称
  -e HELM_USERNAME=<helm_username> \               # 环境变量：Helm仓库用户名
  -e HELM_PASSWORD=<helm_password> \               # 环境变量：Helm仓库密码
  genusbiz/genus-bootstrap /bin/bash               # 镜像名称及启动交互终端

运行脚本

容器启动后，通过交互终端执行以下脚本完成对应操作：

bash
# 1. 基于Helm配置文件引导命名空间
./bootstrap_ns_from_valuefile.sh

# 2. 更新Helm配置参数
./update_helm_values.sh

# 3. 升级Genus应用发布版本（替换<release version number>为目标版本号，如1.2.3）
./upgrade_genus_release.sh <release version number>

# 4. 升级operator版本（替换<operator version number>为目标版本号，如2.1.0）
./upgrade_operator.sh <operator version number>

参数说明

• 挂载卷（-v）：

  • /certificates：容器内Helm证书存储路径，需映射本地证书文件目录。
  • /helm-values：容器内Helm配置文件存储路径，需映射本地Helm values文件目录。
  • /.kube：容器内Kubernetes配置文件存储路径，需映射本地kubeconfig文件目录。

• 环境变量（-e）：

  • CLUSTER_NAME：目标Kubernetes集群的名称，用于脚本定位集群资源。
  • HELM_USERNAME：访问Helm仓库的用户名，用于认证获取Helm Chart。
  • HELM_PASSWORD：访问Helm仓库的密码，与用户名配合完成认证。