4. 参数化设计原则：变量抽象、配置与代码分离、环境差异处理、敏感信息管理

参数化设计的核心目标是将 Runbook 中的可变部分与固定逻辑解耦，使同一份模板能够通过参数注入适配不同的自愈场景。本章围绕四项关键原则展开：变量抽象、配置与代码分离、环境差异处理、敏感信息管理。掌握这些原则，是构建可复用、可维护、可安全交付的自愈 Runbook 的基础。

4.1 变量抽象：从硬编码到语义化占位符

变量抽象要求将 Runbook 中所有可能随场景变化的值提取为命名清晰的参数，而非直接写在脚本或命令中。抽象粒度需要平衡灵活性与可读性。

4.2 配置与代码分离：将参数从执行逻辑中剥离

配置与代码分离要求 Runbook 的执行逻辑（步骤、命令、判断）与参数值（阈值、路径、账号）分属不同文件或存储层。这一原则直接决定了 Runbook 的可维护性和安全性。

推荐的分层结构如下：

runbooks/
├── templates/                  # Runbook 模板（含占位符）
│   ├── nginx_restart.yaml
│   ├── disk_cleanup.yaml
│   └── service_health_check.yaml
├── configs/                    # 参数配置文件（按环境/场景）
│   ├── production/
│   │   ├── nginx_restart.yaml
│   │   └── disk_cleanup.yaml
│   ├── staging/
│   │   └── nginx_restart.yaml
│   └── dr/
│       └── service_health_check.yaml
└── engine/                     # 渲染引擎（负责合并模板+配置）
    └── render.py

渲染引擎的核心逻辑示例（Python + Jinja2）：

from jinja2 import Environment, FileSystemLoader
import yaml

def render_runbook(template_name, config_path):
    env = Environment(loader=FileSystemLoader('templates/'))
    template = env.get_template(template_name)

    with open(config_path, 'r') as f:
        params = yaml.safe_load(f)

    rendered = template.render(params)
    return rendered

# 使用示例
output = render_runbook('nginx_restart.yaml', 'configs/production/nginx_restart.yaml')

4.3 环境差异处理：通过参数化覆盖而非分支逻辑

不同环境（开发、测试、预发、生产、灾备）之间的差异应通过参数配置来覆盖，而非在 Runbook 模板中编写大量 if-else 分支。分支逻辑会显著增加模板的复杂度和测试成本。

下表展示了环境差异的典型参数化方案：

4.4 敏感信息管理：避免参数泄露的安全防线

敏感信息（密码、API 、SSH 密钥、数据库连接串）绝不能以明文形式出现在 Runbook 模板或配置文件中。必须采用专门的密钥管理机制。

推荐的敏感信息处理策略对比：

敏感信息注入的推荐实现模式（伪代码）：

def render_with_secrets(template_name, config_path, vault_):
    # 1. 加载非敏感配置
    with open(config_path, 'r') as f:
        params = yaml.safe_load(f)

    # 2. 从 Vault 获取敏感信息
    secrets = vault_client.get_secrets(
        path="secret/runbook/",
        =vault_
    )
    params.update(secrets)

    # 3. 渲染模板
    rendered = template.render(params)

    # 4. 安全清理
    del params['db_password']
    del params['api_']

    return rendered

4.5 四项原则的协同关系

四项原则并非孤立存在，而是相互支撑的有机整体。变量抽象为配置分离提供了基础，配置分离使得环境差异处理成为可能，而敏感信息管理则为整个参数化体系提供了安全保障。