CLI 参考

Windows 的 CLI 以 zip 存档形式提供，您 可以从红帽客户门户下载。使用您的红帽帐户登录后，您必须有一个活跃的 OpenShift Enterprise 订阅才能访问下载页面：

从红帽客户门户网站下载 CLI

另外，如果集群管理员启用了它，您可以在 web 控制台的 About 页面中下载并解压缩 CLI。

教程视频：

以下视频将引导您完成此过程： 单击此处观看

然后，使用 ZIP 程序解压存档，并将 oc 二进制文件移到 PATH 的目录中。要查看您的 PATH，请打开命令提示并运行：

C:\> path

Mac OS X 的 CLI 以 tar.gz 存档形式提供，您 可以从红帽客户门户下载。使用您的红帽帐户登录后，您必须有一个活跃的 OpenShift Enterprise 订阅才能访问下载页面：

从红帽客户门户网站下载 CLI

另外，如果集群管理员启用了它，您可以在 web 控制台的 About 页面中下载并解压缩 CLI。

教程视频：

以下视频将引导您完成此过程： 单击此处观看

然后，解包存档，并将 oc 二进制文件移到 PATH 的目录中。要查看您的 PATH，请打开终端窗口并运行：

$ echo $PATH

对于 Red Hat Enterprise Linux(RHEL)7，如果您的红帽帐户上已有有效的 OpenShift Enterprise 订阅，则可以使用 Red Hat Subscription Management(RHSM)安装 CLI：

对于 RHEL、Fedora 和其他 Linux 发行版本，您还可以直接从红帽客户门户网站下载 CLI 作为 tar.gz 存档。https://access.redhat.com/downloads/content/290使用您的红帽帐户登录后，您必须有一个有效的 OpenShift Enterprise 订阅才能访问下载页面。

从红帽客户门户网站下载 CLI

教程视频：

以下视频将引导您完成此过程： 单击此处观看

另外，如果集群管理员启用了它，您可以在 web 控制台的 About 页面中下载并解压缩 CLI。

然后，解包存档，并将 oc 二进制文件移到 PATH 的目录中。要查看路径，请运行：

$ echo $PATH

解包存档：

$ tar -xf <file>

oc: No such file or directory

显示一些 OpenShift Container Platform 核心概念的介绍：

$ oc types

登录到 OpenShift Container Platform 服务器：

$ oc login

结束当前会话：

$ oc logout

创建一个新项目

$ oc new-project <project_name>

根据当前目录中的源代码创建新应用： https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/developer_guide/#dev-guide-new-app

$ oc new-app .

根据远程存储库中的源代码创建新应用：

$ oc new-app https://github.com/sclorg/cakephp-ex

根据私有远程存储库中的源代码创建新应用：

$ oc new-app https://github.com/youruser/yourprivaterepo --source-secret=yoursecret

显示当前项目的概述：

$ oc status

切换到另一个项目。运行 （不带选项）以显示当前项目。要查看您有权运行 oc projects 的所有项目。

$ oc project <project_name>

返回 指定对象类型的 对象列表。如果请求中包含可选的 &lt ;object_name >，则会根据该值过滤结果列表。

$ oc get <object_type> [<object_name>]

例如，以下命令列出项目的可用镜像：

$ oc get images

sha256:f86e02fb8c740b4ed1f59300e94be69783ee51a38cc9ce6ddb73b6f817e173b3   registry.redhat.io/jboss-datagrid-6/datagrid65-openshift@sha256:f86e02fb8c740b4ed1f59300e94be69783ee51a38cc9ce6ddb73b6f817e173b3
sha256:f98f90938360ab1979f70195a9d518ae87b1089cd42ba5fc279d647b2cb0351b   registry.redhat.io/jboss-fuse-6/fis-karaf-openshift@sha256:f98f90938360ab1979f70195a9d518ae87b1089cd42ba5fc279d647b2cb0351b

您可以使用 -o 或 --output 选项修改输出格式。

$ oc get <object_type> [<object_name>]-o|--output=json|yaml|wide|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...]

输出格式可以是 JSON 或 YAML，也可以是 自定义列、golang 模板 和 jsonpath 等可扩展格式。

例如，以下命令列出了特定项目中运行的 pod 的名称：

$ oc get pods -n default -o jsonpath='{range .items[*].metadata}{"Pod Name: "}{.name}{"\n"}{end}'

