cunnie/fedora-golang-bosh

BOSH部署镜像文档

镜像概述和主要用途

本镜像用于BOSH（Bosh Open Source Host）部署管理，包含BOSH部署清单（Deployment Manifests）、云配置（Cloud Config）及状态文件（-state.json files）。主要用途是简化BOSH director的部署流程，提供开发和学习BOSH部署的基础环境，支持凭证管理、配置插值及部署验证等核心功能。

核心功能和特性

凭证管理

• 自动生成凭证：包含自动生成的密钥、证书及密码（密码已脱敏，需通过外部方式设置）
• 密码注入机制：支持通过命令行参数或环境变量传入自定义密码，避免硬编码敏感信息
• 安全校验：提供密码插值验证功能，确保部署时密码参数正确配置

证书配置

• 证书覆盖：支持使用CA颁发的证书覆盖默认的/director_ssl/key和/director_ssl/cert，增强SSL通信安全性
• 证书公开说明：镜像中包含的证书和密钥主要用于教学目的，生产环境需使用自定义安全凭证

部署验证

• 密码插值检查：通过bosh int --var-errs命令验证密码参数插值是否完整，避免因遗漏密码导致部署失败或安全风险

使用场景和适用范围

适用场景

• BOSH director的开发环境部署与测试
• BOSH部署流程学习与实践
• 自动化部署脚本调试与验证

不适用场景

• 生产环境BOSH director部署（因公开证书和密钥存在安全风险）
• 对凭证安全性要求极高的部署环境

使用方法和配置说明

环境准备

1. 确保BOSH CLI已安装并配置
2. 定义环境变量DEPLOYMENTS_YML，存储YAML格式的自定义密码（示例格式如下）：

   yaml
   admin_password: your_custom_password
   # 其他需自定义的密码参数
   

部署命令

通过以下命令启动BOSH部署，传入自定义密码配置：

bash
bosh create-env -l <(echo "$DEPLOYMENTS_YML")

说明：-l参数用于指定包含密码变量的文件，<(echo "$DEPLOYMENTS_YML")将环境变量内容转换为临时文件供BOSH CLI读取

证书覆盖配置

如需使用CA颁发的证书替换默认证书，需在部署清单中覆盖以下字段：

yaml
director_ssl:
  key: |
    -----BEGIN RSA PRIVATE KEY-----
    # CA颁发的私钥内容
    -----END RSA PRIVATE KEY-----
  cert: |
    -----BEGIN CERTIFICATE-----
    # CA颁发的证书内容
    -----END CERTIFICATE-----

密码插值验证

部署前建议执行以下命令，检查密码参数是否完整插值，避免遗漏：

bash
bosh int --var-errs <部署清单文件路径>

若存在未插值的密码参数，命令将输出错误信息，需补充对应密码配置后再执行部署

安全注意事项

• 凭证安全：镜像中公开的证书和密钥仅用于教学，生产环境必须使用独立管理的安全凭证，严禁公开CA证书、私钥等敏感信息
• 密码管理：自定义密码需通过安全方式存储（如加密的环境变量、密钥管理服务），避免明文暴露
• 生产建议：本镜像设计用于学习和开发，生产环境部署需基于官方BOSH文档构建安全隔离的部署流程，移除所有公开凭证信息