pivotalservices/cf-mgmt

cf-mgmt Docker镜像文档

一、镜像概述和主要用途

cf-mgmt Docker镜像是一个预打包了cf-mgmt二进制工具的容器化解决方案。cf-mgmt是Cloud Foundry生态中的核心管理工具，旨在通过配置文件驱动的方式，自动化完成Cloud Foundry（CF）环境的组织（Org）、空间（Space）、用户（User）、角色（Role）、配额（Quota）及安全组（Security Group）等资源的创建、配置与维护。该镜像简化了cf-mgmt的部署与依赖管理，支持在容器化环境中快速集成Cloud Foundry自动化运维流程。

二、核心功能和特性

2.1 核心功能

• 组织与空间管理：通过配置文件定义Org/Space结构，自动创建、更新或删除CF中的Org和Space。
• 用户与角色管理：批量配置用户（包括内部用户、LDAP用户）及其在Org/Space中的角色（如OrgManager、SpaceDeveloper等）。
• 资源配额控制：定义并应用Org级/Space级资源配额（内存、CPU、实例数等）。
• 安全组配置：管理CF安全组规则，并绑定到指定Org/Space。
• 多环境适配：支持通过不同配置文件管理开发、测试、生产等多CF环境。

2.2 特性

• 配置驱动：基于YAML配置文件定义运维规则，支持版本化管理。
• 无状态运行：容器启动时加载外部配置文件，支持动态调整。
• 轻量级：基于Alpine或Distroless基础镜像，体积小、启动快。
• 兼容性：兼容CF API v3及以上版本，支持最新CF发行版（如CF for Kubernetes）。

三、使用场景和适用范围

3.1 典型场景

• CF环境自动化运维：替代手动执行cf create-org/cf set-space-role等命令，通过配置文件批量完成资源配置。
• 多租户管理：为企业内部多团队/部门自动分配独立Org/Space，并配置隔离的资源和权限。
• CI/CD流程集成：作为Pipeline步骤（如GitLab CI、Jenkins），在应用部署前自动准备CF环境。
• 大规模CF部署管理：支持管理包含数百个Org/Space的大型CF集群，降低人工操作成本。

3.2 适用范围

• Cloud Foundry管理员、平台工程师。
• 需要标准化CF环境配置的企业或组织。
• 采用基础设施即代码（IaC）理念管理CF资源的团队。

四、使用方法和配置说明

4.1 获取镜像

从Docker Registry拉取镜像（假设镜像名称为cf-mgmt:latest，实际需替换为官方/私有仓库地址）：

bash
docker pull cf-mgmt:latest

4.2 基本使用流程

1. 准备配置文件：创建cf-mgmt配置目录（如./cf-mgmt-config），并编写主配置文件（config.yaml）及Org/Space定义文件。
2. 挂载配置文件：通过Docker卷（Volume）将本地配置目录挂载到容器内。
3. 执行命令：运行容器并指定cf-mgmt子命令（如apply、diff、delete-orphans等）。

4.3 配置文件说明

4.3.1 目录结构

配置文件需按固定目录结构组织，示例：

./cf-mgmt-config/
├── config.yaml          # 全局配置（CF连接信息、通用参数）
├── orgs/                # Org定义目录
│   ├── org1/            # Org名称（需与CF中一致）
│   │   ├── config.yaml  # Org级配置（配额、安全组等）
│   │   └── spaces/      # Space定义目录
│   │       ├── space1/  # Space名称
│   │       │   └── config.yaml  # Space级配置（配额、用户角色等）
│   └── org2/
│       └── ...
└── ldap/                # LDAP用户配置（可选）
    └── users.yaml

4.3.2 核心配置文件示例（config.yaml）

全局配置文件示例（定义CF连接信息及全局规则）：

yaml
# 基础CF连接配置
api_endpoint: "https://api.cf.example.com"  # CF API地址
username: "admin"                          # CF管理员用户名
password: "${CF_PASSWORD}"                 # 支持环境变量引用（推荐）
skip_ssl_validation: false                 # 是否跳过SSL证书验证（生产环境不建议）

# 全局行为配置
enable_delete: true                        # 是否允许自动删除未在配置中定义的资源
default_org_quota: "standard-quota"        # 默认Org配额名称
default_space_quota: "dev-space-quota"     # 默认Space配额名称

4.4 环境变量说明

容器运行时可通过环境变量覆盖配置文件中的敏感信息（如CF密码），常用变量如下：

4.5 部署示例

4.5.1 单容器运行（docker run）

通过docker run执行cf-mgmt apply命令，应用配置文件到CF环境：

bash
docker run -it --rm \
  -v $(pwd)/cf-mgmt-config:/cf-mgmt-config \  # 挂载本地配置目录
  -e CF_PASSWORD="your-cf-admin-password" \   # 注入CF密码环境变量
  cf-mgmt:latest \
  apply  # 执行配置应用命令（其他命令：diff、delete-orphans、export-config等）

4.5.2 Docker Compose配置

通过docker-compose.yml定义服务，支持持久化配置和日志：

yaml
version: "3.8"
services:
  cf-mgmt:
    image: cf-mgmt:latest
    volumes:
      - ./cf-mgmt-config:/cf-mgmt-config:ro  # 只读挂载配置目录
      - ./logs:/cf-mgmt-logs                # 挂载日志目录
    environment:
      - CF_API=https://api.cf.example.com
      - CF_USERNAME=admin
      - CF_PASSWORD=${CF_PASSWORD}          # 从宿主机环境变量读取密码
      - CF_MGMT_CONFIG_PATH=/cf-mgmt-config
    command: apply --log-dir /cf-mgmt-logs  # 指定日志输出目录

启动命令：

bash
CF_PASSWORD="your-cf-admin-password" docker-compose up

五、注意事项

1. 配置文件权限：挂载到容器的配置文件目录需确保读权限（建议设置chmod 755）。
2. 敏感信息保护：避免在配置文件中硬编码密码，优先使用环境变量或外部密钥管理工具（如Vault）。
3. 版本兼容性：使用前确认镜像版本与目标CF环境的API版本兼容（参考cf-mgmt官方文档）。
4. 操作前验证：执行apply前建议先运行diff命令（docker run ... cf-mgmt diff），确认配置变更范围。