CLI 工具
如何使用 OpenShift Container Platform 的命令行工具
摘要
第 1 章 OpenShift Container Platform CLI 工具概述 复制链接链接已复制到粘贴板!
用户在操作 OpenShift Container Platform 时执行一系列操作,例如:
- 管理集群
- 构建、部署和管理应用程序
- 管理部署过程
- 开发 Operator
- 创建和维护 Operator 目录
OpenShift Container Platform 提供了一组命令行界面 (CLI) 工具,通过允许用户从终端执行各种管理和开发操作来简化这些任务。这些工具提供简单的命令来管理应用,并与系统的每个组件交互。
1.1. CLI 工具列表 复制链接链接已复制到粘贴板!
OpenShift Container Platform 中提供了以下一组 CLI 工具:
-
OpenShift CLI (
oc
) :这是 OpenShift Container Platform 用户最常用的 CLI 工具。它帮助集群管理员和开发人员使用终端在 OpenShift Container Platform 间执行端到端操作。与 Web 控制台不同,它允许用户使用命令脚本直接处理项目源代码。 -
Knative CLI(kn) :Knative (
kn
) CLI 工具提供简单直观的终端命令,可用于与 OpenShift Serverless 组件(如 Knative Serving 和 Eventing)交互。 -
Pipelines CLI(tkn) :OpenShift Pipelines 是 OpenShift Container Platform 中的持续集成和持续交付 (CI/CD) 解决方案,内部使用 Tekton。
tkn
CLI 工具提供简单直观的命令,以便使用终端与 OpenShift Pipelines 进行交互。 -
opm CLI :
opm
CLI 工具可帮助 Operator 开发人员和集群管理员从终端创建和维护 Operator 目录。 - Operator SDK :Operator SDK 是 Operator Framework 的一个组件,它提供了一个 CLI 工具,可供 Operator 开发人员用于从终端构建、测试和部署 Operator。它简化了 Kubernetes 原生应用程序的构建流程,这些应用程序需要深入掌握特定于应用程序的操作知识。
第 2 章 OpenShift CLI (oc) 复制链接链接已复制到粘贴板!
2.1. OpenShift CLI 入门 复制链接链接已复制到粘贴板!
2.1.1. 关于 OpenShift CLI 复制链接链接已复制到粘贴板!
借助 OpenShift CLI(oc
),您可以从终端创建应用程序并管理 OpenShift Container Platform 项目。OpenShift CLI 在以下情况下是理想的选择:
- 直接使用项目源代码
- 编写 OpenShift Container Platform 操作脚本
- 在管理项目时,受带宽资源的限制,Web 控制台无法使用
2.1.2. 安装 OpenShift CLI 复制链接链接已复制到粘贴板!
您可以通过下载二进制文件或使用 RPM 来安装 OpenShift CLI(oc
)。
2.1.2.1. 安装 OpenShift CLI 复制链接链接已复制到粘贴板!
您可以安装 OpenShift CLI(oc
)来使用命令行界面与 OpenShift Container Platform 进行交互。您可以在 Linux、Windows 或 macOS 上安装 oc
。
如果安装了旧版本的 oc
,则可能无法使用 OpenShift Container Platform 4.16 中的所有命令。下载并安装新版本的 oc
。
在 Linux 上安装 OpenShift CLI
您可以按照以下流程在 Linux 上安装 OpenShift CLI(oc
)二进制文件。
流程
- 导航到红帽客户门户网站上的 OpenShift Container Platform 下载页面。
- 从 产品变体 下拉列表中选择架构。
- 从 版本 下拉列表中选择适当的版本。
- 点 OpenShift v4.16 Linux Clients 条目旁的 Download Now 来保存文件。
解包存档:
tar xvf <file>
$ tar xvf <file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将
oc
二进制文件放到PATH 中的目录中
。要查看您的
PATH
,请执行以下命令:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
安装 OpenShift CLI 后,可以使用
oc
命令:oc <command>
$ oc <command>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
在 Windows 上安装 OpenShift CLI
您可以按照以下流程在 Windows 上安装 OpenShift CLI(oc
)二进制文件。
流程
- 导航到红帽客户门户网站上的 OpenShift Container Platform 下载页面。
- 从 版本 下拉列表中选择适当的版本。
- 点 OpenShift v4.16 Windows Client 条目旁的 Download Now 来保存文件。
- 使用 ZIP 程序解压存档。
将
oc
二进制文件移到PATH 中的目录中
。要查看您的
PATH
,请打开命令提示并执行以下命令:path
C:\> path
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
安装 OpenShift CLI 后,可以使用
oc
命令:oc <command>
C:\> oc <command>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
在 macOS 上安装 OpenShift CLI
您可以按照以下流程在 macOS 上安装 OpenShift CLI(oc
)二进制文件。
流程
- 导航到红帽客户门户网站上的 OpenShift Container Platform 下载页面。
- 从 版本 下拉列表中选择适当的版本。
点 OpenShift v4.16 macOS Clients 条目旁的 Download Now 来保存文件。
注意对于 macOS arm64,请选择 OpenShift v4.16 macOS arm64 Client 条目。
- 解包和解压存档。
将
oc
二进制文件移到 PATH 的目录中。要查看您的
PATH
,请打开终端并执行以下命令:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
使用
oc
命令验证安装:oc <command>
$ oc <command>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.1.2.2. 使用 Web 控制台安装 OpenShift CLI 复制链接链接已复制到粘贴板!
您可以安装 OpenShift CLI(oc
)来通过 Web 控制台与 OpenShift Container Platform 进行交互。您可以在 Linux、Windows 或 macOS 上安装 oc
。
如果安装了旧版本的 oc
,则可能无法使用 OpenShift Container Platform 4.16 中的所有命令。下载并安装新版本的 oc
。
2.1.2.2.1. 使用 Web 控制台在 Linux 上安装 OpenShift CLI 复制链接链接已复制到粘贴板!
您可以按照以下流程在 Linux 上安装 OpenShift CLI(oc
)二进制文件。
流程
从 Web 控制台,单击 ?。
单击 Command Line Tools。
-
为您的 Linux 平台选择适当的
oc
二进制文件,然后点 Download oc for Linux。 - 保存该文件。
解包存档。
tar xvf <file>
$ tar xvf <file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将
oc
二进制文件移到PATH 中的目录中
。要查看您的
PATH
,请执行以下命令:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
安装 OpenShift CLI 后,可以使用 oc
命令:
oc <command>
$ oc <command>
2.1.2.2.2. 使用 Web 控制台在 Windows 上安装 OpenShift CLI 复制链接链接已复制到粘贴板!
您可以按照以下流程在 Windows 上安装 OpenShift CLI(oc
)二进制文件。
流程
从 Web 控制台,单击 ?。
单击 Command Line Tools。
-
为 Windows 平台选择
oc
二进制文件,然后单击 Download oc for Windows for x86_64。 - 保存该文件。
- 使用 ZIP 程序解压存档。
将
oc
二进制文件移到PATH 中的目录中
。要查看您的
PATH
,请打开命令提示并执行以下命令:path
C:\> path
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
安装 OpenShift CLI 后,可以使用 oc
命令:
oc <command>
C:\> oc <command>
2.1.2.2.3. 使用 Web 控制台在 macOS 上安装 OpenShift CLI 复制链接链接已复制到粘贴板!
您可以按照以下流程在 macOS 上安装 OpenShift CLI(oc
)二进制文件。
流程
从 Web 控制台,单击 ?。
单击 Command Line Tools。
为 macOS 平台选择
oc
二进制文件,然后单击 Download oc for Mac for x86_64。注意对于 macOS arm64,点 Download oc for ARM 64。
- 保存该文件。
- 解包和解压存档。
将
oc
二进制文件移到 PATH 的目录中。要查看您的
PATH
,请打开终端并执行以下命令:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
安装 OpenShift CLI 后,可以使用 oc
命令:
oc <command>
$ oc <command>
2.1.2.3. 使用 RPM 安装 OpenShift CLI 复制链接链接已复制到粘贴板!
对于 Red Hat Enterprise Linux (RHEL),如果您的红帽帐户中包括有效的 OpenShift Container Platform 订阅,则可将通过 RPM 安装 OpenShift CLI (oc
)。
您需要下载二进制文件,为 RHEL 9 安装 oc
。Red Hat Enterprise Linux (RHEL) 9 不支持使用 RPM 软件包安装 oc
。
先决条件
- 必须具有 root 或 sudo 权限。
流程
使用 Red Hat Subscription Manager 注册:
subscription-manager register
# subscription-manager register
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 获取最新的订阅数据:
subscription-manager refresh
# subscription-manager refresh
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 列出可用的订阅:
subscription-manager list --available --matches '*OpenShift*'
# subscription-manager list --available --matches '*OpenShift*'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 在上一命令的输出中,找到 OpenShift Container Platform 订阅的池 ID,并把订阅附加到注册的系统:
subscription-manager attach --pool=<pool_id>
# subscription-manager attach --pool=<pool_id>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 启用 OpenShift Container Platform 4.16 所需的存储库:
subscription-manager repos --enable="rhocp-4.16-for-rhel-8-x86_64-rpms"
# subscription-manager repos --enable="rhocp-4.16-for-rhel-8-x86_64-rpms"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 安装
openshift-clients
软件包:yum install openshift-clients
# yum install openshift-clients
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
-
使用
oc
命令验证安装:
oc <command>
$ oc <command>
2.1.2.4. 使用 Homebrew 安装 OpenShift CLI 复制链接链接已复制到粘贴板!
对于 macOS,您可以使用 Homebrew 软件包管理器安装 OpenShift CLI(oc
)。
先决条件
-
已安装 Homebrew(
brew
)。
流程
运行以下命令来安装 openshift-cli 软件包:
brew install openshift-cli
$ brew install openshift-cli
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
-
使用
oc
命令验证安装:
oc <command>
$ oc <command>
2.1.3. 登录到 OpenShift CLI 复制链接链接已复制到粘贴板!
您可以登录到 OpenShift CLI(oc
)以访问和管理集群。
先决条件
- 有访问 OpenShift Container Platform 集群的权限。
-
已安装 OpenShift CLI (
oc
)。
要访问只能通过 HTTP 代理服务器访问的集群,可以设置 HTTP_PROXY
、HTTPS_PROXY
和 NO_PROXY
变量。oc
CLI 会使用这些环境变量以便所有与集群的通信都通过 HTTP 代理进行。
只有在使用 HTTPS 传输时,才会发送身份验证标头。
流程
输入
oc login
命令并传递用户名:oc login -u user1
$ oc login -u user1
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 提示时,请输入所需信息:
输出示例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
如果登录到 web 控制台,您可以生成包含令牌和服务器信息的 oc login
命令。您可以使用命令来登录 OpenShift Container Platform CLI,而无需交互式的提示。要生成 命令,请从 web 控制台右上角的用户名下拉菜单中选择 Copy login command。
您现在可以创建项目或执行其他命令来管理集群。
2.1.4. 使用 Web 浏览器登录 OpenShift CLI 复制链接链接已复制到粘贴板!
您可以使用 Web 浏览器访问和管理集群来登录 OpenShift CLI (oc
)。这可以使用户避免将其访问令牌插入到命令行中。
通过 Web 浏览器登录 CLI,在 localhost 上使用 HTTP (而非 HTTPS)运行服务器;在多用户工作站中请谨慎使用。
先决条件
- 有访问 OpenShift Container Platform 集群的权限。
-
已安装 OpenShift CLI(
oc
)。 - 已安装浏览器。
流程
输入
oc login
命令,使用--web
标志:oc login <cluster_url> --web
$ oc login <cluster_url> --web
1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 另外,您可以指定服务器 URL 和回调端口。例如,
oc login <cluster_url> --web --callback-port 8280 localhost:8443
。
Web 浏览器会自动打开。如果没有,请点命令输出中的链接。如果没有指定 OpenShift Container Platform 服务器
oc
会尝试打开当前oc
配置文件中指定的集群的 Web 控制台。如果没有oc
配置,oc
会以交互方式提示输入服务器 URL。输出示例
Opening login URL in the default browser: https://openshift.example.com Opening in existing browser session.
Opening login URL in the default browser: https://openshift.example.com Opening in existing browser session.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 如果有多个身份提供程序可用,请从提供的选项中选择您的选择。
-
在对应的浏览器字段中输入您的用户名和密码。登录后,浏览器会显示
access token received successfully; please return to your terminal
。 检查 CLI 是否有登录确认。
输出示例
Login successful. You don't have any projects. You can try to create a new project, by running oc new-project <projectname>
Login successful. You don't have any projects. You can try to create a new project, by running oc new-project <projectname>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Web 控制台默认为前面会话中使用的配置集。要在 Administrator 和 Developer 配置集间切换,请从 OpenShift Container Platform Web 控制台注销并清除缓存。
您现在可以创建项目或执行其他命令来管理集群。
2.1.5. 使用 OpenShift CLI 复制链接链接已复制到粘贴板!
参阅以下部分以了解如何使用 CLI 完成常见任务。
2.1.5.1. 创建一个项目 复制链接链接已复制到粘贴板!
使用oc new-project
命令创建新项目。
oc new-project my-project
$ oc new-project my-project
输出示例
Now using project "my-project" on server "https://openshift.example.com:6443".
Now using project "my-project" on server "https://openshift.example.com:6443".
2.1.5.2. 创建一个新的应用程序 复制链接链接已复制到粘贴板!
使用oc new-app
命令创建新应用程序。
oc new-app https://github.com/sclorg/cakephp-ex
$ oc new-app https://github.com/sclorg/cakephp-ex
输出示例
--> Found image 40de956 (9 days old) in imagestream "openshift/php" under tag "7.2" for "php" ... Run 'oc status' to view your app.
--> Found image 40de956 (9 days old) in imagestream "openshift/php" under tag "7.2" for "php"
...
Run 'oc status' to view your app.
2.1.5.3. 查看 pod 复制链接链接已复制到粘贴板!
使用oc get pods
命令查看当前项目的 pod。
当您在 pod 中运行 oc
且没有指定命名空间时,默认使用 pod 的命名空间。
oc get pods -o wide
$ oc get pods -o wide
输出示例
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE cakephp-ex-1-build 0/1 Completed 0 5m45s 10.131.0.10 ip-10-0-141-74.ec2.internal <none> cakephp-ex-1-deploy 0/1 Completed 0 3m44s 10.129.2.9 ip-10-0-147-65.ec2.internal <none> cakephp-ex-1-ktz97 1/1 Running 0 3m33s 10.128.2.11 ip-10-0-168-105.ec2.internal <none>
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE
cakephp-ex-1-build 0/1 Completed 0 5m45s 10.131.0.10 ip-10-0-141-74.ec2.internal <none>
cakephp-ex-1-deploy 0/1 Completed 0 3m44s 10.129.2.9 ip-10-0-147-65.ec2.internal <none>
cakephp-ex-1-ktz97 1/1 Running 0 3m33s 10.128.2.11 ip-10-0-168-105.ec2.internal <none>
2.1.5.4. 查看 pod 日志 复制链接链接已复制到粘贴板!
使用oc logs
命令查看特定 pod 的日志。
oc logs cakephp-ex-1-deploy
$ oc logs cakephp-ex-1-deploy
输出示例
--> Scaling cakephp-ex-1 to 1 --> Success
--> Scaling cakephp-ex-1 to 1
--> Success
2.1.5.5. 查看当前项目 复制链接链接已复制到粘贴板!
使用oc project
命令查看当前项目。
oc project
$ oc project
输出示例
Using project "my-project" on server "https://openshift.example.com:6443".
Using project "my-project" on server "https://openshift.example.com:6443".
2.1.5.6. 查看当前项目的状态 复制链接链接已复制到粘贴板!
使用 oc status
命令查看有关当前项目的信息,如服务、部署和构建配置。
oc status
$ oc status
输出示例
2.1.5.7. 列出支持的 API 资源 复制链接链接已复制到粘贴板!
使用oc api-resources
命令查看服务器上支持的 API 资源列表。
oc api-resources
$ oc api-resources
输出示例
NAME SHORTNAMES APIGROUP NAMESPACED KIND bindings true Binding componentstatuses cs false ComponentStatus configmaps cm true ConfigMap ...
NAME SHORTNAMES APIGROUP NAMESPACED KIND
bindings true Binding
componentstatuses cs false ComponentStatus
configmaps cm true ConfigMap
...
2.1.6. 获得帮助 复制链接链接已复制到粘贴板!
您可以使用以下方法获取 CLI 命令和 OpenShift Container Platform 资源的帮助信息:
使用
oc help
获取所有可用 CLI 命令的列表和描述:示例:获取 CLI 的常规帮助信息
oc help
$ oc help
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输出示例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 使用
--help
标志获取有关特定CLI命令的帮助信息:示例:获取
oc create
命令的帮助信息oc create --help
$ oc create --help
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输出示例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 使用
oc explain
命令查看特定资源的描述信息和项信息:示例:查看
Pod
资源的文档oc explain pods
$ oc explain pods
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输出示例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.1.7. 注销 OpenShift CLI 复制链接链接已复制到粘贴板!
您可以注销 OpenShift CLI 以结束当前会话。
使用
oc logout
命令。oc logout
$ oc logout
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输出示例
Logged "user1" out on "https://openshift.example.com"
Logged "user1" out on "https://openshift.example.com"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
这将从服务器中删除已保存的身份验证令牌,并将其从配置文件中删除。
2.2. 配置 OpenShift CLI 复制链接链接已复制到粘贴板!
2.2.1. 启用 tab 自动完成功能 复制链接链接已复制到粘贴板!
您可以为 Bash 或 Zsh shell 启用 tab 自动完成功能。
2.2.1.1. 为 Bash 启用 tab 自动完成 复制链接链接已复制到粘贴板!
安装 OpenShift CLI (oc
)后,您可以启用 tab 自动完成功能,以便在按 Tab 键时自动完成 oc
命令或建议选项。以下流程为 Bash shell 启用 tab 自动完成功能。
先决条件
-
已安装 OpenShift CLI (
oc
)。 -
已安装软件包
bash-completion
。
流程
将 Bash 完成代码保存到一个文件中:
oc completion bash > oc_bash_completion
$ oc completion bash > oc_bash_completion
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将文件复制到
/etc/bash_completion.d/
:sudo cp oc_bash_completion /etc/bash_completion.d/
$ sudo cp oc_bash_completion /etc/bash_completion.d/
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 您也可以将文件保存到一个本地目录,并从您的
.bashrc
文件中 source 这个文件。
开新终端时 tab 自动完成功能将被启用。
2.2.1.2. 为 Zsh 启用 tab 自动完成功能 复制链接链接已复制到粘贴板!
安装 OpenShift CLI (oc
)后,您可以启用 tab 自动完成功能,以便在按 Tab 键时自动完成 oc
命令或建议选项。以下流程为 Zsh shell 启用 tab 自动完成功能。
先决条件
-
已安装 OpenShift CLI (
oc
)。
流程
要在
.zshrc
文件中为oc
添加 tab 自动完成功能,请运行以下命令:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
开新终端时 tab 自动完成功能将被启用。
2.3. oc 和 kubectl 命令的使用方法 复制链接链接已复制到粘贴板!
Kubernetes 命令行界面(CLI)kubectl
可以用来对 Kubernetes 集群运行命令。由于 OpenShift Container Platform 是经过认证的 Kubernetes 发行版本,因此您可以使用 OpenShift Container Platform 附带的受支持的 kubectl
二进制文件,或者使用 oc
二进制文件来获得扩展的功能。
2.3.1. oc 二进制文件 复制链接链接已复制到粘贴板!
oc
二进制文件提供与 kubectl
二进制文件相同的功能,但它经过扩展,可原生支持额外的 OpenShift Container Platform 功能,包括:
对 OpenShift Container Platform 资源的完整支持
DeploymentConfig
、BuildConfig
、Route
、ImageStream
和ImageStreamTag
对象等资源特定于 OpenShift Container Platform 发行版本,并基于标准 Kubernetes 原语构建。身份验证
oc
二进制文件提供了一个用于身份验证的内置login
命令,并可让您使用项目,将 Kubernetes 命名空间映射到经过身份验证的用户。如需更多信息,请阅读了解身份验证。附加命令
例如,借助附加命令
oc new-app
可以更轻松地使用现有源代码或预构建镜像来启动新的应用程序。同样,附加命令oc new-project
让您可以更轻松地启动一个项目并切换到该项目作为您的默认项目。
如果安装了旧版本的 oc
二进制文件,则无法使用 OpenShift Container Platform 4.16 中的所有命令。如果要使用最新的功能,您必须下载并安装与 OpenShift Container Platform 服务器版本对应的 oc
二进制文件的最新版本。
非安全 API 更改至少涉及两个次发行版本(例如,4.1 到 4.2 到 4.3)来更新旧的 oc
二进制文件。使用新功能可能需要较新的 oc
二进制文件。一个 4.3 服务器可能会带有版本 4.2 oc
二进制文件无法使用的功能,而一个 4.3 oc
二进制文件可能会带有 4.2 服务器不支持的功能。
X.Y ( |
X.Y+N footnote:versionpolicyn[其中 N 是一个大于或等于 1 的数字] ( | |
X.Y (Server) |
|
|
X.Y+N footnote:versionpolicyn[] (Server) |
|
|
完全兼容。
oc
客户端可能无法访问服务器的功能。
oc
客户端可能会提供与要访问的服务器不兼任的选项和功能。
2.3.2. kubectl 二进制文件 复制链接链接已复制到粘贴板!
提供 kubectl
二进制文件的目的是为来自标准 Kubernetes 环境的新 OpenShift Container Platform 用户或者希望使用 kubectl
CLI 的用户支持现有工作流和脚本。kubectl
的现有用户可以继续使用二进制文件与 Kubernetes 原语交互,而不需要对 OpenShift Container Platform 集群进行任何更改。
您可以按照安装 OpenShift CLI 的步骤安装受支持的 kubectl
二进制文件。如果您下载二进制文件,或者在使用 RPM 安装 CLI 时安装,则 kubectl
二进制文件会包括在存档中。
如需更多信息,请参阅 kubectl 文档。
2.4. 管理 CLI 配置集 复制链接链接已复制到粘贴板!
CLI 配置文件允许您配置不同的配置文件或上下文,以用于 CLI 工具概述。上下文由与 nickname 关联的用户身份验证 OpenShift Container Platform 服务器信息组成。
2.4.1. 关于 CLI 配置集间的切换 复制链接链接已复制到粘贴板!
通过上下文,您可以在多个 OpenShift Container Platform 服务器或使用 CLI 操作时轻松地切换多个用户。nicknames 通过提供对上下文、用户凭证和集群详情的简短参考来更轻松地管理 CLI 配置。在用户第一次使用 oc
CLI 登录后,OpenShift Container Platform 会创建一个 ~/.kube/config
文件(如果尚不存在)。随着更多身份验证和连接详情被提供给 CLI,可以在 oc login
操作或手动配置 CLI 配置集过程中自动提供,更新的信息会存储在配置文件中:
CLI 配置文件
- 1
clusters
部分定义 OpenShift Container Platform 集群的连接详情,包括其 master 服务器的地址。在本例中,一个集群的别名为openshift1.example.com:8443
,另一个别名是openshift2.example.com:8443
。- 2
- 这个
contexts
项定义了两个上下文:一个别名是alice-project/openshift1.example.com:8443/alice
,使用alice-project
项目,openshift1.example.com:8443
集群以及alice
用户,另外一个别名是joe-project/openshift1.example.com:8443/alice
,使用joe-project
项目,openshift1.example.com:8443
集群以及alice
用户。 - 3
current-context
参数显示joe-project/openshift1.example.com:8443/alice
上下文当前正在使用中,允许alice
用户在openshift1.example.com:8443
集群上的joe-project
项目中工作。- 4
users
部分定义用户凭据。在本例中,用户别名alice/openshift1.example.com:8443
使用访问令牌。
CLI 可以支持多个在运行时加载的配置文件,并合并在一起,以及从命令行指定的覆盖选项。登录后,您可以使用 oc status
或 oc project
命令验证您当前的环境:
验证当前工作环境
oc status
$ oc status
输出示例
列出当前项目
oc project
$ oc project
输出示例
Using project "joe-project" from context named "joe-project/openshift1.example.com:8443/alice" on server "https://openshift1.example.com:8443".
Using project "joe-project" from context named "joe-project/openshift1.example.com:8443/alice" on server "https://openshift1.example.com:8443".
您可以再次运行 oc login
命令,并在互动过程中提供所需的信息,使用用户凭证和集群详情的任何其他组合登录。基于提供的信息构建上下文(如果尚不存在)。如果您已经登录,并希望切换到当前用户已有权访问的另一个项目,请使用 oc project
命令并输入项目名称:
oc project alice-project
$ oc project alice-project
输出示例
Now using project "alice-project" on server "https://openshift1.example.com:8443".
Now using project "alice-project" on server "https://openshift1.example.com:8443".
在任何时候,您可以使用 oc config view
命令查看当前的 CLI 配置,如输出中所示。其他 CLI 配置命令也可用于更高级的用法。
如果您可以访问管理员凭证,但不再作为默认系统用户 system:admin
登录,只要仍存在于 CLI 配置文件中,您可以随时以这个用户身份登录。以下命令登录并切换到默认项目:
oc login -u system:admin -n default
$ oc login -u system:admin -n default
2.4.2. 手动配置 CLI 配置集 复制链接链接已复制到粘贴板!
本节介绍 CLI 配置的更多高级用法。在大多数情况下,您可以使用 oc login
和 oc project
命令登录并在上下文和项目间切换。
如果要手动配置 CLI 配置文件,您可以使用 oc config
命令,而不是直接修改这些文件。oc config
命令包括很多有用的子命令来实现这一目的:
子命令 | 使用方法 |
---|---|
| 在 CLI 配置文件中设置集群条目。如果引用的 cluster nickname 已存在,则指定的信息将合并到其中。 oc config set-cluster <cluster_nickname> [--server=<master_ip_or_fqdn>]
|
| 在 CLI 配置文件中设置上下文条目。如果引用的上下文 nickname 已存在,则指定的信息将合并在. oc config set-context <context_nickname> [--cluster=<cluster_nickname>]
|
| 使用指定上下文 nickname 设置当前上下文。 oc config use-context <context_nickname>
|
| 在 CLI 配置文件中设置单个值。 oc config set <property_name> <property_value>
|
| 在 CLI 配置文件中取消设置单个值。 oc config unset <property_name>
|
| 显示当前正在使用的合并 CLI 配置。 oc config view
显示指定 CLI 配置文件的结果。 oc config view --config=<specific_filename>
|
用法示例
-
以使用访问令牌的用户身份登录。
alice
用户使用此令牌:
oc login https://openshift1.example.com --token=ns7yVhuRNpDM9cgzfhhxQ7bM5s7N2ZVrkZepSRf4LC0
$ oc login https://openshift1.example.com --token=ns7yVhuRNpDM9cgzfhhxQ7bM5s7N2ZVrkZepSRf4LC0
- 查看自动创建的集群条目:
oc config view
$ oc config view
输出示例
- 更新当前上下文以便用户登录到所需的命名空间:
oc config set-context `oc config current-context` --namespace=<project_name>
$ oc config set-context `oc config current-context` --namespace=<project_name>
- 检查当前上下文,确认是否实施了更改:
oc whoami -c
$ oc whoami -c
所有后续 CLI 操作都使用新的上下文,除非通过覆盖 CLI 选项或直至上下文切换为止。
2.4.3. 载入和合并规则 复制链接链接已复制到粘贴板!
您可以在为 CLI 配置发出加载和合并顺序的 CLI 操作时遵循这些规则:
使用以下层次结构和合并规则从工作站检索 CLI 配置文件:
-
如果设置了
--config
选项,则只加载该文件。标志会被设置一次,且不会发生合并。 -
如果设置了
$KUBECONFIG
环境变量,则会使用它。变量可以是路径列表,如果将路径合并在一起。修改值后,会在定义该节的文件中对其进行修改。创建值时,会在存在的第一个文件中创建它。如果链中不存在任何文件,则会在列表中创建最后一个文件。 -
否则,将使用
~/.kube/config
文件,且不会发生合并。
-
如果设置了
使用的上下文根据以下流程中的第一个匹配项决定:
-
--context
选项的值。 -
CLI 配置文件中的
current-context
值。 - 此阶段允许一个空值。
-
要使用的用户和集群是决定的。此时,您可能也可能没有上下文;它们基于以下流程中的第一个匹配项构建,该流中为用户运行一次,一次用于集群:
-
用于用户名的
--user
的值,以及集群名称的--cluster
选项。 -
如果存在
--context
选项,则使用上下文的值。 - 此阶段允许一个空值。
-
用于用户名的
要使用的实际集群信息决定。此时,您可能没有集群信息。集群信息的每个信息根据以下流程中的第一个匹配项构建:
以下命令行选项中的任何值:
-
--server
, -
--api-version
-
--certificate-authority
-
--insecure-skip-tls-verify
-
- 如果集群信息和属性的值存在,则使用它。
- 如果您没有服务器位置,则出现错误。
要使用的实际用户信息是确定的。用户使用与集群相同的规则构建,但每个用户只能有一个身份验证技术;冲突的技术会导致操作失败。命令行选项优先于配置文件值。有效命令行选项包括:
-
--auth-path
-
--client-certificate
-
--client-key
-
--token
-
- 对于仍缺失的任何信息,将使用默认值,并提示提供其他信息。
2.5. 使用插件扩展 OpenShift CLI 复制链接链接已复制到粘贴板!
您可以针对默认的oc
命令编写并安装插件,从而可以使用OpenShift Container Platform CLI执行新的及更复杂的任务。
2.5.1. 编写 CLI 插件 复制链接链接已复制到粘贴板!
您可以使用任何可以编写命令行命令的编程语言或脚本为OpenShift Container Platform CLI编写插件。请注意,您无法使用插件来覆盖现有的 oc
命令。
流程
此过程创建一个简单的Bash插件,它的功能是在执行oc foo
命令时将消息输出到终端。
创建一个名为
oc-foo
的文件。在命名插件文件时,请记住以下几点:
-
该文件必须以
oc-
或kubectl-
开头,才能被识别为插件。 -
文件名决定了调用该插件的命令。例如,可以通过
oc foo bar
命令调用文件名为oc-foo-bar
的插件。如果希望命令中包含破折号,也可以使用下划线。例如,可以通过oc foo-bar
命令调用文件名为oc-foo_bar
的插件。
-
该文件必须以
将以下内容添加到该文件中。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
为 OpenShift Container Platform CLI 安装此插件后,可以使用 oc foo
命令调用。
2.5.2. 安装和使用 CLI 插件 复制链接链接已复制到粘贴板!
为 OpenShift Container Platform CLI 编写自定义插件后,您必须使用前安装插件。
先决条件
-
已安装
oc
CLI工具。 -
您必须具有以
oc-
或kubectl-
开头的 CLI 插件文件。
流程
如有必要,将插件文件更新为可执行。
chmod +x <plugin_file>
$ chmod +x <plugin_file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将文件放在
PATH
中的任何位置,例如/usr/local/bin/
。sudo mv <plugin_file> /usr/local/bin/.
$ sudo mv <plugin_file> /usr/local/bin/.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 运行
oc plugin list
以确保列出了插件。oc plugin list
$ oc plugin list
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输出示例
The following compatible plugins are available: /usr/local/bin/<plugin_file>
The following compatible plugins are available: /usr/local/bin/<plugin_file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 如果您的插件没有被列出,请验证文件是否以
oc-
或kubectl-
开头,是否可执行,且位于PATH
中。调用插件引入的新命令或选项。
例如,如果您从 Sample plug-in repository 构建并安装了
kubectl-ns
插件,则可以使用以下命令查看当前命名空间。oc ns
$ oc ns
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 请注意,调用插件的命令取决于插件文件名。例如,文件名为
oc-foo-bar
的插件会被oc foo bar
命令调用。
2.6. 使用 Krew 管理 CLI 插件 复制链接链接已复制到粘贴板!
您可以使用 Krew 为 OpenShift CLI (oc
)安装和管理插件。
使用 Krew 为 OpenShift CLI 安装和管理插件只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
2.6.1. 使用 Krew 安装 CLI 插件 复制链接链接已复制到粘贴板!
您可以使用 Krew 为 OpenShift CLI (oc
)安装插件。
先决条件
- 您已按照 Krew 文档中的 安装过程安装 Krew。
流程
要列出所有可用插件,请运行以下命令:
oc krew search
$ oc krew search
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 要获取插件的信息,请运行以下命令:
oc krew info <plugin_name>
$ oc krew info <plugin_name>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 要安装插件,请运行以下命令:
oc krew install <plugin_name>
$ oc krew install <plugin_name>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 要列出 Krew 安装的所有插件,请运行以下命令:
oc krew list
$ oc krew list
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.6.2. 使用 Krew 更新 CLI 插件 复制链接链接已复制到粘贴板!
您可以使用 Krew 更新为 OpenShift CLI (oc
) 安装的插件。
先决条件
- 您已按照 Krew 文档中的 安装过程安装 Krew。
- 您已使用 Krew 为 OpenShift CLI 安装了一个插件。
流程
要更新单个插件,请运行以下命令:
oc krew upgrade <plugin_name>
$ oc krew upgrade <plugin_name>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 要更新 Krew 安装的所有插件,请运行以下命令:
oc krew upgrade
$ oc krew upgrade
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.6.3. 使用 Krew 卸载 CLI 插件 复制链接链接已复制到粘贴板!
您可以使用 Krew 卸载为 OpenShift CLI (oc
)安装的插件。
先决条件
- 您已按照 Krew 文档中的 安装过程安装 Krew。
- 您已使用 Krew 为 OpenShift CLI 安装了一个插件。
流程
要卸载插件,请运行以下命令:
oc krew uninstall <plugin_name>
$ oc krew uninstall <plugin_name>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.7. OpenShift CLI 开发人员命令参考 复制链接链接已复制到粘贴板!
本参考提供了 OpenShift CLI(oc
)开发人员命令的描述和示例命令。有关管理员命令,请参阅 OpenShift CLI 管理员命令参考。
运行 oc help
来列出所有命令或运行 oc <command> --help
获取特定命令的附加详情。
2.7.1. OpenShift CLI(oc)开发人员命令 复制链接链接已复制到粘贴板!
2.7.1.1. oc annotate 复制链接链接已复制到粘贴板!
更新资源上的注解
用法示例
2.7.1.2. oc api-resources 复制链接链接已复制到粘贴板!
在服务器上显示支持的 API 资源
用法示例
2.7.1.3. oc api-versions 复制链接链接已复制到粘贴板!
以"group/version"的形式输出服务器上支持的 API 版本。
用法示例
Print the supported API versions
# Print the supported API versions
oc api-versions
2.7.1.4. oc apply 复制链接链接已复制到粘贴板!
通过文件名或 stdin 将配置应用到资源
用法示例
2.7.1.5. oc apply edit-last-applied 复制链接链接已复制到粘贴板!
编辑资源/对象的最新 last-applied-configuration 注解
用法示例
Edit the last-applied-configuration annotations by type/name in YAML
# Edit the last-applied-configuration annotations by type/name in YAML
oc apply edit-last-applied deployment/nginx
# Edit the last-applied-configuration annotations by file in JSON
oc apply edit-last-applied -f deploy.yaml -o json
2.7.1.6. oc apply set-last-applied 复制链接链接已复制到粘贴板!
设置 live 对象上的 last-applied-configuration 注释,以匹配文件的内容。
用法示例
2.7.1.7. oc apply view-last-applied 复制链接链接已复制到粘贴板!
查看资源/对象最新的最后应用配置注解
用法示例
View the last-applied-configuration annotations by type/name in YAML
# View the last-applied-configuration annotations by type/name in YAML
oc apply view-last-applied deployment/nginx
# View the last-applied-configuration annotations by file in JSON
oc apply view-last-applied -f deploy.yaml -o json
2.7.1.8. oc attach 复制链接链接已复制到粘贴板!
附加到正在运行的容器
用法示例
2.7.1.9. oc auth can-i 复制链接链接已复制到粘贴板!
检查是否允许操作
用法示例
2.7.1.10. oc auth reconcile 复制链接链接已复制到粘贴板!
协调 RBAC 角色、角色绑定、集群角色和集群角色绑定对象的规则
用法示例
Reconcile RBAC resources from a file
# Reconcile RBAC resources from a file
oc auth reconcile -f my-rbac-rules.yaml
2.7.1.11. oc auth whoami 复制链接链接已复制到粘贴板!
实验性:检查自我主题属性
用法示例
Get your subject attributes.
# Get your subject attributes.
oc auth whoami
# Get your subject attributes in JSON format.
oc auth whoami -o json
2.7.1.12. oc autoscale 复制链接链接已复制到粘贴板!
自动缩放部署配置、部署、副本集、有状态集或复制控制器
用法示例
Auto scale a deployment "foo", with the number of pods between 2 and 10, no target CPU utilization specified so a default autoscaling policy will be used
# Auto scale a deployment "foo", with the number of pods between 2 and 10, no target CPU utilization specified so a default autoscaling policy will be used
oc autoscale deployment foo --min=2 --max=10
# Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%
oc autoscale rc foo --max=5 --cpu-percent=80
2.7.1.13. oc cancel-build 复制链接链接已复制到粘贴板!
取消正在运行、待处理或新的构建
用法示例
2.7.1.14. oc cluster-info 复制链接链接已复制到粘贴板!
显示集群信息
用法示例
Print the address of the control plane and cluster services
# Print the address of the control plane and cluster services
oc cluster-info
2.7.1.15. oc cluster-info dump 复制链接链接已复制到粘贴板!
转储用于调试和诊断的相关信息
用法示例
2.7.1.16. oc completion 复制链接链接已复制到粘贴板!
输出指定 shell 的 shell 完成代码 (bash、zsh、fish 或 powershell)
用法示例
2.7.1.17. oc config current-context 复制链接链接已复制到粘贴板!
显示 current-context
用法示例
Display the current-context
# Display the current-context
oc config current-context
2.7.1.18. oc config delete-cluster 复制链接链接已复制到粘贴板!
从 kubeconfig 删除指定的集群
用法示例
Delete the minikube cluster
# Delete the minikube cluster
oc config delete-cluster minikube
2.7.1.19. oc config delete-context 复制链接链接已复制到粘贴板!
从 kubeconfig 删除指定的上下文
用法示例
Delete the context for the minikube cluster
# Delete the context for the minikube cluster
oc config delete-context minikube
2.7.1.20. oc config delete-user 复制链接链接已复制到粘贴板!
从 kubeconfig 删除指定用户
用法示例
Delete the minikube user
# Delete the minikube user
oc config delete-user minikube
2.7.1.21. oc config get-clusters 复制链接链接已复制到粘贴板!
显示 kubeconfig 中定义的集群
用法示例
List the clusters that oc knows about
# List the clusters that oc knows about
oc config get-clusters
2.7.1.22. oc config get-contexts 复制链接链接已复制到粘贴板!
描述一个或多个上下文
用法示例
List all the contexts in your kubeconfig file
# List all the contexts in your kubeconfig file
oc config get-contexts
# Describe one context in your kubeconfig file
oc config get-contexts my-context
2.7.1.23. oc config get-users 复制链接链接已复制到粘贴板!
显示 kubeconfig 中定义的用户
用法示例
List the users that oc knows about
# List the users that oc knows about
oc config get-users
2.7.1.24. oc config new-admin-kubeconfig 复制链接链接已复制到粘贴板!
生成,使服务器信任并显示新的 admin.kubeconfig。
用法示例
Generate a new admin kubeconfig
# Generate a new admin kubeconfig
oc config new-admin-kubeconfig
2.7.1.25. oc config new-kubelet-bootstrap-kubeconfig 复制链接链接已复制到粘贴板!
生成,使服务器信任并显示新的 kubelet /etc/kubernetes/kubeconfig。
用法示例
Generate a new kubelet bootstrap kubeconfig
# Generate a new kubelet bootstrap kubeconfig
oc config new-kubelet-bootstrap-kubeconfig
2.7.1.26. oc config refresh-ca-bundle 复制链接链接已复制到粘贴板!
通过联系 apiserver 来更新 OpenShift CA 捆绑包。
用法示例
2.7.1.27. oc config rename-context 复制链接链接已复制到粘贴板!
从 kubeconfig 文件中重命名上下文
用法示例
Rename the context 'old-name' to 'new-name' in your kubeconfig file
# Rename the context 'old-name' to 'new-name' in your kubeconfig file
oc config rename-context old-name new-name
2.7.1.28. oc config set 复制链接链接已复制到粘贴板!
在 kubeconfig 文件中设置单个值
用法示例
2.7.1.29. oc config set-cluster 复制链接链接已复制到粘贴板!
在 kubeconfig 中设置集群条目
用法示例
2.7.1.30. oc config set-context 复制链接链接已复制到粘贴板!
在 kubeconfig 中设置上下文条目
用法示例
Set the user field on the gce context entry without touching other values
# Set the user field on the gce context entry without touching other values
oc config set-context gce --user=cluster-admin
2.7.1.31. oc config set-credentials 复制链接链接已复制到粘贴板!
在 kubeconfig 中设置用户条目
用法示例
2.7.1.32. oc config unset 复制链接链接已复制到粘贴板!
在 kubeconfig 文件中取消设置单个值
用法示例
Unset the current-context
# Unset the current-context
oc config unset current-context
# Unset namespace in foo context
oc config unset contexts.foo.namespace
2.7.1.33. oc config use-context 复制链接链接已复制到粘贴板!
在 kubeconfig 文件中设置 current-context
用法示例
Use the context for the minikube cluster
# Use the context for the minikube cluster
oc config use-context minikube
2.7.1.34. oc config view 复制链接链接已复制到粘贴板!
显示合并的 kubeconfig 设置或指定的 kubeconfig 文件
用法示例
2.7.1.35. oc cp 复制链接链接已复制到粘贴板!
将文件和目录复制到容器或从容器中复制
用法示例
2.7.1.36. oc create 复制链接链接已复制到粘贴板!
从文件或 stdin 创建资源
用法示例
2.7.1.37. oc create build 复制链接链接已复制到粘贴板!
创建一个新构建
用法示例
Create a new build
# Create a new build
oc create build myapp
2.7.1.38. oc create clusterresourcequota 复制链接链接已复制到粘贴板!
创建集群资源配额
用法示例
Create a cluster resource quota limited to 10 pods
# Create a cluster resource quota limited to 10 pods
oc create clusterresourcequota limit-bob --project-annotation-selector=openshift.io/requester=user-bob --hard=pods=10
2.7.1.39. oc create clusterrole 复制链接链接已复制到粘贴板!
创建集群角色
用法示例
2.7.1.40. oc create clusterrolebinding 复制链接链接已复制到粘贴板!
为特定集群角色创建集群角色绑定
用法示例
Create a cluster role binding for user1, user2, and group1 using the cluster-admin cluster role
# Create a cluster role binding for user1, user2, and group1 using the cluster-admin cluster role
oc create clusterrolebinding cluster-admin --clusterrole=cluster-admin --user=user1 --user=user2 --group=group1
2.7.1.41. oc create configmap 复制链接链接已复制到粘贴板!
从本地文件、目录或字面值创建配置映射
用法示例
2.7.1.42. oc create cronjob 复制链接链接已复制到粘贴板!
使用指定名称创建 cron 作业
用法示例
Create a cron job
# Create a cron job
oc create cronjob my-job --image=busybox --schedule="*/1 * * * *"
# Create a cron job with a command
oc create cronjob my-job --image=busybox --schedule="*/1 * * * *" -- date
2.7.1.43. oc create deployment 复制链接链接已复制到粘贴板!
使用指定名称创建部署
用法示例
2.7.1.44. oc create deploymentconfig 复制链接链接已复制到粘贴板!
使用给定镜像的默认选项创建部署配置
用法示例
Create an nginx deployment config named my-nginx
# Create an nginx deployment config named my-nginx
oc create deploymentconfig my-nginx --image=nginx
2.7.1.45. oc create identity 复制链接链接已复制到粘贴板!
手动创建身份(仅在禁用自动创建时才需要)
用法示例
Create an identity with identity provider "acme_ldap" and the identity provider username "adamjones"
# Create an identity with identity provider "acme_ldap" and the identity provider username "adamjones"
oc create identity acme_ldap:adamjones
2.7.1.46. oc create imagestream 复制链接链接已复制到粘贴板!
创建新的空镜像流
用法示例
Create a new image stream
# Create a new image stream
oc create imagestream mysql
2.7.1.47. oc create imagestreamtag 复制链接链接已复制到粘贴板!
创建新镜像流标签
用法示例
Create a new image stream tag based on an image in a remote registry
# Create a new image stream tag based on an image in a remote registry
oc create imagestreamtag mysql:latest --from-image=myregistry.local/mysql/mysql:5.0
2.7.1.48. oc create ingress 复制链接链接已复制到粘贴板!
使用指定名称创建入口
用法示例
2.7.1.49. oc create job 复制链接链接已复制到粘贴板!
使用指定名称创建作业
用法示例
2.7.1.50. oc create namespace 复制链接链接已复制到粘贴板!
使用指定名称创建命名空间
用法示例
Create a new namespace named my-namespace
# Create a new namespace named my-namespace
oc create namespace my-namespace
2.7.1.51. oc create poddisruptionBudget 复制链接链接已复制到粘贴板!
使用指定名称创建 pod 中断预算
用法示例
2.7.1.52. oc create priorityclass 复制链接链接已复制到粘贴板!
创建具有指定名称的优先级类
用法示例
2.7.1.53. oc create quota 复制链接链接已复制到粘贴板!
使用指定名称创建配额
用法示例
Create a new resource quota named my-quota
# Create a new resource quota named my-quota
oc create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
# Create a new resource quota named best-effort
oc create quota best-effort --hard=pods=100 --scopes=BestEffort
2.7.1.54. oc create role 复制链接链接已复制到粘贴板!
创建具有单一规则的角色
用法示例
2.7.1.55. oc create rolebinding 复制链接链接已复制到粘贴板!
为特定角色或集群角色创建角色绑定
用法示例
Create a role binding for user1, user2, and group1 using the admin cluster role
# Create a role binding for user1, user2, and group1 using the admin cluster role
oc create rolebinding admin --clusterrole=admin --user=user1 --user=user2 --group=group1
# Create a role binding for serviceaccount monitoring:sa-dev using the admin role
oc create rolebinding admin-binding --role=admin --serviceaccount=monitoring:sa-dev
2.7.1.56. oc create route edge 复制链接链接已复制到粘贴板!
创建使用边缘 TLS 终止的路由
用法示例
2.7.1.57. oc create route passthrough 复制链接链接已复制到粘贴板!
创建使用 passthrough TLS 终止的路由
用法示例
2.7.1.58. oc create route reencrypt 复制链接链接已复制到粘贴板!
创建使用重新加密 TLS 终止的路由
用法示例
2.7.1.59. oc create secret docker-registry 复制链接链接已复制到粘贴板!
创建用于 Docker registry 的 secret
用法示例
If you do not already have a .dockercfg file, create a dockercfg secret directly
# If you do not already have a .dockercfg file, create a dockercfg secret directly
oc create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
# Create a new secret named my-secret from ~/.docker/config.json
oc create secret docker-registry my-secret --from-file=.dockerconfigjson=path/to/.docker/config.json
2.7.1.60. oc create secret generic 复制链接链接已复制到粘贴板!
从本地文件、目录或字面值创建 secret
用法示例
2.7.1.61. oc create secret tls 复制链接链接已复制到粘贴板!
创建 TLS secret
用法示例
Create a new TLS secret named tls-secret with the given key pair
# Create a new TLS secret named tls-secret with the given key pair
oc create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
2.7.1.62. oc create service clusterip 复制链接链接已复制到粘贴板!
创建 ClusterIP 服务
用法示例
Create a new ClusterIP service named my-cs
# Create a new ClusterIP service named my-cs
oc create service clusterip my-cs --tcp=5678:8080
# Create a new ClusterIP service named my-cs (in headless mode)
oc create service clusterip my-cs --clusterip="None"
2.7.1.63. oc create service externalname 复制链接链接已复制到粘贴板!
创建 ExternalName 服务
用法示例
Create a new ExternalName service named my-ns
# Create a new ExternalName service named my-ns
oc create service externalname my-ns --external-name bar.com
2.7.1.64. oc create service loadbalancer 复制链接链接已复制到粘贴板!
创建 LoadBalancer 服务
用法示例
Create a new LoadBalancer service named my-lbs
# Create a new LoadBalancer service named my-lbs
oc create service loadbalancer my-lbs --tcp=5678:8080
2.7.1.65. oc create service nodeport 复制链接链接已复制到粘贴板!
创建 NodePort 服务
用法示例
Create a new NodePort service named my-ns
# Create a new NodePort service named my-ns
oc create service nodeport my-ns --tcp=5678:8080
2.7.1.66. oc create serviceaccount 复制链接链接已复制到粘贴板!
使用指定名称创建服务帐户
用法示例
Create a new service account named my-service-account
# Create a new service account named my-service-account
oc create serviceaccount my-service-account
2.7.1.67. oc create token 复制链接链接已复制到粘贴板!
请求服务帐户令牌
用法示例
2.7.1.68. oc create user 复制链接链接已复制到粘贴板!
手动创建用户(仅在禁用自动创建时才需要)
用法示例
Create a user with the username "ajones" and the display name "Adam Jones"
# Create a user with the username "ajones" and the display name "Adam Jones"
oc create user ajones --full-name="Adam Jones"
2.7.1.69. oc create useridentitymapping 复制链接链接已复制到粘贴板!
手动将身份映射到用户
用法示例
Map the identity "acme_ldap:adamjones" to the user "ajones"
# Map the identity "acme_ldap:adamjones" to the user "ajones"
oc create useridentitymapping acme_ldap:adamjones ajones
2.7.1.70. oc debug 复制链接链接已复制到粘贴板!
启动用于调试的 pod 的新实例
用法示例
2.7.1.71. oc delete 复制链接链接已复制到粘贴板!
通过文件名、stdin、资源和名称或者资源和标签选择器删除资源
用法示例
2.7.1.72. oc describe 复制链接链接已复制到粘贴板!
显示特定资源或一组资源的详情
用法示例
2.7.1.73. oc diff 复制链接链接已复制到粘贴板!
针对 would-be 应用的版本对 live 版本进行 diff 操作
用法示例
Diff resources included in pod.json
# Diff resources included in pod.json
oc diff -f pod.json
# Diff file read from stdin
cat service.yaml | oc diff -f -
2.7.1.74. oc edit 复制链接链接已复制到粘贴板!
编辑服务器上的资源
用法示例
2.7.1.75. oc events 复制链接链接已复制到粘贴板!
列出事件
用法示例
2.7.1.76. oc exec 复制链接链接已复制到粘贴板!
在容器中执行命令
用法示例
2.7.1.77. oc explain 复制链接链接已复制到粘贴板!
获取资源的文档
用法示例
2.7.1.78. oc expose 复制链接链接已复制到粘贴板!
将复制的应用程序作为服务或路由公开
用法示例
2.7.1.79. oc extract 复制链接链接已复制到粘贴板!
将 secret 或配置映射提取到磁盘
用法示例
2.7.1.80. oc get 复制链接链接已复制到粘贴板!
显示一个或多个资源
用法示例
2.7.1.81. oc get-token 复制链接链接已复制到粘贴板!
实验性:从外部 OIDC 签发者获取令牌作为凭证 exec 插件
用法示例
Starts an auth code flow to the issuer url with the client id and the given extra scopes
# Starts an auth code flow to the issuer url with the client id and the given extra scopes
oc get-token --client-id=client-id --issuer-url=test.issuer.url --extra-scopes=email,profile
# Starts an authe code flow to the issuer url with a different callback address.
oc get-token --client-id=client-id --issuer-url=test.issuer.url --callback-address=127.0.0.1:8343
2.7.1.82. oc idle 复制链接链接已复制到粘贴板!
闲置可扩展资源
用法示例
Idle the scalable controllers associated with the services listed in to-idle.txt
# Idle the scalable controllers associated with the services listed in to-idle.txt
$ oc idle --resource-names-file to-idle.txt
2.7.1.83. oc image append 复制链接链接已复制到粘贴板!
向镜像添加层并将其推送到 registry
用法示例
2.7.1.84. oc image extract 复制链接链接已复制到粘贴板!
将文件从镜像复制到文件系统
用法示例
2.7.1.85. oc image info 复制链接链接已复制到粘贴板!
显示镜像的信息
用法示例
2.7.1.86. oc image mirror 复制链接链接已复制到粘贴板!
将镜像从一个存储库镜像到另一个存储库
用法示例
2.7.1.87. oc import-image 复制链接链接已复制到粘贴板!
从容器镜像 registry 中导入镜像
用法示例
2.7.1.88. oc kustomize 复制链接链接已复制到粘贴板!
从目录或 URL 构建 kustomization 目标
用法示例
2.7.1.89. oc label 复制链接链接已复制到粘贴板!
更新资源上的标签
用法示例
2.7.1.90. oc login 复制链接链接已复制到粘贴板!
登录到服务器
用法示例
2.7.1.91. oc logout 复制链接链接已复制到粘贴板!
结束当前服务器会话
用法示例
Log out
# Log out
oc logout
2.7.1.92. oc logs 复制链接链接已复制到粘贴板!
显示 pod 中容器的日志
用法示例
2.7.1.93. oc new-app 复制链接链接已复制到粘贴板!
创建新应用程序
用法示例
2.7.1.94. oc new-build 复制链接链接已复制到粘贴板!
创建新构建配置
用法示例
2.7.1.95. oc new-project 复制链接链接已复制到粘贴板!
请求新项目
用法示例
Create a new project with minimal information
# Create a new project with minimal information
oc new-project web-team-dev
# Create a new project with a display name and description
oc new-project web-team-dev --display-name="Web Team Development" --description="Development project for the web team."
2.7.1.96. oc observe 复制链接链接已复制到粘贴板!
观察资源的变化并对其做出反应(实验性)
用法示例
2.7.1.97. oc patch 复制链接链接已复制到粘贴板!
更新资源字段
用法示例
2.7.1.98. oc plugin list 复制链接链接已复制到粘贴板!
列出用户 PATH 中的所有可见插件可执行文件
用法示例
List all available plugins
# List all available plugins
oc plugin list
2.7.1.99. oc policy add-role-to-user 复制链接链接已复制到粘贴板!
为当前项目的用户或服务帐户添加角色
用法示例
Add the 'view' role to user1 for the current project
# Add the 'view' role to user1 for the current project
oc policy add-role-to-user view user1
# Add the 'edit' role to serviceaccount1 for the current project
oc policy add-role-to-user edit -z serviceaccount1
2.7.1.100. oc policy scc-review 复制链接链接已复制到粘贴板!
检查哪个服务帐户可以创建 pod
用法示例
2.7.1.101. oc policy scc-subject-review 复制链接链接已复制到粘贴板!
检查用户或服务帐户是否可以创建 pod
用法示例
2.7.1.102. oc port-forward 复制链接链接已复制到粘贴板!
将一个或多个本地端口转发到一个 pod
用法示例
2.7.1.103. oc process 复制链接链接已复制到粘贴板!
将模板处理为资源列表
用法示例
2.7.1.104. oc project 复制链接链接已复制到粘贴板!
切换到另一个项目
用法示例
Switch to the 'myapp' project
# Switch to the 'myapp' project
oc project myapp
# Display the project currently in use
oc project
2.7.1.105. oc projects 复制链接链接已复制到粘贴板!
显示现有项目
用法示例
List all projects
# List all projects
oc projects
2.7.1.106. oc proxy 复制链接链接已复制到粘贴板!
运行到 Kubernetes API 服务器的代理
用法示例
2.7.1.107. oc registry login 复制链接链接已复制到粘贴板!
登录到集成的 registry
用法示例
Log in to the integrated registry
# Log in to the integrated registry
oc registry login
# Log in to different registry using BASIC auth credentials
oc registry login --registry quay.io/myregistry --auth-basic=USER:PASS
2.7.1.108. oc replace 复制链接链接已复制到粘贴板!
使用文件名或 stdin 替换资源
用法示例
2.7.1.109. oc rollback 复制链接链接已复制到粘贴板!
将应用程序的一部分还原回以前的部署
用法示例
2.7.1.110. oc rollout cancel 复制链接链接已复制到粘贴板!
取消进行中的部署
用法示例
Cancel the in-progress deployment based on 'nginx'
# Cancel the in-progress deployment based on 'nginx'
oc rollout cancel dc/nginx
2.7.1.111. oc rollout history 复制链接链接已复制到粘贴板!
查看推出(rollout)历史记录
用法示例
View the rollout history of a deployment
# View the rollout history of a deployment
oc rollout history dc/nginx
# View the details of deployment revision 3
oc rollout history dc/nginx --revision=3
2.7.1.112. oc rollout latest 复制链接链接已复制到粘贴板!
使用来自触发器的最新状态为部署配置启动一个新的 rollout 操作
用法示例
Start a new rollout based on the latest images defined in the image change triggers
# Start a new rollout based on the latest images defined in the image change triggers
oc rollout latest dc/nginx
# Print the rolled out deployment config
oc rollout latest dc/nginx -o json
2.7.1.113. oc rollout pause 复制链接链接已复制到粘贴板!
将提供的资源标记为暂停
用法示例
Mark the nginx deployment as paused. Any current state of
# Mark the nginx deployment as paused. Any current state of
# the deployment will continue its function, new updates to the deployment will not
# have an effect as long as the deployment is paused
oc rollout pause dc/nginx
2.7.1.114. oc rollout restart 复制链接链接已复制到粘贴板!
重启资源
用法示例
2.7.1.115. oc rollout resume 复制链接链接已复制到粘贴板!
恢复暂停的资源
用法示例
Resume an already paused deployment
# Resume an already paused deployment
oc rollout resume dc/nginx
2.7.1.116. oc rollout retry 复制链接链接已复制到粘贴板!
重试最新失败的 rollout 操作
用法示例
Retry the latest failed deployment based on 'frontend'
# Retry the latest failed deployment based on 'frontend'
# The deployer pod and any hook pods are deleted for the latest failed deployment
oc rollout retry dc/frontend
2.7.1.117. oc rollout status 复制链接链接已复制到粘贴板!
显示推出部署的状态
用法示例
Watch the status of the latest rollout
# Watch the status of the latest rollout
oc rollout status dc/nginx
2.7.1.118. oc rollout undo 复制链接链接已复制到粘贴板!
撤消之前的推出部署
用法示例
Roll back to the previous deployment
# Roll back to the previous deployment
oc rollout undo dc/nginx
# Roll back to deployment revision 3. The replication controller for that version must exist
oc rollout undo dc/nginx --to-revision=3
2.7.1.119. oc rsh 复制链接链接已复制到粘贴板!
在容器中启动 shell 会话
用法示例
2.7.1.120. oc rsync 复制链接链接已复制到粘贴板!
在本地文件系统和 pod 间复制文件
用法示例
Synchronize a local directory with a pod directory
# Synchronize a local directory with a pod directory
oc rsync ./local/dir/ POD:/remote/dir
# Synchronize a pod directory with a local directory
oc rsync POD:/remote/dir/ ./local/dir
2.7.1.121. oc run 复制链接链接已复制到粘贴板!
在集群中运行特定镜像
用法示例
2.7.1.122. oc scale 复制链接链接已复制到粘贴板!
为部署、副本集或复制控制器设置新大小
用法示例
2.7.1.123. oc secrets link 复制链接链接已复制到粘贴板!
将 secret 链接到服务帐户
用法示例
Add an image pull secret to a service account to automatically use it for pulling pod images
# Add an image pull secret to a service account to automatically use it for pulling pod images
oc secrets link serviceaccount-name pull-secret --for=pull
# Add an image pull secret to a service account to automatically use it for both pulling and pushing build images
oc secrets link builder builder-image-secret --for=pull,mount
2.7.1.124. oc secrets unlink 复制链接链接已复制到粘贴板!
从服务帐户分离 secret
用法示例
Unlink a secret currently associated with a service account
# Unlink a secret currently associated with a service account
oc secrets unlink serviceaccount-name secret-name another-secret-name ...
2.7.1.125. oc set build-hook 复制链接链接已复制到粘贴板!
更新构建配置上的构建 hook
用法示例
2.7.1.126. oc set build-secret 复制链接链接已复制到粘贴板!
更新构建配置上的构建 secret
用法示例
2.7.1.127. oc set data 复制链接链接已复制到粘贴板!
更新配置映射或 secret 中的数据
用法示例
2.7.1.128. oc set deployment-hook 复制链接链接已复制到粘贴板!
更新部署配置上的部署 hook
用法示例
2.7.1.129. oc set env 复制链接链接已复制到粘贴板!
更新 pod 模板上的环境变量
用法示例
2.7.1.130. oc set image 复制链接链接已复制到粘贴板!
更新 pod 模板的镜像
用法示例
2.7.1.131. oc set image-lookup 复制链接链接已复制到粘贴板!
更改部署应用程序时镜像的解析方式
用法示例
2.7.1.132. oc set probe 复制链接链接已复制到粘贴板!
更新 pod 模板上的探测
用法示例
2.7.1.133. oc set resources 复制链接链接已复制到粘贴板!
使用 pod 模板更新对象上的资源请求/限制
用法示例
2.7.1.134. oc set route-backends 复制链接链接已复制到粘贴板!
更新路由的后端
用法示例
2.7.1.135. oc set selector 复制链接链接已复制到粘贴板!
在资源上设置选择器
用法示例
Set the labels and selector before creating a deployment/service pair.
# Set the labels and selector before creating a deployment/service pair.
oc create service clusterip my-svc --clusterip="None" -o yaml --dry-run | oc set selector --local -f - 'environment=qa' -o yaml | oc create -f -
oc create deployment my-dep -o yaml --dry-run | oc label --local -f - environment=qa -o yaml | oc create -f -
2.7.1.136. oc set serviceaccount 复制链接链接已复制到粘贴板!
更新资源的服务帐户
用法示例
Set deployment nginx-deployment's service account to serviceaccount1
# Set deployment nginx-deployment's service account to serviceaccount1
oc set serviceaccount deployment nginx-deployment serviceaccount1
# Print the result (in YAML format) of updated nginx deployment with service account from a local file, without hitting the API server
oc set sa -f nginx-deployment.yaml serviceaccount1 --local --dry-run -o yaml
2.7.1.137. oc set subject 复制链接链接已复制到粘贴板!
更新角色绑定或集群角色绑定中的用户、组或服务帐户
用法示例
2.7.1.138. oc set triggers 复制链接链接已复制到粘贴板!
更新一个或多个对象上的触发器
用法示例
2.7.1.139. oc set volumes 复制链接链接已复制到粘贴板!
更新 pod 模板中的卷
用法示例
2.7.1.140. oc start-build 复制链接链接已复制到粘贴板!
启动新构建
用法示例
2.7.1.141. oc status 复制链接链接已复制到粘贴板!
显示当前项目的概述
用法示例
2.7.1.142. oc tag 复制链接链接已复制到粘贴板!
将现有镜像标记到镜像流中
用法示例
2.7.1.143. oc version 复制链接链接已复制到粘贴板!
输出客户端和服务器版本信息
用法示例
2.7.1.144. oc wait 复制链接链接已复制到粘贴板!
实验性:等待一个或多个资源上的特定条件
用法示例
2.7.1.145. oc whoami 复制链接链接已复制到粘贴板!
返回有关当前会话的信息
用法示例
Display the currently authenticated user
# Display the currently authenticated user
oc whoami
2.8. OpenShift CLI 管理员命令参考 复制链接链接已复制到粘贴板!
本参考提供了 OpenShift CLI(oc
)管理员命令的描述和示例命令。您必须具有 cluster-admin
或同等权限才能使用这些命令。
如需开发人员命令,请参阅 OpenShift CLI 开发人员命令参考。
运行 oc adm -h
以列出所有管理员命令或运行 oc <command> --help
获取特定命令的更多详情。
2.8.1. OpenShift CLI(oc)管理员命令 复制链接链接已复制到粘贴板!
2.8.1.1. oc adm build-chain 复制链接链接已复制到粘贴板!
输出构建的输入和依赖项
用法示例
2.8.1.2. oc adm catalog mirror 复制链接链接已复制到粘贴板!
镜像 operator-registry 目录
用法示例
2.8.1.3. oc adm 证书批准 复制链接链接已复制到粘贴板!
批准证书签名请求
用法示例
Approve CSR 'csr-sqgzp'
# Approve CSR 'csr-sqgzp'
oc adm certificate approve csr-sqgzp
2.8.1.4. oc adm 证书拒绝 复制链接链接已复制到粘贴板!
拒绝证书签名请求
用法示例
Deny CSR 'csr-sqgzp'
# Deny CSR 'csr-sqgzp'
oc adm certificate deny csr-sqgzp
2.8.1.5. oc adm copy-to-node 复制链接链接已复制到粘贴板!
将指定的文件复制到节点。
用法示例
copy a new bootstrap kubeconfig file to node-0
# copy a new bootstrap kubeconfig file to node-0
oc adm copy-to-node --copy=new-bootstrap-kubeconfig=/etc/kubernetes/kubeconfig node/node-0
2.8.1.6. oc adm cordon 复制链接链接已复制到粘贴板!
将节点标记为不可调度
用法示例
Mark node "foo" as unschedulable
# Mark node "foo" as unschedulable
oc adm cordon foo
2.8.1.7. oc adm create-bootstrap-project-template 复制链接链接已复制到粘贴板!
创建 bootstrap 项目模板
用法示例
Output a bootstrap project template in YAML format to stdout
# Output a bootstrap project template in YAML format to stdout
oc adm create-bootstrap-project-template -o yaml
2.8.1.8. oc adm create-error-template 复制链接链接已复制到粘贴板!
创建错误页面模板
用法示例
Output a template for the error page to stdout
# Output a template for the error page to stdout
oc adm create-error-template
2.8.1.9. oc adm create-login-template 复制链接链接已复制到粘贴板!
创建登录模板
用法示例
Output a template for the login page to stdout
# Output a template for the login page to stdout
oc adm create-login-template
2.8.1.10. oc adm create-provider-selection-template 复制链接链接已复制到粘贴板!
创建供应商选择模板
用法示例
Output a template for the provider selection page to stdout
# Output a template for the provider selection page to stdout
oc adm create-provider-selection-template
2.8.1.11. oc adm drain 复制链接链接已复制到粘贴板!
排空节点以准备进行维护
用法示例
Drain node "foo", even if there are pods not managed by a replication controller, replica set, job, daemon set, or stateful set on it
# Drain node "foo", even if there are pods not managed by a replication controller, replica set, job, daemon set, or stateful set on it
oc adm drain foo --force
# As above, but abort if there are pods not managed by a replication controller, replica set, job, daemon set, or stateful set, and use a grace period of 15 minutes
oc adm drain foo --grace-period=900
2.8.1.12. oc adm groups add-users 复制链接链接已复制到粘贴板!
将用户添加到组
用法示例
Add user1 and user2 to my-group
# Add user1 and user2 to my-group
oc adm groups add-users my-group user1 user2
2.8.1.13. oc adm groups new 复制链接链接已复制到粘贴板!
创建一个新组
用法示例
2.8.1.14. oc adm groups prune 复制链接链接已复制到粘贴板!
从外部提供程序中删除引用缺失记录的旧 OpenShift 组
用法示例
2.8.1.15. oc adm groups remove-users 复制链接链接已复制到粘贴板!
从组中删除用户
用法示例
Remove user1 and user2 from my-group
# Remove user1 and user2 from my-group
oc adm groups remove-users my-group user1 user2
2.8.1.16. oc adm groups sync 复制链接链接已复制到粘贴板!
将 OpenShift 组与来自外部提供程序的记录同步
用法示例
2.8.1.17. oc adm inspect 复制链接链接已复制到粘贴板!
为给定资源收集调试数据
用法示例
2.8.1.18. oc adm migrate icsp 复制链接链接已复制到粘贴板!
将 imagecontentsourcepolicy 文件更新为 imagedigestmirrorset 文件
用法示例
Update the imagecontentsourcepolicy.yaml file to a new imagedigestmirrorset file under the mydir directory
# Update the imagecontentsourcepolicy.yaml file to a new imagedigestmirrorset file under the mydir directory
oc adm migrate icsp imagecontentsourcepolicy.yaml --dest-dir mydir
2.8.1.19. oc adm migrate template-instances 复制链接链接已复制到粘贴板!
更新模板实例以指向最新的 group-version-kinds
用法示例
Perform a dry-run of updating all objects
# Perform a dry-run of updating all objects
oc adm migrate template-instances
# To actually perform the update, the confirm flag must be appended
oc adm migrate template-instances --confirm
2.8.1.20. oc adm must-gather 复制链接链接已复制到粘贴板!
启动用于收集调试信息的 pod 的新实例
用法示例
2.8.1.21. oc adm new-project 复制链接链接已复制到粘贴板!
创建新项目
用法示例
Create a new project using a node selector
# Create a new project using a node selector
oc adm new-project myproject --node-selector='type=user-node,region=east'
2.8.1.22. oc adm node-logs 复制链接链接已复制到粘贴板!
显示和过滤节点日志
用法示例
2.8.1.23. oc adm ocp-certificates monitor-certificates 复制链接链接已复制到粘贴板!
观察平台证书。
用法示例
Watch platform certificates.
# Watch platform certificates.
oc adm ocp-certificates monitor-certificates
2.8.1.24. oc adm ocp-certificates regenerate-leaf 复制链接链接已复制到粘贴板!
重新生成 OpenShift 集群的客户端和提供证书
用法示例
Regenerate a leaf certificate contained in a particular secret.
# Regenerate a leaf certificate contained in a particular secret.
oc adm ocp-certificates regenerate-leaf -n openshift-config-managed secret/kube-controller-manager-client-cert-key
在 OpenShift 集群中重新生成机器配置 Operator 证书
用法示例
Regenerate the MCO certs without modifying user-data secrets
# Regenerate the MCO certs without modifying user-data secrets
oc adm ocp-certificates regenerate-machine-config-server-serving-cert --update-ignition=false
# Update the user-data secrets to use new MCS certs
oc adm ocp-certificates update-ignition-ca-bundle-for-machine-config-server
2.8.1.26. oc adm ocp-certificates regenerate-top-level 复制链接链接已复制到粘贴板!
在 OpenShift 集群中重新生成顶级证书
用法示例
Regenerate the signing certificate contained in a particular secret.
# Regenerate the signing certificate contained in a particular secret.
oc adm ocp-certificates regenerate-top-level -n openshift-kube-apiserver-operator secret/loadbalancer-serving-signer-key
2.8.1.27. oc adm ocp-certificates remove-old-trust 复制链接链接已复制到粘贴板!
从代表 OpenShift 集群中平台信任捆绑包的 ConfigMap 中删除旧的 CA
用法示例
Remove a trust bundled contained in a particular config map
# Remove a trust bundled contained in a particular config map
oc adm ocp-certificates remove-old-trust -n openshift-config-managed configmaps/kube-apiserver-aggregator-client-ca --created-before 2023-06-05T14:44:06Z
# Remove only CA certificates created before a certain date from all trust bundles
oc adm ocp-certificates remove-old-trust configmaps -A --all --created-before 2023-06-05T14:44:06Z
更新 OpenShift 集群中的 user-data secret,以使用更新的 MCO certfs
用法示例
Regenerate the MCO certs without modifying user-data secrets
# Regenerate the MCO certs without modifying user-data secrets
oc adm ocp-certificates regenerate-machine-config-server-serving-cert --update-ignition=false
# Update the user-data secrets to use new MCS certs
oc adm ocp-certificates update-ignition-ca-bundle-for-machine-config-server
2.8.1.29. oc adm pod-network isolate-projects 复制链接链接已复制到粘贴板!
隔离项目网络
用法示例
Provide isolation for project p1
# Provide isolation for project p1
oc adm pod-network isolate-projects <p1>
# Allow all projects with label name=top-secret to have their own isolated project network
oc adm pod-network isolate-projects --selector='name=top-secret'
2.8.1.30. oc adm pod-network join-projects 复制链接链接已复制到粘贴板!
加入项目网络
用法示例
Allow project p2 to use project p1 network
# Allow project p2 to use project p1 network
oc adm pod-network join-projects --to=<p1> <p2>
# Allow all projects with label name=top-secret to use project p1 network
oc adm pod-network join-projects --to=<p1> --selector='name=top-secret'
2.8.1.31. oc adm pod-network make-projects-global 复制链接链接已复制到粘贴板!
使项目网络为全局有效
用法示例
Allow project p1 to access all pods in the cluster and vice versa
# Allow project p1 to access all pods in the cluster and vice versa
oc adm pod-network make-projects-global <p1>
# Allow all projects with label name=share to access all pods in the cluster and vice versa
oc adm pod-network make-projects-global --selector='name=share'
2.8.1.32. oc adm policy add-role-to-user 复制链接链接已复制到粘贴板!
为当前项目的用户或服务帐户添加角色
用法示例
Add the 'view' role to user1 for the current project
# Add the 'view' role to user1 for the current project
oc adm policy add-role-to-user view user1
# Add the 'edit' role to serviceaccount1 for the current project
oc adm policy add-role-to-user edit -z serviceaccount1
2.8.1.33. oc adm policy add-scc-to-group 复制链接链接已复制到粘贴板!
为组添加安全性上下文约束
用法示例
Add the 'restricted' security context constraint to group1 and group2
# Add the 'restricted' security context constraint to group1 and group2
oc adm policy add-scc-to-group restricted group1 group2
2.8.1.34. oc adm policy add-scc-to-user 复制链接链接已复制到粘贴板!
为用户或服务帐户添加安全性上下文约束
用法示例
Add the 'restricted' security context constraint to user1 and user2
# Add the 'restricted' security context constraint to user1 and user2
oc adm policy add-scc-to-user restricted user1 user2
# Add the 'privileged' security context constraint to serviceaccount1 in the current namespace
oc adm policy add-scc-to-user privileged -z serviceaccount1
2.8.1.35. oc adm policy scc-review 复制链接链接已复制到粘贴板!
检查哪个服务帐户可以创建 pod
用法示例
2.8.1.36. oc adm policy scc-subject-review 复制链接链接已复制到粘贴板!
检查用户或服务帐户是否可以创建 pod
用法示例
2.8.1.37. oc adm prune builds 复制链接链接已复制到粘贴板!
删除旧的完成和失败的构建
用法示例
2.8.1.38. oc adm prune deployments 复制链接链接已复制到粘贴板!
删除旧的完成和失败的部署配置
用法示例
Dry run deleting all but the last complete deployment for every deployment config
# Dry run deleting all but the last complete deployment for every deployment config
oc adm prune deployments --keep-complete=1
# To actually perform the prune operation, the confirm flag must be appended
oc adm prune deployments --keep-complete=1 --confirm
2.8.1.39. oc adm prune groups 复制链接链接已复制到粘贴板!
从外部提供程序中删除引用缺失记录的旧 OpenShift 组
用法示例
2.8.1.40. oc adm prune images 复制链接链接已复制到粘贴板!
删除未引用的镜像
用法示例
2.8.1.41. oc adm prune renderedmachineconfigs 复制链接链接已复制到粘贴板!
在 OpenShift 集群中修剪渲染的 MachineConfig
用法示例
2.8.1.42. oc adm prune renderedmachineconfigs list 复制链接链接已复制到粘贴板!
列出 OpenShift 集群中渲染的 MachineConfig
用法示例
List all rendered MachineConfigs for the worker MachineConfigPool in the cluster
# List all rendered MachineConfigs for the worker MachineConfigPool in the cluster
oc adm prune renderedmachineconfigs list --pool-name=worker
# List all rendered MachineConfigs in use by the cluster's MachineConfigPools
oc adm prune renderedmachineconfigs list --in-use
2.8.1.43. oc adm reboot-machine-config-pool 复制链接链接已复制到粘贴板!
启动指定的 MachineConfigPool 重启。
用法示例
2.8.1.44. oc adm release extract 复制链接链接已复制到粘贴板!
将更新有效负载的内容提取到磁盘
用法示例
2.8.1.45. oc adm release info 复制链接链接已复制到粘贴板!
显示发行版本的信息
用法示例
2.8.1.46. oc adm release mirror 复制链接链接已复制到粘贴板!
将发行版本 mirror 到不同的镜像 registry 位置
用法示例
2.8.1.47. oc adm release new 复制链接链接已复制到粘贴板!
创建新的 OpenShift 发行版本
用法示例
2.8.1.48. oc adm restart-kubelet 复制链接链接已复制到粘贴板!
在指定节点上重启 kubelet
用法示例
2.8.1.49. oc adm taint 复制链接链接已复制到粘贴板!
更新一个或多个节点上的污点
用法示例
2.8.1.50. oc adm top images 复制链接链接已复制到粘贴板!
显示镜像的用量统计
用法示例
Show usage statistics for images
# Show usage statistics for images
oc adm top images
2.8.1.51. oc adm top imagestreams 复制链接链接已复制到粘贴板!
显示镜像流的用量统计
用法示例
Show usage statistics for image streams
# Show usage statistics for image streams
oc adm top imagestreams
2.8.1.52. oc adm top node 复制链接链接已复制到粘贴板!
显示节点的资源(CPU/内存)使用情况
用法示例
Show metrics for all nodes
# Show metrics for all nodes
oc adm top node
# Show metrics for a given node
oc adm top node NODE_NAME
2.8.1.53. oc adm top pod 复制链接链接已复制到粘贴板!
显示 pod 的资源(CPU/内存)使用情况
用法示例
2.8.1.54. oc adm uncordon 复制链接链接已复制到粘贴板!
将节点标记为可调度
用法示例
Mark node "foo" as schedulable
# Mark node "foo" as schedulable
oc adm uncordon foo
2.8.1.55. oc adm upgrade 复制链接链接已复制到粘贴板!
升级集群或调整升级频道
用法示例
View the update status and available cluster updates
# View the update status and available cluster updates
oc adm upgrade
# Update to the latest version
oc adm upgrade --to-latest=true
2.8.1.56. oc adm verify-image-signature 复制链接链接已复制到粘贴板!
验证镜像签名中包含的镜像身份
用法示例
2.8.1.57. oc adm wait-for-node-reboot 复制链接链接已复制到粘贴板!
在运行 oc adm reboot-machine-config-pool
后等待节点重新引导
用法示例
2.8.1.58. oc adm wait-for-stable-cluster 复制链接链接已复制到粘贴板!
等待平台 operator 变得稳定
用法示例
Wait for all clusteroperators to become stable
# Wait for all clusteroperators to become stable
oc adm wait-for-stable-cluster
# Consider operators to be stable if they report as such for 5 minutes straight
oc adm wait-for-stable-cluster --minimum-stable-period 5m
第 3 章 odo 的重要更新 复制链接链接已复制到粘贴板!
红帽没有在 OpenShift Container Platform 文档站点上提供有关 odo
的信息。请参阅由红帽维护的文档,以及上游社区的与 odo
相关的文档。
对于上游社区维护的材料,红帽在合作社区支持下提供支持。
第 4 章 用于 OpenShift Serverless 的 Knative CLI 复制链接链接已复制到粘贴板!
Knative (kn
) CLI 在 OpenShift Container Platform 上启用了与 Knative 组件的简单交互。
4.1. 主要特性 复制链接链接已复制到粘贴板!
Knative (kn
) CLI 旨在使无服务器计算任务简单明确。Knative CLI 的主要功能包括:
- 从命令行部署无服务器应用程序。
- 管理 Knative Serving 的功能,如服务、修订和流量分割。
- 创建和管理 Knative Eventing 组件,如事件源和触发器。
- 创建 sink 绑定来连接现有的 Kubernetes 应用程序和 Knative 服务。
-
使用灵活的插件架构扩展 Knative CLI,类似于
kubectl
CLI。 - 为 Knative 服务配置 autoscaling 参数。
- 脚本化使用,如等待一个操作的结果,或部署自定义推出和回滚策略。
4.2. 安装 Knative CLI 复制链接链接已复制到粘贴板!
请参阅安装 Knative CLI。
第 5 章 Pipelines CLI (tkn) 复制链接链接已复制到粘贴板!
5.1. 安装 tkn 复制链接链接已复制到粘贴板!
使用 CLI 工具从终端管理 Red Hat OpenShift Pipelines。下面的部分论述了如何在不同的平台中安装 CLI 工具。
在 OpenShift Container Platform web 控制台中,点右上角的 ? 图标并选 Command Line Tools。
归档和 RPM 都包含以下可执行文件:
-
tkn
-
tkn-pac
-
opc
使用 opc
CLI 工具运行 Red Hat OpenShift Pipelines 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
5.1.1. 在 Linux 上安装 Red Hat OpenShift Pipelines CLI 复制链接链接已复制到粘贴板!
对于 Linux 发行版,您可以将 CLI 下载为 tar.gz
存档。
流程
下载相关的 CLI 工具。
解包存档:
tar xvzf <file>
$ tar xvzf <file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
将您的
tkn
,tkn-pac
, 和opc
文件添加到PATH
环境变量中。 要查看您的
PATH
,请运行以下命令:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
对于 Red Hat Enterprise Linux (RHEL) 版本 8,您可以使用 RPM 安装 Red Hat OpenShift Pipelines CLI。
先决条件
- 您的红帽帐户必须具有有效的 OpenShift Container Platform 订阅。
- 您在本地系统中有 root 或者 sudo 权限。
流程
使用 Red Hat Subscription Manager 注册:
subscription-manager register
# subscription-manager register
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 获取最新的订阅数据:
subscription-manager refresh
# subscription-manager refresh
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 列出可用的订阅:
subscription-manager list --available --matches '*pipelines*'
# subscription-manager list --available --matches '*pipelines*'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 在上一命令的输出中,找到 OpenShift Container Platform 订阅的池 ID,并把订阅附加到注册的系统:
subscription-manager attach --pool=<pool_id>
# subscription-manager attach --pool=<pool_id>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 启用 Red Hat OpenShift Pipelines 所需的仓库:
Linux (x86_64, amd64)
subscription-manager repos --enable="pipelines-1.18-for-rhel-8-x86_64-rpms"
# subscription-manager repos --enable="pipelines-1.18-for-rhel-8-x86_64-rpms"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Linux on IBM Z® 和 IBM® LinuxONE (s390x)
subscription-manager repos --enable="pipelines-1.18-for-rhel-8-s390x-rpms"
# subscription-manager repos --enable="pipelines-1.18-for-rhel-8-s390x-rpms"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Linux on IBM Power® (ppc64le)
subscription-manager repos --enable="pipelines-1.18-for-rhel-8-ppc64le-rpms"
# subscription-manager repos --enable="pipelines-1.18-for-rhel-8-ppc64le-rpms"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Linux on ARM (aarch64, arm64)
subscription-manager repos --enable="pipelines-1.18-for-rhel-8-aarch64-rpms"
# subscription-manager repos --enable="pipelines-1.18-for-rhel-8-aarch64-rpms"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
安装
openshift-pipelines-client
软件包:yum install openshift-pipelines-client
# yum install openshift-pipelines-client
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
安装 CLI 后,就可以使用tkn
命令:
tkn version
$ tkn version
5.1.3. 在 Windows 上安装 Red Hat OpenShift Pipelines CLI 复制链接链接已复制到粘贴板!
对于 Windows,您可以将 CLI 下载为 zip
存档。
流程
- 下载 CLI 工具。
- 使用 ZIP 程序解压存档。
-
将您的
tkn
,tkn-pac
, 和opc
文件添加到PATH
环境变量中。 要查看您的
PATH
,请运行以下命令:path
C:\> path
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.1.4. 在 macOS 上安装 Red Hat OpenShift Pipelines CLI 复制链接链接已复制到粘贴板!
对于 macOS,您可以将 CLI 下载为 tar.gz
存档。
流程
下载相关的 CLI 工具。
- 解包并提取存档。
-
将您的
tkn
,tkn-pac
, 和opc
文件添加到PATH
环境变量中。 要查看您的
PATH
,请运行以下命令:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.2. 配置 OpenShift Pipelines tkn CLI 复制链接链接已复制到粘贴板!
配置 Red Hat OpenShift Pipelines tkn
CLI 以启用 tab 自动完成功能。
5.2.1. 启用 tab 自动完成功能 复制链接链接已复制到粘贴板!
在安装tkn
CLI,可以启用 tab 自动完成功能,以便在按 Tab 键时自动完成tkn
命令或显示建议选项。
先决条件
-
已安装
tkn
CLI。 -
需要在本地系统中安装了
bash-completion
。
流程
以下过程为 Bash 启用 tab 自动完成功能。
将 Bash 完成代码保存到一个文件中:
tkn completion bash > tkn_bash_completion
$ tkn completion bash > tkn_bash_completion
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将文件复制到
/etc/bash_completion.d/
:sudo cp tkn_bash_completion /etc/bash_completion.d/
$ sudo cp tkn_bash_completion /etc/bash_completion.d/
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 您也可以将文件保存到一个本地目录,并从您的
.bashrc
文件中 source 这个文件。
开新终端时 tab 自动完成功能将被启用。
5.3. OpenShift Pipelines tkn 参考 复制链接链接已复制到粘贴板!
本节列出了基本的 tkn
CLI 命令。
5.3.1. 基本语法 复制链接链接已复制到粘贴板!
tkn [command or options] [arguments…]
5.3.2. 全局选项 复制链接链接已复制到粘贴板!
--help, -h
5.3.3. 工具命令 复制链接链接已复制到粘贴板!
5.3.3.1. tkn 复制链接链接已复制到粘贴板!
tkn
CLI 的主命令。
示例: 显示所有选项
tkn
$ tkn
5.3.3.2. completion [shell] 复制链接链接已复制到粘贴板!
输出 shell 完成代码,必须经过评估方可提供互动完成。支持的 shell 是 bash
和 zsh
。
示例:bash
shell 完成代码
tkn completion bash
$ tkn completion bash
5.3.3.3. version 复制链接链接已复制到粘贴板!
输出 tkn
CLI 的版本信息。
示例: 检查 tkn
版本
tkn version
$ tkn version
5.3.4. Pipelines 管理命令 复制链接链接已复制到粘贴板!
5.3.4.1. pipeline 复制链接链接已复制到粘贴板!
管理管道。
示例: 显示帮助信息
tkn pipeline --help
$ tkn pipeline --help
5.3.4.2. pipeline delete 复制链接链接已复制到粘贴板!
删除管道。
示例:从命名空间中删除 mypipeline
管道
tkn pipeline delete mypipeline -n myspace
$ tkn pipeline delete mypipeline -n myspace
5.3.4.3. pipeline describe 复制链接链接已复制到粘贴板!
描述管道。
示例:描述 mypipeline
管道
tkn pipeline describe mypipeline
$ tkn pipeline describe mypipeline
5.3.4.4. pipeline list 复制链接链接已复制到粘贴板!
显示管道列表。
示例:显示管道列表
tkn pipeline list
$ tkn pipeline list
5.3.4.5. pipeline logs 复制链接链接已复制到粘贴板!
显示特定管道的日志。
示例:将 mypipeline
管道的 live 日志流
tkn pipeline logs -f mypipeline
$ tkn pipeline logs -f mypipeline
5.3.4.6. pipeline start 复制链接链接已复制到粘贴板!
启动管道。
示例:启动 mypipeline
管道
tkn pipeline start mypipeline
$ tkn pipeline start mypipeline
5.3.5. pipeline run 命令 复制链接链接已复制到粘贴板!
5.3.5.1. pipelinerun 复制链接链接已复制到粘贴板!
管理管道运行。
示例: 显示帮助信息
tkn pipelinerun -h
$ tkn pipelinerun -h
5.3.5.2. pipelinerun cancel 复制链接链接已复制到粘贴板!
取消管道运行。
示例:取消从命名空间中运行的 mypipelinerun
管道
tkn pipelinerun cancel mypipelinerun -n myspace
$ tkn pipelinerun cancel mypipelinerun -n myspace
5.3.5.3. pipelinerun delete 复制链接链接已复制到粘贴板!
删除管道运行。
示例:删除管道从命名空间中运行
tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
示例:删除所有管道从命名空间中运行,但最近执行的管道运行除外
tkn pipelinerun delete -n myspace --keep 5
$ tkn pipelinerun delete -n myspace --keep 5
- 1
- 使用您要保留的最新执行的管道运行数量替换
5
。
示例:删除所有管道
tkn pipelinerun delete --all
$ tkn pipelinerun delete --all
从 Red Hat OpenShift Pipelines 1.6 开始,tkn pipelinerun delete --all
命令不会删除处于 running 状态的任何资源。
5.3.5.4. pipelinerun describe 复制链接链接已复制到粘贴板!
描述管道运行。
示例:描述在命名空间中运行的 mypipelinerun
管道
tkn pipelinerun describe mypipelinerun -n myspace
$ tkn pipelinerun describe mypipelinerun -n myspace
5.3.5.5. pipelinerun list 复制链接链接已复制到粘贴板!
列出管道运行。
示例: 显示在命名空间中运行的管道列表
tkn pipelinerun list -n myspace
$ tkn pipelinerun list -n myspace
5.3.5.6. pipelinerun logs 复制链接链接已复制到粘贴板!
显示管道运行的日志。
示例:显示 mypipelinerun
管道运行的日志,其中包含命名空间中的所有任务和步骤
tkn pipelinerun logs mypipelinerun -a -n myspace
$ tkn pipelinerun logs mypipelinerun -a -n myspace
5.3.6. 任务管理命令 复制链接链接已复制到粘贴板!
5.3.6.1. task 复制链接链接已复制到粘贴板!
管理任务。
示例: 显示帮助信息
tkn task -h
$ tkn task -h
5.3.6.2. task delete 复制链接链接已复制到粘贴板!
删除任务。
示例:从命名空间中删除 mytask1
和 mytask2
任务
tkn task delete mytask1 mytask2 -n myspace
$ tkn task delete mytask1 mytask2 -n myspace
5.3.6.3. task describe 复制链接链接已复制到粘贴板!
描述任务。
示例:描述命名空间中的 mytask
任务
tkn task describe mytask -n myspace
$ tkn task describe mytask -n myspace
5.3.6.4. task list 复制链接链接已复制到粘贴板!
列出任务。
示例: 列出命名空间中的所有任务
tkn task list -n myspace
$ tkn task list -n myspace
5.3.6.5. task logs 复制链接链接已复制到粘贴板!
显示任务日志。
示例:显示 mytask
任务的 mytaskrun
任务运行的日志
tkn task logs mytask mytaskrun -n myspace
$ tkn task logs mytask mytaskrun -n myspace
5.3.6.6. task start 复制链接链接已复制到粘贴板!
启动一个任务。
示例: 在命名空间中启动 mytask
任务
tkn task start mytask -s <ServiceAccountName> -n myspace
$ tkn task start mytask -s <ServiceAccountName> -n myspace
5.3.7. task run 命令 复制链接链接已复制到粘贴板!
5.3.7.1. taskrun 复制链接链接已复制到粘贴板!
管理任务运行。
示例: 显示帮助信息
tkn taskrun -h
$ tkn taskrun -h
5.3.7.2. taskrun cancel 复制链接链接已复制到粘贴板!
取消任务运行。
示例:取消从命名空间中运行的 mytaskrun
任务
tkn taskrun cancel mytaskrun -n myspace
$ tkn taskrun cancel mytaskrun -n myspace
5.3.7.3. taskrun delete 复制链接链接已复制到粘贴板!
删除一个 TaskRun。
示例:从命名空间中删除 mytaskrun1
和 mytaskrun2
任务
tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
示例:删除除五个最近执行的任务外从命名空间中运行的所有任务
tkn taskrun delete -n myspace --keep 5
$ tkn taskrun delete -n myspace --keep 5
- 1
- 将
5
替换为您要保留的最新执行任务数量。
5.3.7.4. taskrun describe 复制链接链接已复制到粘贴板!
描述任务运行。
示例:描述在命名空间中运行的 mytaskrun
任务
tkn taskrun describe mytaskrun -n myspace
$ tkn taskrun describe mytaskrun -n myspace
5.3.7.5. taskrun list 复制链接链接已复制到粘贴板!
列出任务运行。
示例:列出所有任务在命名空间中运行
tkn taskrun list -n myspace
$ tkn taskrun list -n myspace
5.3.7.6. taskrun logs 复制链接链接已复制到粘贴板!
显示任务运行日志.
示例:显示在命名空间中运行的 mytaskrun
任务的实时日志
tkn taskrun logs -f mytaskrun -n myspace
$ tkn taskrun logs -f mytaskrun -n myspace
5.3.8. 条件管理命令 复制链接链接已复制到粘贴板!
5.3.8.1. 条件 复制链接链接已复制到粘贴板!
管理条件(Condition)。
示例: 显示帮助信息
tkn condition --help
$ tkn condition --help
5.3.8.2. 删除条件 复制链接链接已复制到粘贴板!
删除一个条件。
示例:从命名空间中删除 mycondition1
Condition
tkn condition delete mycondition1 -n myspace
$ tkn condition delete mycondition1 -n myspace
5.3.8.3. condition describe 复制链接链接已复制到粘贴板!
描述条件。
示例:在命名空间中描述 mycondition1
Condition
tkn condition describe mycondition1 -n myspace
$ tkn condition describe mycondition1 -n myspace
5.3.8.4. condition list 复制链接链接已复制到粘贴板!
列出条件。
示例: 列出命名空间中的条件
tkn condition list -n myspace
$ tkn condition list -n myspace
5.3.9. Pipeline 资源管理命令 复制链接链接已复制到粘贴板!
5.3.9.1. resource 复制链接链接已复制到粘贴板!
管理管道资源。
示例: 显示帮助信息
tkn resource -h
$ tkn resource -h
5.3.9.2. resource create 复制链接链接已复制到粘贴板!
创建一个 Pipeline 资源。
示例: 在命名空间中创建一个 Pipeline 资源
tkn resource create -n myspace
$ tkn resource create -n myspace
这是一个交互式命令,它要求输入资源名称、资源类型以及基于资源类型的值。
5.3.9.3. resource delete 复制链接链接已复制到粘贴板!
删除 Pipeline 资源。
示例:从命名空间中删除 myresource
Pipeline 资源
tkn resource delete myresource -n myspace
$ tkn resource delete myresource -n myspace
5.3.9.4. resource describe 复制链接链接已复制到粘贴板!
描述管道资源。
示例:描述 myresource
Pipeline 资源
tkn resource describe myresource -n myspace
$ tkn resource describe myresource -n myspace
5.3.9.5. resource list 复制链接链接已复制到粘贴板!
列出管道资源。
示例: 列出命名空间中的所有管道资源
tkn resource list -n myspace
$ tkn resource list -n myspace
5.3.10. ClusterTask 管理命令 复制链接链接已复制到粘贴板!
在 Red Hat OpenShift Pipelines 1.10 中,tkn
命令行工具的 ClusterTask 功能已弃用,计划在以后的发行版本中删除。
5.3.10.1. clustertask 复制链接链接已复制到粘贴板!
管理 ClusterTasks。
示例: 显示帮助信息
tkn clustertask --help
$ tkn clustertask --help
5.3.10.2. clustertask delete 复制链接链接已复制到粘贴板!
删除集群中的 ClusterTask 资源。
示例: 删除 mytask1
和 mytask2
ClusterTasks
tkn clustertask delete mytask1 mytask2
$ tkn clustertask delete mytask1 mytask2
5.3.10.3. clustertask describe 复制链接链接已复制到粘贴板!
描述 ClusterTask。
示例: 描述 mytask
ClusterTask
tkn clustertask describe mytask1
$ tkn clustertask describe mytask1
5.3.10.4. clustertask list 复制链接链接已复制到粘贴板!
列出 ClusterTasks。
示例: 列出 ClusterTasks
tkn clustertask list
$ tkn clustertask list
5.3.10.5. clustertask start 复制链接链接已复制到粘贴板!
启动 ClusterTasks。
示例: 启动 mytask
ClusterTask
tkn clustertask start mytask
$ tkn clustertask start mytask
5.3.11. 触发器管理命令 复制链接链接已复制到粘贴板!
5.3.11.1. eventlistener 复制链接链接已复制到粘贴板!
管理 EventListeners。
示例: 显示帮助信息
tkn eventlistener -h
$ tkn eventlistener -h
5.3.11.2. eventlistener delete 复制链接链接已复制到粘贴板!
删除一个 EventListener。
示例:删除命令空间中的 mylistener1
和 mylistener2
EventListeners
tkn eventlistener delete mylistener1 mylistener2 -n myspace
$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
5.3.11.3. eventlistener describe 复制链接链接已复制到粘贴板!
描述 EventListener。
示例:描述命名空间中的 mylistener
EventListener
tkn eventlistener describe mylistener -n myspace
$ tkn eventlistener describe mylistener -n myspace
5.3.11.4. eventlistener list 复制链接链接已复制到粘贴板!
列出 EventListeners。
示例: 列出命名空间中的所有 EventListeners
tkn eventlistener list -n myspace
$ tkn eventlistener list -n myspace
5.3.11.5. eventListener 日志 复制链接链接已复制到粘贴板!
显示 EventListener 的日志。
示例: 在一个命名空间中显示 mylistener
EventListener 的日志
tkn eventlistener logs mylistener -n myspace
$ tkn eventlistener logs mylistener -n myspace
5.3.11.6. triggerbinding 复制链接链接已复制到粘贴板!
管理 TriggerBindings。
示例: 显示 TriggerBindings 帮助信息
tkn triggerbinding -h
$ tkn triggerbinding -h
5.3.11.7. triggerbinding delete 复制链接链接已复制到粘贴板!
删除 TriggerBinding。
示例:删除一个命名空间中的 mybinding1
和 mybinding2
TriggerBindings
tkn triggerbinding delete mybinding1 mybinding2 -n myspace
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
5.3.11.8. triggerbinding describe 复制链接链接已复制到粘贴板!
描述 TriggerBinding。
示例:描述命名空间中的 mybinding
TriggerBinding
tkn triggerbinding describe mybinding -n myspace
$ tkn triggerbinding describe mybinding -n myspace
5.3.11.9. triggerbinding list 复制链接链接已复制到粘贴板!
列出 TriggerBindings。
示例: 列出命名空间中的所有 TriggerBindings
tkn triggerbinding list -n myspace
$ tkn triggerbinding list -n myspace
5.3.11.10. triggertemplate 复制链接链接已复制到粘贴板!
管理 TriggerTemplates。
示例: 显示 TriggerTemplate 帮助
tkn triggertemplate -h
$ tkn triggertemplate -h
5.3.11.11. triggertemplate delete 复制链接链接已复制到粘贴板!
删除 TriggerTemplate。
示例:删除命名空间中的 mytemplate1
和 mytemplate2
TriggerTemplates
tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
5.3.11.12. triggertemplate describe 复制链接链接已复制到粘贴板!
描述 TriggerTemplate。
示例: 描述命名空间中的 mytemplate
TriggerTemplate
tkn triggertemplate describe mytemplate -n `myspace`
$ tkn triggertemplate describe mytemplate -n `myspace`
5.3.11.13. triggertemplate list 复制链接链接已复制到粘贴板!
列出 TriggerTemplates。
示例: 列出命名空间中的所有 TriggerTemplates
tkn triggertemplate list -n myspace
$ tkn triggertemplate list -n myspace
5.3.11.14. clustertriggerbinding 复制链接链接已复制到粘贴板!
管理 ClusterTriggerBindings。
示例: 显示 ClusterTriggerBindings 帮助信息
tkn clustertriggerbinding -h
$ tkn clustertriggerbinding -h
5.3.11.15. clustertriggerbinding delete 复制链接链接已复制到粘贴板!
删除 ClusterTriggerBinding。
示例: 删除 myclusterbinding1
和 myclusterbinding2
ClusterTriggerBindings
tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
5.3.11.16. clustertriggerbinding describe 复制链接链接已复制到粘贴板!
描述 ClusterTriggerBinding。
示例: 描述 myclusterbinding
ClusterTriggerBinding
tkn clustertriggerbinding describe myclusterbinding
$ tkn clustertriggerbinding describe myclusterbinding
5.3.11.17. clustertriggerbinding list 复制链接链接已复制到粘贴板!
列出 ClusterTriggerBindings。
示例: 列出所有 ClusterTriggerBindings
tkn clustertriggerbinding list
$ tkn clustertriggerbinding list
5.3.12. hub 互动命令 复制链接链接已复制到粘贴板!
与 Tekton Hub 交互,以获取任务和管道等资源。
5.3.12.1. hub 复制链接链接已复制到粘贴板!
与 hub 交互。
示例: 显示帮助信息
tkn hub -h
$ tkn hub -h
示例:与 hub API 服务器交互
tkn hub --api-server https://api.hub.tekton.dev
$ tkn hub --api-server https://api.hub.tekton.dev
对于每个示例,若要获取对应的子命令和标记,请运行 tkn hub <command> --help
。
5.3.12.2. hub downgrade 复制链接链接已复制到粘贴板!
对一个安装的资源进行降级。
示例:将 mynamespace
命名空间中的 mytask
任务降级到它的较旧版本
tkn hub downgrade task mytask --to version -n mynamespace
$ tkn hub downgrade task mytask --to version -n mynamespace
5.3.12.3. hub get 复制链接链接已复制到粘贴板!
按名称、类型、目录和版本获取资源清单。
示例:从 tekton
目录中获取 myresource
管道或任务的特定版本的清单
tkn hub get [pipeline | task] myresource --from tekton --version version
$ tkn hub get [pipeline | task] myresource --from tekton --version version
5.3.12.4. hub info 复制链接链接已复制到粘贴板!
按名称、类型、目录和版本显示资源的信息。
示例:显示 tekton
目录中有关 mytask
任务的特定版本的信息
tkn hub info task mytask --from tekton --version version
$ tkn hub info task mytask --from tekton --version version
5.3.12.5. hub install 复制链接链接已复制到粘贴板!
按类型、名称和版本从目录安装资源。
示例:从 mynamespace
命名空间中的 tekton
目录安装 mytask
任务的特定版本
tkn hub install task mytask --from tekton --version version -n mynamespace
$ tkn hub install task mytask --from tekton --version version -n mynamespace
5.3.12.6. hub reinstall 复制链接链接已复制到粘贴板!
按类型和名称重新安装资源。
示例:从 mynamespace
命名空间中的 tekton
目录重新安装 mytask
任务的特定版本
tkn hub reinstall task mytask --from tekton --version version -n mynamespace
$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace
5.3.12.7. hub search 复制链接链接已复制到粘贴板!
按名称、类型和标签组合搜索资源。
示例:搜索带有标签 cli
的资源
tkn hub search --tags cli
$ tkn hub search --tags cli
5.3.12.8. hub upgrade 复制链接链接已复制到粘贴板!
升级已安装的资源。
示例:将 mynamespace
命名空间中安装的 mytask
任务升级到新版本
tkn hub upgrade task mytask --to version -n mynamespace
$ tkn hub upgrade task mytask --to version -n mynamespace
第 6 章 用于 Red Hat OpenShift GitOps 的 GitOps CLI 复制链接链接已复制到粘贴板!
GitOps argocd
CLI 是一个从终端配置和管理 Red Hat OpenShift GitOps 和 Argo CD 资源的工具。
使用 GitOps CLI,您可以使 GitOps 计算任务简单而简洁。您可以在不同的平台上安装此 CLI 工具。
6.1. 安装 GitOps CLI 复制链接链接已复制到粘贴板!
请参阅安装 GitOps CLI。
第 7 章 opm CLI 复制链接链接已复制到粘贴板!
7.1. 安装 opm CLI 复制链接链接已复制到粘贴板!
7.1.1. 关于 opm CLI 复制链接链接已复制到粘贴板!
opm
CLI 工具由 Operator Framework 提供,用于 Operator 捆绑格式。您可以通过此工具从与软件存储库类似的 Operator 捆绑包列表中创建和维护 Operator 目录。其结果是一个容器镜像,它可以存储在容器的 registry 中,然后安装到集群中。
目录包含一个指向 Operator 清单内容的指针数据库,可通过在运行容器镜像时提供的已包含 API 进行查询。在 OpenShift Container Platform 中,Operator Lifecycle Manager (OLM) 可以引用由 CatalogSource
对象定义的目录源中的镜像,它会定期轮询镜像,以对集群上安装的 Operator 进行更新。
7.1.2. 安装 opm CLI 复制链接链接已复制到粘贴板!
您可以在您的 Linux、macOS 或者 Windows 工作站上安装 opm
CLI 工具。
先决条件
对于 Linux,您必须提供以下软件包:RHEL 8 满足以下要求:
-
podman
1.9.3+(推荐版本 2.0+) -
glibc
版本 2.28+
-
流程
- 进入到 OpenShift 镜像站点并下载与您的操作系统匹配的 tarball 的最新版本。
解包存档。
对于 Linux 或者 macOS:
tar xvf <file>
$ tar xvf <file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 对于 Windows,使用 ZIP 程序解压存档。
将文件放在
PATH
中的任何位置。对于 Linux 或者 macOS:
检查
PATH
:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 移动文件。例如:
sudo mv ./opm /usr/local/bin/
$ sudo mv ./opm /usr/local/bin/
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
对于 Windows:
检查
PATH
:path
C:\> path
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 移动文件:
move opm.exe <directory>
C:\> move opm.exe <directory>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
安装
opm
CLI 后,验证是否可用:opm version
$ opm version
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.2. opm CLI 参考 复制链接链接已复制到粘贴板!
opm
命令行界面 (CLI) 是用于创建和维护 Operator 目录的工具。
opm
CLI 语法
opm <command> [<subcommand>] [<argument>] [<flags>]
$ opm <command> [<subcommand>] [<argument>] [<flags>]
opm
CLI 不是转发兼容。用于生成目录内容的 opm
CLI 版本必须早于或等于用于在集群中提供内容的版本。
标记 | 描述 |
---|---|
| 在拉取捆绑包或索引时跳过容器镜像 registry 的 TLS 证书验证。 |
| 在拉取捆绑包时,将普通 HTTP 用于容器镜像 registry。 |
基于 SQLite 的目录格式(包括相关的 CLI 命令)是一个弃用的功能。弃用的功能仍然包含在 OpenShift Container Platform 中,并将继续被支持。但是,这个功能会在以后的发行版本中被删除,且不建议在新的部署中使用。
有关 OpenShift Container Platform 中已弃用或删除的主要功能的最新列表,请参阅 OpenShift Container Platform 发行注记中已弃用和删除的功能部分。
7.2.1. generate 复制链接链接已复制到粘贴板!
为声明性配置索引生成各种工件。
命令语法
opm generate <subcommand> [<flags>]
$ opm generate <subcommand> [<flags>]
子命令 | 描述 |
---|---|
| 为声明性配置索引生成 Dockerfile。 |
标记 | 描述 |
---|---|
| 生成帮助信息。 |
7.2.1.1. dockerfile 复制链接链接已复制到粘贴板!
为声明性配置索引生成 Dockerfile。
此命令在与 <dcRootDir>
(名为 <dcDirName>.Dockerfile
)相同的目录中创建 Dockerfile,用于构建索引。如果存在具有相同名称的 Dockerfile,这个命令会失败。
当指定额外标签时,如果存在重复的键,则只有每个重复键的最后值都会添加到生成的 Dockerfile 中。
命令语法
opm generate dockerfile <dcRootDir> [<flags>]
$ opm generate dockerfile <dcRootDir> [<flags>]
标记 | 描述 |
---|---|
|
要构建目录的镜像。默认值为 |
|
生成的 Dockerfile 中包含的额外标签。标签的格式为 |
| Dockerfile 帮助。 |
要使用官方红帽镜像构建,请使用带有 -i
标志的 registry.redhat.io/openshift4/ose-operator-registry-rhel9:v4.16
值。
7.2.2. index 复制链接链接已复制到粘贴板!
从预先存在的 Operator 捆绑包中为 SQLite 数据库格式容器镜像生成 Operator 索引。
从 OpenShift Container Platform 4.11 开始,默认的红帽提供的 Operator 目录以基于文件的目录格式发布。通过以过时的 SQLite 数据库格式发布的 4.10,用于 OpenShift Container Platform 4.6 的默认红帽提供的 Operator 目录。
与 SQLite 数据库格式相关的 opm
子命令、标志和功能已被弃用,并将在以后的版本中删除。功能仍被支持,且必须用于使用已弃用的 SQLite 数据库格式的目录。
许多 opm
子命令和标志都用于 SQLite 数据库格式,如 opm index prune
,它们无法使用基于文件的目录格式。
有关使用基于文件的目录的更多信息,请参阅"添加资源"。
命令语法
opm index <subcommand> [<flags>]
$ opm index <subcommand> [<flags>]
子命令 | 描述 |
---|---|
| 将 Operator 捆绑包添加到索引中。 |
| 修剪除指定软件包以外的所有索引。 |
| 修剪没有与特定镜像关联的分级捆绑包索引。 |
| 从索引中删除整个 Operator。 |
7.2.2.1. add 复制链接链接已复制到粘贴板!
将 Operator 捆绑包添加到索引中。
命令语法
opm index add [<flags>]
$ opm index add [<flags>]
标记 | 描述 |
---|---|
|
on-image |
|
构建容器镜像的工具: |
| 要添加的捆绑包的逗号分隔列表。 |
|
与容器镜像交互的工具,如保存和构建: |
| 要添加到的上一个索引。 |
| 如果启用,则仅创建 Dockerfile 并将其保存到本地磁盘。 |
|
图形更新模式,用来定义通频道图形如何被更新: |
| 可选:如果生成 Dockerfile,请指定一个文件名。 |
| 允许 registry 加载错误。 |
|
拉取容器镜像的工具: |
| 正在构建的容器镜像的自定义标签。 |
7.2.2.2. prune 复制链接链接已复制到粘贴板!
修剪除指定软件包以外的所有索引。
命令语法
opm index prune [<flags>]
$ opm index prune [<flags>]
标记 | 描述 |
---|---|
|
on-image |
|
与容器镜像交互的工具,如保存和构建: |
| 到修剪的索引。 |
| 如果启用,则仅创建 Dockerfile 并将其保存到本地磁盘。 |
| 可选:如果生成 Dockerfile,请指定一个文件名。 |
| 要保留的软件包用逗号隔开。 |
| 允许 registry 加载错误。 |
| 正在构建的容器镜像的自定义标签。 |
7.2.2.3. prune-stranded 复制链接链接已复制到粘贴板!
修剪没有与特定镜像关联的分级捆绑包索引。
命令语法
opm index prune-stranded [<flags>]
$ opm index prune-stranded [<flags>]
标记 | 描述 |
---|---|
|
on-image |
|
与容器镜像交互的工具,如保存和构建: |
| 到修剪的索引。 |
| 如果启用,则仅创建 Dockerfile 并将其保存到本地磁盘。 |
| 可选:如果生成 Dockerfile,请指定一个文件名。 |
| 要保留的软件包用逗号隔开。 |
| 允许 registry 加载错误。 |
| 正在构建的容器镜像的自定义标签。 |
7.2.2.4. rm 复制链接链接已复制到粘贴板!
从索引中删除整个 Operator。
命令语法
opm index rm [<flags>]
$ opm index rm [<flags>]
标记 | 描述 |
---|---|
|
on-image |
|
构建容器镜像的工具: |
|
与容器镜像交互的工具,如保存和构建: |
| 从中删除的以前索引。 |
| 如果启用,则仅创建 Dockerfile 并将其保存到本地磁盘。 |
| 要删除的用逗号分开的 Operator 列表。 |
| 可选:如果生成 Dockerfile,请指定一个文件名。 |
| 要保留的软件包用逗号隔开。 |
| 允许 registry 加载错误。 |
|
拉取容器镜像的工具: |
| 正在构建的容器镜像的自定义标签。 |
7.2.3. init 复制链接链接已复制到粘贴板!
生成 olm.package
声明性配置 blob。
命令语法
opm init <package_name> [<flags>]
$ opm init <package_name> [<flags>]
标记 | 描述 |
---|---|
| 如果未指定,订阅的频道将默认为。 |
|
Operator 的 |
| 软件包图标的路径. |
|
输出格式: |
7.2.4. migrate 复制链接链接已复制到粘贴板!
将 SQLite 数据库格式索引镜像或数据库文件迁移到基于文件的目录。
基于 SQLite 的目录格式(包括相关的 CLI 命令)是一个弃用的功能。弃用的功能仍然包含在 OpenShift Container Platform 中,并将继续被支持。但是,这个功能会在以后的发行版本中被删除,且不建议在新的部署中使用。
有关 OpenShift Container Platform 中已弃用或删除的主要功能的最新列表,请参阅 OpenShift Container Platform 发行注记中已弃用和删除的功能部分。
命令语法
opm migrate <index_ref> <output_dir> [<flags>]
$ opm migrate <index_ref> <output_dir> [<flags>]
标记 | 描述 |
---|---|
|
输出格式: |
7.2.5. render 复制链接链接已复制到粘贴板!
从提供的索引镜像、捆绑包镜像和 SQLite 数据库文件生成声明性配置 blob。
命令语法
opm render <index_image | bundle_image | sqlite_file> [<flags>]
$ opm render <index_image | bundle_image | sqlite_file> [<flags>]
标记 | 描述 |
---|---|
|
输出格式: |
7.2.6. serve 复制链接链接已复制到粘贴板!
通过 GRPC 服务器提供声明配置。
声明性配置目录在启动时由 serving
命令加载。此命令启动后对声明配置所做的更改不会反映在提供的内容中。
命令语法
opm serve <source_path> [<flags>]
$ opm serve <source_path> [<flags>]
标记 | 描述 |
---|---|
| 如果设置了此标志,它会同步并保留服务器缓存目录。 |
|
如果缓存不存在或无效,则退出并显示错误。当设置了 |
| 同步服务缓存,并在没有服务的情况下退出。 |
| 启用调试日志记录。 |
| 服务帮助。 |
|
服务的端口号。默认值为 |
|
启动性能分析端点的地址。格式为 |
|
容器终止日志文件的路径。默认值为 |
7.2.7. validate 复制链接链接已复制到粘贴板!
验证给定目录中声明性配置 JSON 文件。
命令语法
opm validate <directory> [<flags>]
$ opm validate <directory> [<flags>]
第 8 章 Operator SDK 复制链接链接已复制到粘贴板!
8.1. 安装 Operator SDK CLI 复制链接链接已复制到粘贴板!
Operator SDK 提供了一个命令行界面(CLI)工具,Operator 开发人员可使用它来构建、测试和部署 Operator。您可以在工作站上安装 Operator SDK CLI,以便准备开始编写自己的 Operator。
红帽支持的 Operator SDK CLI 工具版本(包括 Operator 项目的相关构建和测试工具)已被弃用,计划在以后的 OpenShift Container Platform 发行版本中删除。红帽将在当前发行生命周期中提供对这个功能的程序错误修复和支持,但此功能将不再获得改进,并将在以后的 OpenShift Container Platform 版本中删除。
对于创建新 Operator 项目,不建议使用红帽支持的 Operator SDK 版本。现有 Operator 项目的 Operator 作者可以使用 OpenShift Container Platform 4.16 发布的 Operator SDK CLI 工具版本来维护其项目,并创建针对较新版本的 OpenShift Container Platform 的 Operator 发行版本。
以下与 Operator 项目相关的基础镜像 没有被弃用。这些基础镜像的运行时功能和配置 API 仍然会有程序错误修复和并提供对相关 CVE 的解决方案。
- 基于 Ansible 的 Operator 项目的基础镜像
- 基于 Helm 的 Operator 项目的基础镜像
有关 OpenShift Container Platform 中已弃用或删除的主要功能的最新列表,请参阅 OpenShift Container Platform 发行注记中已弃用和删除的功能部分。
有关 Operator SDK 不支持的、社区维护版本的信息,请参阅 Operator SDK (Operator Framework)。
具有集群管理员访问权限的 operator 作者(如 OpenShift Container Platform)可以使用 Operator SDK CLI 根据 Go、Ansible、Java 或 Helm 开发自己的 Operator。Kubebuilder 作为基于 Go 的 Operator 的构建解决方案嵌入到 Operator SDK 中,这意味着现有的 Kubebuilder 项目可以象 Operator SDK 一样使用并继续工作。如需有关 Operator SDK 的完整文档,请参阅 Operators。
OpenShift Container Platform 4.16 支持 Operator SDK 1.36.1。
8.1.1. 在 Linux 上安装 Operator SDK CLI 复制链接链接已复制到粘贴板!
您可以在 Linux 上安装 OpenShift SDK CLI 工具。
先决条件
- Go v1.19+
-
docker
v17.03+、podman
v1.9.3+ 或buildah
v1.7+
流程
- 进入到 OpenShift 镜像站点。
- 从最新的 4.16 目录中,下载适用于 Linux 的 tarball 的最新版本。
解包存档:
tar xvf operator-sdk-v1.36.1-ocp-linux-x86_64.tar.gz
$ tar xvf operator-sdk-v1.36.1-ocp-linux-x86_64.tar.gz
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 使文件可执行:
chmod +x operator-sdk
$ chmod +x operator-sdk
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将提取的
operator-sdk
二进制文件移到PATH
中的一个目录中。提示检查
PATH
:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow sudo mv ./operator-sdk /usr/local/bin/operator-sdk
$ sudo mv ./operator-sdk /usr/local/bin/operator-sdk
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
安装 Operator SDK CLI 后,验证它是否可用:
operator-sdk version
$ operator-sdk version
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输出示例
operator-sdk version: "v1.36.1-ocp", ...
operator-sdk version: "v1.36.1-ocp", ...
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
8.1.2. 在 macOS 上安装 Operator SDK CLI 复制链接链接已复制到粘贴板!
您可以在 macOS 上安装 OpenShift SDK CLI 工具。
先决条件
- Go v1.19+
-
docker
v17.03+、podman
v1.9.3+ 或buildah
v1.7+
流程
-
对于
amd64
和arm64
架构,分别进入amd64
集成架构的 OpenShift 镜像站点和arm64
基础架构的 OpenShift 镜像站点。 - 从最新的 4.16 目录中,下载 macOS 的 tarball 的最新版本。
运行以下命令,为
amd64
架构解包 Operator SDK 归档:tar xvf operator-sdk-v1.36.1-ocp-darwin-x86_64.tar.gz
$ tar xvf operator-sdk-v1.36.1-ocp-darwin-x86_64.tar.gz
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 运行以下命令,为
arm64
架构解包 Operator SDK 归档:tar xvf operator-sdk-v1.36.1-ocp-darwin-aarch64.tar.gz
$ tar xvf operator-sdk-v1.36.1-ocp-darwin-aarch64.tar.gz
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 运行以下命令使文件可执行:
chmod +x operator-sdk
$ chmod +x operator-sdk
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 运行以下命令,将提取的
operator-sdk
二进制文件移到PATH
上的目录中:提示运行以下命令检查
PATH
:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow sudo mv ./operator-sdk /usr/local/bin/operator-sdk
$ sudo mv ./operator-sdk /usr/local/bin/operator-sdk
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
安装 Operator SDK CLI 后,运行以下命令验证是否可用:
operator-sdk version
$ operator-sdk version
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输出示例
operator-sdk version: "v1.36.1-ocp", ...
operator-sdk version: "v1.36.1-ocp", ...
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
8.2. Operator SDK CLI 参考 复制链接链接已复制到粘贴板!
Operator SDK 命令行界面(CLI)是一个开发组件,旨在更轻松地编写 Operator。
红帽支持的 Operator SDK CLI 工具版本(包括 Operator 项目的相关构建和测试工具)已被弃用,计划在以后的 OpenShift Container Platform 发行版本中删除。红帽将在当前发行生命周期中提供对这个功能的程序错误修复和支持,但此功能将不再获得改进,并将在以后的 OpenShift Container Platform 版本中删除。
对于创建新 Operator 项目,不建议使用红帽支持的 Operator SDK 版本。现有 Operator 项目的 Operator 作者可以使用 OpenShift Container Platform 4.16 发布的 Operator SDK CLI 工具版本来维护其项目,并创建针对较新版本的 OpenShift Container Platform 的 Operator 发行版本。
以下与 Operator 项目相关的基础镜像 没有被弃用。这些基础镜像的运行时功能和配置 API 仍然会有程序错误修复和并提供对相关 CVE 的解决方案。
- 基于 Ansible 的 Operator 项目的基础镜像
- 基于 Helm 的 Operator 项目的基础镜像
有关 OpenShift Container Platform 中已弃用或删除的主要功能的最新列表,请参阅 OpenShift Container Platform 发行注记中已弃用和删除的功能部分。
有关 Operator SDK 不支持的、社区维护版本的信息,请参阅 Operator SDK (Operator Framework)。
operator SDK CLI 语法
operator-sdk <command> [<subcommand>] [<argument>] [<flags>]
$ operator-sdk <command> [<subcommand>] [<argument>] [<flags>]
如需有关 Operator SDK 的完整文档,请参阅 Operators。
8.2.1. bundle 复制链接链接已复制到粘贴板!
operator-sdk bundle
命令管理 Operator 捆绑包元数据。
8.2.1.1. validate 复制链接链接已复制到粘贴板!
bundle validate
子命令会验证 Operator 捆绑包。
标记 | 描述 |
---|---|
|
|
|
拉取和解包捆绑包镜像的工具。仅在验证捆绑包镜像时使用。可用选项是 |
| 列出所有可用的可选验证器。设置后,不会运行验证器。 |
|
选择要运行的可选验证器的标签选择器。当使用 |
8.2.2. cleanup 复制链接链接已复制到粘贴板!
operator-sdk cleanup
命令会销毁并删除为通过 run
命令部署的 Operator 创建的资源。
标记 | 描述 |
---|---|
|
|
|
用于 CLI 请求的 |
| 如果存在,代表在其中运行 CLI 请求的命名空间。 |
|
失败前,等待命令完成的时间。默认值为 |
8.2.3. completion 复制链接链接已复制到粘贴板!
operator-sdk completion
命令生成 shell completion,以便更迅速、更轻松地发出 CLI 命令。
子命令 | 描述 |
---|---|
| 生成 bash completion。 |
| 生成 zsh completion。 |
标记 | 描述 |
---|---|
| 使用方法帮助输出。 |
例如:
operator-sdk completion bash
$ operator-sdk completion bash
输出示例
bash completion for operator-sdk -*- shell-script -*- ex: ts=4 sw=4 et filetype=sh
# bash completion for operator-sdk -*- shell-script -*-
...
# ex: ts=4 sw=4 et filetype=sh
8.2.4. create 复制链接链接已复制到粘贴板!
operator-sdk create
命令用于创建或 scaffold Kubernetes API。
8.2.4.1. api 复制链接链接已复制到粘贴板!
create api
子命令构建 Kubernetes API。子命令必须在 init
命令初始化的项目中运行。
标记 | 描述 |
---|---|
|
|
8.2.5. generate 复制链接链接已复制到粘贴板!
operator-sdk generate
命令调用特定的生成器来生成代码或清单。
8.2.5.1. bundle 复制链接链接已复制到粘贴板!
generate bundle
子命令为您的 Operator 项目生成一组捆绑包清单、元数据和 bundle.Dockerfile
文件。
通常,您首先运行 generate kustomize manifests
子命令来生成由 generate bundle
子命令使用的输入 Kustomize 基础。但是,您可以使用初始项目中的 make bundle
命令按顺序自动运行这些命令。
标记 | 描述 |
---|---|
|
捆绑包所属频道的以逗号分隔的列表。默认值为 |
|
|
| 捆绑包的默认频道。 |
|
Operator 清单的根目录,如部署和 RBAC。这个目录与传递给 |
|
|
|
从中读取现有捆绑包的目录。这个目录是捆绑包 |
|
包含 Kustomize 基础的目录以及用于捆绑包清单的 |
| 生成捆绑包清单。 |
| 生成捆绑包元数据和 Dockerfile。 |
| 将捆绑包写入的目录。 |
|
如果捆绑包元数据和 Dockerfile 存在,则覆盖它们。默认值为 |
| 捆绑包的软件包名称。 |
| 在静默模式下运行。 |
| 将捆绑包清单写入标准输出。 |
| 生成的捆绑包中的 Operator 语义版本。仅在创建新捆绑包或升级 Operator 时设置。 |
8.2.5.2. kustomize 复制链接链接已复制到粘贴板!
generate kustomize
子命令包含为 Operator 生成 Kustomize 数据的子命令。
8.2.5.2.1. 清单 复制链接链接已复制到粘贴板!
generate kustomize manifests
子命令生成或重新生成 Kustomize 基础以及 config/manifests
目录中的 kustomization.yaml
文件,用于其他 Operator SDK 命令构建捆绑包清单。在默认情况下,这个命令会以互动方式询问 UI 元数据,即清单基础的重要组件,除非基础已存在或设置了 --interactive=false
标志。
标记 | 描述 |
---|---|
| API 类型定义的根目录。 |
|
|
| 包含现有 Kustomize 文件的目录。 |
|
当设置为 |
| 写入 Kustomize 文件的目录。 |
| 软件包名称。 |
| 在静默模式下运行。 |
8.2.6. init 复制链接链接已复制到粘贴板!
operator-sdk init
命令初始化 Operator 项目,并为给定插件生成或 scaffolds 默认项目目录布局。
这个命令会写入以下文件:
- boilerplate 许可证文件
-
带有域和库的
PROJECT
文件 -
构建项目的
Makefile
-
go.mod
文件带有项目依赖项 -
用于自定义清单的
kustomization.yaml
文件 - 用于为管理器清单自定义镜像的补丁文件
- 启用 Prometheus 指标的补丁文件
-
运行的
main.go
文件
标记 | 描述 |
---|---|
|
|
|
插件的名称和可选版本,用于初始化项目。可用插件包括 |
|
项目版本。可用值为 |
8.2.7. run 复制链接链接已复制到粘贴板!
operator-sdk run
命令提供可在各种环境中启动 Operator 的选项。
8.2.7.1. bundle 复制链接链接已复制到粘贴板!
run bundle
子命令使用 Operator Lifecycle Manager(OLM)以捆绑包格式部署 Operator。
标记 | 描述 |
---|---|
|
在其中注入捆绑包的索引镜像。默认镜像为 |
|
安装 Operator 的集群服务版本(CSV)支持的模式,如 |
|
安装超时。默认值为 |
|
用于 CLI 请求的 |
| 如果存在,代表在其中运行 CLI 请求的命名空间。 |
|
指定用于目录 pod 的安全上下文。允许的值包括 |
|
|
-
restricted
安全上下文与default
命名空间不兼容。要在生产环境中配置 Operator 的 pod 安全准入,请参阅"Complying with pod 安全准入"。如需有关 pod 安全准入的更多信息,请参阅"了解和管理 pod 安全准入"。
8.2.7.2. bundle-upgrade 复制链接链接已复制到粘贴板!
run bundle-upgrade
子命令升级之前使用 Operator Lifecycle Manager(OLM)以捆绑包格式安装的 Operator。
标记 | 描述 |
---|---|
|
升级超时。默认值为 |
|
用于 CLI 请求的 |
| 如果存在,代表在其中运行 CLI 请求的命名空间。 |
|
指定用于目录 pod 的安全上下文。允许的值包括 |
|
|
-
restricted
安全上下文与default
命名空间不兼容。要在生产环境中配置 Operator 的 pod 安全准入,请参阅"Complying with pod 安全准入"。如需有关 pod 安全准入的更多信息,请参阅"了解和管理 pod 安全准入"。
8.2.8. scorecard 复制链接链接已复制到粘贴板!
operator-sdk scorecard
命令运行 scorecard 工具来验证 Operator 捆绑包并提供改进建议。该命令使用一个参数,可以是捆绑包镜像,也可以是包含清单和元数据的目录。如果参数包含镜像标签,则镜像必须远程存在。
标记 | 描述 |
---|---|
|
scorecard 配置文件的路径。默认路径为 |
|
|
|
|
| 列出哪些测试可以运行。 |
| 运行测试镜像的命名空间。 |
|
结果的输出格式。可用值为 |
|
使用指定安全上下文运行 scorecard 的选项。允许的值包括 |
| 标识选择器以确定要运行哪个测试。 |
|
用于测试的服务帐户。默认值为 |
| 运行测试后禁用资源清理。 |
|
等待测试完成的时间,如 |
-
restricted
安全上下文与default
命名空间不兼容。要在生产环境中配置 Operator 的 pod 安全准入,请参阅"Complying with pod 安全准入"。如需有关 pod 安全准入的更多信息,请参阅"了解和管理 pod 安全准入"。
Legal Notice
复制链接链接已复制到粘贴板!
Copyright © 2025 Red Hat
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.