OpenShift CLI工具集成Docker镜像文档

镜像概述与主要用途

概述

本Docker镜像集成了OpenShift生态系统核心命令行工具（CLI），提供一个隔离、便捷的运行环境，用户无需在本地系统直接安装即可使用oc、odo等工具，简化OpenShift集群管理、应用开发与部署流程。

主要用途

• 提供OpenShift命令行工具（oc、odo）的即开即用执行环境
• 支持临时或隔离场景下的OpenShift集群操作（如资源管理、应用部署）
• 便于集成至CI/CD流水线或自动化脚本，统一工具版本与运行环境

核心功能与特性

已集成工具

• oc：OpenShift集群管理核心工具，支持集群资源操作、应用部署、日志查询等（基于openshift/oc）。
• odo：面向开发者的OpenShift工具，简化应用构建、部署与调试流程，专注提升开发者体验（基于redhat-developer/odo）。

暂未集成工具

• crc（CodeReady Containers）：本地OpenShift集群运行工具，因需完整GLib依赖（会导致镜像体积显著增大），当前暂未集成，将在后续版本中评估支持。

其他特性

• 轻量级：基于精简基础镜像，最小化体积，降低资源占用。
• 版本一致性：工具版本预先集成并测试，避免本地环境版本冲突。
• 隔离性：工具运行于容器环境，不影响主机系统配置。

使用场景与适用范围

适用场景

• OpenShift集群管理：临时执行oc命令（如资源创建、扩缩容、日志查询），无需本地安装oc。
• 应用开发与调试：通过odo快速初始化、构建并推送应用至OpenShift集群，适合多环境切换或临时开发。
• CI/CD流水线集成：作为工具容器嵌入自动化流程（如Jenkins、GitLab CI），执行部署脚本或集群状态检查。
• 培训与演示：为学员或演示环境提供统一工具集，规避本地环境配置差异。

适用人群

• OpenShift集群管理员、运维人员
• 基于OpenShift开发应用的开发者
• 构建CI/CD流程的DevOps工程师

使用方法与配置说明

基本使用流程

1. 拉取镜像

docker pull [镜像仓库地址]/openshift-cli-tools:latest

注：实际使用时需替换[镜像仓库地址]为具体镜像仓库（如私有仓库或公共镜像源）。

2. 交互式运行容器

启动容器并进入终端，直接使用工具：

docker run -it --rm [镜像仓库地址]/openshift-cli-tools:latest /bin/sh

进入容器后可执行工具命令：

# 验证oc版本
oc version

# 验证odo版本
odo version

3. 挂载集群配置（必选）

通过挂载本地kubeconfig文件（存放OpenShift集群认证信息），使工具能访问集群：

docker run -it --rm \
  -v $HOME/.kube/config:/root/.kube/config \  # 挂载本地kubeconfig
  [镜像仓库地址]/openshift-cli-tools:latest \
  /bin/sh

说明：kubeconfig默认路径为/root/.kube/config，如需自定义路径可通过环境变量KUBECONFIG指定。

环境变量配置

示例：自定义kubeconfig路径

docker run -it --rm \
  -v /path/to/custom/kubeconfig:/custom/config \  # 挂载自定义kubeconfig
  -e KUBECONFIG=/custom/config \  # 指定环境变量
  [镜像仓库地址]/openshift-cli-tools:latest \
  oc config view  # 查看当前kubeconfig配置

数据持久化

如需保留工具配置（如odo项目设置、oc命令历史），可挂载对应目录至主机：

docker run -it --rm \
  -v $HOME/.kube/config:/root/.kube/config \  # 集群配置持久化
  -v $HOME/.odo:/root/.odo \  # odo配置持久化
  -v $HOME/.oc:/root/.oc \  # oc命令历史持久化
  [镜像仓库地址]/openshift-cli-tools:latest \
  /bin/sh

部署方案示例

示例1：使用oc管理远程集群

执行集群资源查询命令：

docker run --rm \
  -v $HOME/.kube/config:/root/.kube/config \
  [镜像仓库地址]/openshift-cli-tools:latest \
  oc get deployment -n my-project  # 查看my-project命名空间下的Deployment

示例2：使用odo部署本地应用

挂载应用代码目录，通过odo构建并推送应用：

docker run -it --rm \
  -v $HOME/.kube/config:/root/.kube/config \  # 集群配置
  -v $(pwd):/app \  # 挂载本地应用代码（当前目录）
  [镜像仓库地址]/openshift-cli-tools:latest \
  /bin/sh

# 在容器内执行：初始化并部署Node.js应用
cd /app
odo init --name my-node-app --devfile nodejs  # 初始化Node.js应用（基于devfile）
odo push  # 构建并推送应用至OpenShift集群

示例3：docker-compose配置（简化版）

创建docker-compose.yml定义工具容器及挂载配置：

version: '3'
services:
  openshift-cli:
    image: [镜像仓库地址]/openshift-cli-tools:latest
    volumes:
      - $HOME/.kube/config:/root/.kube/config  # 集群配置
      - $HOME/.odo:/root/.odo  # odo配置持久化
      - ./app:/app  # 本地应用代码目录
    tty: true  # 保持终端交互

启动容器：

docker-compose up -d
docker-compose exec openshift-cli /bin/sh  # 进入容器终端

未来规划（待办事项）

• 多架构支持：扩展镜像支持arm64、amd64等多种硬件架构。
• 集成crc工具：评估GLib依赖优化方案，将crc集成至镜像，支持本地OpenShift集群运行。