logiva/nmanifest

镜像概述

logiva/nmanifest镜像用于解决在FluxCD管理的GitOps工作流中，动态生成和重复多环境（如dev、qa、staging、prod）下的Kubernetes manifests的问题。它支持通过模板和配置差异生成多个实例（如HelmRelease），避免重复编写相似配置，简化多环境配置管理。

核心功能

1. 模板集管理：通过basetemplates目录管理基础模板，新环境实例可基于基础模板创建。
2. 动态配置生成：通过generatorconfig文件定义参数替换和配置覆盖，生成不同实例的manifest。
3. 多环境支持：在environments目录下创建子目录管理不同环境的配置，直接编辑模板即可影响生成结果。
4. 参数导入与覆盖：支持从其他generatorconfig导入参数，并可覆盖已有参数。
5. manifest覆盖：允许对生成的manifest进行细粒度覆盖，灵活调整配置。

使用场景

• FluxCD管理的GitOps工作流中，需要为多个环境（如dev、qa）生成相似但略有差异的Kubernetes manifest。
• 需要部署多个实例的应用（如多个客户的遗留应用服务器），只需定义一次模板，通过配置差异生成多个实例。
• 简化多环境配置维护，避免重复编写相同配置。

配置说明

目录结构

镜像预期的目录结构如下：

├── releases          # FluxCD同步的manifest目录（生成结果存放处）
│   └── .flux.yaml    # FluxCD配置文件
├── environments      # 环境实例配置目录
└── basetemplates     # 基础模板目录

basetemplates目录

存放基础模板集，每个模板集为一个子目录，包含Jinja2模板文件：

└── basetemplates
    ├── SET1
    │   ├── template1.yaml
    │   └── template2.yaml
    └── SET2
        ├── template1.yaml
        └── template2.yaml

environments目录

每个环境实例为一个子目录，包含模板快照和generatorconfig文件：

└── environments
    └── NAME
        ├── templates       # 基础模板的快照副本
        │   ├── SET1
        │   └── SET2
        └── generatorconfigs # generatorconfig配置文件
            ├── SET1-a-generatorconfig.yaml
            └── SET2-b-generatorconfig.yaml

generatorconfig格式

generatorconfig文件用于定义模板参数和覆盖规则，格式如下：

yaml
generatorconfigversion: 1  # 必须为1
templateset: SET2          # 指向模板集目录
id: set2-a                 # 可选，用于其他config引用
import_substitution_parameters:  # 导入其他config的参数
  - set1
substitution_parameters:   # Jinja2模板参数
  NAME1: VALUE
  NAME2: VALUE
overrides:                 # 覆盖生成的manifest
  - manifest:
      kind: MFKIND
      namespace: MFNAMESPACE
      name: MFNAME
    values:
      PATH: OVERRIDE

Docker部署示例

将本地的environments、basetemplates和releases目录挂载到容器中，运行镜像生成manifest：

bash
docker run -v $(pwd)/environments:/app/environments \
           -v $(pwd)/basetemplates:/app/basetemplates \
           -v $(pwd)/releases:/app/releases \
           logiva/nmanifest