Pod Name: docker-registry-1-wvhrx
Pod Name: registry-console-1-ntq65
Pod Name: router-1-xzw69

返回有关查询返回的特定对象的信息。必须提供特定的 <object_name >。可用的实际信息因 对象类型 所述而异。

$ oc describe <object_type> <object_name>

编辑所需的对象类型：

$ oc edit <object_type>/<object_name>

使用指定的文本编辑器编辑所需的对象类型：

$ OC_EDITOR="<text_editor>" oc edit <object_type>/<object_name>

以指定格式（如 JSON）编辑所需的对象：

$ oc edit <object_type>/<object_name> \
    --output-version=<object_type_version> \
    -o <object_type_format>

修改 卷 ：

$ oc set volume <object_type>/<object_name> [--option]

更新对象上的标签：

$ oc label <object_type> <object_name> <label>

查找服务并将其公开为路由。另外，也可以在指定端口上公开部署配置、复制控制器、服务或 pod 作为新服务。如果没有指定标签，新对象将重新使用其公开对象中的标签。

如果您要公开服务，则默认生成器是 --generator=route/v1。对于所有其他情况下，默认为 --generator=service/v2，这会留下端口未命名。通常，不需要使用 oc expose 命令设置生成器。第三个生成器 --generator=service/v1 提供了端口名称 default。

$ oc expose <object_type> <object_name>

删除指定的对象。对象配置也可通过 STDIN 传递到。oc delete all -l <label > 操作将删除与指定 & lt;label > 匹配的所有对象，包括 复制控制器，以便 pod 不会重新创建。

$ oc delete -f <file_path>

$ oc delete <object_type> <object_name>

$ oc delete <object_type> -l <label>

$ oc delete all -l <label>

修改指定对象的特定属性。

$ oc set env dc/mydc VAR1=value1

$ oc set build-secret --source bc/mybc mysecret

使用指定的构建配置文件手动启动构建流程：

$ oc start-build <buildconfig_name>

将上一构建的名称指定为起点，手动启动构建流程：

$ oc start-build --from-build=<build_name>

通过指定配置文件或上一个构建的名称并检索其构建日志来手动启动构建流程：

$ oc start-build --from-build=<build_name> --follow

$ oc start-build <buildconfig_name> --follow

如果构建失败，请等待构建完成，然后以非零返回代码退出：

$ oc start-build --from-build=<build_name> --wait

设置或覆盖当前构建的环境变量，而不更改构建配置。或者，使用 -e。

$ oc start-build --env <var_name>=<value>

在构建期间设置或覆盖默认构建日志级别输出：

$ oc start-build --build-loglevel [0-5]

指定构建应使用的源代码提交标识符 ; 需要基于 Git 存储库的构建：

$ oc start-build --commit=<hash>

使用名称 < build_name& gt; 重新运行构建：

$ oc start-build --from-build=<build_name>

归档 <dir_name > 并将其作为二进制输入进行构建：

$ oc start-build --from-dir=<dir_name>

使用现有存档作为二进制输入；与 --from-file 不同，构建过程前由构建器提取存档：

$ oc start-build --from-archive=<archive_name>

使用 <file_name > 作为构建的二进制输入。此文件必须是构建源中唯一一个。例如： pom.xml 或 Dockerfile。

$ oc start-build --from-file=<file_name>

使用 HTTP 或 HTTPS 下载二进制文件输入，而不是从文件系统中读取它：

$ oc start-build --from-file=<file_URL>

下载存档并使用其内容作为构建源：

$ oc start-build --from-archive=<archive_URL>

用作构建二进制输入的本地源代码存储库的路径：

$ oc start-build --from-repo=<path_to_repo>

为要触发的现有构建配置指定 Webhook URL：

$ oc start-build --from-webhook=<webhook_URL>

触发构建的 post-receive hook 的内容：

$ oc start-build --git-post-receive=<contents>

post-receive 的 Git 存储库的路径；默认为当前目录：

$ oc start-build --git-repository=<path_to_repo>

列出指定构建配置或构建的 webhook； 接受所有、通用 或 github ：

$ oc start-build --list-webhooks

覆盖 source-strategy 构建的 Spec.Strategy.SourceStrategy.Incremental 选项：

$ oc start-build --incremental

覆盖 docker-strategy 构建的 Spec.Strategy.DockerStrategy.NoCache 选项：

$oc start-build --no-cache

执行 回滚 ：

$ oc rollback <deployment_name>

