Golang动态Kubernetes清单和配置文件模板化工具 - crab-config-files-templating

crab-config-files-templating 是一个用于动态生成Kubernetes清单文件和配置文件的Golang模板化工具插件，它可以帮助开发者在部署应用时根据环境变量或输入参数动态生成配置文件。

主要特性

1. 支持Go模板语法
2. 支持环境变量注入
3. 支持JSON/YAML配置文件处理
4. 与Kubernetes生态系统无缝集成
5. 轻量级且易于使用

安装

go get github.com/containersolutions/crab-config-files-templating

基本用法示例

1. 简单模板渲染

package main

import (
	"fmt"
	"os"
	
	"github.com/containersolutions/crab-config-files-templating/pkg/template"
)

func main() {
	// 定义模板内容
	tmpl := `apiVersion: v1
kind: Pod
metadata:
  name: {{.PodName}}
  labels:
    app: {{.AppLabel}}
spec:
  containers:
  - name: {{.ContainerName}}
    image: {{.Image}}`

	// 准备模板数据
	data := map[string]interface{}{
		"PodName":       "my-pod",
		"AppLabel":      "my-app",
		"ContainerName": "main-container",
		"Image":         "nginx:latest",
	}

	// 渲染模板
	result, err := template.Render(tmpl, data)
	if err != nil {
		fmt.Printf("Error rendering template: %v\n", err)
		os.Exit(1)
	}

	fmt.Println(result)
}

2. 从文件加载模板并渲染

package main

import (
	"fmt"
	"os"
	
	"github.com/containersolutions/crab-config-files-templating/pkg/template"
)

func main() {
	// 从文件加载模板
	tmpl, err := os.ReadFile("pod-template.yaml")
	if err != nil {
		fmt.Printf("Error reading template file: %v\n", err)
		os.Exit(1)
	}

	// 准备模板数据
	data := map[string]interface{}{
		"PodName":       "file-based-pod",
		"AppLabel":      "file-app",
		"ContainerName": "file-container",
		"Image":         "nginx:1.19",
	}

	// 渲染模板
	result, err := template.Render(string(tmpl), data)
	if err != nil {
		fmt.Printf("Error rendering template: %v\n", err)
		os.Exit(1)
	}

	fmt.Println(result)
}

3. 使用环境变量

package main

import (
	"fmt"
	"os"
	
	"github.com/containersolutions/crab-config-files-templating/pkg/template"
)

func main() {
	// 设置环境变量
	os.Setenv("POD_NAME", "env-pod")
	os.Setenv("APP_LABEL", "env-app")

	// 定义使用环境变量的模板
	tmpl := `apiVersion: v1
kind: Pod
metadata:
  name: {{ env "POD_NAME" }}
  labels:
    app: {{ env "APP_LABEL" }}`

	// 渲染模板
	result, err := template.Render(tmpl, nil)
	if err != nil {
		fmt.Printf("Error rendering template: %v\n", err)
		os.Exit(1)
	}

	fmt.Println(result)
}

4. 高级功能 - 条件判断和循环

package main

import (
	"fmt"
	"os"
	
	"github.com/containersolutions/crab-config-files-templating/pkg/template"
)

func main() {
	// 定义带条件和循环的模板
	tmpl := `apiVersion: v1
kind: Pod
metadata:
  name: {{.PodName}}
spec:
  containers:
  {{- range .Containers }}
  - name: {{.Name}}
    image: {{.Image}}
    {{- if .Resources }}
    resources:
      limits:
        cpu: {{.Resources.Limits.CPU}}
        memory: {{.Resources.Limits.Memory}}
    {{- end }}
  {{- end }}`

	// 准备复杂数据
	data := map[string]interface{}{
		"PodName": "multi-container-pod",
		"Containers": []map[string]interface{}{
			{
				"Name":  "web",
				"Image": "nginx:latest",
				"Resources": map[string]interface{}{
					"Limits": map[string]string{
						"CPU":    "500m",
						"Memory": "512Mi",
					},
				},
			},
			{
				"Name":  "sidecar",
				"Image": "busybox:latest",
			},
		},
	}

	// 渲染模板
	result, err := template.Render(tmpl, data)
	if err != nil {
		fmt.Printf("Error rendering template: %v\n", err)
		os.Exit(1)
	}

	fmt.Println(result)
}

最佳实践

1. 模板组织：将常用模板保存在单独的文件中，便于管理和重用
2. 数据分离：将配置数据与模板分离，便于不同环境的部署
3. 输入验证：在渲染前验证输入数据，确保生成的清单有效
4. 错误处理：妥善处理模板渲染错误，提供有意义的错误信息
5. 版本控制：将模板文件纳入版本控制，跟踪变更历史

集成到CI/CD流程

crab-config-files-templating 可以轻松集成到CI/CD流程中，在部署阶段动态生成Kubernetes清单。例如在GitLab CI中：

deploy:
  stage: deploy
  image: golang:1.18
  script:
    - go install github.com/containersolutions/crab-config-files-templating/cmd/crab-render@latest
    - crab-render -template deployment.yaml.tmpl -data config/prod.json -output deployment.yaml
    - kubectl apply -f deployment.yaml

crab-config-files-templating 提供了灵活而强大的方式来管理Kubernetes清单和配置文件的模板化，特别适合需要根据不同环境动态生成配置的场景。