hashicorppreview/hcp

HCP CLI镜像文档

镜像概述和主要用途

hcp CLI Docker镜像提供了管理HashiCorp Cloud Platform (HCP)资源和服务的工具。您可以直接与hcp交互，或将其集成到脚本中实现工作流自动化。HCP CLI跨多数平台可用，能高效执行常见平台任务并大规模管理HCP资源。

• 官方文档：[***]
• GitHub仓库：https://github.com/hashicorp/hcp

核心功能和特性

• 资源管理：全面管理HCP资源和服务，支持创建、配置、监控等操作
• 多模式交互：支持交互式直接操作和非交互式脚本集成
• 跨平台兼容：可在多数主流操作系统平台上运行
• 高效任务执行：快速完成常见平台任务，支持大规模资源管理
• 安全认证：支持服务主体凭证认证，提供环境变量和凭证文件两种安全认证方式

使用场景和适用范围

• 交互式管理：开发或运维人员通过命令行直接操作HCP资源，进行临时配置或查询
• 自动化工作流：集成到CI/CD管道、定时任务等脚本中，实现HCP资源的自动化部署和管理
• 跨环境一致性：通过Docker容器确保HCP CLI版本和运行环境一致性，避免本地环境差异

详细使用方法和配置说明

交互式使用

该镜像可用于交互式运行hcp CLI，适用于需要手动输入命令的场景：

bash
$ docker run -it hashicorp/hcp
# hcp auth login --client-id=<客户端ID> --client-secret=<客户端密钥>
# hcp <其他命令>

执行上述命令后，将进入容器的交互式终端，可直接输入hcp命令进行操作，首次使用需通过hcp auth login命令登录。

非交互式使用

非交互式使用需在调用时传递凭证，通常用于脚本自动化，需使用服务主体凭证。有以下两种传递方式：

1. 使用环境变量

最简单的方式是通过环境变量传递服务主体凭证：

bash
$ docker run -e HCP_CLIENT_ID=<客户端ID> -e HCP_CLIENT_SECRET=<客户端密钥> hashicorp/hcp hcp <命令>

• -e HCP_CLIENT_ID：设置服务主体的客户端ID
• -e HCP_CLIENT_SECRET：设置服务主体的客户端密钥
• <命令>：需执行的hcp具体命令（如organizations list）

2. 使用凭证文件

更安全的方式是创建包含服务主体凭证的文件并挂载到容器中。创建凭证文件的详细步骤可参考官方文档，若使用工作负载身份提供商，可参考create-cred-file命令。

创建凭证文件示例：

bash
$ hcp iam service-principals create example-sp  # 创建服务主体
$ hcp iam service-principals keys create example-sp --output-cred-file=cred_file.json  # 创建凭证文件

挂载凭证文件到容器：

bash
$ docker run -v /本地路径/凭证文件目录/:/root/hcp/ \
  -e HCP_CRED_FILE=/root/hcp/cred_file.json hashicorp/hcp hcp <命令>

• -v /本地路径/凭证文件目录/:/root/hcp/：将本地凭证文件目录挂载到容器内/root/hcp/路径
• -e HCP_CRED_FILE=/root/hcp/cred_file.json：设置环境变量指定凭证文件路径，CLI将通过该文件认证
• <命令>：需执行的hcp具体命令