根据当前 Git 存储库中的源代码（具有公共远程）和容器镜像创建构建配置：

$ oc new-build .

基于远程 git 存储库创建构建配置：

$ oc new-build https://github.com/sclorg/cakephp-ex

基于私有远程 git 存储库创建构建配置：

$ oc new-build https://github.com/youruser/yourprivaterepo --source-secret=yoursecret

停止正在进行中的构建：

$ oc cancel-build <build_name>

同时取消多个构建：

$ oc cancel-build <build1_name> <build2_name> <build3_name>

取消从构建配置创建的所有构建：

$ oc cancel-build bc/<buildconfig_name>

指定要取消的构建：

$ oc cancel-build bc/<buildconfig_name> --state=<state>

状态的示例值为 new 或 pending。

从外部镜像存储库导入标签和镜像信息：

$ oc import-image <image_stream>

将 复制控制器或部署配置 所需的副本数设置为指定副本数：

$ oc scale <object_type> <object_name> --replicas=<#_of_replicas>

从镜像流或容器镜像"pull spec"中提取现有标签或镜像，并将其设置为一个或多个镜像流中标签的最新镜像：

$ oc tag <current_image> <image_stream>

解析配置文件，并根据文件内容创建一个或多个 OpenShift Container Platform 对象。f 标志 可多次传递，不同的文件或目录路径。当多次传递该标志时，oc create 会逐一迭代，创建所有指定文件中描述的对象。任何现有的资源将被忽略。

$ oc create -f <file_or_dir_path>

尝试根据指定配置文件的内容修改现有对象。f 标志 可多次传递，不同的文件或目录路径。当多次传递该标志时，oc replace 会逐一迭代，更新所有指定文件中描述的对象。

$ oc replace -f <file_or_dir_path>

将 项目模板 转换为项目配置文件：

$ oc process -f <template_file_path>

创建并运行特定的镜像（可能复制）。默认情况下，创建部署配置以管理所创建的容器。您可以选择使用 --generator 标志创建不同的资源：

您可以选择在前台运行，以进行交互式容器执行。

$ oc run NAME --image=<image> \
    [--generator=<resource>] \
    [--port=<port>] \
    [--replicas=<replicas>] \
    [--dry-run=<bool>] \
    [--overrides=<inline_json>] \
    [options]

使用策略合并补丁更新对象的一个或多个字段：

$ oc patch <object_type> <object_name> -p <changes>

<changes> 是一个 JSON 或 YAML 表达式，其中包含新字段和值。例如，要将节点 node1 的 spec.unschedulable 字段更新为值 true，json 表达式为：

$ oc patch node node1 -p '{"spec":{"unschedulable":true}}'

管理授权策略：

$ oc policy [--options]

配置 secret ：

$ oc secrets [--options] path/to/ssh_key

为您的应用程序设置 自动扩展器。需要在集群中启用指标。如果需要，请参阅为集群管理员说明 启用集群指标。

$ oc autoscale dc/<dc_name> [--options]

启动一个 shell 以调试正在运行的应用程序。

$ oc debug -h

调试镜像并设置问题时，您可以获取正在运行的 pod 配置的确切副本，并使用 shell 进行故障排除。因为一个失败的 pod 可能无法启动且无法被 rsh 或 exec 访问，运行 debug 命令会创建那个设置的 carbon 副本。

默认模式是在引用的 pod、复制控制器或部署配置的第一个容器内启动 shell。启动的 pod 将是源 pod 的副本，其标签会剥离，命令的变为 /bin/sh，并且禁用就绪度和存活度检查。如果您只想运行命令，请添加 -- 和要运行的命令。默认情况下，传递命令将不会创建 TTY 或发送 STDIN。其他标记支持以常见方式更改容器或 pod。

运行容器的常见问题是一个安全策略，它会阻止您在集群中以 root 用户身份运行。您可以使用此命令测试以非 root 运行 pod（使用 --as-user）或以 root 身份运行非 root pod（使用 --as-root）。

当远程命令完成或中断 shell 时，调试 pod 将被删除。

$ oc debug RESOURCE/NAME [ENV1=VAL1 ...] [-c CONTAINER] [options] [-- COMMAND]

$ oc debug dc/test

$ oc debug dc/test --as-user=1000000

$ oc debug dc/test -c second -- /bin/env

$ oc debug dc/test -o yaml

检索特定构建、部署或 Pod 的日志输出。此命令适用于构建、构建配置、部署配置和容器集。

