pjcdawkins/platformsh-cli

Platform.sh CLI with Git and SSH 镜像

镜像概述与主要用途

本Docker镜像集成了Platform.sh命令行工具(CLI)、Git版本控制系统及SSH客户端，旨在为用户提供一个便捷的工具链，用于与Platform.sh云平台进行交互。通过该镜像，用户无需在本地系统直接安装Platform.sh CLI、Git或配置SSH环境，即可快速执行项目部署、环境管理、代码同步等操作，适用于开发、测试及CI/CD场景下的Platform.sh平台交互需求。

核心功能与特性

核心组件

• Platform.sh CLI：完整集成Platform.sh官方命令行工具，支持项目创建、环境管理、部署配置、日志查看等平台操作。
• Git：包含Git客户端，支持代码拉取、提交、推送等版本控制操作，可直接与Platform.sh Git仓库交互。
• SSH客户端：内置SSH工具，支持通过SSH密钥认证连接Platform.sh环境，实现安全的远程操作与文件传输。

特性优势

• 工具链集成：一站式提供Platform.sh交互所需核心工具，避免本地环境依赖冲突。
• 轻量级基础：基于精简的Linux基础镜像构建，减少镜像体积，提升启动速度。
• 跨平台兼容：支持Docker兼容的各类操作系统（Linux、macOS、Windows），确保环境一致性。
• 即开即用：无需复杂配置，拉取镜像后可直接运行命令，降低使用门槛。

使用场景与适用范围

典型使用场景

• 开发环境快速部署：开发人员无需在本地系统安装Platform.sh CLI，通过容器快速获取完整工具链，测试平台操作命令。
• CI/CD流水线集成：在自动化流水线（如GitHub Actions、GitLab CI）中作为执行环境，运行Platform.sh部署命令、环境检查等操作。
• 多环境隔离：通过容器化方式隔离不同项目或版本的Platform.sh操作环境，避免工具版本冲突。
• 临时运维操作：临时需要管理Platform.sh项目时，无需配置本地环境，直接通过容器执行SSH连接、日志导出等运维任务。

适用人群

• 与Platform.sh平台交互的开发人员
• 负责Platform.sh项目部署的DevOps工程师
• 需要自动化Platform.sh操作的CI/CD管理员

使用方法与配置说明

基本使用流程

1. 拉取镜像（假设镜像名为platformsh/cli-git-ssh，实际名称请以官方为准）：

   bash
   docker pull platformsh/cli-git-ssh
   

2. 验证工具版本：

   bash
   docker run --rm platformsh/cli-git-ssh platform --version  # 验证Platform.sh CLI版本
   docker run --rm platformsh/cli-git-ssh git --version        # 验证Git版本
   docker run --rm platformsh/cli-git-ssh ssh -V               # 验证SSH版本
   

关键配置与挂载

1. 挂载项目目录

如需操作本地项目文件（如提交代码、部署本地代码），需将项目目录挂载至容器内：

bash
docker run --rm -v $(pwd):/project -w /project platformsh/cli-git-ssh git status

• -v $(pwd):/project：将当前目录挂载至容器内/project路径
• -w /project：设置工作目录为/project，确保命令在项目目录下执行

2. 配置SSH密钥

通过挂载本地SSH配置目录或传递密钥内容，实现与Platform.sh的SSH认证：

bash
# 挂载本地SSH目录（包含id_rsa等密钥文件）
docker run --rm -v ~/.ssh:/root/.ssh platformsh/cli-git-ssh ssh git@git.platform.sh

注意：确保本地SSH密钥具有访问Platform.sh仓库或环境的权限，且文件权限设置正确（如~/.ssh/id_rsa权限为600）。

3. 配置Platform.sh认证

通过环境变量PLATFORMSH_TOKEN传递Platform.sh API令牌，实现CLI认证（令牌可从Platform.sh控制台获取）：

bash
docker run --rm -e PLATFORMSH_TOKEN="your-api-token" platformsh/cli-git-ssh platform project:list

执行后将列出当前账号下的Platform.sh项目，无需手动运行platform login。

部署示例

示例1：通过容器部署代码至Platform.sh环境

bash
# 1. 挂载项目目录并配置SSH密钥
docker run -it --rm \
  -v $(pwd):/project \
  -v ~/.ssh:/root/.ssh \
  -w /project \
  platformsh/cli-git-ssh \
  /bin/bash

# 2. 在容器内执行部署操作（示例命令）
git add .
git commit -m "Update code"
git push platform main  # 推送到Platform.sh Git仓库触发部署
platform environment:activate main  # 激活环境（如需要）

示例2：CI/CD流水线中使用（GitLab CI配置示例）

yaml
# .gitlab-ci.yml
deploy_to_platformsh:
  image: platformsh/cli-git-ssh
  stage: deploy
  before_script:
    # 配置SSH密钥（通过CI/CD变量传入）
    - mkdir -p ~/.ssh
    - echo "$PLATFORM_SSH_KEY" > ~/.ssh/id_rsa
    - chmod 600 ~/.ssh/id_rsa
    # 配置Platform.sh令牌
    - export PLATFORMSH_TOKEN="$PLATFORM_API_TOKEN"
  script:
    - platform project:select my-project-id  # 选择目标项目
    - platform environment:deploy --environment=staging  # 部署至staging环境
  only:
    - main

配置参数说明

环境变量

卷挂载点

注意事项

• 确保挂载的SSH密钥文件权限为600（仅所有者可读写），否则SSH客户端可能拒绝使用密钥。
• PLATFORMSH_TOKEN具有平台操作权限，请勿在非可信环境中暴露或硬编码。
• 如需持久化CLI配置（如保存已认证状态），可挂载/root/.platformsh目录至本地文件系统。