hashicorp/hcpvs-gateway

hcpvs-gateway 镜像文档

1. 镜像概述和主要用途

hcpvs-gateway 是一款专注于 HCP（HashiCorp Cloud Platform）工作流与本地网络集成的工具。其核心作用是建立到 HCP Vault Secrets 服务的出站连接，并持续监听该连接通道，以接收和处理密钥轮换请求，从而实现本地网络环境与 HCP 密钥管理服务的安全协作。

2. 核心功能和特性

• HCP Vault Secrets 连接：主动建立并维护与 HCP Vault Secrets 服务的安全出站连接，确保通信链路的稳定性。
• 密钥轮换请求处理：在已建立的连接通道上监听并接收来自 HCP Vault Secrets 服务的密钥轮换请求，支持本地环境密钥的动态更新。
• 轻量化集成：作为中间件实现 HCP 云端服务与本地网络的无缝对接，无需复杂的网络配置变更。

3. 使用场景和适用范围

• 企业级密钥管理集成：适用于需要将本地应用与 HCP Vault Secrets 服务集成，实现密钥集中管理和自动轮换的企业环境。
• 混合云密钥同步：在混合云架构中，用于同步 HCP 云端密钥轮换指令到本地网络，保障本地应用使用的密钥始终为最新状态。
• 安全通信通道：为本地网络与 HCP 服务之间提供专用通信路径，确保密钥轮换等敏感操作的安全性。

4. 使用方法和配置说明

4.1 环境变量配置

启动容器前需配置以下必要环境变量，用于与 HCP Vault Secrets 服务建立连接：

4.2 Docker 运行示例

通过以下命令启动容器，替换 <HCP_VAULT_SECRETS_ENDPOINT> 和 <HCP_SERVICE_TOKEN> 为实际值：

bash
docker run -d \
  --name hcpvs-gateway \
  -e HCP_VAULT_SECRETS_ENDPOINT=<HCP_VAULT_SECRETS_ENDPOINT> \
  -e HCP_SERVICE_TOKEN=<HCP_SERVICE_TOKEN> \
  -e LOG_LEVEL=info \
  hcpvs-gateway:latest

4.3 Docker Compose 配置示例

创建 docker-compose.yml 文件，配置如下：

yaml
version: '3.8'
services:
  hcpvs-gateway:
    image: hcpvs-gateway:latest
    container_name: hcpvs-gateway
    environment:
      - HCP_VAULT_SECRETS_ENDPOINT=<HCP_VAULT_SECRETS_ENDPOINT>
      - HCP_SERVICE_TOKEN=<HCP_SERVICE_TOKEN>
      - LOG_LEVEL=info
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

5. 注意事项

• 网络连通性：确保容器所在网络允许出站连接到 HCP Vault Secrets 服务的端口（通常为 443）。
• 令牌安全性：HCP_SERVICE_TOKEN 应通过安全方式注入（如 Docker Secrets、Kubernetes Secrets），避免明文存储。
• 版本兼容性：需使用与 HCP Vault Secrets 服务版本兼容的镜像标签，避免协议不匹配导致连接失败。