$ oc logs -f <pod> -c <container_name>

在已在运行的容器中执行命令。您可以选择指定容器 ID，否则默认为第一个容器。

$ oc exec <pod> [-c <container>] <command>

打开到容器的远程 shell 会话：

$ oc rsh <pod>

将内容复制到已在运行的 pod 容器中的某一目录，或从中复制内容。如果没有指定容器，则默认为 pod 中的第一个容器。

将本地目录中的内容复制到 pod 中的目录中：

$ oc rsync <local_dir> <pod>:<pod_dir> -c <container>

将 pod 中某一目录的内容复制到本地目录：

$ oc rsync <pod>:<pod_dir> <local_dir> -c <container>

将一个或多个本地端口转发到一个 pod:

$ oc port-forward <pod> <local_port>:<remote_port>

运行到 Kubernetes API 服务器的代理：

$ oc proxy --port=<port> --www=<static_directory>

创建一个新项目

$ oc adm new-project <project_name>

管理授权策略：

$ oc adm policy

管理组：

$ oc adm groups

安装路由器：

$ oc adm router <router_name>

为一组节点安装 IP 故障转移组：

$ oc adm ipfailover <ipfailover_config>

安装集成的容器镜像 registry：

$ oc adm registry

输出构建的输入和依赖项：

$ oc adm build-chain <image_stream>[:<tag>]

管理节点。例如，列出或撤离 pod，或者标记它们就绪：

$ oc adm manage-node

从服务器中删除旧版本的资源：

$ oc adm prune

更改 kubelet 配置文件：

$ oc adm config <subcommand>

从客户端证书创建基本 .kubeconfig 文件：

$ oc adm create-kubeconfig

创建用于以用户连接到服务器的配置文件：

$ oc adm create-api-client-config

创建 bootstrap 项目模板：

$ oc adm create-bootstrap-project-template

创建默认 bootstrap 策略：

$ oc adm create-bootstrap-policy-file

创建登录模板：

$ oc adm create-login-template

为节点创建配置捆绑包：

$ oc adm create-node-config

管理证书和密钥：

$ oc adm ca

插件加载程序负责 搜索插件文件，并检查插件是否提供运行所需的最小信息。放置在正确位置的文件不提供最小信息（例如，不完整的 plugin.yaml 描述符）。

描述符文件支持以下属性：

name: "great-plugin"              # REQUIRED: the plug-in command name, to be invoked under 'kubectl'
shortDesc: "great-plugin plug-in" # REQUIRED: the command short description, for help
longDesc: ""                      # the command long description, for help
example: ""                       # command example(s), for help
command: "./example"              # REQUIRED: the command, binary, or script to invoke when running the plug-in
flags:                            # flags supported by the plug-in
  - name: "flag-name"             # REQUIRED for each flag: flag name
    shorthand: "f"                # short version of the flag name
    desc: "example flag"          # REQUIRED for each flag: flag description
    defValue: "extreme"           # default value of the flag
tree:                             # allows the declaration of subcommands
  - ...                           # subcommands support the same set of attributes

上述描述符声明了 great-plugin 插件，它具有一个名为 -f | --flag-name 的标签。它可以通过以下命令调用：

$ oc plugin great-plugin -f value

调用插件时，它将调用 示例二进制文件或 脚本，该二进制文件位于与描述符文件相同的目录中，传递多个参数和环境变量。Accessing Runtime Attributes 部分论述了 示例 命令如何访问标志值和其他运行时上下文。

建议每个插件在文件系统中都有自己的子目录，最好与插件命令的名称相同。目录必须包含 plugin.yaml 描述符以及它可能需要的任何二进制、脚本、资产或其他依赖项。

例如，great-plugin 插件的目录结构可能类似如下：

~/.kube/plugins/
└── great-plugin
    ├── plugin.yaml
    └── example

在大多数用例中，您写入的二进制文件或脚本文件必须有权访问插件框架提供的一些上下文信息。例如，如果您在描述符文件中声明了标记，则插件必须在运行时能够访问用户提供的标志值。

全局标志也是如此。插件框架负责执行此操作，因此插件作者不需要担心解析参数。这也确保插件和常规 oc 命令之间的最佳一致性水平。

插件可以通过环境变量访问运行时上下文属性。例如，若要访问通过标志提供的值，例如，使用针对二进制或脚本的适当函数调用查找正确的环境变量值。

支持的环境变量有：