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.9 中的所有命令。下载并安装新版本的 oc
。
在 Linux 上安装 OpenShift CLI
您可以按照以下流程在 Linux 上安装 OpenShift CLI(oc
)二进制文件。
流程
- 导航到红帽客户门户网站上的 OpenShift Container Platform 下载页面。
- 在 Version 下拉菜单中选择相应的版本。
- 单击 OpenShift v4.9 Linux 客户端 条目旁边的 Download Now,再保存文件。
解包存档:
$ tar xvf <file>
将
oc
二进制文件放到PATH 中的目录中
。要查看您的
PATH
,请执行以下命令:$ echo $PATH
安装 OpenShift CLI 后,可以使用 oc
命令:
$ oc <command>
在 Windows 上安装 OpenShift CLI
您可以按照以下流程在 Windows 上安装 OpenShift CLI(oc
)二进制文件。
流程
- 导航到红帽客户门户网站上的 OpenShift Container Platform 下载页面。
- 在 Version 下拉菜单中选择相应的版本。
- 单击 OpenShift v4.9 Windows 客户端 条目旁边的 Download Now,再保存文件。
- 使用 ZIP 程序解压存档。
将
oc
二进制文件移到PATH 中的目录中
。要查看您的
PATH
,请打开命令提示并执行以下命令:C:\> path
安装 OpenShift CLI 后,可以使用 oc
命令:
C:\> oc <command>
在 macOS 上安装 OpenShift CLI
您可以按照以下流程在 macOS 上安装 OpenShift CLI(oc
)二进制文件。
流程
- 导航到红帽客户门户网站上的 OpenShift Container Platform 下载页面。
- 在 Version 下拉菜单中选择相应的版本。
- 单击 OpenShift v4.9 MacOSX Client 条目旁边的 Download Now,再保存文件。
- 解包和解压存档。
将
oc
二进制文件移到 PATH 的目录中。要查看您的
PATH
,请打开终端并执行以下命令:$ echo $PATH
安装 OpenShift CLI 后,可以使用 oc
命令:
$ oc <command>
2.1.2.2. 使用 Web 控制台安装 OpenShift CLI
您可以安装 OpenShift CLI(oc
)来通过 Web 控制台与 OpenShift Container Platform 进行交互。您可以在 Linux、Windows 或 macOS 上安装 oc
。
如果安装了旧版本的 oc
,则无法使用 OpenShift Container Platform 4.9 中的所有命令。下载并安装新版本的 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>
将
oc
二进制文件移到PATH 中的目录中
。要查看您的
PATH
,请执行以下命令:$ echo $PATH
安装 OpenShift CLI 后,可以使用 oc
命令:
$ oc <command>
2.1.2.2.2. 使用 Web 控制台在 Windows 上安装 OpenShift CLI
您可以按照以下流程在 Winndows 上安装 OpenShift CLI(oc
)二进制文件。
流程
从 Web 控制台,单击 ?。
单击 Command Line Tools。
-
为 Windows 平台选择
oc
二进制文件,然后单击 Download oc for Windows for x86_64。 - 保存该文件。
- 使用 ZIP 程序解压存档。
将
oc
二进制文件移到PATH 中的目录中
。要查看您的
PATH
,请打开命令提示并执行以下命令:C:\> path
安装 OpenShift CLI 后,可以使用 oc
命令:
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。 - 保存该文件。
- 解包和解压存档。
将
oc
二进制文件移到 PATH 的目录中。要查看您的
PATH
,请打开终端并执行以下命令:$ echo $PATH
安装 OpenShift CLI 后,可以使用 oc
命令:
$ oc <command>
2.1.2.3. 使用 RPM 安装 OpenShift CLI
对于 Red Hat Enterprise Linux (RHEL),如果您的红帽帐户中包括有效的 OpenShift Container Platform 订阅,则可将通过 RPM 安装 OpenShift CLI (oc
)。
先决条件
- 必须具有 root 或 sudo 权限。
流程
使用 Red Hat Subscription Manager 注册:
# subscription-manager register
获取最新的订阅数据:
# subscription-manager refresh
列出可用的订阅:
# subscription-manager list --available --matches '*OpenShift*'
在上一命令的输出中,找到 OpenShift Container Platform 订阅的池 ID,并把订阅附加到注册的系统:
# subscription-manager attach --pool=<pool_id>
启用 OpenShift Container Platform 4.9 所需的存储库。
Red Hat Enterprise Linux 8:
# subscription-manager repos --enable="rhocp-4.9-for-rhel-8-x86_64-rpms"
Red Hat Enterprise Linux 7:
# subscription-manager repos --enable="rhel-7-server-ose-4.9-rpms"
安装
openshift-clients
软件包:# yum install openshift-clients
安装 CLI 后,就可以使用oc
命令:
$ oc <command>
2.1.2.4. 使用 Homebrew 安装 OpenShift CLI
对于 macOS,您可以使用 Homebrew 软件包管理器安装 OpenShift CLI(oc
)。
先决条件
-
已安装 Homebrew(
brew
)。
流程
运行以下命令来安装 openshift-cli 软件包:
$ brew install openshift-cli
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
提示时,请输入所需信息:
输出示例
Server [https://localhost:8443]: https://openshift.example.com:6443 1 The server uses a certificate signed by an unknown authority. You can bypass the certificate check, but any data you send to the server could be intercepted by others. Use insecure connections? (y/n): y 2 Authentication required for https://openshift.example.com:6443 (openshift) Username: user1 Password: 3 Login successful. You don't have any projects. You can try to create a new project, by running oc new-project <projectname> Welcome! See 'oc help' to get started.
如果登录到 web 控制台,您可以生成包含令牌和服务器信息的 oc login
命令。您可以使用命令来登录 OpenShift Container Platform CLI,而无需交互式的提示。要生成 命令,请从 web 控制台右上角的用户名下拉菜单中选择 Copy login command。
您现在可以创建项目或执行其他命令来管理集群。
2.1.4. 使用 OpenShift CLI
参阅以下部分以了解如何使用 CLI 完成常见任务。
2.1.4.1. 创建一个项目
使用oc new-project
命令创建新项目。
$ oc new-project my-project
输出示例
Now using project "my-project" on server "https://openshift.example.com:6443".
2.1.4.2. 创建一个新的应用程序
使用oc new-app
命令创建新应用程序。
$ 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.
2.1.4.3. 查看 pod
使用oc get pods
命令查看当前项目的 pod。
当您在 pod 中运行 oc
且没有指定命名空间时,默认使用 pod 的命名空间。
$ 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>
2.1.4.4. 查看 pod 日志
使用oc logs
命令查看特定 pod 的日志。
$ oc logs cakephp-ex-1-deploy
输出示例
--> Scaling cakephp-ex-1 to 1 --> Success
2.1.4.5. 查看当前项目
使用oc project
命令查看当前项目。
$ oc project
输出示例
Using project "my-project" on server "https://openshift.example.com:6443".
2.1.4.6. 查看当前项目的状态
使用 oc status
命令查看有关当前项目的信息,如服务、部署和构建配置。
$ oc status
输出示例
In project my-project on server https://openshift.example.com:6443 svc/cakephp-ex - 172.30.236.80 ports 8080, 8443 dc/cakephp-ex deploys istag/cakephp-ex:latest <- bc/cakephp-ex source builds https://github.com/sclorg/cakephp-ex on openshift/php:7.2 deployment #1 deployed 2 minutes ago - 1 pod 3 infos identified, use 'oc status --suggest' to see details.
2.1.4.7. 列出支持的 API 资源
使用oc api-resources
命令查看服务器上支持的 API 资源列表。
$ oc api-resources
输出示例
NAME SHORTNAMES APIGROUP NAMESPACED KIND bindings true Binding componentstatuses cs false ComponentStatus configmaps cm true ConfigMap ...
2.1.5. 获得帮助
您可以通过以下方式获得有关 CLI 命令和 OpenShift Container Platform 资源的帮助信息。
使用
oc help
获取所有可用 CLI 命令的列表和描述:示例:获取 CLI 的常规帮助信息
$ oc help
输出示例
OpenShift Client This client helps you develop, build, deploy, and run your applications on any OpenShift or Kubernetes compatible platform. It also includes the administrative commands for managing a cluster under the 'adm' subcommand. Usage: oc [flags] Basic Commands: login Log in to a server new-project Request a new project new-app Create a new application ...
使用
--help
标志获取有关特定CLI命令的帮助信息:示例:获取
oc create
命令的帮助信息$ oc create --help
输出示例
Create a resource by filename or stdin JSON and YAML formats are accepted. Usage: oc create -f FILENAME [flags] ...
使用
oc explain
命令查看特定资源的描述信息和项信息:示例:查看
Pod
资源的文档$ oc explain pods
输出示例
KIND: Pod VERSION: v1 DESCRIPTION: Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. FIELDS: apiVersion <string> APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources ...
2.1.6. 注销 OpenShift CLI
您可以注销 OpenShift CLI 以结束当前会话。
使用
oc logout
命令。$ oc logout
输出示例
Logged "user1" out on "https://openshift.example.com"
这将从服务器中删除已保存的身份验证令牌,并将其从配置文件中删除。
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
将文件复制到
/etc/bash_completion.d/
:$ sudo cp oc_bash_completion /etc/bash_completion.d/
您也可以将文件保存到一个本地目录,并从您的
.bashrc
文件中 source 这个文件。
开新终端时 tab 自动完成功能将被启用。
2.2.1.2. 为 Zsh 启用 tab 自动完成功能
安装 OpenShift CLI (oc
)后,您可以启用 tab 自动完成功能,以便在按 Tab 键时自动完成 oc
命令或建议选项。以下流程为 Zsh shell 启用 tab 自动完成功能。
先决条件
-
已安装 OpenShift CLI (
oc
)。
流程
要在
.zshrc
文件中为oc
添加 tab 自动完成功能,请运行以下命令:$ cat >>~/.zshrc<<EOF if [ $commands[oc] ]; then source <(oc completion zsh) compdef _oc oc fi EOF
开新终端时 tab 自动完成功能将被启用。
2.3. 管理 CLI 配置集
CLI 配置文件允许您配置不同的配置文件或上下文,以用于 CLI 工具概述。上下文由与 nickname 关联的 用户身份验证 和 OpenShift Container Platform 服务器信息组成。
2.3.1. 关于 CLI 配置集间的切换
通过上下文,您可以在多个 OpenShift Container Platform 服务器或使用 CLI 操作时轻松地切换多个用户。nicknames 通过提供对上下文、用户凭证和集群详情的简短参考来更轻松地管理 CLI 配置。第一次使用 CLI 登录后,OpenShift Container Platform 会创建一个 ~/.kube/config
文件(如果不存在)。随着更多身份验证和连接详情被提供给 CLI,可以在 oc login
操作或手动配置 CLI 配置集过程中自动提供,更新的信息会存储在配置文件中:
CLI 配置文件
apiVersion: v1 clusters: 1 - cluster: insecure-skip-tls-verify: true server: https://openshift1.example.com:8443 name: openshift1.example.com:8443 - cluster: insecure-skip-tls-verify: true server: https://openshift2.example.com:8443 name: openshift2.example.com:8443 contexts: 2 - context: cluster: openshift1.example.com:8443 namespace: alice-project user: alice/openshift1.example.com:8443 name: alice-project/openshift1.example.com:8443/alice - context: cluster: openshift1.example.com:8443 namespace: joe-project user: alice/openshift1.example.com:8443 name: joe-project/openshift1/alice current-context: joe-project/openshift1.example.com:8443/alice 3 kind: Config preferences: {} users: 4 - name: alice/openshift1.example.com:8443 user: token: xZHd2piv5_9vQrg-SKXRJ2Dsl9SceNJdhNTljEKTb8k
- 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 In project Joe's Project (joe-project) service database (172.30.43.12:5434 -> 3306) database deploys docker.io/openshift/mysql-55-centos7:latest #1 deployed 25 minutes ago - 1 pod service frontend (172.30.159.137:5432 -> 8080) frontend deploys origin-ruby-sample:latest <- builds https://github.com/openshift/ruby-hello-world with joe-project/ruby-20-centos7:latest #1 deployed 22 minutes ago - 2 pods To see more information about a service or deployment, use 'oc describe service <name>' or 'oc describe dc <name>'. You can use 'oc get all' to see lists of each of the types described in this example.
列出当前项目
$ oc project
输出示例
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
输出示例
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
2.3.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>] [--certificate-authority=<path/to/certificate/authority>] [--api-version=<apiversion>] [--insecure-skip-tls-verify=true] |
| 在 CLI 配置文件中设置上下文条目。如果引用的上下文 nickname 已存在,则指定的信息将合并在. $ oc config set-context <context_nickname> [--cluster=<cluster_nickname>] [--user=<user_nickname>] [--namespace=<namespace>] |
| 使用指定上下文 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 config view
输出示例
apiVersion: v1 clusters: - cluster: insecure-skip-tls-verify: true server: https://openshift1.example.com name: openshift1-example-com contexts: - context: cluster: openshift1-example-com namespace: default user: alice/openshift1-example-com name: default/openshift1-example-com/alice current-context: default/openshift1-example-com/alice kind: Config preferences: {} users: - name: alice/openshift1.example.com user: token: ns7yVhuRNpDM9cgzfhhxQ7bM5s7N2ZVrkZepSRf4LC0
- 更新当前上下文以便用户登录到所需的命名空间:
$ oc config set-context `oc config current-context` --namespace=<project_name>
- 检查当前上下文,确认是否实施了更改:
$ oc whoami -c
所有后续 CLI 操作都使用新的上下文,除非通过覆盖 CLI 选项或直至上下文切换为止。
2.3.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.4. 使用插件扩展 OpenShift CLI
您可以针对默认的oc
命令编写并安装插件,从而可以使用OpenShift Container Platform CLI执行新的及更复杂的任务。
2.4.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
的插件。
-
该文件必须以
将以下内容添加到该文件中。
#!/bin/bash # optional argument handling if [[ "$1" == "version" ]] then echo "1.0.0" exit 0 fi # optional argument handling if [[ "$1" == "config" ]] then echo $KUBECONFIG exit 0 fi echo "I am a plugin named kubectl-foo"
为 OpenShift Container Platform CLI 安装此插件后,可以使用 oc foo
命令调用。
其他资源
- 查看 Sample plugin 存储库,以了解使用 Go 编写的插件示例。
- 查看 CLI 运行时存储库 以获取一组工具,以帮助在 Go 中编写插件。
2.4.2. 安装和使用 CLI 插件
为 OpenShift Container Platform CLI 编写自定义插件后,您必须安装该插件以使用它提供的功能。
先决条件
-
已安装
oc
CLI工具。 -
您必须具有以
oc-
或kubectl-
开头的 CLI 插件文件。
流程
如有必要,将插件文件更新为可执行。
$ chmod +x <plugin_file>
将文件放在
PATH
中的任何位置,例如/usr/local/bin/
。$ sudo mv <plugin_file> /usr/local/bin/.
运行
oc plugin list
以确保列出了插件。$ oc plugin list
输出示例
The following compatible plugins are available: /usr/local/bin/<plugin_file>
如果您的插件没有被列出,请验证文件是否以
oc-
或kubectl-
开头,是否可执行,且位于PATH
中。调用插件引入的新命令或选项。
例如,如果您从 Sample plug-in repository 构建并安装了
kubectl-ns
插件,则可以使用以下命令查看当前命名空间。$ oc ns
请注意,调用插件的命令取决于插件文件名。例如,文件名为
oc-foo-bar
的插件会被oc foo bar
命令调用。
2.5. OpenShift CLI 开发人员命令参考
本参考提供了 OpenShift CLI(oc
)开发人员命令的描述和示例命令。如需管理员命令,请参阅 OpenShift CLI 管理员命令参考。
运行 oc help
来列出所有命令或运行 oc <command> --help
获取特定命令的附加详情。
2.5.1. OpenShift CLI(oc)开发人员命令
2.5.1.1. oc annotate
更新资源上的注解
用法示例
# Update pod 'foo' with the annotation 'description' and the value 'my frontend' # If the same annotation is set multiple times, only the last value will be applied oc annotate pods foo description='my frontend' # Update a pod identified by type and name in "pod.json" oc annotate -f pod.json description='my frontend' # Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value oc annotate --overwrite pods foo description='my frontend running nginx' # Update all pods in the namespace oc annotate pods --all description='my frontend running nginx' # Update pod 'foo' only if the resource is unchanged from version 1 oc annotate pods foo description='my frontend running nginx' --resource-version=1 # Update pod 'foo' by removing an annotation named 'description' if it exists # Does not require the --overwrite flag oc annotate pods foo description-
2.5.1.2. oc api-resources
在服务器上显示支持的 API 资源
用法示例
# Print the supported API resources oc api-resources # Print the supported API resources with more information oc api-resources -o wide # Print the supported API resources sorted by a column oc api-resources --sort-by=name # Print the supported namespaced resources oc api-resources --namespaced=true # Print the supported non-namespaced resources oc api-resources --namespaced=false # Print the supported API resources with a specific APIGroup oc api-resources --api-group=extensions
2.5.1.3. oc api-versions
以"group/version"的形式输出服务器上支持的 API 版本。
用法示例
# Print the supported API versions oc api-versions
2.5.1.4. oc apply
通过文件名或 stdin 将配置应用到资源
用法示例
# Apply the configuration in pod.json to a pod oc apply -f ./pod.json # Apply resources from a directory containing kustomization.yaml - e.g. dir/kustomization.yaml oc apply -k dir/ # Apply the JSON passed into stdin to a pod cat pod.json | oc apply -f - # Note: --prune is still in Alpha # Apply the configuration in manifest.yaml that matches label app=nginx and delete all other resources that are not in the file and match label app=nginx oc apply --prune -f manifest.yaml -l app=nginx # Apply the configuration in manifest.yaml and delete all the other config maps that are not in the file oc apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap
2.5.1.5. oc apply edit-last-applied
编辑资源/对象的最新 last-applied-configuration 注解
用法示例
# 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.5.1.6. oc apply set-last-applied
设置 live 对象上的 last-applied-configuration 注释,以匹配文件的内容。
用法示例
# Set the last-applied-configuration of a resource to match the contents of a file oc apply set-last-applied -f deploy.yaml # Execute set-last-applied against each configuration file in a directory oc apply set-last-applied -f path/ # Set the last-applied-configuration of a resource to match the contents of a file; will create the annotation if it does not already exist oc apply set-last-applied -f deploy.yaml --create-annotation=true
2.5.1.7. oc apply view-last-applied
查看资源/对象最新的最后应用配置注解
用法示例
# 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.5.1.8. oc attach
附加到正在运行的容器
用法示例
# Get output from running pod mypod; use the 'oc.kubernetes.io/default-container' annotation # for selecting the container to be attached or the first container in the pod will be chosen oc attach mypod # Get output from ruby-container from pod mypod oc attach mypod -c ruby-container # Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod # and sends stdout/stderr from 'bash' back to the client oc attach mypod -c ruby-container -i -t # Get output from the first pod of a replica set named nginx oc attach rs/nginx
2.5.1.9. oc auth can-i
检查是否允许操作
用法示例
# Check to see if I can create pods in any namespace oc auth can-i create pods --all-namespaces # Check to see if I can list deployments in my current namespace oc auth can-i list deployments.apps # Check to see if I can do everything in my current namespace ("*" means all) oc auth can-i '*' '*' # Check to see if I can get the job named "bar" in namespace "foo" oc auth can-i list jobs.batch/bar -n foo # Check to see if I can read pod logs oc auth can-i get pods --subresource=log # Check to see if I can access the URL /logs/ oc auth can-i get /logs/ # List all allowed actions in namespace "foo" oc auth can-i --list --namespace=foo
2.5.1.10. oc auth reconcile
协调 RBAC 角色、角色绑定、集群角色和集群角色绑定对象的规则
用法示例
# Reconcile RBAC resources from a file oc auth reconcile -f my-rbac-rules.yaml
2.5.1.11. 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 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.5.1.12. oc cancel-build
取消正在运行、待处理或新的构建
用法示例
# Cancel the build with the given name oc cancel-build ruby-build-2 # Cancel the named build and print the build logs oc cancel-build ruby-build-2 --dump-logs # Cancel the named build and create a new one with the same parameters oc cancel-build ruby-build-2 --restart # Cancel multiple builds oc cancel-build ruby-build-1 ruby-build-2 ruby-build-3 # Cancel all builds created from the 'ruby-build' build config that are in the 'new' state oc cancel-build bc/ruby-build --state=new
2.5.1.13. oc cluster-info
显示集群信息
用法示例
# Print the address of the control plane and cluster services oc cluster-info
2.5.1.14. oc cluster-info dump
转储用于调试和诊断的相关信息
用法示例
# Dump current cluster state to stdout oc cluster-info dump # Dump current cluster state to /path/to/cluster-state oc cluster-info dump --output-directory=/path/to/cluster-state # Dump all namespaces to stdout oc cluster-info dump --all-namespaces # Dump a set of namespaces to /path/to/cluster-state oc cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
2.5.1.15. oc completion
输出指定 shell 的 shell 完成代码(bash 或 zsh)
用法示例
# Installing bash completion on macOS using homebrew ## If running Bash 3.2 included with macOS brew install bash-completion ## or, if running Bash 4.1+ brew install bash-completion@2 ## If oc is installed via homebrew, this should start working immediately ## If you've installed via other means, you may need add the completion to your completion directory oc completion bash > $(brew --prefix)/etc/bash_completion.d/oc # Installing bash completion on Linux ## If bash-completion is not installed on Linux, install the 'bash-completion' package ## via your distribution's package manager. ## Load the oc completion code for bash into the current shell source <(oc completion bash) ## Write bash completion code to a file and source it from .bash_profile oc completion bash > ~/.kube/completion.bash.inc printf " # Kubectl shell completion source '$HOME/.kube/completion.bash.inc' " >> $HOME/.bash_profile source $HOME/.bash_profile # Load the oc completion code for zsh[1] into the current shell source <(oc completion zsh) # Set the oc completion code for zsh[1] to autoload on startup oc completion zsh > "${fpath[1]}/_oc"
2.5.1.16. oc config current-context
显示 current-context
用法示例
# Display the current-context oc config current-context
2.5.1.17. oc config delete-cluster
从 kubeconfig 删除指定的集群
用法示例
# Delete the minikube cluster oc config delete-cluster minikube
2.5.1.18. oc config delete-context
从 kubeconfig 删除指定的上下文
用法示例
# Delete the context for the minikube cluster oc config delete-context minikube
2.5.1.19. oc config delete-user
从 kubeconfig 删除指定用户
用法示例
# Delete the minikube user oc config delete-user minikube
2.5.1.20. oc config get-clusters
显示 kubeconfig 中定义的集群
用法示例
# List the clusters that oc knows about oc config get-clusters
2.5.1.21. oc config get-contexts
描述一个或多个上下文
用法示例
# 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.5.1.22. oc config get-users
显示 kubeconfig 中定义的用户
用法示例
# List the users that oc knows about oc config get-users
2.5.1.23. oc config rename-context
从 kubeconfig 文件中重命名上下文
用法示例
# Rename the context 'old-name' to 'new-name' in your kubeconfig file oc config rename-context old-name new-name
2.5.1.24. oc config set
在 kubeconfig 文件中设置单个值
用法示例
# Set the server field on the my-cluster cluster to https://1.2.3.4 oc config set clusters.my-cluster.server https://1.2.3.4 # Set the certificate-authority-data field on the my-cluster cluster oc config set clusters.my-cluster.certificate-authority-data $(echo "cert_data_here" | base64 -i -) # Set the cluster field in the my-context context to my-cluster oc config set contexts.my-context.cluster my-cluster # Set the client-key-data field in the cluster-admin user using --set-raw-bytes option oc config set users.cluster-admin.client-key-data cert_data_here --set-raw-bytes=true
2.5.1.25. oc config set-cluster
在 kubeconfig 中设置集群条目
用法示例
# Set only the server field on the e2e cluster entry without touching other values oc config set-cluster e2e --server=https://1.2.3.4 # Embed certificate authority data for the e2e cluster entry oc config set-cluster e2e --embed-certs --certificate-authority=~/.kube/e2e/kubernetes.ca.crt # Disable cert checking for the dev cluster entry oc config set-cluster e2e --insecure-skip-tls-verify=true # Set custom TLS server name to use for validation for the e2e cluster entry oc config set-cluster e2e --tls-server-name=my-cluster-name
2.5.1.26. oc config set-context
在 kubeconfig 中设置上下文条目
用法示例
# Set the user field on the gce context entry without touching other values oc config set-context gce --user=cluster-admin
2.5.1.27. oc config set-credentials
在 kubeconfig 中设置用户条目
用法示例
# Set only the "client-key" field on the "cluster-admin" # entry, without touching other values oc config set-credentials cluster-admin --client-key=~/.kube/admin.key # Set basic auth for the "cluster-admin" entry oc config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif # Embed client certificate data in the "cluster-admin" entry oc config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true # Enable the Google Compute Platform auth provider for the "cluster-admin" entry oc config set-credentials cluster-admin --auth-provider=gcp # Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args oc config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar # Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry oc config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret- # Enable new exec auth plugin for the "cluster-admin" entry oc config set-credentials cluster-admin --exec-command=/path/to/the/executable --exec-api-version=client.authentication.k8s.io/v1beta1 # Define new exec auth plugin args for the "cluster-admin" entry oc config set-credentials cluster-admin --exec-arg=arg1 --exec-arg=arg2 # Create or update exec auth plugin environment variables for the "cluster-admin" entry oc config set-credentials cluster-admin --exec-env=key1=val1 --exec-env=key2=val2 # Remove exec auth plugin environment variables for the "cluster-admin" entry oc config set-credentials cluster-admin --exec-env=var-to-remove-
2.5.1.28. oc config unset
在 kubeconfig 文件中取消设置单个值
用法示例
# Unset the current-context oc config unset current-context # Unset namespace in foo context oc config unset contexts.foo.namespace
2.5.1.29. oc config use-context
在 kubeconfig 文件中设置 current-context
用法示例
# Use the context for the minikube cluster oc config use-context minikube
2.5.1.30. oc config view
显示合并的 kubeconfig 设置或指定的 kubeconfig 文件
用法示例
# Show merged kubeconfig settings oc config view # Show merged kubeconfig settings and raw certificate data oc config view --raw # Get the password for the e2e user oc config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
2.5.1.31. oc cp
将文件和目录复制到容器或从容器中复制
用法示例
# !!!Important Note!!! # Requires that the 'tar' binary is present in your container # image. If 'tar' is not present, 'oc cp' will fail. # # For advanced use cases, such as symlinks, wildcard expansion or # file mode preservation, consider using 'oc exec'. # Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace <some-namespace> tar cf - /tmp/foo | oc exec -i -n <some-namespace> <some-pod> -- tar xf - -C /tmp/bar # Copy /tmp/foo from a remote pod to /tmp/bar locally oc exec -n <some-namespace> <some-pod> -- tar cf - /tmp/foo | tar xf - -C /tmp/bar # Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod in the default namespace oc cp /tmp/foo_dir <some-pod>:/tmp/bar_dir # Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container oc cp /tmp/foo <some-pod>:/tmp/bar -c <specific-container> # Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace <some-namespace> oc cp /tmp/foo <some-namespace>/<some-pod>:/tmp/bar # Copy /tmp/foo from a remote pod to /tmp/bar locally oc cp <some-namespace>/<some-pod>:/tmp/foo /tmp/bar
2.5.1.32. oc create
从文件或 stdin 创建资源
用法示例
# Create a pod using the data in pod.json oc create -f ./pod.json # Create a pod based on the JSON passed into stdin cat pod.json | oc create -f - # Edit the data in docker-registry.yaml in JSON then create the resource using the edited data oc create -f docker-registry.yaml --edit -o json
2.5.1.33. oc create build
创建一个新构建
用法示例
# Create a new build oc create build myapp
2.5.1.34. oc create clusterresourcequota
创建集群资源配额
用法示例
# 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.5.1.35. oc create clusterrole
创建集群角色
用法示例
# Create a cluster role named "pod-reader" that allows user to perform "get", "watch" and "list" on pods oc create clusterrole pod-reader --verb=get,list,watch --resource=pods # Create a cluster role named "pod-reader" with ResourceName specified oc create clusterrole pod-reader --verb=get --resource=pods --resource-name=readablepod --resource-name=anotherpod # Create a cluster role named "foo" with API Group specified oc create clusterrole foo --verb=get,list,watch --resource=rs.extensions # Create a cluster role named "foo" with SubResource specified oc create clusterrole foo --verb=get,list,watch --resource=pods,pods/status # Create a cluster role name "foo" with NonResourceURL specified oc create clusterrole "foo" --verb=get --non-resource-url=/logs/* # Create a cluster role name "monitoring" with AggregationRule specified oc create clusterrole monitoring --aggregation-rule="rbac.example.com/aggregate-to-monitoring=true"
2.5.1.36. oc create clusterrolebinding
为特定集群角色创建集群角色绑定
用法示例
# 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.5.1.37. oc create configmap
从本地文件、目录或字面值创建配置映射
用法示例
# Create a new config map named my-config based on folder bar oc create configmap my-config --from-file=path/to/bar # Create a new config map named my-config with specified keys instead of file basenames on disk oc create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt # Create a new config map named my-config with key1=config1 and key2=config2 oc create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2 # Create a new config map named my-config from the key=value pairs in the file oc create configmap my-config --from-file=path/to/bar # Create a new config map named my-config from an env file oc create configmap my-config --from-env-file=path/to/bar.env
2.5.1.38. oc create cronjob
使用指定名称创建 cron 作业
用法示例
# 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.5.1.39. oc create deployment
使用指定名称创建部署
用法示例
# Create a deployment named my-dep that runs the busybox image oc create deployment my-dep --image=busybox # Create a deployment with a command oc create deployment my-dep --image=busybox -- date # Create a deployment named my-dep that runs the nginx image with 3 replicas oc create deployment my-dep --image=nginx --replicas=3 # Create a deployment named my-dep that runs the busybox image and expose port 5701 oc create deployment my-dep --image=busybox --port=5701
2.5.1.40. oc create deploymentconfig
使用给定镜像的默认选项创建部署配置
用法示例
# Create an nginx deployment config named my-nginx oc create deploymentconfig my-nginx --image=nginx
2.5.1.41. oc create identity
手动创建身份(仅在禁用自动创建时才需要)
用法示例
# Create an identity with identity provider "acme_ldap" and the identity provider username "adamjones" oc create identity acme_ldap:adamjones
2.5.1.42. oc create imagestream
创建新的空镜像流
用法示例
# Create a new image stream oc create imagestream mysql
2.5.1.43. oc create imagestreamtag
创建新镜像流标签
用法示例
# 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.5.1.44. oc create ingress
使用指定名称创建入口
用法示例
# Create a single ingress called 'simple' that directs requests to foo.com/bar to svc # svc1:8080 with a tls secret "my-cert" oc create ingress simple --rule="foo.com/bar=svc1:8080,tls=my-cert" # Create a catch all ingress of "/path" pointing to service svc:port and Ingress Class as "otheringress" oc create ingress catch-all --class=otheringress --rule="/path=svc:port" # Create an ingress with two annotations: ingress.annotation1 and ingress.annotations2 oc create ingress annotated --class=default --rule="foo.com/bar=svc:port" \ --annotation ingress.annotation1=foo \ --annotation ingress.annotation2=bla # Create an ingress with the same host and multiple paths oc create ingress multipath --class=default \ --rule="foo.com/=svc:port" \ --rule="foo.com/admin/=svcadmin:portadmin" # Create an ingress with multiple hosts and the pathType as Prefix oc create ingress ingress1 --class=default \ --rule="foo.com/path*=svc:8080" \ --rule="bar.com/admin*=svc2:http" # Create an ingress with TLS enabled using the default ingress certificate and different path types oc create ingress ingtls --class=default \ --rule="foo.com/=svc:https,tls" \ --rule="foo.com/path/subpath*=othersvc:8080" # Create an ingress with TLS enabled using a specific secret and pathType as Prefix oc create ingress ingsecret --class=default \ --rule="foo.com/*=svc:8080,tls=secret1" # Create an ingress with a default backend oc create ingress ingdefault --class=default \ --default-backend=defaultsvc:http \ --rule="foo.com/*=svc:8080,tls=secret1"
2.5.1.45. oc create job
使用指定名称创建作业
用法示例
# Create a job oc create job my-job --image=busybox # Create a job with a command oc create job my-job --image=busybox -- date # Create a job from a cron job named "a-cronjob" oc create job test-job --from=cronjob/a-cronjob
2.5.1.46. oc create namespace
使用指定名称创建命名空间
用法示例
# Create a new namespace named my-namespace oc create namespace my-namespace
2.5.1.47. oc create poddisruptionBudget
使用指定名称创建 pod 中断预算
用法示例
# Create a pod disruption budget named my-pdb that will select all pods with the app=rails label # and require at least one of them being available at any point in time oc create poddisruptionbudget my-pdb --selector=app=rails --min-available=1 # Create a pod disruption budget named my-pdb that will select all pods with the app=nginx label # and require at least half of the pods selected to be available at any point in time oc create pdb my-pdb --selector=app=nginx --min-available=50%
2.5.1.48. oc create priorityclass
创建具有指定名称的优先级类
用法示例
# Create a priority class named high-priority oc create priorityclass high-priority --value=1000 --description="high priority" # Create a priority class named default-priority that is considered as the global default priority oc create priorityclass default-priority --value=1000 --global-default=true --description="default priority" # Create a priority class named high-priority that cannot preempt pods with lower priority oc create priorityclass high-priority --value=1000 --description="high priority" --preemption-policy="Never"
2.5.1.49. oc create 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.5.1.50. oc create role
创建具有单一规则的角色
用法示例
# Create a role named "pod-reader" that allows user to perform "get", "watch" and "list" on pods oc create role pod-reader --verb=get --verb=list --verb=watch --resource=pods # Create a role named "pod-reader" with ResourceName specified oc create role pod-reader --verb=get --resource=pods --resource-name=readablepod --resource-name=anotherpod # Create a role named "foo" with API Group specified oc create role foo --verb=get,list,watch --resource=rs.extensions # Create a role named "foo" with SubResource specified oc create role foo --verb=get,list,watch --resource=pods,pods/status
2.5.1.51. oc create rolebinding
为特定角色或集群角色创建角色绑定
用法示例
# 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
2.5.1.52. oc create route edge
创建使用边缘 TLS 终止的路由
用法示例
# Create an edge route named "my-route" that exposes the frontend service oc create route edge my-route --service=frontend # Create an edge route that exposes the frontend service and specify a path # If the route name is omitted, the service name will be used oc create route edge --service=frontend --path /assets
2.5.1.53. oc create route passthrough
创建使用 passthrough TLS 终止的路由
用法示例
# Create a passthrough route named "my-route" that exposes the frontend service oc create route passthrough my-route --service=frontend # Create a passthrough route that exposes the frontend service and specify # a host name. If the route name is omitted, the service name will be used oc create route passthrough --service=frontend --hostname=www.example.com
2.5.1.54. oc create route reencrypt
创建使用重新加密 TLS 终止的路由
用法示例
# Create a route named "my-route" that exposes the frontend service oc create route reencrypt my-route --service=frontend --dest-ca-cert cert.cert # Create a reencrypt route that exposes the frontend service, letting the # route name default to the service name and the destination CA certificate # default to the service CA oc create route reencrypt --service=frontend
2.5.1.55. oc create secret docker-registry
创建用于 Docker registry 的 secret
用法示例
# If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: 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.5.1.56. oc create secret generic
从本地文件、目录或字面值创建 secret
用法示例
# Create a new secret named my-secret with keys for each file in folder bar oc create secret generic my-secret --from-file=path/to/bar # Create a new secret named my-secret with specified keys instead of names on disk oc create secret generic my-secret --from-file=ssh-privatekey=path/to/id_rsa --from-file=ssh-publickey=path/to/id_rsa.pub # Create a new secret named my-secret with key1=supersecret and key2=topsecret oc create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret # Create a new secret named my-secret using a combination of a file and a literal oc create secret generic my-secret --from-file=ssh-privatekey=path/to/id_rsa --from-literal=passphrase=topsecret # Create a new secret named my-secret from an env file oc create secret generic my-secret --from-env-file=path/to/bar.env
2.5.1.57. oc create secret tls
创建 TLS secret
用法示例
# 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.5.1.58. oc create service clusterip
创建 ClusterIP 服务
用法示例
# 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.5.1.59. oc create service externalname
创建 ExternalName 服务
用法示例
# Create a new ExternalName service named my-ns oc create service externalname my-ns --external-name bar.com
2.5.1.60. oc create service loadbalancer
创建 LoadBalancer 服务
用法示例
# Create a new LoadBalancer service named my-lbs oc create service loadbalancer my-lbs --tcp=5678:8080
2.5.1.61. oc create service nodeport
创建 NodePort 服务
用法示例
# Create a new NodePort service named my-ns oc create service nodeport my-ns --tcp=5678:8080
2.5.1.62. oc create serviceaccount
使用指定名称创建服务帐户
用法示例
# Create a new service account named my-service-account oc create serviceaccount my-service-account
2.5.1.63. oc create user
手动创建用户(仅在禁用自动创建时才需要)
用法示例
# Create a user with the username "ajones" and the display name "Adam Jones" oc create user ajones --full-name="Adam Jones"
2.5.1.64. oc create useridentitymapping
手动将身份映射到用户
用法示例
# Map the identity "acme_ldap:adamjones" to the user "ajones" oc create useridentitymapping acme_ldap:adamjones ajones
2.5.1.65. oc debug
启动用于调试的 pod 的新实例
用法示例
# Start a shell session into a pod using the OpenShift tools image oc debug # Debug a currently running deployment by creating a new pod oc debug deploy/test # Debug a node as an administrator oc debug node/master-1 # Launch a shell in a pod using the provided image stream tag oc debug istag/mysql:latest -n openshift # Test running a job as a non-root user oc debug job/test --as-user=1000000 # Debug a specific failing container by running the env command in the 'second' container oc debug daemonset/test -c second -- /bin/env # See the pod that would be created to debug oc debug mypod-9xbc -o yaml # Debug a resource but launch the debug pod in another namespace # Note: Not all resources can be debugged using --to-namespace without modification. For example, # volumes and service accounts are namespace-dependent. Add '-o yaml' to output the debug pod definition # to disk. If necessary, edit the definition then run 'oc debug -f -' or run without --to-namespace oc debug mypod-9xbc --to-namespace testns
2.5.1.66. oc delete
通过文件名、stdin、资源和名称或者资源和标签选择器删除资源
用法示例
# Delete a pod using the type and name specified in pod.json oc delete -f ./pod.json # Delete resources from a directory containing kustomization.yaml - e.g. dir/kustomization.yaml oc delete -k dir # Delete a pod based on the type and name in the JSON passed into stdin cat pod.json | oc delete -f - # Delete pods and services with same names "baz" and "foo" oc delete pod,service baz foo # Delete pods and services with label name=myLabel oc delete pods,services -l name=myLabel # Delete a pod with minimal delay oc delete pod foo --now # Force delete a pod on a dead node oc delete pod foo --force # Delete all pods oc delete pods --all
2.5.1.67. oc describe
显示特定资源或一组资源的详情
用法示例
# Describe a node oc describe nodes kubernetes-node-emt8.c.myproject.internal # Describe a pod oc describe pods/nginx # Describe a pod identified by type and name in "pod.json" oc describe -f pod.json # Describe all pods oc describe pods # Describe pods by label name=myLabel oc describe po -l name=myLabel # Describe all pods managed by the 'frontend' replication controller (rc-created pods # get the name of the rc as a prefix in the pod the name) oc describe pods frontend
2.5.1.68. oc diff
针对 would-be 应用的版本对 live 版本进行 diff 操作
用法示例
# Diff resources included in pod.json oc diff -f pod.json # Diff file read from stdin cat service.yaml | oc diff -f -
2.5.1.69. oc edit
编辑服务器上的资源
用法示例
# Edit the service named 'docker-registry' oc edit svc/docker-registry # Use an alternative editor KUBE_EDITOR="nano" oc edit svc/docker-registry # Edit the job 'myjob' in JSON using the v1 API format oc edit job.v1.batch/myjob -o json # Edit the deployment 'mydeployment' in YAML and save the modified config in its annotation oc edit deployment/mydeployment -o yaml --save-config
2.5.1.70. oc ex dockergc
执行垃圾回收以释放 docker 存储中的空间
用法示例
# Perform garbage collection with the default settings oc ex dockergc
2.5.1.71. oc exec
在容器中执行命令
用法示例
# Get output from running the 'date' command from pod mypod, using the first container by default oc exec mypod -- date # Get output from running the 'date' command in ruby-container from pod mypod oc exec mypod -c ruby-container -- date # Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod # and sends stdout/stderr from 'bash' back to the client oc exec mypod -c ruby-container -i -t -- bash -il # List contents of /usr from the first container of pod mypod and sort by modification time # If the command you want to execute in the pod has any flags in common (e.g. -i), # you must use two dashes (--) to separate your command's flags/arguments # Also note, do not surround your command and its flags/arguments with quotes # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr") oc exec mypod -i -t -- ls -t /usr # Get output from running 'date' command from the first pod of the deployment mydeployment, using the first container by default oc exec deploy/mydeployment -- date # Get output from running 'date' command from the first pod of the service myservice, using the first container by default oc exec svc/myservice -- date
2.5.1.72. oc explain
获取资源的文档
用法示例
# Get the documentation of the resource and its fields oc explain pods # Get the documentation of a specific field of a resource oc explain pods.spec.containers
2.5.1.73. oc expose
将复制的应用程序作为服务或路由公开
用法示例
# Create a route based on service nginx. The new route will reuse nginx's labels oc expose service nginx # Create a route and specify your own label and route name oc expose service nginx -l name=myroute --name=fromdowntown # Create a route and specify a host name oc expose service nginx --hostname=www.example.com # Create a route with a wildcard oc expose service nginx --hostname=x.example.com --wildcard-policy=Subdomain # This would be equivalent to *.example.com. NOTE: only hosts are matched by the wildcard; subdomains would not be included # Expose a deployment configuration as a service and use the specified port oc expose dc ruby-hello-world --port=8080 # Expose a service as a route in the specified path oc expose service nginx --path=/nginx # Expose a service using different generators oc expose service nginx --name=exposed-svc --port=12201 --protocol="TCP" --generator="service/v2" oc expose service nginx --name=my-route --port=12201 --generator="route/v1" # Exposing a service using the "route/v1" generator (default) will create a new exposed route with the "--name" provided # (or the name of the service otherwise). You may not specify a "--protocol" or "--target-port" option when using this generator
2.5.1.74. oc extract
将 secret 或配置映射提取到磁盘
用法示例
# Extract the secret "test" to the current directory oc extract secret/test # Extract the config map "nginx" to the /tmp directory oc extract configmap/nginx --to=/tmp # Extract the config map "nginx" to STDOUT oc extract configmap/nginx --to=- # Extract only the key "nginx.conf" from config map "nginx" to the /tmp directory oc extract configmap/nginx --to=/tmp --keys=nginx.conf
2.5.1.75. oc get
显示一个或多个资源
用法示例
# List all pods in ps output format oc get pods # List all pods in ps output format with more information (such as node name) oc get pods -o wide # List a single replication controller with specified NAME in ps output format oc get replicationcontroller web # List deployments in JSON output format, in the "v1" version of the "apps" API group oc get deployments.v1.apps -o json # List a single pod in JSON output format oc get -o json pod web-pod-13je7 # List a pod identified by type and name specified in "pod.yaml" in JSON output format oc get -f pod.yaml -o json # List resources from a directory with kustomization.yaml - e.g. dir/kustomization.yaml oc get -k dir/ # Return only the phase value of the specified pod oc get -o template pod/web-pod-13je7 --template={{.status.phase}} # List resource information in custom columns oc get pod test-pod -o custom-columns=CONTAINER:.spec.containers[0].name,IMAGE:.spec.containers[0].image # List all replication controllers and services together in ps output format oc get rc,services # List one or more resources by their type and names oc get rc/web service/frontend pods/web-pod-13je7
2.5.1.76. oc idle
闲置可扩展资源
用法示例
# Idle the scalable controllers associated with the services listed in to-idle.txt $ oc idle --resource-names-file to-idle.txt
2.5.1.77. oc image append
向镜像添加层并将其推送到 registry
用法示例
# Remove the entrypoint on the mysql:latest image oc image append --from mysql:latest --to myregistry.com/myimage:latest --image '{"Entrypoint":null}' # Add a new layer to the image oc image append --from mysql:latest --to myregistry.com/myimage:latest layer.tar.gz # Add a new layer to the image and store the result on disk # This results in $(pwd)/v2/mysql/blobs,manifests oc image append --from mysql:latest --to file://mysql:local layer.tar.gz # Add a new layer to the image and store the result on disk in a designated directory # This will result in $(pwd)/mysql-local/v2/mysql/blobs,manifests oc image append --from mysql:latest --to file://mysql:local --dir mysql-local layer.tar.gz # Add a new layer to an image that is stored on disk (~/mysql-local/v2/image exists) oc image append --from-dir ~/mysql-local --to myregistry.com/myimage:latest layer.tar.gz # Add a new layer to an image that was mirrored to the current directory on disk ($(pwd)/v2/image exists) oc image append --from-dir v2 --to myregistry.com/myimage:latest layer.tar.gz # Add a new layer to a multi-architecture image for an os/arch that is different from the system's os/arch # Note: Wildcard filter is not supported with append. Pass a single os/arch to append oc image append --from docker.io/library/busybox:latest --filter-by-os=linux/s390x --to myregistry.com/myimage:latest layer.tar.gz
2.5.1.78. oc image extract
将文件从镜像复制到文件系统
用法示例
# Extract the busybox image into the current directory oc image extract docker.io/library/busybox:latest # Extract the busybox image into a designated directory (must exist) oc image extract docker.io/library/busybox:latest --path /:/tmp/busybox # Extract the busybox image into the current directory for linux/s390x platform # Note: Wildcard filter is not supported with extract. Pass a single os/arch to extract oc image extract docker.io/library/busybox:latest --filter-by-os=linux/s390x # Extract a single file from the image into the current directory oc image extract docker.io/library/centos:7 --path /bin/bash:. # Extract all .repo files from the image's /etc/yum.repos.d/ folder into the current directory oc image extract docker.io/library/centos:7 --path /etc/yum.repos.d/*.repo:. # Extract all .repo files from the image's /etc/yum.repos.d/ folder into a designated directory (must exist) # This results in /tmp/yum.repos.d/*.repo on local system oc image extract docker.io/library/centos:7 --path /etc/yum.repos.d/*.repo:/tmp/yum.repos.d # Extract an image stored on disk into the current directory ($(pwd)/v2/busybox/blobs,manifests exists) # --confirm is required because the current directory is not empty oc image extract file://busybox:local --confirm # Extract an image stored on disk in a directory other than $(pwd)/v2 into the current directory # --confirm is required because the current directory is not empty ($(pwd)/busybox-mirror-dir/v2/busybox exists) oc image extract file://busybox:local --dir busybox-mirror-dir --confirm # Extract an image stored on disk in a directory other than $(pwd)/v2 into a designated directory (must exist) oc image extract file://busybox:local --dir busybox-mirror-dir --path /:/tmp/busybox # Extract the last layer in the image oc image extract docker.io/library/centos:7[-1] # Extract the first three layers of the image oc image extract docker.io/library/centos:7[:3] # Extract the last three layers of the image oc image extract docker.io/library/centos:7[-3:]
2.5.1.79. oc image info
显示镜像的信息
用法示例
# Show information about an image oc image info quay.io/openshift/cli:latest # Show information about images matching a wildcard oc image info quay.io/openshift/cli:4.* # Show information about a file mirrored to disk under DIR oc image info --dir=DIR file://library/busybox:latest # Select which image from a multi-OS image to show oc image info library/busybox:latest --filter-by-os=linux/arm64
2.5.1.80. oc image mirror
将镜像从一个存储库镜像到另一个存储库
用法示例
# Copy image to another tag oc image mirror myregistry.com/myimage:latest myregistry.com/myimage:stable # Copy image to another registry oc image mirror myregistry.com/myimage:latest docker.io/myrepository/myimage:stable # Copy all tags starting with mysql to the destination repository oc image mirror myregistry.com/myimage:mysql* docker.io/myrepository/myimage # Copy image to disk, creating a directory structure that can be served as a registry oc image mirror myregistry.com/myimage:latest file://myrepository/myimage:latest # Copy image to S3 (pull from <bucket>.s3.amazonaws.com/image:latest) oc image mirror myregistry.com/myimage:latest s3://s3.amazonaws.com/<region>/<bucket>/image:latest # Copy image to S3 without setting a tag (pull via @<digest>) oc image mirror myregistry.com/myimage:latest s3://s3.amazonaws.com/<region>/<bucket>/image # Copy image to multiple locations oc image mirror myregistry.com/myimage:latest docker.io/myrepository/myimage:stable \ docker.io/myrepository/myimage:dev # Copy multiple images oc image mirror myregistry.com/myimage:latest=myregistry.com/other:test \ myregistry.com/myimage:new=myregistry.com/other:target # Copy manifest list of a multi-architecture image, even if only a single image is found oc image mirror myregistry.com/myimage:latest=myregistry.com/other:test \ --keep-manifest-list=true # Copy specific os/arch manifest of a multi-architecture image # Run 'oc image info myregistry.com/myimage:latest' to see available os/arch for multi-arch images # Note that with multi-arch images, this results in a new manifest list digest that includes only # the filtered manifests oc image mirror myregistry.com/myimage:latest=myregistry.com/other:test \ --filter-by-os=os/arch # Copy all os/arch manifests of a multi-architecture image # Run 'oc image info myregistry.com/myimage:latest' to see list of os/arch manifests that will be mirrored oc image mirror myregistry.com/myimage:latest=myregistry.com/other:test \ --keep-manifest-list=true # Note the above command is equivalent to oc image mirror myregistry.com/myimage:latest=myregistry.com/other:test \ --filter-by-os=.*
2.5.1.81. oc import-image
从容器镜像 registry 中导入镜像
用法示例
# Import tag latest into a new image stream oc import-image mystream --from=registry.io/repo/image:latest --confirm # Update imported data for tag latest in an already existing image stream oc import-image mystream # Update imported data for tag stable in an already existing image stream oc import-image mystream:stable # Update imported data for all tags in an existing image stream oc import-image mystream --all # Import all tags into a new image stream oc import-image mystream --from=registry.io/repo/image --all --confirm # Import all tags into a new image stream using a custom timeout oc --request-timeout=5m import-image mystream --from=registry.io/repo/image --all --confirm
2.5.1.82. oc kustomize
从目录或 URL 构建 kustomization 目标。
用法示例
# Build the current working directory oc kustomize # Build some shared configuration directory oc kustomize /home/config/production # Build from github oc kustomize https://github.com/kubernetes-sigs/kustomize.git/examples/helloWorld?ref=v1.0.6
2.5.1.83. oc label
更新资源上的标签
用法示例
# Update pod 'foo' with the label 'unhealthy' and the value 'true' oc label pods foo unhealthy=true # Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value oc label --overwrite pods foo status=unhealthy # Update all pods in the namespace oc label pods --all status=unhealthy # Update a pod identified by the type and name in "pod.json" oc label -f pod.json status=unhealthy # Update pod 'foo' only if the resource is unchanged from version 1 oc label pods foo status=unhealthy --resource-version=1 # Update pod 'foo' by removing a label named 'bar' if it exists # Does not require the --overwrite flag oc label pods foo bar-
2.5.1.84. oc login
登录到服务器
用法示例
# Log in interactively oc login --username=myuser # Log in to the given server with the given certificate authority file oc login localhost:8443 --certificate-authority=/path/to/cert.crt # Log in to the given server with the given credentials (will not prompt interactively) oc login localhost:8443 --username=myuser --password=mypass
2.5.1.85. oc logout
结束当前服务器会话
用法示例
# Log out oc logout
2.5.1.86. oc logs
显示 pod 中容器的日志
用法示例
# Start streaming the logs of the most recent build of the openldap build config oc logs -f bc/openldap # Start streaming the logs of the latest deployment of the mysql deployment config oc logs -f dc/mysql # Get the logs of the first deployment for the mysql deployment config. Note that logs # from older deployments may not exist either because the deployment was successful # or due to deployment pruning or manual deletion of the deployment oc logs --version=1 dc/mysql # Return a snapshot of ruby-container logs from pod backend oc logs backend -c ruby-container # Start streaming of ruby-container logs from pod backend oc logs -f pod/backend -c ruby-container
2.5.1.87. oc new-app
创建新应用程序
用法示例
# List all local templates and image streams that can be used to create an app oc new-app --list # Create an application based on the source code in the current git repository (with a public remote) and a container image oc new-app . --image=registry/repo/langimage # Create an application myapp with Docker based build strategy expecting binary input oc new-app --strategy=docker --binary --name myapp # Create a Ruby application based on the provided [image]~[source code] combination oc new-app centos/ruby-25-centos7~https://github.com/sclorg/ruby-ex.git # Use the public container registry MySQL image to create an app. Generated artifacts will be labeled with db=mysql oc new-app mysql MYSQL_USER=user MYSQL_PASSWORD=pass MYSQL_DATABASE=testdb -l db=mysql # Use a MySQL image in a private registry to create an app and override application artifacts' names oc new-app --image=myregistry.com/mycompany/mysql --name=private # Create an application from a remote repository using its beta4 branch oc new-app https://github.com/openshift/ruby-hello-world#beta4 # Create an application based on a stored template, explicitly setting a parameter value oc new-app --template=ruby-helloworld-sample --param=MYSQL_USER=admin # Create an application from a remote repository and specify a context directory oc new-app https://github.com/youruser/yourgitrepo --context-dir=src/build # Create an application from a remote private repository and specify which existing secret to use oc new-app https://github.com/youruser/yourgitrepo --source-secret=yoursecret # Create an application based on a template file, explicitly setting a parameter value oc new-app --file=./example/myapp/template.json --param=MYSQL_USER=admin # Search all templates, image streams, and container images for the ones that match "ruby" oc new-app --search ruby # Search for "ruby", but only in stored templates (--template, --image-stream and --image # can be used to filter search results) oc new-app --search --template=ruby # Search for "ruby" in stored templates and print the output as YAML oc new-app --search --template=ruby --output=yaml
2.5.1.88. oc new-build
创建新构建配置
用法示例
# Create a build config based on the source code in the current git repository (with a public # remote) and a container image oc new-build . --image=repo/langimage # Create a NodeJS build config based on the provided [image]~[source code] combination oc new-build centos/nodejs-8-centos7~https://github.com/sclorg/nodejs-ex.git # Create a build config from a remote repository using its beta2 branch oc new-build https://github.com/openshift/ruby-hello-world#beta2 # Create a build config using a Dockerfile specified as an argument oc new-build -D $'FROM centos:7\nRUN yum install -y httpd' # Create a build config from a remote repository and add custom environment variables oc new-build https://github.com/openshift/ruby-hello-world -e RACK_ENV=development # Create a build config from a remote private repository and specify which existing secret to use oc new-build https://github.com/youruser/yourgitrepo --source-secret=yoursecret # Create a build config from a remote repository and inject the npmrc into a build oc new-build https://github.com/openshift/ruby-hello-world --build-secret npmrc:.npmrc # Create a build config from a remote repository and inject environment data into a build oc new-build https://github.com/openshift/ruby-hello-world --build-config-map env:config # Create a build config that gets its input from a remote repository and another container image oc new-build https://github.com/openshift/ruby-hello-world --source-image=openshift/jenkins-1-centos7 --source-image-path=/var/lib/jenkins:tmp
2.5.1.89. oc new-project
请求新项目
用法示例
# 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.5.1.90. oc observe
观察资源的变化并对其做出反应(实验性)
用法示例
# Observe changes to services oc observe services # Observe changes to services, including the clusterIP and invoke a script for each oc observe services --template '{ .spec.clusterIP }' -- register_dns.sh # Observe changes to services filtered by a label selector oc observe namespaces -l regist-dns=true --template '{ .spec.clusterIP }' -- register_dns.sh
2.5.1.91. oc patch
更新资源字段
用法示例
# Partially update a node using a strategic merge patch, specifying the patch as JSON oc patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}' # Partially update a node using a strategic merge patch, specifying the patch as YAML oc patch node k8s-node-1 -p $'spec:\n unschedulable: true' # Partially update a node identified by the type and name specified in "node.json" using strategic merge patch oc patch -f node.json -p '{"spec":{"unschedulable":true}}' # Update a container's image; spec.containers[*].name is required because it's a merge key oc patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}' # Update a container's image using a JSON patch with positional arrays oc patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
2.5.1.92. oc policy add-role-to-user
为当前项目的用户或服务帐户添加角色
用法示例
# 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.5.1.93. oc policy scc-review
检查哪个服务帐户可以创建 pod
用法示例
# Check whether service accounts sa1 and sa2 can admit a pod with a template pod spec specified in my_resource.yaml # Service Account specified in myresource.yaml file is ignored oc policy scc-review -z sa1,sa2 -f my_resource.yaml # Check whether service accounts system:serviceaccount:bob:default can admit a pod with a template pod spec specified in my_resource.yaml oc policy scc-review -z system:serviceaccount:bob:default -f my_resource.yaml # Check whether the service account specified in my_resource_with_sa.yaml can admit the pod oc policy scc-review -f my_resource_with_sa.yaml # Check whether the default service account can admit the pod; default is taken since no service account is defined in myresource_with_no_sa.yaml oc policy scc-review -f myresource_with_no_sa.yaml
2.5.1.94. oc policy scc-subject-review
检查用户或服务帐户是否可以创建 pod
用法示例
# Check whether user bob can create a pod specified in myresource.yaml oc policy scc-subject-review -u bob -f myresource.yaml # Check whether user bob who belongs to projectAdmin group can create a pod specified in myresource.yaml oc policy scc-subject-review -u bob -g projectAdmin -f myresource.yaml # Check whether a service account specified in the pod template spec in myresourcewithsa.yaml can create the pod oc policy scc-subject-review -f myresourcewithsa.yaml
2.5.1.95. oc port-forward
将一个或多个本地端口转发到一个 pod
用法示例
# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod oc port-forward pod/mypod 5000 6000 # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment oc port-forward deployment/mydeployment 5000 6000 # Listen on port 8443 locally, forwarding to the targetPort of the service's port named "https" in a pod selected by the service oc port-forward service/myservice 8443:https # Listen on port 8888 locally, forwarding to 5000 in the pod oc port-forward pod/mypod 8888:5000 # Listen on port 8888 on all addresses, forwarding to 5000 in the pod oc port-forward --address 0.0.0.0 pod/mypod 8888:5000 # Listen on port 8888 on localhost and selected IP, forwarding to 5000 in the pod oc port-forward --address localhost,10.19.21.23 pod/mypod 8888:5000 # Listen on a random port locally, forwarding to 5000 in the pod oc port-forward pod/mypod :5000
2.5.1.96. oc process
将模板处理为资源列表
用法示例
# Convert the template.json file into a resource list and pass to create oc process -f template.json | oc create -f - # Process a file locally instead of contacting the server oc process -f template.json --local -o yaml # Process template while passing a user-defined label oc process -f template.json -l name=mytemplate # Convert a stored template into a resource list oc process foo # Convert a stored template into a resource list by setting/overriding parameter values oc process foo PARM1=VALUE1 PARM2=VALUE2 # Convert a template stored in different namespace into a resource list oc process openshift//foo # Convert template.json into a resource list cat template.json | oc process -f -
2.5.1.97. oc project
切换到另一个项目
用法示例
# Switch to the 'myapp' project oc project myapp # Display the project currently in use oc project
2.5.1.98. oc projects
显示现有项目
用法示例
# List all projects oc projects
2.5.1.99. oc proxy
运行到 Kubernetes API 服务器的代理
用法示例
# To proxy all of the Kubernetes API and nothing else oc proxy --api-prefix=/ # To proxy only part of the Kubernetes API and also some static files # You can get pods info with 'curl localhost:8001/api/v1/pods' oc proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/ # To proxy the entire Kubernetes API at a different root # You can get pods info with 'curl localhost:8001/custom/api/v1/pods' oc proxy --api-prefix=/custom/ # Run a proxy to the Kubernetes API server on port 8011, serving static content from ./local/www/ oc proxy --port=8011 --www=./local/www/ # Run a proxy to the Kubernetes API server on an arbitrary local port # The chosen port for the server will be output to stdout oc proxy --port=0 # Run a proxy to the Kubernetes API server, changing the API prefix to k8s-api # This makes e.g. the pods API available at localhost:8001/k8s-api/v1/pods/ oc proxy --api-prefix=/k8s-api
2.5.1.100. oc registry info
输出有关集成 registry 的信息
用法示例
# Display information about the integrated registry oc registry info
2.5.1.101. oc registry login
登录到集成的 registry
用法示例
# Log in to the integrated registry oc registry login # Log in as the default service account in the current namespace oc registry login -z default # Log in to different registry using BASIC auth credentials oc registry login --registry quay.io/myregistry --auth-basic=USER:PASS
2.5.1.102. oc replace
使用文件名或 stdin 替换资源
用法示例
# Replace a pod using the data in pod.json oc replace -f ./pod.json # Replace a pod based on the JSON passed into stdin cat pod.json | oc replace -f - # Update a single-container pod's image version (tag) to v4 oc get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | oc replace -f - # Force replace, delete and then re-create the resource oc replace --force -f ./pod.json
2.5.1.103. oc rollback
将应用程序的一部分还原回以前的部署
用法示例
# Perform a rollback to the last successfully completed deployment for a deployment config oc rollback frontend # See what a rollback to version 3 will look like, but do not perform the rollback oc rollback frontend --to-version=3 --dry-run # Perform a rollback to a specific deployment oc rollback frontend-2 # Perform the rollback manually by piping the JSON of the new config back to oc oc rollback frontend -o json | oc replace dc/frontend -f - # Print the updated deployment configuration in JSON format instead of performing the rollback oc rollback frontend -o json
2.5.1.104. oc rollout cancel
取消进行中的部署
用法示例
# Cancel the in-progress deployment based on 'nginx' oc rollout cancel dc/nginx
2.5.1.105. oc rollout history
查看推出(rollout)历史记录
用法示例
# 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.5.1.106. oc rollout latest
使用来自触发器的最新状态为部署配置启动一个新的 rollout 操作
用法示例
# 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.5.1.107. oc rollout pause
将提供的资源标记为暂停
用法示例
# 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.5.1.108. oc rollout restart
重启资源
用法示例
# Restart a deployment oc rollout restart deployment/nginx # Restart a daemon set oc rollout restart daemonset/abc
2.5.1.109. oc rollout resume
恢复暂停的资源
用法示例
# Resume an already paused deployment oc rollout resume dc/nginx
2.5.1.110. oc rollout retry
重试最新失败的 rollout 操作
用法示例
# 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.5.1.111. oc rollout status
显示推出部署的状态
用法示例
# Watch the status of the latest rollout oc rollout status dc/nginx
2.5.1.112. oc rollout undo
撤消之前的推出部署
用法示例
# 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.5.1.113. oc rsh
在容器中启动 shell 会话
用法示例
# Open a shell session on the first container in pod 'foo' oc rsh foo # Open a shell session on the first container in pod 'foo' and namespace 'bar' # (Note that oc client specific arguments must come before the resource name and its arguments) oc rsh -n bar foo # Run the command 'cat /etc/resolv.conf' inside pod 'foo' oc rsh foo cat /etc/resolv.conf # See the configuration of your internal registry oc rsh dc/docker-registry cat config.yml # Open a shell session on the container named 'index' inside a pod of your job oc rsh -c index job/sheduled
2.5.1.114. oc rsync
在本地文件系统和 pod 间复制文件
用法示例
# 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.5.1.115. oc run
在集群中运行特定镜像
用法示例
# Start a nginx pod oc run nginx --image=nginx # Start a hazelcast pod and let the container expose port 5701 oc run hazelcast --image=hazelcast/hazelcast --port=5701 # Start a hazelcast pod and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container oc run hazelcast --image=hazelcast/hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default" # Start a hazelcast pod and set labels "app=hazelcast" and "env=prod" in the container oc run hazelcast --image=hazelcast/hazelcast --labels="app=hazelcast,env=prod" # Dry run; print the corresponding API objects without creating them oc run nginx --image=nginx --dry-run=client # Start a nginx pod, but overload the spec with a partial set of values parsed from JSON oc run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }' # Start a busybox pod and keep it in the foreground, don't restart it if it exits oc run -i -t busybox --image=busybox --restart=Never # Start the nginx pod using the default command, but use custom arguments (arg1 .. argN) for that command oc run nginx --image=nginx -- <arg1> <arg2> ... <argN> # Start the nginx pod using a different command and custom arguments oc run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
2.5.1.116. oc scale
为部署、副本集或复制控制器设置新大小
用法示例
# Scale a replica set named 'foo' to 3 oc scale --replicas=3 rs/foo # Scale a resource identified by type and name specified in "foo.yaml" to 3 oc scale --replicas=3 -f foo.yaml # If the deployment named mysql's current size is 2, scale mysql to 3 oc scale --current-replicas=2 --replicas=3 deployment/mysql # Scale multiple replication controllers oc scale --replicas=5 rc/foo rc/bar rc/baz # Scale stateful set named 'web' to 3 oc scale --replicas=3 statefulset/web
2.5.1.117. oc secrets link
将 secret 链接到服务帐户
用法示例
# 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 # If the cluster's serviceAccountConfig is operating with limitSecretReferences: True, secrets must be added to the pod's service account whitelist in order to be available to the pod oc secrets link pod-sa pod-secret
2.5.1.118. oc secrets unlink
从服务帐户分离 secret
用法示例
# Unlink a secret currently associated with a service account oc secrets unlink serviceaccount-name secret-name another-secret-name ...
2.5.1.119. oc serviceaccounts create-kubeconfig
为服务帐户生成 kubeconfig 文件
用法示例
# Create a kubeconfig file for service account 'default' oc serviceaccounts create-kubeconfig 'default' > default.kubeconfig
2.5.1.120. oc serviceaccounts get-token
获取分配给服务帐户的令牌
用法示例
# Get the service account token from service account 'default' oc serviceaccounts get-token 'default'
2.5.1.121. oc serviceaccounts new-token
为服务帐户生成新令牌
用法示例
# Generate a new token for service account 'default' oc serviceaccounts new-token 'default' # Generate a new token for service account 'default' and apply # labels 'foo' and 'bar' to the new token for identification oc serviceaccounts new-token 'default' --labels foo=foo-value,bar=bar-value
2.5.1.122. oc set build-hook
更新构建配置上的构建 hook
用法示例
# Clear post-commit hook on a build config oc set build-hook bc/mybuild --post-commit --remove # Set the post-commit hook to execute a test suite using a new entrypoint oc set build-hook bc/mybuild --post-commit --command -- /bin/bash -c /var/lib/test-image.sh # Set the post-commit hook to execute a shell script oc set build-hook bc/mybuild --post-commit --script="/var/lib/test-image.sh param1 param2 && /var/lib/done.sh"
2.5.1.123. oc set build-secret
更新构建配置上的构建 secret
用法示例
# Clear the push secret on a build config oc set build-secret --push --remove bc/mybuild # Set the pull secret on a build config oc set build-secret --pull bc/mybuild mysecret # Set the push and pull secret on a build config oc set build-secret --push --pull bc/mybuild mysecret # Set the source secret on a set of build configs matching a selector oc set build-secret --source -l app=myapp gitsecret
2.5.1.124. oc set data
更新配置映射或 secret 中的数据
用法示例
# Set the 'password' key of a secret oc set data secret/foo password=this_is_secret # Remove the 'password' key from a secret oc set data secret/foo password- # Update the 'haproxy.conf' key of a config map from a file on disk oc set data configmap/bar --from-file=../haproxy.conf # Update a secret with the contents of a directory, one key per file oc set data secret/foo --from-file=secret-dir
2.5.1.125. oc set deployment-hook
更新部署配置上的部署 hook
用法示例
# Clear pre and post hooks on a deployment config oc set deployment-hook dc/myapp --remove --pre --post # Set the pre deployment hook to execute a db migration command for an application # using the data volume from the application oc set deployment-hook dc/myapp --pre --volumes=data -- /var/lib/migrate-db.sh # Set a mid deployment hook along with additional environment variables oc set deployment-hook dc/myapp --mid --volumes=data -e VAR1=value1 -e VAR2=value2 -- /var/lib/prepare-deploy.sh
2.5.1.126. oc set env
更新 pod 模板上的环境变量
用法示例
# Update deployment config 'myapp' with a new environment variable oc set env dc/myapp STORAGE_DIR=/local # List the environment variables defined on a build config 'sample-build' oc set env bc/sample-build --list # List the environment variables defined on all pods oc set env pods --all --list # Output modified build config in YAML oc set env bc/sample-build STORAGE_DIR=/data -o yaml # Update all containers in all replication controllers in the project to have ENV=prod oc set env rc --all ENV=prod # Import environment from a secret oc set env --from=secret/mysecret dc/myapp # Import environment from a config map with a prefix oc set env --from=configmap/myconfigmap --prefix=MYSQL_ dc/myapp # Remove the environment variable ENV from container 'c1' in all deployment configs oc set env dc --all --containers="c1" ENV- # Remove the environment variable ENV from a deployment config definition on disk and # update the deployment config on the server oc set env -f dc.json ENV- # Set some of the local shell environment into a deployment config on the server oc set env | grep RAILS_ | oc env -e - dc/myapp
2.5.1.127. oc set image
更新 pod 模板的镜像
用法示例
# Set a deployment configs's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'. oc set image dc/nginx busybox=busybox nginx=nginx:1.9.1 # Set a deployment configs's app container image to the image referenced by the imagestream tag 'openshift/ruby:2.3'. oc set image dc/myapp app=openshift/ruby:2.3 --source=imagestreamtag # Update all deployments' and rc's nginx container's image to 'nginx:1.9.1' oc set image deployments,rc nginx=nginx:1.9.1 --all # Update image of all containers of daemonset abc to 'nginx:1.9.1' oc set image daemonset abc *=nginx:1.9.1 # Print result (in yaml format) of updating nginx container image from local file, without hitting the server oc set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
2.5.1.128. oc set image-lookup
更改部署应用程序时镜像的解析方式
用法示例
# Print all of the image streams and whether they resolve local names oc set image-lookup # Use local name lookup on image stream mysql oc set image-lookup mysql # Force a deployment to use local name lookup oc set image-lookup deploy/mysql # Show the current status of the deployment lookup oc set image-lookup deploy/mysql --list # Disable local name lookup on image stream mysql oc set image-lookup mysql --enabled=false # Set local name lookup on all image streams oc set image-lookup --all
2.5.1.129. oc set probe
更新 pod 模板上的探测
用法示例
# Clear both readiness and liveness probes off all containers oc set probe dc/myapp --remove --readiness --liveness # Set an exec action as a liveness probe to run 'echo ok' oc set probe dc/myapp --liveness -- echo ok # Set a readiness probe to try to open a TCP socket on 3306 oc set probe rc/mysql --readiness --open-tcp=3306 # Set an HTTP startup probe for port 8080 and path /healthz over HTTP on the pod IP oc set probe dc/webapp --startup --get-url=http://:8080/healthz # Set an HTTP readiness probe for port 8080 and path /healthz over HTTP on the pod IP oc set probe dc/webapp --readiness --get-url=http://:8080/healthz # Set an HTTP readiness probe over HTTPS on 127.0.0.1 for a hostNetwork pod oc set probe dc/router --readiness --get-url=https://127.0.0.1:1936/stats # Set only the initial-delay-seconds field on all deployments oc set probe dc --all --readiness --initial-delay-seconds=30
2.5.1.130. oc set resources
使用 pod 模板更新对象上的资源请求/限制
用法示例
# Set a deployments nginx container CPU limits to "200m and memory to 512Mi" oc set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi # Set the resource request and limits for all containers in nginx oc set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi # Remove the resource requests for resources on containers in nginx oc set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0 # Print the result (in YAML format) of updating nginx container limits locally, without hitting the server oc set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --local -o yaml
2.5.1.131. oc set route-backends
更新路由的后端
用法示例
# Print the backends on the route 'web' oc set route-backends web # Set two backend services on route 'web' with 2/3rds of traffic going to 'a' oc set route-backends web a=2 b=1 # Increase the traffic percentage going to b by 10%% relative to a oc set route-backends web --adjust b=+10%% # Set traffic percentage going to b to 10%% of the traffic going to a oc set route-backends web --adjust b=10%% # Set weight of b to 10 oc set route-backends web --adjust b=10 # Set the weight to all backends to zero oc set route-backends web --zero
2.5.1.132. oc set selector
在资源上设置选择器
用法示例
# 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.5.1.133. oc set serviceaccount
更新资源的服务帐户
用法示例
# 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.5.1.134. oc set subject
更新角色绑定或集群角色绑定中的用户、组或服务帐户
用法示例
# Update a cluster role binding for serviceaccount1 oc set subject clusterrolebinding admin --serviceaccount=namespace:serviceaccount1 # Update a role binding for user1, user2, and group1 oc set subject rolebinding admin --user=user1 --user=user2 --group=group1 # Print the result (in YAML format) of updating role binding subjects locally, without hitting the server oc create rolebinding admin --role=admin --user=admin -o yaml --dry-run | oc set subject --local -f - --user=foo -o yaml
2.5.1.135. oc set triggers
更新一个或多个对象上的触发器
用法示例
# Print the triggers on the deployment config 'myapp' oc set triggers dc/myapp # Set all triggers to manual oc set triggers dc/myapp --manual # Enable all automatic triggers oc set triggers dc/myapp --auto # Reset the GitHub webhook on a build to a new, generated secret oc set triggers bc/webapp --from-github oc set triggers bc/webapp --from-webhook # Remove all triggers oc set triggers bc/webapp --remove-all # Stop triggering on config change oc set triggers dc/myapp --from-config --remove # Add an image trigger to a build config oc set triggers bc/webapp --from-image=namespace1/image:latest # Add an image trigger to a stateful set on the main container oc set triggers statefulset/db --from-image=namespace1/image:latest -c main
2.5.1.136. oc set volumes
更新 pod 模板中的卷
用法示例
# List volumes defined on all deployment configs in the current project oc set volume dc --all # Add a new empty dir volume to deployment config (dc) 'myapp' mounted under # /var/lib/myapp oc set volume dc/myapp --add --mount-path=/var/lib/myapp # Use an existing persistent volume claim (pvc) to overwrite an existing volume 'v1' oc set volume dc/myapp --add --name=v1 -t pvc --claim-name=pvc1 --overwrite # Remove volume 'v1' from deployment config 'myapp' oc set volume dc/myapp --remove --name=v1 # Create a new persistent volume claim that overwrites an existing volume 'v1' oc set volume dc/myapp --add --name=v1 -t pvc --claim-size=1G --overwrite # Change the mount point for volume 'v1' to /data oc set volume dc/myapp --add --name=v1 -m /data --overwrite # Modify the deployment config by removing volume mount "v1" from container "c1" # (and by removing the volume "v1" if no other containers have volume mounts that reference it) oc set volume dc/myapp --remove --name=v1 --containers=c1 # Add new volume based on a more complex volume source (AWS EBS, GCE PD, # Ceph, Gluster, NFS, ISCSI, ...) oc set volume dc/myapp --add -m /data --source=<json-string>
2.5.1.137. oc start-build
启动新构建
用法示例
# Starts build from build config "hello-world" oc start-build hello-world # Starts build from a previous build "hello-world-1" oc start-build --from-build=hello-world-1 # Use the contents of a directory as build input oc start-build hello-world --from-dir=src/ # Send the contents of a Git repository to the server from tag 'v2' oc start-build hello-world --from-repo=../hello-world --commit=v2 # Start a new build for build config "hello-world" and watch the logs until the build # completes or fails oc start-build hello-world --follow # Start a new build for build config "hello-world" and wait until the build completes. It # exits with a non-zero return code if the build fails oc start-build hello-world --wait
2.5.1.138. oc status
显示当前项目的概述
用法示例
# See an overview of the current project oc status # Export the overview of the current project in an svg file oc status -o dot | dot -T svg -o project.svg # See an overview of the current project including details for any identified issues oc status --suggest
2.5.1.139. oc tag
将现有镜像标记到镜像流中
用法示例
# Tag the current image for the image stream 'openshift/ruby' and tag '2.0' into the image stream 'yourproject/ruby with tag 'tip' oc tag openshift/ruby:2.0 yourproject/ruby:tip # Tag a specific image oc tag openshift/ruby@sha256:6b646fa6bf5e5e4c7fa41056c27910e679c03ebe7f93e361e6515a9da7e258cc yourproject/ruby:tip # Tag an external container image oc tag --source=docker openshift/origin-control-plane:latest yourproject/ruby:tip # Tag an external container image and request pullthrough for it oc tag --source=docker openshift/origin-control-plane:latest yourproject/ruby:tip --reference-policy=local # Remove the specified spec tag from an image stream oc tag openshift/origin-control-plane:latest -d
2.5.1.140. oc version
输出客户端和服务器版本信息
用法示例
# Print the OpenShift client, kube-apiserver, and openshift-apiserver version information for the current context oc version # Print the OpenShift client, kube-apiserver, and openshift-apiserver version numbers for the current context oc version --short # Print the OpenShift client version information for the current context oc version --client
2.5.1.141. oc wait
实验性:等待一个或多个资源上的特定条件
用法示例
# Wait for the pod "busybox1" to contain the status condition of type "Ready" oc wait --for=condition=Ready pod/busybox1 # The default value of status condition is true; you can set it to false oc wait --for=condition=Ready=false pod/busybox1 # Wait for the pod "busybox1" to be deleted, with a timeout of 60s, after having issued the "delete" command oc delete pod/busybox1 oc wait --for=delete pod/busybox1 --timeout=60s
2.5.1.142. oc whoami
返回有关当前会话的信息
用法示例
# Display the currently authenticated user oc whoami
2.5.2. 其他资源
2.6. OpenShift CLI 管理员命令参考
本参考提供了 OpenShift CLI(oc
)管理员命令的描述和示例命令。您必须具有 cluster-admin
或同等权限才能使用这些命令。
如需开发人员命令,请参阅 OpenShift CLI 开发人员命令参考。
运行 oc adm -h
以列出所有管理员命令或运行 oc <command> --help
获取特定命令的更多详情。
2.6.1. OpenShift CLI(oc)管理员命令
2.6.1.1. oc adm build-chain
输出构建的输入和依赖项
用法示例
# Build the dependency tree for the 'latest' tag in <image-stream> oc adm build-chain <image-stream> # Build the dependency tree for the 'v2' tag in dot format and visualize it via the dot utility oc adm build-chain <image-stream>:v2 -o dot | dot -T svg -o deps.svg # Build the dependency tree across all namespaces for the specified image stream tag found in the 'test' namespace oc adm build-chain <image-stream> -n test --all
2.6.1.2. oc adm catalog mirror
镜像 operator-registry 目录
用法示例
# Mirror an operator-registry image and its contents to a registry oc adm catalog mirror quay.io/my/image:latest myregistry.com # Mirror an operator-registry image and its contents to a particular namespace in a registry oc adm catalog mirror quay.io/my/image:latest myregistry.com/my-namespace # Mirror to an airgapped registry by first mirroring to files oc adm catalog mirror quay.io/my/image:latest file:///local/index oc adm catalog mirror file:///local/index/my/image:latest my-airgapped-registry.com # Configure a cluster to use a mirrored registry oc apply -f manifests/imageContentSourcePolicy.yaml # Edit the mirroring mappings and mirror with "oc image mirror" manually oc adm catalog mirror --manifests-only quay.io/my/image:latest myregistry.com oc image mirror -f manifests/mapping.txt # Delete all ImageContentSourcePolicies generated by oc adm catalog mirror oc delete imagecontentsourcepolicy -l operators.openshift.org/catalog=true
2.6.1.3. oc adm 证书批准
批准证书签名请求
用法示例
# Approve CSR 'csr-sqgzp' oc adm certificate approve csr-sqgzp
2.6.1.4. oc adm 证书拒绝
拒绝证书签名请求
用法示例
# Deny CSR 'csr-sqgzp' oc adm certificate deny csr-sqgzp
2.6.1.5. oc adm completion
输出指定 shell 的 shell 完成代码(bash 或 zsh)
用法示例
# Installing bash completion on macOS using homebrew ## If running Bash 3.2 included with macOS brew install bash-completion ## or, if running Bash 4.1+ brew install bash-completion@2 ## If oc is installed via homebrew, this should start working immediately ## If you've installed via other means, you may need add the completion to your completion directory oc completion bash > $(brew --prefix)/etc/bash_completion.d/oc # Installing bash completion on Linux ## If bash-completion is not installed on Linux, install the 'bash-completion' package ## via your distribution's package manager. ## Load the oc completion code for bash into the current shell source <(oc completion bash) ## Write bash completion code to a file and source it from .bash_profile oc completion bash > ~/.kube/completion.bash.inc printf " # Kubectl shell completion source '$HOME/.kube/completion.bash.inc' " >> $HOME/.bash_profile source $HOME/.bash_profile # Load the oc completion code for zsh[1] into the current shell source <(oc completion zsh) # Set the oc completion code for zsh[1] to autoload on startup oc completion zsh > "${fpath[1]}/_oc"
2.6.1.6. oc adm config current-context
显示 current-context
用法示例
# Display the current-context oc config current-context
2.6.1.7. oc adm config delete-cluster
从 kubeconfig 删除指定的集群
用法示例
# Delete the minikube cluster oc config delete-cluster minikube
2.6.1.8. oc adm config delete-context
从 kubeconfig 删除指定的上下文
用法示例
# Delete the context for the minikube cluster oc config delete-context minikube
2.6.1.9. oc adm config delete-user
从 kubeconfig 删除指定用户
用法示例
# Delete the minikube user oc config delete-user minikube
2.6.1.10. oc adm config get-clusters
显示 kubeconfig 中定义的集群
用法示例
# List the clusters that oc knows about oc config get-clusters
2.6.1.11. oc adm config get-contexts
描述一个或多个上下文
用法示例
# 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.6.1.12. oc adm config get-users
显示 kubeconfig 中定义的用户
用法示例
# List the users that oc knows about oc config get-users
2.6.1.13. oc adm config rename-context
从 kubeconfig 文件中重命名上下文
用法示例
# Rename the context 'old-name' to 'new-name' in your kubeconfig file oc config rename-context old-name new-name
2.6.1.14. oc adm config set
在 kubeconfig 文件中设置单个值
用法示例
# Set the server field on the my-cluster cluster to https://1.2.3.4 oc config set clusters.my-cluster.server https://1.2.3.4 # Set the certificate-authority-data field on the my-cluster cluster oc config set clusters.my-cluster.certificate-authority-data $(echo "cert_data_here" | base64 -i -) # Set the cluster field in the my-context context to my-cluster oc config set contexts.my-context.cluster my-cluster # Set the client-key-data field in the cluster-admin user using --set-raw-bytes option oc config set users.cluster-admin.client-key-data cert_data_here --set-raw-bytes=true
2.6.1.15. oc adm config set-cluster
在 kubeconfig 中设置集群条目
用法示例
# Set only the server field on the e2e cluster entry without touching other values oc config set-cluster e2e --server=https://1.2.3.4 # Embed certificate authority data for the e2e cluster entry oc config set-cluster e2e --embed-certs --certificate-authority=~/.kube/e2e/kubernetes.ca.crt # Disable cert checking for the dev cluster entry oc config set-cluster e2e --insecure-skip-tls-verify=true # Set custom TLS server name to use for validation for the e2e cluster entry oc config set-cluster e2e --tls-server-name=my-cluster-name
2.6.1.16. oc adm config set-context
在 kubeconfig 中设置上下文条目
用法示例
# Set the user field on the gce context entry without touching other values oc config set-context gce --user=cluster-admin
2.6.1.17. oc adm config set-credentials
在 kubeconfig 中设置用户条目
用法示例
# Set only the "client-key" field on the "cluster-admin" # entry, without touching other values oc config set-credentials cluster-admin --client-key=~/.kube/admin.key # Set basic auth for the "cluster-admin" entry oc config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif # Embed client certificate data in the "cluster-admin" entry oc config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true # Enable the Google Compute Platform auth provider for the "cluster-admin" entry oc config set-credentials cluster-admin --auth-provider=gcp # Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args oc config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar # Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry oc config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret- # Enable new exec auth plugin for the "cluster-admin" entry oc config set-credentials cluster-admin --exec-command=/path/to/the/executable --exec-api-version=client.authentication.k8s.io/v1beta1 # Define new exec auth plugin args for the "cluster-admin" entry oc config set-credentials cluster-admin --exec-arg=arg1 --exec-arg=arg2 # Create or update exec auth plugin environment variables for the "cluster-admin" entry oc config set-credentials cluster-admin --exec-env=key1=val1 --exec-env=key2=val2 # Remove exec auth plugin environment variables for the "cluster-admin" entry oc config set-credentials cluster-admin --exec-env=var-to-remove-
2.6.1.18. oc adm config unset
在 kubeconfig 文件中取消设置单个值
用法示例
# Unset the current-context oc config unset current-context # Unset namespace in foo context oc config unset contexts.foo.namespace
2.6.1.19. oc adm config use-context
在 kubeconfig 文件中设置 current-context
用法示例
# Use the context for the minikube cluster oc config use-context minikube
2.6.1.20. oc adm config view
显示合并的 kubeconfig 设置或指定的 kubeconfig 文件
用法示例
# Show merged kubeconfig settings oc config view # Show merged kubeconfig settings and raw certificate data oc config view --raw # Get the password for the e2e user oc config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
2.6.1.21. oc adm cordon
将节点标记为不可调度
用法示例
# Mark node "foo" as unschedulable oc adm cordon foo
2.6.1.22. oc adm create-bootstrap-project-template
创建 bootstrap 项目模板
用法示例
# Output a bootstrap project template in YAML format to stdout oc adm create-bootstrap-project-template -o yaml
2.6.1.23. oc adm create-error-template
创建错误页面模板
用法示例
# Output a template for the error page to stdout oc adm create-error-template
2.6.1.24. oc adm create-login-template
创建登录模板
用法示例
# Output a template for the login page to stdout oc adm create-login-template
2.6.1.25. oc adm create-provider-selection-template
创建供应商选择模板
用法示例
# Output a template for the provider selection page to stdout oc adm create-provider-selection-template
2.6.1.26. 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 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.6.1.27. oc adm groups add-users
将用户添加到组
用法示例
# Add user1 and user2 to my-group oc adm groups add-users my-group user1 user2
2.6.1.28. oc adm groups new
创建一个新组
用法示例
# Add a group with no users oc adm groups new my-group # Add a group with two users oc adm groups new my-group user1 user2 # Add a group with one user and shorter output oc adm groups new my-group user1 -o name
2.6.1.29. oc adm groups prune
从外部提供程序中删除引用缺失记录的旧 OpenShift 组
用法示例
# Prune all orphaned groups oc adm groups prune --sync-config=/path/to/ldap-sync-config.yaml --confirm # Prune all orphaned groups except the ones from the blacklist file oc adm groups prune --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm # Prune all orphaned groups from a list of specific groups specified in a whitelist file oc adm groups prune --whitelist=/path/to/whitelist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm # Prune all orphaned groups from a list of specific groups specified in a whitelist oc adm groups prune groups/group_name groups/other_name --sync-config=/path/to/ldap-sync-config.yaml --confirm
2.6.1.30. oc adm groups remove-users
从组中删除用户
用法示例
# Remove user1 and user2 from my-group oc adm groups remove-users my-group user1 user2
2.6.1.31. oc adm groups sync
将 OpenShift 组与来自外部提供程序的记录同步
用法示例
# Sync all groups with an LDAP server oc adm groups sync --sync-config=/path/to/ldap-sync-config.yaml --confirm # Sync all groups except the ones from the blacklist file with an LDAP server oc adm groups sync --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm # Sync specific groups specified in a whitelist file with an LDAP server oc adm groups sync --whitelist=/path/to/whitelist.txt --sync-config=/path/to/sync-config.yaml --confirm # Sync all OpenShift groups that have been synced previously with an LDAP server oc adm groups sync --type=openshift --sync-config=/path/to/ldap-sync-config.yaml --confirm # Sync specific OpenShift groups if they have been synced previously with an LDAP server oc adm groups sync groups/group1 groups/group2 groups/group3 --sync-config=/path/to/sync-config.yaml --confirm
2.6.1.32. oc adm inspect
为给定资源收集调试数据
用法示例
# Collect debugging data for the "openshift-apiserver" clusteroperator oc adm inspect clusteroperator/openshift-apiserver # Collect debugging data for the "openshift-apiserver" and "kube-apiserver" clusteroperators oc adm inspect clusteroperator/openshift-apiserver clusteroperator/kube-apiserver # Collect debugging data for all clusteroperators oc adm inspect clusteroperator # Collect debugging data for all clusteroperators and clusterversions oc adm inspect clusteroperators,clusterversions
2.6.1.33. oc adm migrate template-instances
更新模板实例以指向最新的 group-version-kinds
用法示例
# 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.6.1.34. oc adm must-gather
启动用于收集调试信息的 pod 的新实例
用法示例
# Gather information using the default plug-in image and command, writing into ./must-gather.local.<rand> oc adm must-gather # Gather information with a specific local folder to copy to oc adm must-gather --dest-dir=/local/directory # Gather audit information oc adm must-gather -- /usr/bin/gather_audit_logs # Gather information using multiple plug-in images oc adm must-gather --image=quay.io/kubevirt/must-gather --image=quay.io/openshift/origin-must-gather # Gather information using a specific image stream plug-in oc adm must-gather --image-stream=openshift/must-gather:latest # Gather information using a specific image, command, and pod-dir oc adm must-gather --image=my/image:tag --source-dir=/pod/directory -- myspecial-command.sh
2.6.1.35. oc adm new-project
创建新项目
用法示例
# Create a new project using a node selector oc adm new-project myproject --node-selector='type=user-node,region=east'
2.6.1.36. oc adm node-logs
显示和过滤节点日志
用法示例
# Show kubelet logs from all masters oc adm node-logs --role master -u kubelet # See what logs are available in masters in /var/logs oc adm node-logs --role master --path=/ # Display cron log file from all masters oc adm node-logs --role master --path=cron
2.6.1.37. oc adm pod-network isolate-projects
隔离项目网络
用法示例
# 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.6.1.38. oc adm pod-network join-projects
加入项目网络
用法示例
# 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.6.1.39. oc adm pod-network make-projects-global
使项目网络为全局有效
用法示例
# 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.6.1.40. oc adm policy add-role-to-user
为当前项目的用户或服务帐户添加角色
用法示例
# 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.6.1.41. oc adm policy add-scc-to-group
为组添加安全性上下文约束
用法示例
# Add the 'restricted' security context constraint to group1 and group2 oc adm policy add-scc-to-group restricted group1 group2
2.6.1.42. oc adm policy add-scc-to-user
为用户或服务帐户添加安全性上下文约束
用法示例
# 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.6.1.43. oc adm policy scc-review
检查哪个服务帐户可以创建 pod
用法示例
# Check whether service accounts sa1 and sa2 can admit a pod with a template pod spec specified in my_resource.yaml # Service Account specified in myresource.yaml file is ignored oc policy scc-review -z sa1,sa2 -f my_resource.yaml # Check whether service accounts system:serviceaccount:bob:default can admit a pod with a template pod spec specified in my_resource.yaml oc policy scc-review -z system:serviceaccount:bob:default -f my_resource.yaml # Check whether the service account specified in my_resource_with_sa.yaml can admit the pod oc policy scc-review -f my_resource_with_sa.yaml # Check whether the default service account can admit the pod; default is taken since no service account is defined in myresource_with_no_sa.yaml oc policy scc-review -f myresource_with_no_sa.yaml
2.6.1.44. oc adm policy scc-subject-review
检查用户或服务帐户是否可以创建 pod
用法示例
# Check whether user bob can create a pod specified in myresource.yaml oc policy scc-subject-review -u bob -f myresource.yaml # Check whether user bob who belongs to projectAdmin group can create a pod specified in myresource.yaml oc policy scc-subject-review -u bob -g projectAdmin -f myresource.yaml # Check whether a service account specified in the pod template spec in myresourcewithsa.yaml can create the pod oc policy scc-subject-review -f myresourcewithsa.yaml
2.6.1.45. oc adm prune builds
删除旧的完成和失败的构建
用法示例
# Dry run deleting older completed and failed builds and also including # all builds whose associated build config no longer exists oc adm prune builds --orphans # To actually perform the prune operation, the confirm flag must be appended oc adm prune builds --orphans --confirm
2.6.1.46. oc adm prune deployments
删除旧的完成和失败的部署配置
用法示例
# 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.6.1.47. oc adm prune groups
从外部提供程序中删除引用缺失记录的旧 OpenShift 组
用法示例
# Prune all orphaned groups oc adm prune groups --sync-config=/path/to/ldap-sync-config.yaml --confirm # Prune all orphaned groups except the ones from the blacklist file oc adm prune groups --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm # Prune all orphaned groups from a list of specific groups specified in a whitelist file oc adm prune groups --whitelist=/path/to/whitelist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm # Prune all orphaned groups from a list of specific groups specified in a whitelist oc adm prune groups groups/group_name groups/other_name --sync-config=/path/to/ldap-sync-config.yaml --confirm
2.6.1.48. oc adm prune images
删除未引用的镜像
用法示例
# See what the prune command would delete if only images and their referrers were more than an hour old # and obsoleted by 3 newer revisions under the same tag were considered oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m # To actually perform the prune operation, the confirm flag must be appended oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm # See what the prune command would delete if we are interested in removing images # exceeding currently set limit ranges ('openshift.io/Image') oc adm prune images --prune-over-size-limit # To actually perform the prune operation, the confirm flag must be appended oc adm prune images --prune-over-size-limit --confirm # Force the insecure http protocol with the particular registry host name oc adm prune images --registry-url=http://registry.example.org --confirm # Force a secure connection with a custom certificate authority to the particular registry host name oc adm prune images --registry-url=registry.example.org --certificate-authority=/path/to/custom/ca.crt --confirm
2.6.1.49. oc adm release extract
将更新有效负载的内容提取到磁盘
用法示例
# Use git to check out the source code for the current cluster release to DIR oc adm release extract --git=DIR # Extract cloud credential requests for AWS oc adm release extract --credentials-requests --cloud=aws
2.6.1.50. oc adm release info
显示发行版本的信息
用法示例
# Show information about the cluster's current release oc adm release info # Show the source code that comprises a release oc adm release info 4.2.2 --commit-urls # Show the source code difference between two releases oc adm release info 4.2.0 4.2.2 --commits # Show where the images referenced by the release are located oc adm release info quay.io/openshift-release-dev/ocp-release:4.2.2 --pullspecs
2.6.1.51. oc adm release mirror
将发行版本 mirror 到不同的镜像 registry 位置
用法示例
# Perform a dry run showing what would be mirrored, including the mirror objects oc adm release mirror 4.3.0 --to myregistry.local/openshift/release \ --release-image-signature-to-dir /tmp/releases --dry-run # Mirror a release into the current directory oc adm release mirror 4.3.0 --to file://openshift/release \ --release-image-signature-to-dir /tmp/releases # Mirror a release to another directory in the default location oc adm release mirror 4.3.0 --to-dir /tmp/releases # Upload a release from the current directory to another server oc adm release mirror --from file://openshift/release --to myregistry.com/openshift/release \ --release-image-signature-to-dir /tmp/releases # Mirror the 4.3.0 release to repository registry.example.com and apply signatures to connected cluster oc adm release mirror --from=quay.io/openshift-release-dev/ocp-release:4.3.0-x86_64 \ --to=registry.example.com/your/repository --apply-release-image-signature
2.6.1.52. oc adm release new
创建新的 OpenShift 发行版本
用法示例
# Create a release from the latest origin images and push to a DockerHub repo oc adm release new --from-image-stream=4.1 -n origin --to-image docker.io/mycompany/myrepo:latest # Create a new release with updated metadata from a previous release oc adm release new --from-release registry.svc.ci.openshift.org/origin/release:v4.1 --name 4.1.1 \ --previous 4.1.0 --metadata ... --to-image docker.io/mycompany/myrepo:latest # Create a new release and override a single image oc adm release new --from-release registry.svc.ci.openshift.org/origin/release:v4.1 \ cli=docker.io/mycompany/cli:latest --to-image docker.io/mycompany/myrepo:latest # Run a verification pass to ensure the release can be reproduced oc adm release new --from-release registry.svc.ci.openshift.org/origin/release:v4.1
2.6.1.53. oc adm taint
更新一个或多个节点上的污点
用法示例
# Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule' # If a taint with that key and effect already exists, its value is replaced as specified oc adm taint nodes foo dedicated=special-user:NoSchedule # Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists oc adm taint nodes foo dedicated:NoSchedule- # Remove from node 'foo' all the taints with key 'dedicated' oc adm taint nodes foo dedicated- # Add a taint with key 'dedicated' on nodes having label mylabel=X oc adm taint node -l myLabel=X dedicated=foo:PreferNoSchedule # Add to node 'foo' a taint with key 'bar' and no value oc adm taint nodes foo bar:NoSchedule
2.6.1.54. oc adm top images
显示镜像的用量统计
用法示例
# Show usage statistics for images oc adm top images
2.6.1.55. oc adm top imagestreams
显示镜像流的用量统计
用法示例
# Show usage statistics for image streams oc adm top imagestreams
2.6.1.56. oc adm top node
显示节点的资源(CPU/内存)使用情况
用法示例
# Show metrics for all nodes oc adm top node # Show metrics for a given node oc adm top node NODE_NAME
2.6.1.57. oc adm top pod
显示 pod 的资源(CPU/内存)使用情况
用法示例
# Show metrics for all pods in the default namespace oc adm top pod # Show metrics for all pods in the given namespace oc adm top pod --namespace=NAMESPACE # Show metrics for a given pod and its containers oc adm top pod POD_NAME --containers # Show metrics for the pods defined by label name=myLabel oc adm top pod -l name=myLabel
2.6.1.58. oc adm uncordon
将节点标记为可调度
用法示例
# Mark node "foo" as schedulable oc adm uncordon foo
2.6.1.59. oc adm verify-image-signature
验证镜像签名中包含的镜像身份
用法示例
# Verify the image signature and identity using the local GPG keychain oc adm verify-image-signature sha256:c841e9b64e4579bd56c794bdd7c36e1c257110fd2404bebbb8b613e4935228c4 \ --expected-identity=registry.local:5000/foo/bar:v1 # Verify the image signature and identity using the local GPG keychain and save the status oc adm verify-image-signature sha256:c841e9b64e4579bd56c794bdd7c36e1c257110fd2404bebbb8b613e4935228c4 \ --expected-identity=registry.local:5000/foo/bar:v1 --save # Verify the image signature and identity via exposed registry route oc adm verify-image-signature sha256:c841e9b64e4579bd56c794bdd7c36e1c257110fd2404bebbb8b613e4935228c4 \ --expected-identity=registry.local:5000/foo/bar:v1 \ --registry-url=docker-registry.foo.com # Remove all signature verifications from the image oc adm verify-image-signature sha256:c841e9b64e4579bd56c794bdd7c36e1c257110fd2404bebbb8b613e4935228c4 --remove-all
2.6.2. 其他资源
2.7. oc 和 kubectl 命令的使用方法
Kubernetes 命令行界面(CLI)kubectl
可以用来对 Kubernetes 集群运行命令。由于 OpenShift Container Platform 是经过认证的 Kubernetes 发行版本,因此您可以使用 OpenShift Container Platform 附带的受支持的 kubectl
二进制文件,或者使用 oc
二进制文件来获得扩展的功能。
2.7.1. oc 二进制文件
oc
二进制文件提供与 kubectl
二进制文件相同的功能,但它经过扩展,可原生支持额外的 OpenShift Container Platform 功能,包括:
对 OpenShift Container Platform 资源的完整支持
DeploymentConfig
、BuildConfig
、Route
、ImageStream
和ImageStreamTag
对象等资源特定于 OpenShift Container Platform 发行版本,并基于标准 Kubernetes 原语构建。身份验证
oc
二进制文件提供了一个内置login
命令,此命令可进行身份验证,并让您处理 OpenShift Container Platform 项目,这会将 Kubernetes 命名空间映射到经过身份验证的用户。如需更多信息,请参阅了解身份验证。附加命令
例如,借助附加命令
oc new-app
可以更轻松地使用现有源代码或预构建镜像来启动新的应用程序。同样,附加命令oc new-project
让您可以更轻松地启动一个项目并切换到该项目作为您的默认项目。
如果安装了旧版本的 oc
二进制文件,则无法使用 OpenShift Container Platform 4.9 中的所有命令。如果要使用最新的功能,您必须下载并安装与 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.7.2. kubectl 二进制文件
提供 kubectl
二进制文件的目的是为来自标准 Kubernetes 环境的新 OpenShift Container Platform 用户或者希望使用 kubectl
CLI 的用户支持现有工作流和脚本。kubectl
的现有用户可以继续使用二进制文件与 Kubernetes 原语交互,而不需要对 OpenShift Container Platform 集群进行任何更改。
您可以按照安装 OpenShift CLI 的步骤安装受支持的 kubectl
二进制文件。如果您下载二进制文件,或者在使用 RPM 安装 CLI 时安装,则 kubectl
二进制文件会包括在存档中。
如需更多信息,请参阅 kubectl 文档。
第 3 章 开发人员 CLI (odo)
3.1. odo
发行注记
3.1.1. odo
版本 2.5.0 中的显著变化和改进
-
使用
adler32
哈希来为每个组件创建唯一路由 支持 devfile 中的其他字段来分配资源:
- cpuRequest
- cpuLimit
- memoryRequest
- memoryLimit
在
odo delete
命令中添加--deploy
标志,删除使用odo deploy
命令部署的组件:$ odo delete --deploy
-
在
odo link
命令中添加映射支持 -
支持临时卷,使用
volume
组件中的ephemeral
字段。 -
在请求遥测选择时,将默认回答设置为
yes
- 通过将额外的遥测数据发送到 devfile registry 来提高指标
-
将 bootstrap 镜像更新至
registry.access.redhat.com/ocp-tools-4/odo-init-container-rhel8:1.1.11
- 上游存储库位于 https://github.com/redhat-developer/odo
3.1.2. 程序错误修复
-
在以前的版本中,如果
.odo/env
文件不存在,odo deploy
将失败。现在,如果需要,请创建.odo/env
文件。 -
在以前的版本中,如果断开与集群的连接,使用
odo create
命令创建交互式组件会失败。此问题已在最新的发行版本中解决。
3.1.3. 获取支持
对于产品
如果您发现了错误,遇到问题或者有改进 odo
功能的建议,请在 Bugzilla 中提交问题。选择 OpenShift Developer Tools and Services 作为产品类型,odo 作为组件。
请在问题描述中提供尽可能多的细节。
对于文档
如果您发现了错误或有改进文档的建议,请为相关文档组件提交 JIRA 问题。
3.2. 了解 odo
Red Hat OpenShift Developer CLI(odo
)是在 OpenShift Container Platform 和 Kubernetes 上创建应用程序的工具。使用 odo
,您可以在 Kubernetes 集群中开发、测试、调试和部署基于微服务的应用,而无需深入了解平台。
odo
遵循 创建和推送 工作流。作为用户,当您创建时,信息(或清单)存储在配置文件中。推送 时,会在 Kubernetes 集群中创建对应的资源。所有这些配置都存储在 Kubernetes API 中,以实现无缝访问和功能。
odo
使用 service 和 link 命令将组件和服务链接在一起。odo
通过使用集群中的 Kubernetes Operator 创建和部署服务来实现这个目标。可使用 Operator Hub 上可用的任何 Operator 创建服务。在链接服务后,odo
会将服务配置注入组件。然后,应用程序就可以使用此配置与 Operator 支持的服务通信。
3.2.1. odo 的主要功能
odo
的设计目的是为 Kubernetes 的开发人员提供一个友好的 Kubernetes 接口,能够:
- 通过创建新清单或使用现有清单,在 Kubernetes 集群上快速部署应用程序
- 使用命令轻松创建和更新清单,而无需理解和维护 Kubernetes 配置文件
- 提供对在 Kubernetes 集群上运行的应用程序的安全访问
- 为 Kubernetes 集群上的应用程序添加和删除额外存储
- 创建 Operator 支持的服务,并将应用程序链接到它们
-
在作为
odo
组件部署的多个微服务间创建一个链接 -
在 IDE 中使用
odo
进行远程调试应用程序 -
使用
odo
轻松测试 Kubernetes 上部署的应用程序
3.2.2. odo 核心概念
odo
将 Kubernetes 概念抽象化为开发人员熟悉的术语:
- Application(应用程序)
使用 云原生方法 开发的典型应用,用于执行特定的任务。
应用程序示例包括在线视频流、在线购物和酒店预订系统。
- 组件
一组可单独运行和部署的 Kubernetes 资源。云原生应用是一系列小、独立、松散耦合的组件。
组件示例包括 API 后端、Web 界面和支付后端。
- 项目
- 包含源代码、测试和库的单一单元。
- Context
-
包含单一组件的源代码、测试、库和
odo
配置文件的目录。 - URL
- 公开组件的机制可从集群外部访问。
- 存储
- 集群中的持久性存储。它会在重启和组件重建过程中保留数据。
- Service
为组件提供额外的功能的外部应用程序。
服务 示例包括 PostgreSQL、MySQL、Redis 和 RabbitMQ。
在
odo
中,服务从 OpenShift Service Catalog 置备,且必须在集群中启用。- devfile
用于定义容器化开发环境的开放式标准,使开发人员工具可以简化和加速工作流。如需更多信息,请参阅文档 https://devfile.io。
您可以连接到公开可用的 devfile registry,也可以安装安全 registry。
3.2.3. 列出 odo 中的组件
odo
使用可移植 devfile 格式来描述组件及其相关 URL、存储和服务。odo
可以连接到各种 devfile registry,以下载用于不同语言和框架的 devfile。有关如何管理 odo registry
用来检索 devfile 信息的更多信息,请参阅 odo
registry 命令的文档。
您可以使用 odo catalog list components
命令列出不同 registry 的所有 devfile。
流程
使用
odo
登陆到集群:$ odo login -u developer -p developer
列出可用的
odo
组件:$ odo catalog list components
输出示例
Odo Devfile Components: NAME DESCRIPTION REGISTRY dotnet50 Stack with .NET 5.0 DefaultDevfileRegistry dotnet60 Stack with .NET 6.0 DefaultDevfileRegistry dotnetcore31 Stack with .NET Core 3.1 DefaultDevfileRegistry go Stack with the latest Go version DefaultDevfileRegistry java-maven Upstream Maven and OpenJDK 11 DefaultDevfileRegistry java-openliberty Java application Maven-built stack using the Open Liberty ru... DefaultDevfileRegistry java-openliberty-gradle Java application Gradle-built stack using the Open Liberty r... DefaultDevfileRegistry java-quarkus Quarkus with Java DefaultDevfileRegistry java-springboot Spring Boot® using Java DefaultDevfileRegistry java-vertx Upstream Vert.x using Java DefaultDevfileRegistry java-websphereliberty Java application Maven-built stack using the WebSphere Liber... DefaultDevfileRegistry java-websphereliberty-gradle Java application Gradle-built stack using the WebSphere Libe... DefaultDevfileRegistry java-wildfly Upstream WildFly DefaultDevfileRegistry java-wildfly-bootable-jar Java stack with WildFly in bootable Jar mode, OpenJDK 11 and... DefaultDevfileRegistry nodejs Stack with Node.js 14 DefaultDevfileRegistry nodejs-angular Stack with Angular 12 DefaultDevfileRegistry nodejs-nextjs Stack with Next.js 11 DefaultDevfileRegistry nodejs-nuxtjs Stack with Nuxt.js 2 DefaultDevfileRegistry nodejs-react Stack with React 17 DefaultDevfileRegistry nodejs-svelte Stack with Svelte 3 DefaultDevfileRegistry nodejs-vue Stack with Vue 3 DefaultDevfileRegistry php-laravel Stack with Laravel 8 DefaultDevfileRegistry python Python Stack with Python 3.7 DefaultDevfileRegistry python-django Python3.7 with Django DefaultDevfileRegistry
3.2.4. odo 中的 Telemetry
odo
会收集有关如何使用它的信息,包括操作系统、RAM、CPU、内核数量、odo
版本、错误、成功/失败以及 odo
命令完成所需的时间。
您可以使用 odo preference
命令修改遥测同意:
-
odo preference set ConsentTelemetry true
代表同意遥测。 -
odo preference unset ConsentTelemetry
会禁用 Telemetry。 -
odo preference view
显示当前的首选项。
3.3. 安装 odo
您可以通过下载二进制文件,在 Linux、Windows 或 macOS 上安装 odo
CLI。您还可以安装 OpenShift VS Code 扩展,它使用 odo
和 oc
二进制文件与 OpenShift Container Platform 集群交互。对于 Red Hat Enterprise Linux(RHEL),您可以使用 RPM 安装 odo
CLI。
目前,odo
不支持在限制的网络环境中安装。
3.3.1. 在 Linux 中安装 odo
odo
CLI 可作为二进制文件下载,并为多个操作系统和架构提供 tarball,其中包括:
操作系统 | 二进制 | Tarball |
---|---|---|
Linux | ||
Linux on IBM Power | ||
Linux on IBM Z 和 LinuxONE |
流程
进入内容网关,再下载适用于您的操作系统和架构的适当文件。
如果下载二进制文件,请将其重命名为
odo
:$ curl -L https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-amd64 -o odo
如果下载 tarball,解压二进制文件:
$ curl -L https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-amd64.tar.gz -o odo.tar.gz $ tar xvzf odo.tar.gz
更改二进制的权限:
$ chmod +x <filename>
将
odo
二进制文件放到PATH
中的目录中。要查看您的
PATH
,请执行以下命令:$ echo $PATH
验证您的系统中现在可用的
odo
:$ odo version
3.3.2. 在 Windows 中安装 odo
用于 Windows 的 odo
CLI 可作为二进制文件下载,并作为一个存档。
操作系统 | 二进制 | Tarball |
---|---|---|
Windows |
流程
进入 内容网关 并下载相应的文件:
-
如果您下载了二进制文件,请将其重命名为
odo.exe
。 -
如果您下载了一个存档包,使用 ZIP 程序解压二进制文件,然后将其重命名为
odo.exe
。
-
如果您下载了二进制文件,请将其重命名为
将
odo.exe
二进制文件移到PATH
中的一个目录中。要查看您的
PATH
,请打开命令提示并执行以下命令:C:\> path
验证您的系统中现在可用的
odo
:C:\> odo version
3.3.3. 在 macOS 中安装 odo
macOS 的 odo
CLI 可用于下载作为一个二进制文件,并作为 tarball 进行下载。
操作系统 | 二进制 | Tarball |
---|---|---|
macOS |
流程
进入 内容网关 并下载相应的文件:
如果下载二进制文件,请将其重命名为
odo
:$ curl -L https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64 -o odo
如果下载 tarball,解压二进制文件:
$ curl -L https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64.tar.gz -o odo.tar.gz $ tar xvzf odo.tar.gz
更改二进制的权限:
# chmod +x odo
将
odo
二进制文件放到PATH
中的目录中。要查看您的
PATH
,请执行以下命令:$ echo $PATH
验证您的系统中现在可用的
odo
:$ odo version
3.3.4. 在 VS Code 上安装 odo
OpenShift VS Code 扩展 使用 odo
和 oc
二进制文件来与 OpenShift Container Platform 集群交互。要使用这些功能,在 VS Code 中安装 OpenShift VS Code 扩展。
先决条件
- 您已安装了 VS Code。
流程
- 打开 VS Code.
-
使用
Ctrl
+P
启动 VS Code Quick Open。 输入以下命令:
$ ext install redhat.vscode-openshift-connector
3.3.5. 使用 RPM 在 Red Hat Enterprise Linux(RHEL)中安装 odo
对于 Red Hat Enterprise Linux(RHEL),您可以使用 RPM 安装 odo
CLI。
流程
使用 Red Hat Subscription Manager 注册:
# subscription-manager register
获取最新的订阅数据:
# subscription-manager refresh
列出可用的订阅:
# subscription-manager list --available --matches '*OpenShift Developer Tools and Services*'
在上一命令的输出中,找到 OpenShift Container Platform 订阅的
Pool ID
字段,并把订阅附加到注册的系统:# subscription-manager attach --pool=<pool_id>
启用
odo
所需的存储库:# subscription-manager repos --enable="ocp-tools-4.9-for-rhel-8-x86_64-rpms"
安装
odo
软件包:# yum install odo
验证您的系统中现在可用的
odo
:$ odo version
3.4. 配置 odo CLI
您可以在 preference.yaml
文件中找到 odo
的全局设置,该文件位于 $HOME/.odo
目录中。
您可以通过导出 GLOBALODOCONFIG
变量来为 preference.yaml
文件设置不同的位置。
3.4.1. 查看当前配置
您可以使用以下命令查看当前的 odo
CLI 配置:
$ odo preference view
输出示例
PARAMETER CURRENT_VALUE UpdateNotification NamePrefix Timeout BuildTimeout PushTimeout Ephemeral ConsentTelemetry true
3.4.2. 设置值
您可以使用以下命令为首选键设置值:
$ odo preference set <key> <value>
首选项键不区分大小写。
示例命令
$ odo preference set updatenotification false
输出示例
Global preference was successfully updated
3.4.3. 取消设置值
您可以使用以下命令为首选键取消设置值:
$ odo preference unset <key>
您可以使用 -f
标志跳过确认。
示例命令
$ odo preference unset updatenotification ? Do you want to unset updatenotification in the preference (y/N) y
输出示例
Global preference was successfully updated
3.4.4. 首选键盘表
下表显示了为 odo
CLI 设置首选项键的可用选项:
首选键 | 描述 | 默认值 |
---|---|---|
|
控制是否显示更新 | True |
|
为 | 当前目录名称 |
| Kubernetes 服务器连接检查的超时。 | 1 秒 |
| 等待 git 组件的构建完成超时。 | 300 秒 |
| 等待组件启动超时。 | 240 秒 |
|
控制 | True |
|
控制 | False |
3.4.5. 忽略文件或特征
您可以通过修改应用程序根目录中的 .odoignore
文件来配置要忽略的文件或模式列表。这适用于 odo push
和 odo watch
。
如果 .odoignore 文件
不 存在,则会使用 .gitignore
文件来忽略特定的文件和文件夹。
要忽略 .git
文件、任意带有 .js
扩展名的文件,以及 tests
目录,在 .odoignore
或 .gitignore
文件中添加以下内容:
.git *.js tests/
.odoignore 文件
允许任何 glob 表达式。
3.5. odo CLI 参考指南
3.5.1. odo build-images
odo
可根据 Dockerfile 构建容器镜像,并将这些镜像推送到 registry。
在运行 odo build-images
命令时,odo
会使用 镜像
类型搜索 devfile.yaml
中的所有组件,例如:
components: - image: imageName: quay.io/myusername/myimage dockerfile: uri: ./Dockerfile 1 buildContext: ${PROJECTS_ROOT} 2 name: component-built-from-dockerfile
对于每个镜像组件,odo 执行 podman
或 docker
(按此顺序找到的第一个),以使用指定的 Dockerfile、构建上下文和参数构建镜像。
如果将 --push
标志传递给命令,则镜像会在构建后推送到其 registry。
3.5.2. odo catalog
odo
使用不同的目录来部署组件和服务。
3.5.2.1. 组件
odo
使用可移植 devfile 格式来描述组件。它可以连接到各种 devfile registry,以便为不同的语言和框架下载 devfile。如需更多信息,请参阅 odo registry
。
3.5.2.1.1. 列出组件
要列出不同 registry 中可用的所有 devfile,请运行以下命令:
$ odo catalog list components
输出示例
NAME DESCRIPTION REGISTRY go Stack with the latest Go version DefaultDevfileRegistry java-maven Upstream Maven and OpenJDK 11 DefaultDevfileRegistry nodejs Stack with Node.js 14 DefaultDevfileRegistry php-laravel Stack with Laravel 8 DefaultDevfileRegistry python Python Stack with Python 3.7 DefaultDevfileRegistry [...]
3.5.2.1.2. 获取有关组件的信息
要获得有关特定组件的更多信息,请运行以下命令:
$ odo catalog describe component
例如,运行以下命令:
$ odo catalog describe component nodejs
输出示例
* Registry: DefaultDevfileRegistry 1 Starter Projects: 2 --- name: nodejs-starter attributes: {} description: "" subdir: "" projectsource: sourcetype: "" git: gitlikeprojectsource: commonprojectsource: {} checkoutfrom: null remotes: origin: https://github.com/odo-devfiles/nodejs-ex.git zip: null custom: null
如需有关从入门项目创建项目的更多信息,请参阅 odo create
。
3.5.2.2. 服务
odo
可使用 Operator 帮助部署服务。
odo 仅支持 Operator Lifecycle Manager 帮助部署的 Operator。
3.5.2.2.1. 列出服务
要列出可用的 Operator 及其关联的服务,请运行以下命令:
$ odo catalog list services
输出示例
Services available through Operators NAME CRDs postgresql-operator.v0.1.1 Backup, Database redis-operator.v0.8.0 RedisCluster, Redis
在本例中,集群中安装两个 Operator。postgresql-operator.v0.1.1
Operator 部署与 PostgreSQL 相关的服务: Backup
和 Database
。redis-operator.v0.8.0
Operator 将部署与 Redis 相关的服务:RedisCluster
和 Redis
。
要获取所有可用 Operator 的列表,odo
会获取当前处于 Succeeded 阶段的当前命名空间的 ClusterServiceVersion(CSV)资源。对于支持集群范围的访问权限的 Operator,当创建新命名空间时,这些资源会自动添加到其中。但是,在 Succeeded 阶段前可能需要一些时间,odo
可能会返回空列表,直到资源就绪为止。
3.5.2.2.2. 搜索服务
要通过关键字搜索特定服务,请运行以下命令:
$ odo catalog search service
例如,要检索 PostgreSQL 服务,请运行以下命令:
$ odo catalog search service postgres
输出示例
Services available through Operators NAME CRDs postgresql-operator.v0.1.1 Backup, Database
您将看到在其名称中包含 search 关键字的 Operator 列表。
3.5.2.2.3. 获取有关服务的信息
要获取有关特定服务的更多信息,请运行以下命令:
$ odo catalog describe service
例如:
$ odo catalog describe service postgresql-operator.v0.1.1/Database
输出示例
KIND: Database VERSION: v1alpha1 DESCRIPTION: Database is the Schema for the the Database Database API FIELDS: awsAccessKeyId (string) AWS S3 accessKey/token ID Key ID of AWS S3 storage. Default Value: nil Required to create the Secret with the data to allow send the backup files to AWS S3 storage. [...]
服务通过 CustomResourceDefinition(CRD)资源表示在集群中。上一命令显示 CRD 的详细信息,如 kind
、version
,以及用于定义此自定义资源实例的字段列表。
从 CRD 中包含的 OpenAPI schema 中提取字段列表。此信息在 CRD 中是可选的,如果不存在,它将从代表该服务的 ClusterServiceVersion(CSV)资源中提取。
也可以请求 Operator 支持的服务的描述,而无需提供 CRD 类型信息。要描述没有 CRD 的集群中的 Redis Operator,请运行以下命令:
$ odo catalog describe service redis-operator.v0.8.0
输出示例
NAME: redis-operator.v0.8.0 DESCRIPTION: A Golang based redis operator that will make/oversee Redis standalone/cluster mode setup on top of the Kubernetes. It can create a redis cluster setup with best practices on Cloud as well as the Bare metal environment. Also, it provides an in-built monitoring capability using ... (cut short for beverity) Logging Operator is licensed under [Apache License, Version 2.0](https://github.com/OT-CONTAINER-KIT/redis-operator/blob/master/LICENSE) CRDs: NAME DESCRIPTION RedisCluster Redis Cluster Redis Redis
3.5.3. odo create
odo
使用 devfile 来存储组件的配置,并描述组件的资源,如存储和服务。odo create 命令生成这个文件。
3.5.3.1. 创建组件
要为现有项目创建 devfile,请运行 odo create
命令,使用组件的名称和类型(例如 nodejs
或 go
):
odo create nodejs mynodejs
在示例中,nodejs
是组件的类型,mynodejs
是 odo
为您创建的组件的名称。
如需所有支持的组件类型列表,请运行 odo catalog list components
命令。
如果您的源代码存在于当前目录之外,可以使用 --context
标志来指定路径。例如,如果 nodejs 组件的源位于相对于当前工作目录的名为 node-backend
的文件夹,则运行以下命令:
odo create nodejs mynodejs --context ./node-backend
--context
标志支持相对和绝对路径。
要指定部署组件的项目或应用程序,请使用 --project
和 --app
标志。例如,要在 backend
项目中创建一个部分 myapp
应用程序的组件,请运行以下命令:
odo create nodejs --app myapp --project backend
如果没有指定这些标志,它们将默认为活跃的应用和项目。
3.5.3.2. Starter (初学者)项目
如果您没有现有的源代码,但希望快速设置并运行,请使用初学者项目来试验 devfile 和组件。要使用初学者项目,在 odo create
命令中添加 --starter
标志。
要获取组件类型的可用启动程序项目列表,请运行 odo catalog describe component
命令。例如,若要获取 nodejs 组件类型的所有可用入门项目,请运行以下命令:
odo catalog describe component nodejs
然后,在 odo create
命令中使用 --starter
标志指定所需的项目:
odo create nodejs --starter nodejs-starter
这将下载与所选组件类型对应的示例模板,在本例中为 nodejs
。模板已下载到您的当前目录中,或附加到 --context
标志指定的位置。如果初学者项目有自己的 devfile,则会保留此 devfile。
3.5.3.3. 使用现有的 devfile
如果要从现有 devfile 创建新组件,您可以使用 --devfile
标志指定 devfile 的路径。例如,要基于 GitHub 中的 devfile 创建名为 mynodejs
的组件,请使用以下命令:
odo create mynodejs --devfile https://raw.githubusercontent.com/odo-devfiles/registry/master/devfiles/nodejs/devfile.yaml
3.5.3.4. 互动创建
您还可以以互动方式运行 odo create
命令,以引导您按照创建组件所需的步骤进行指导:
$ odo create
? Which devfile component type do you wish to create go
? What do you wish to name the new devfile component go-api
? What project do you want the devfile component to be created in default
Devfile Object Validation
✓ Checking devfile existence [164258ns]
✓ Creating a devfile component from registry: DefaultDevfileRegistry [246051ns]
Validation
✓ Validating if devfile name is correct [92255ns]
? Do you want to download a starter project Yes
Starter Project
✓ Downloading starter project go-starter from https://github.com/devfile-samples/devfile-stack-go.git [429ms]
Please use odo push
command to create the component with source deployed
系统将提示您选择组件类型、名称和项目。您还可以选择是否下载初学者项目。完成后,在工作目录中创建一个新的 devfile.yaml
文件。
要将这些资源部署到集群中,请运行 odo push
命令。
3.5.4. odo delete
odo delete
命令对删除由 odo
管理的资源很有用。
3.5.4.1. 删除组件
要删除 devfile 组件,请运行 odo delete
命令:
$ odo delete
如果组件已推送到集群,则组件将从集群中删除,以及其依赖存储、URL、secret 和其他资源。如果组件还没有推送,则命令退出并显示一个错误,表示它无法找到集群中的资源。
使用 -f
或 --force
标志以避免出现确认问题。
3.5.4.2. 取消部署 devfile Kubernetes 组件
要取消部署 devfile Kubernetes 组件(已使用 odo deploy
部署 ),请使用 --deploy
标志执行 odo delete
命令:
$ odo delete --deploy
使用 -f
或 --force
标志以避免出现确认问题。
3.5.4.3. 全部删除
要删除包括以下项目的所有工件,请运行带有 --all
标记的 odo delete
命令:
- devfile 组件
-
使用
odo deploy
命令部署的 devfile Kubernetes 组件 - devfile
- 本地配置
$ odo delete --all
3.5.4.4. 可用标记
-f
,--force
- 使用此标志以避免出现确认问题。
-w
,--wait
- 使用此标志等待组件删除和任何依赖项。取消部署时,此标志不起作用。
关于 Common Flags 的文档提供有关可用于命令的标记的更多信息。
3.5.5. odo deploy
odo
可用于部署组件的方式类似于如何使用 CI/CD 系统进行部署。首先,odo
构建容器镜像,然后部署部署组件所需的 Kubernetes 资源。
在运行命令 odo deploy
时,odo
在 devfile 中搜索 kind deploy
的默认命令,并执行这个命令。从 2.2.0 版本开始的 devfile 格式支持 kind 部署
。
deploy
命令通常是一个 复合 命令,由多个 应用命令组成 :
-
引用
镜像
组件(应用时)的命令将构建要部署的容器的镜像,然后将其推送到注册表。 - 引用 Kubernetes 组件的命令 (应用时)将在集群中创建 Kubernetes 资源。
使用以下示例 devfile.yaml
文件,会使用 目录中存在的 Dockerfile
来构建容器镜像。镜像被推送到其 registry,然后使用这个全新的构建镜像在集群中创建 Kubernetes Deployment 资源。
schemaVersion: 2.2.0 [...] variables: CONTAINER_IMAGE: quay.io/phmartin/myimage commands: - id: build-image apply: component: outerloop-build - id: deployk8s apply: component: outerloop-deploy - id: deploy composite: commands: - build-image - deployk8s group: kind: deploy isDefault: true components: - name: outerloop-build image: imageName: "{{CONTAINER_IMAGE}}" dockerfile: uri: ./Dockerfile buildContext: ${PROJECTS_ROOT} - name: outerloop-deploy kubernetes: inlined: | kind: Deployment apiVersion: apps/v1 metadata: name: my-component spec: replicas: 1 selector: matchLabels: app: node-app template: metadata: labels: app: node-app spec: containers: - name: main image: {{CONTAINER_IMAGE}}
3.5.6. odo link
odo link
命令帮助将 odo
组件链接到由 Operator 支持的服务或另一个 odo
组件。它通过使用 Service Binding Operator 来达到此目的。目前,odo
使用 Service Binding 库,而不是 Operator 本身来实现所需的功能。
3.5.6.1. 各种链接选项
odo
提供了不同的选项,用来将组件链接到 Operator 支持的服务或另一个 odo
组件。无论您将组件链接到服务还是另一个组件,都可以使用这些选项(或标志)。
3.5.6.1.1. 默认行为
默认情况下,odo link
命令在组件目录中创建一个名为 kubernetes/
的目录,并在其中存储有关服务和链接的信息(YAML 清单)。当使用 odo push
时,odo
会将这些清单与 Kubernetes 集群上的资源状态进行比较,并决定是否需要创建、修改或销毁资源以匹配用户指定的内容。
3.5.6.1.2. --inlined
标记
如果在 odo link
命令中指定 --inlined
标志,odo
会将 devfile.yaml
中的链接信息存储在组件目录中,而不是在 kubernetes/
目录下创建一个文件。--inlined
标记的行为与 odo link
和 odo service create
命令相似。如果您希望在一个 devfile.yaml
中存储的所有内容,则此标志很有用。您必须记住在每个 odo link
和 odo service create
命令中使用 --inlined
标志。
3.5.6.1.3. --map
标志
有时,除了默认可用的组件外,您可能还想向组件添加更多绑定信息。例如,如果您将组件链接到服务,并希望从服务的 spec 中绑定一些信息(用于规格的缩写),您可以使用 --map
标志。请注意,odo
不会针对所链接的服务或组件的 spec 进行任何验证。只有在您熟悉 Kubernetes YAML 清单时,才建议使用这个标志。
3.5.6.1.4. --bind-as-files
标志
对于目前讨论的所有链接选项,odo
会将绑定信息作为环境变量注入组件。如果您想要将这些信息挂载为文件,您可以使用 --bind-as-files
标志。这可让 odo
将绑定信息作为文件注入到组件的 Pod 中的 /bindings
位置。与环境变量方案相比,当您使用 --bind-as-files
时,文件会以键命名,并且这些键的值存储为这些文件的内容。
3.5.6.2. 例子
3.5.6.2.1. 默认 odo 链接
在以下示例中,后端组件使用默认的 odo link
命令与 PostgreSQL 服务相关联。对于后端组件,请确定您的组件和服务被推送到集群:
$ odo list
输出示例
APP NAME PROJECT TYPE STATE MANAGED BY ODO app backend myproject spring Pushed Yes
$ odo service list
输出示例
NAME MANAGED BY ODO STATE AGE PostgresCluster/hippo Yes (backend) Pushed 59m41s
现在,运行 odo link
将后端组件与 PostgreSQL 服务链接:
$ odo link PostgresCluster/hippo
输出示例
✓ Successfully created link between component "backend" and service "PostgresCluster/hippo" To apply the link, please use `odo push`
然后,运行 odo push
在 Kubernetes 集群中实际创建链接。
在 odo push
成功后,您会看到几个结果:
当您打开由 backend 组件部署的应用程序的 URL 时,它会显示数据库中的
todo
列表。例如,在odo url list
命令的输出中,会列出todos
的路径:$ odo url list
输出示例
Found the following URLs for component backend NAME STATE URL PORT SECURE KIND 8080-tcp Pushed http://8080-tcp.192.168.39.112.nip.io 8080 false ingress
URL 的正确路径为 http://8080-tcp.192.168.39.112.nip.io/api/v1/todos。确切的 URL 取决于您的设置。另请注意,除非添加一些,否则数据库中也没有
todos
,因此 URL 可能会只显示空的 JSON 对象。您可以查看与 Postgres 服务注入后端组件相关的绑定信息。默认情况下,此绑定信息作为环境变量注入。您可以在后端组件的目录中使用
odo describe
命令检查它:$ odo describe
输出示例:
Component Name: backend Type: spring Environment Variables: · PROJECTS_ROOT=/projects · PROJECT_SOURCE=/projects · DEBUG_PORT=5858 Storage: · m2 of size 3Gi mounted to /home/user/.m2 URLs: · http://8080-tcp.192.168.39.112.nip.io exposed via 8080 Linked Services: · PostgresCluster/hippo Environment Variables: · POSTGRESCLUSTER_PGBOUNCER-EMPTY · POSTGRESCLUSTER_PGBOUNCER.INI · POSTGRESCLUSTER_ROOT.CRT · POSTGRESCLUSTER_VERIFIER · POSTGRESCLUSTER_ID_ECDSA · POSTGRESCLUSTER_PGBOUNCER-VERIFIER · POSTGRESCLUSTER_TLS.CRT · POSTGRESCLUSTER_PGBOUNCER-URI · POSTGRESCLUSTER_PATRONI.CRT-COMBINED · POSTGRESCLUSTER_USER · pgImage · pgVersion · POSTGRESCLUSTER_CLUSTERIP · POSTGRESCLUSTER_HOST · POSTGRESCLUSTER_PGBACKREST_REPO.CONF · POSTGRESCLUSTER_PGBOUNCER-USERS.TXT · POSTGRESCLUSTER_SSH_CONFIG · POSTGRESCLUSTER_TLS.KEY · POSTGRESCLUSTER_CONFIG-HASH · POSTGRESCLUSTER_PASSWORD · POSTGRESCLUSTER_PATRONI.CA-ROOTS · POSTGRESCLUSTER_DBNAME · POSTGRESCLUSTER_PGBOUNCER-PASSWORD · POSTGRESCLUSTER_SSHD_CONFIG · POSTGRESCLUSTER_PGBOUNCER-FRONTEND.KEY · POSTGRESCLUSTER_PGBACKREST_INSTANCE.CONF · POSTGRESCLUSTER_PGBOUNCER-FRONTEND.CA-ROOTS · POSTGRESCLUSTER_PGBOUNCER-HOST · POSTGRESCLUSTER_PORT · POSTGRESCLUSTER_ROOT.KEY · POSTGRESCLUSTER_SSH_KNOWN_HOSTS · POSTGRESCLUSTER_URI · POSTGRESCLUSTER_PATRONI.YAML · POSTGRESCLUSTER_DNS.CRT · POSTGRESCLUSTER_DNS.KEY · POSTGRESCLUSTER_ID_ECDSA.PUB · POSTGRESCLUSTER_PGBOUNCER-FRONTEND.CRT · POSTGRESCLUSTER_PGBOUNCER-PORT · POSTGRESCLUSTER_CA.CRT
其中一些变量在后端组件的
src/main/resources/application.properties
文件中使用,以便 Java Spring Boot 应用程序可以连接到 PostgreSQL 数据库服务。最后,
odo
在后端组件的目录中创建一个名为kubernetes/
的目录,其中包含以下文件:$ ls kubernetes odo-service-backend-postgrescluster-hippo.yaml odo-service-hippo.yaml
这些文件包含两个资源的信息(YAML 清单):
-
odo-service-hippo.yaml
- 使用odo service create --from-file ../postgrescluster.yaml
命令创建的 Postgres 服务。 -
odo-service-backend-postgrescluster-hippo.yaml
- 使用odo link
命令创建的链接。
-
3.5.6.2.2. 使用带有 --inlined 标记的 odo 链接
在 odo link
命令中使用 --inlined
标志与没有标志的 odo link
命令的效果相同,在注入绑定信息中。但是,通常的差异是,在上述情况下,kubernetes/
目录下有两个清单文件,一个用于 Postgres 服务,另一个用于后端组件和该服务之间的链接。但是,当您传递 --inlined
标志时,odo
不会在 kubernetes/
目录下创建一个文件来存储 YAML 清单,而是将其内联存储在 devfile.yaml
文件中。
要查看此信息,请首先从 PostgreSQL 服务中取消链接组件:
$ odo unlink PostgresCluster/hippo
输出示例:
✓ Successfully unlinked component "backend" from service "PostgresCluster/hippo" To apply the changes, please use `odo push`
要在集群中取消链接它们,请运行 odo push
。现在,如果您检查 kubernetes/
目录,则只看到一个文件:
$ ls kubernetes odo-service-hippo.yaml
接下来,使用 --inlined
标志来创建链接:
$ odo link PostgresCluster/hippo --inlined
输出示例:
✓ Successfully created link between component "backend" and service "PostgresCluster/hippo" To apply the link, please use `odo push`
您需要运行 odo push
以便在集群中创建链接,如省略 --inlined
标志的步骤。odo
将配置存储在 devfile.yaml
中。在这个文件中,您可以看到类似如下的条目:
kubernetes: inlined: | apiVersion: binding.operators.coreos.com/v1alpha1 kind: ServiceBinding metadata: creationTimestamp: null name: backend-postgrescluster-hippo spec: application: group: apps name: backend-app resource: deployments version: v1 bindAsFiles: false detectBindingResources: true services: - group: postgres-operator.crunchydata.com id: hippo kind: PostgresCluster name: hippo version: v1beta1 status: secret: "" name: backend-postgrescluster-hippo
现在,如果您运行 odo unlink PostgresCluster/hippo
,odo
会首先从 devfile.yaml
中删除链接信息,然后后续 odo push
将从集群中删除链接。
3.5.6.2.3. 自定义绑定
odo link
接受标记 --map
,它可以将自定义绑定信息注入组件。此类绑定信息将从您链接到您的组件的资源清单中获取。例如,在后端组件和 PostgreSQL 服务的上下文中,您可以将 PostgreSQL 服务的清单 postgrescluster.yaml
文件中的信息注入后端组件。
如果 PostgresCluster
服务的名称是 hippo
(或者 odo service list
的输出,如果您的 PostgresCluster 服务被命名),当您需要将 YAML 定义中的 postgresVersion
值注入后端组件时,请运行以下命令:
$ odo link PostgresCluster/hippo --map pgVersion='{{ .hippo.spec.postgresVersion }}'
请注意,如果 Postgres 服务的名称与 hippo
不同,则必须在上述命令中指定在 pgVersion
的值代替 .hippo
的位置。
在链接操作后,照常运行 odo push
。在成功完成推送操作后,您可以从后端组件目录中运行以下命令,以验证是否正确注入自定义映射:
$ odo exec -- env | grep pgVersion
输出示例:
pgVersion=13
因为您可能希望注入多个自定义绑定信息,odo link
接受映射的多个键值对。唯一约束应将它们指定为 --map <key>=<value>
。例如,如果还想将 PostgreSQL 镜像信息与版本一起注入,您可以运行:
$ odo link PostgresCluster/hippo --map pgVersion='{{ .hippo.spec.postgresVersion }}' --map pgImage='{{ .hippo.spec.image }}'
然后运行 odo push
。要验证两个映射是否已正确注入的映射,请运行以下命令:
$ odo exec -- env | grep -e "pgVersion\|pgImage"
输出示例:
pgVersion=13 pgImage=registry.developers.crunchydata.com/crunchydata/crunchy-postgres-ha:centos8-13.4-0
3.5.6.2.3.1. 使用内联还是不使用?
您可以接受默认行为,odo link
为 kubernetes/
目录下的链接生成清单文件。另外,如果您想将所有内容存储在单个 devfile.yaml
文件中,您可以使用 --inlined
标志。
3.5.6.3. 将绑定作为文件绑定
odo link
提供的另一个有用标志是 --bind-as-files
。当传递此标记时,绑定信息不会作为环境变量注入组件的 Pod 中,而是作为文件系统挂载。
确保后端组件和 PostgreSQL 服务之间没有现有链接。您可以通过在后端组件的目录中运行 odo describe
来检查输出是否类似以下内容:
Linked Services: · PostgresCluster/hippo
使用以下命令从组件中取消链接该服务:
$ odo unlink PostgresCluster/hippo $ odo push
3.5.6.4. --bind-as-files 示例
3.5.6.4.1. 使用默认 odo 链接
默认情况下,odo
在 kubernetes/
目录下创建清单文件来存储链接信息。使用以下命令链接后端组件和 PostgreSQL 服务:
$ odo link PostgresCluster/hippo --bind-as-files $ odo push
odo describe
输出示例:
$ odo describe Component Name: backend Type: spring Environment Variables: · PROJECTS_ROOT=/projects · PROJECT_SOURCE=/projects · DEBUG_PORT=5858 · SERVICE_BINDING_ROOT=/bindings · SERVICE_BINDING_ROOT=/bindings Storage: · m2 of size 3Gi mounted to /home/user/.m2 URLs: · http://8080-tcp.192.168.39.112.nip.io exposed via 8080 Linked Services: · PostgresCluster/hippo Files: · /bindings/backend-postgrescluster-hippo/pgbackrest_instance.conf · /bindings/backend-postgrescluster-hippo/user · /bindings/backend-postgrescluster-hippo/ssh_known_hosts · /bindings/backend-postgrescluster-hippo/clusterIP · /bindings/backend-postgrescluster-hippo/password · /bindings/backend-postgrescluster-hippo/patroni.yaml · /bindings/backend-postgrescluster-hippo/pgbouncer-frontend.crt · /bindings/backend-postgrescluster-hippo/pgbouncer-host · /bindings/backend-postgrescluster-hippo/root.key · /bindings/backend-postgrescluster-hippo/pgbouncer-frontend.key · /bindings/backend-postgrescluster-hippo/pgbouncer.ini · /bindings/backend-postgrescluster-hippo/uri · /bindings/backend-postgrescluster-hippo/config-hash · /bindings/backend-postgrescluster-hippo/pgbouncer-empty · /bindings/backend-postgrescluster-hippo/port · /bindings/backend-postgrescluster-hippo/dns.crt · /bindings/backend-postgrescluster-hippo/pgbouncer-uri · /bindings/backend-postgrescluster-hippo/root.crt · /bindings/backend-postgrescluster-hippo/ssh_config · /bindings/backend-postgrescluster-hippo/dns.key · /bindings/backend-postgrescluster-hippo/host · /bindings/backend-postgrescluster-hippo/patroni.crt-combined · /bindings/backend-postgrescluster-hippo/pgbouncer-frontend.ca-roots · /bindings/backend-postgrescluster-hippo/tls.key · /bindings/backend-postgrescluster-hippo/verifier · /bindings/backend-postgrescluster-hippo/ca.crt · /bindings/backend-postgrescluster-hippo/dbname · /bindings/backend-postgrescluster-hippo/patroni.ca-roots · /bindings/backend-postgrescluster-hippo/pgbackrest_repo.conf · /bindings/backend-postgrescluster-hippo/pgbouncer-port · /bindings/backend-postgrescluster-hippo/pgbouncer-verifier · /bindings/backend-postgrescluster-hippo/id_ecdsa · /bindings/backend-postgrescluster-hippo/id_ecdsa.pub · /bindings/backend-postgrescluster-hippo/pgbouncer-password · /bindings/backend-postgrescluster-hippo/pgbouncer-users.txt · /bindings/backend-postgrescluster-hippo/sshd_config · /bindings/backend-postgrescluster-hippo/tls.crt
之前的 odo describe
输出中的 key=value
格式是一个环境变量,现在作为一个文件被挂载。使用 cat
命令查看其中的一些文件的内容:
示例命令:
$ odo exec -- cat /bindings/backend-postgrescluster-hippo/password
输出示例:
q({JC:jn^mm/Bw}eu+j.GX{k
示例命令:
$ odo exec -- cat /bindings/backend-postgrescluster-hippo/user
输出示例:
hippo
示例命令:
$ odo exec -- cat /bindings/backend-postgrescluster-hippo/clusterIP
输出示例:
10.101.78.56
3.5.6.4.2. 使用 --inlined
使用 --bind-as-files
和 --inlined
的结果与使用 odo link --inlined
类似。链接的清单存储在 devfile.yaml
中,而不是存储在 kubernetes/
目录中的单独文件中。除此之外,odo describe
输出的内容与之前的输出相同。
3.5.6.4.3. 自定义绑定
当在将后端组件与 PostgreSQL 服务链接时传递自定义绑定时,这些自定义绑定不会作为环境变量注入,而是作为文件挂载。例如:
$ odo link PostgresCluster/hippo --map pgVersion='{{ .hippo.spec.postgresVersion }}' --map pgImage='{{ .hippo.spec.image }}' --bind-as-files $ odo push
这些自定义绑定作为文件挂载,而不是作为环境变量注入。要验证是否可以正常工作,请运行以下命令:
示例命令:
$ odo exec -- cat /bindings/backend-postgrescluster-hippo/pgVersion
输出示例:
13
示例命令:
$ odo exec -- cat /bindings/backend-postgrescluster-hippo/pgImage
输出示例:
registry.developers.crunchydata.com/crunchydata/crunchy-postgres-ha:centos8-13.4-0
3.5.7. odo registry
odo
使用可移植 devfile 格式来描述组件。odo
可以连接到各种 devfile registry,以下载用于不同语言和框架的 devfile。
您可以连接到公开可用的 devfile registry,也可以安装自己的 安全 Registry。
您可以使用 odo registry
命令管理 odo
使用的 registry 来检索 devfile 信息。
3.5.7.1. 列出 registry
要列出 odo
当前联系的 registry,请运行以下命令:
$ odo registry list
输出示例:
NAME URL SECURE DefaultDevfileRegistry https://registry.devfile.io No
DefaultDevfileRegistry
是 odo 使用的默认 registry,它由 devfile.io 项目提供。
3.5.7.2. 添加 registry
要添加 registry,请运行以下命令:
$ odo registry add
输出示例:
$ odo registry add StageRegistry https://registry.stage.devfile.io New registry successfully added
如果要部署自己的安全 Registry,您可以指定个人访问令牌来使用 --token
标志向安全 registry 进行身份验证:
$ odo registry add MyRegistry https://myregistry.example.com --token <access_token> New registry successfully added
3.5.7.3. 删除 registry
要删除 registry,请运行以下命令:
$ odo registry delete
输出示例:
$ odo registry delete StageRegistry ? Are you sure you want to delete registry "StageRegistry" Yes Successfully deleted registry
使用 --force
(或 -f
)标记强制删除 registry,而无需确认。
3.5.7.4. 更新 registry
要更新已注册的 registry 的 URL 或已经注册的个人访问令牌,请运行以下命令:
$ odo registry update
输出示例:
$ odo registry update MyRegistry https://otherregistry.example.com --token <other_access_token> ? Are you sure you want to update registry "MyRegistry" Yes Successfully updated registry
使用 --force
(或 -f
)标记强制更新 registry,而无需确认。
3.5.8. odo service
odo
可使用 Operator 帮助部署服务。
可使用 odo catalog
命令找到可用的 Operator 和服务列表。
服务在 组件 上下文中创建,因此在部署服务前运行 odo create
命令。
服务通过以下两个步骤进行部署:
- 定义服务并将其定义存储在 devfile 中。
-
使用
odo push
命令将定义的服务部署到集群。
3.5.8.1. 创建新服务
要创建新服务,请运行以下命令:
$ odo service create
例如,要创建一个名为 my-redis-service
的 Redis 服务实例,您可以运行以下命令:
输出示例
$ odo catalog list services Services available through Operators NAME CRDs redis-operator.v0.8.0 RedisCluster, Redis $ odo service create redis-operator.v0.8.0/Redis my-redis-service Successfully added service to the configuration; do 'odo push' to create service on the cluster
此命令在 kubernetes/
目录中创建 Kubernetes 清单,其中包含服务的定义,此文件从 devfile.yaml
文件引用。
$ cat kubernetes/odo-service-my-redis-service.yaml
输出示例
apiVersion: redis.redis.opstreelabs.in/v1beta1 kind: Redis metadata: name: my-redis-service spec: kubernetesConfig: image: quay.io/opstree/redis:v6.2.5 imagePullPolicy: IfNotPresent resources: limits: cpu: 101m memory: 128Mi requests: cpu: 101m memory: 128Mi serviceType: ClusterIP redisExporter: enabled: false image: quay.io/opstree/redis-exporter:1.0 storage: volumeClaimTemplate: spec: accessModes: - ReadWriteOnce resources: requests: storage: 1Gi
示例命令
$ cat devfile.yaml
输出示例
[...] components: - kubernetes: uri: kubernetes/odo-service-my-redis-service.yaml name: my-redis-service [...]
请注意,所创建的实例的名称是可选的。如果您不提供名称,它将是服务的小写名称。例如,以下命令创建一个名为 redis
的 Redis 服务实例:
$ odo service create redis-operator.v0.8.0/Redis
3.5.8.1.1. 显示清单
默认情况下,在 kubernetes/
目录中创建一个新清单,从 devfile.yaml
文件引用。可以使用 --inlined
标志在 devfile.yaml
文件中内联清单:
$ odo service create redis-operator.v0.8.0/Redis my-redis-service --inlined Successfully added service to the configuration; do 'odo push' to create service on the cluster
示例命令
$ cat devfile.yaml
输出示例
[...] components: - kubernetes: inlined: | apiVersion: redis.redis.opstreelabs.in/v1beta1 kind: Redis metadata: name: my-redis-service spec: kubernetesConfig: image: quay.io/opstree/redis:v6.2.5 imagePullPolicy: IfNotPresent resources: limits: cpu: 101m memory: 128Mi requests: cpu: 101m memory: 128Mi serviceType: ClusterIP redisExporter: enabled: false image: quay.io/opstree/redis-exporter:1.0 storage: volumeClaimTemplate: spec: accessModes: - ReadWriteOnce resources: requests: storage: 1Gi name: my-redis-service [...]
3.5.8.1.2. 配置服务
如果没有特定的自定义,将使用默认配置创建该服务。您可以使用命令行参数或文件来指定您自己的配置。
3.5.8.1.2.1. 使用命令行参数
使用 --parameters
(或 -p
)指定您自己的配置。
以下示例使用三个参数配置 Redis 服务:
$ odo service create redis-operator.v0.8.0/Redis my-redis-service \ -p kubernetesConfig.image=quay.io/opstree/redis:v6.2.5 \ -p kubernetesConfig.serviceType=ClusterIP \ -p redisExporter.image=quay.io/opstree/redis-exporter:1.0 Successfully added service to the configuration; do 'odo push' to create service on the cluster
示例命令
$ cat kubernetes/odo-service-my-redis-service.yaml
输出示例
apiVersion: redis.redis.opstreelabs.in/v1beta1 kind: Redis metadata: name: my-redis-service spec: kubernetesConfig: image: quay.io/opstree/redis:v6.2.5 serviceType: ClusterIP redisExporter: image: quay.io/opstree/redis-exporter:1.0
您可以使用 odo catalog describe service
命令获取特定服务的可能参数。
3.5.8.1.2.2. 使用文件
使用 YAML 清单来配置您自己的规格。在以下示例中,Red Hat Redis 服务配置了三个参数。
创建清单:
$ cat > my-redis.yaml <<EOF apiVersion: redis.redis.opstreelabs.in/v1beta1 kind: Redis metadata: name: my-redis-service spec: kubernetesConfig: image: quay.io/opstree/redis:v6.2.5 serviceType: ClusterIP redisExporter: image: quay.io/opstree/redis-exporter:1.0 EOF
在清单中创建服务:
$ odo service create --from-file my-redis.yaml Successfully added service to the configuration; do 'odo push' to create service on the cluster
3.5.8.2. 删除服务
要删除服务,请运行以下命令:
$ odo service delete
输出示例
$ odo service list NAME MANAGED BY ODO STATE AGE Redis/my-redis-service Yes (api) Deleted locally 5m39s
$ odo service delete Redis/my-redis-service ? Are you sure you want to delete Redis/my-redis-service Yes Service "Redis/my-redis-service" has been successfully deleted; do 'odo push' to delete service from the cluster
使用 --force
(或 -f
)标记强制删除该服务而无需确认。
3.5.8.3. 列出服务
要列出为组件创建的服务,请运行以下命令:
$ odo service list
输出示例
$ odo service list NAME MANAGED BY ODO STATE AGE Redis/my-redis-service-1 Yes (api) Not pushed Redis/my-redis-service-2 Yes (api) Pushed 52s Redis/my-redis-service-3 Yes (api) Deleted locally 1m22s
对于每个服务,STATE
表示该服务是否使用 odo push
命令推送到集群,或者该服务仍然在集群中运行,但使用 odo service delete
命令在本地移除 devfile。
3.5.8.4. 获取有关服务的信息
要获取服务的详情,如其类型、版本、名称和配置参数列表,请运行以下命令:
$ odo service describe
输出示例
$ odo service describe Redis/my-redis-service Version: redis.redis.opstreelabs.in/v1beta1 Kind: Redis Name: my-redis-service Parameters: NAME VALUE kubernetesConfig.image quay.io/opstree/redis:v6.2.5 kubernetesConfig.serviceType ClusterIP redisExporter.image quay.io/opstree/redis-exporter:1.0
3.5.9. odo storage
odo
允许用户管理附加到组件的存储卷。存储卷可以是使用 emptyDir
Kubernetes 卷或 持久性卷声明 (PVC)的临时卷。PVC 允许用户声明持久性卷(如 GCE PersistentDisk 或 iSCSI 卷),而无需了解特定的云环境的详情。持久性存储卷可用于在重启后保留数据,并重新构建组件。
3.5.9.1. 添加存储卷
要在集群中添加存储卷,请运行以下命令:
$ odo storage create
输出示例:
$ odo storage create store --path /data --size 1Gi ✓ Added storage store to nodejs-project-ufyy $ odo storage create tempdir --path /tmp --size 2Gi --ephemeral ✓ Added storage tempdir to nodejs-project-ufyy Please use `odo push` command to make the storage accessible to the component
在上例中,第一个存储卷已挂载到 /data
路径中,大小为 1Gi
,第二个卷已挂载到 /tmp
,并且是临时卷。
3.5.9.2. 列出存储卷
要检查组件当前使用的存储卷,请运行以下命令:
$ odo storage list
输出示例:
$ odo storage list The component 'nodejs-project-ufyy' has the following storage attached: NAME SIZE PATH STATE store 1Gi /data Not Pushed tempdir 2Gi /tmp Not Pushed
3.5.9.3. 删除存储卷
要删除存储卷,请运行以下命令:
$ odo storage delete
输出示例:
$ odo storage delete store -f Deleted storage store from nodejs-project-ufyy Please use `odo push` command to delete the storage from the cluster
在上例中,使用 -f
标志强制删除存储而无需询问用户权限。
3.5.9.4. 在特定容器中添加存储
如果您的 devfile 有多个容器,您可以使用 odo storage create
命令中的 --container
标志指定您要将存储附加到的容器。
以下示例是带有多个容器的 devfile 摘录:
components: - name: nodejs1 container: image: registry.access.redhat.com/ubi8/nodejs-12:1-36 memoryLimit: 1024Mi endpoints: - name: "3000-tcp" targetPort: 3000 mountSources: true - name: nodejs2 container: image: registry.access.redhat.com/ubi8/nodejs-12:1-36 memoryLimit: 1024Mi
在示例中,有两个容器nodejs1
和 nodejs2
。要将存储附加到 nodejs2
容器,请使用以下命令:
$ odo storage create --container
输出示例:
$ odo storage create store --path /data --size 1Gi --container nodejs2 ✓ Added storage store to nodejs-testing-xnfg Please use `odo push` command to make the storage accessible to the component
您可以使用 odo storage list
命令列出存储资源:
$ odo storage list
输出示例:
The component 'nodejs-testing-xnfg' has the following storage attached: NAME SIZE PATH CONTAINER STATE store 1Gi /data nodejs2 Not Pushed
3.5.10. common 标记
多数 odo
命令提供了以下标记:
命令 | 描述 |
---|---|
| 设置定义组件的上下文目录。 |
| 设置组件的项目。默认为本地配置中定义的项目。如果没有可用的,则集群上的当前项目。 |
| 设置组件的应用程序。默认为本地配置中定义的应用程序。如果没有可用的,则为 app。 |
|
如果不使用默认配置,请将 path 设置为 |
| 使用此标志查看日志。 |
| 使用这个标志代表命令不会提示用户进行确认。 |
| 设置详细程度。如需更多信息,请参阅 odo 中的日志记录。 |
| 输出命令的帮助信息。 |
某些命令可能不能使用一些标志。使用 --help
标志运行命令以获取所有可用标志的列表。
3.5.11. JSON 输出
输出内容的 odo
命令通常会接受 -o json
标志以 JSON 格式输出此内容,适用于其他程序来更轻松地解析此输出。
输出结构与 Kubernetes 资源类似,带有 kind
, apiVersion
, metadata
, spec
, 和status
字段。
List 命令会返回 List
资源,其中包含一个项列表的 items
(或类似)字段,每个项目也与 Kubernetes 资源类似。
Delete 命令会返回一个 Status
资源;请参阅 Status Kubernetes 资源。
其他命令会返回与命令关联的资源,如 Application
, Storage
, URL
等。
当前接受 -o json
标记的命令的完整列表是:
命令 | kind(版本) | 列表项目的 kind(版本) | 完整内容? |
---|---|---|---|
odo application describe | Application (odo.dev/v1alpha1) | 不适用 | 否 |
odo application list | List (odo.dev/v1alpha1) | Application (odo.dev/v1alpha1) | ? |
odo catalog list components | List (odo.dev/v1alpha1) | 缺少 | 是 |
odo catalog list services | List (odo.dev/v1alpha1) | ClusterServiceVersion (operators.coreos.com/v1alpha1) | ? |
odo catalog describe component | 缺少 | 不适用 | 是 |
odo catalog describe service | CRDDescription (odo.dev/v1alpha1) | 不适用 | 是 |
odo component create | Component (odo.dev/v1alpha1) | 不适用 | 是 |
odo component describe | Component (odo.dev/v1alpha1) | 不适用 | 是 |
odo component list | List (odo.dev/v1alpha1) | Component (odo.dev/v1alpha1) | 是 |
odo config view | DevfileConfiguration (odo.dev/v1alpha1) | 不适用 | 是 |
odo debug info | OdoDebugInfo (odo.dev/v1alpha1) | 不适用 | 是 |
odo env view | EnvInfo (odo.dev/v1alpha1) | 不适用 | 是 |
odo preference view | PreferenceList (odo.dev/v1alpha1) | 不适用 | 是 |
odo project create | Project (odo.dev/v1alpha1) | 不适用 | 是 |
odo project delete | Status (v1) | 不适用 | 是 |
odo project get | Project (odo.dev/v1alpha1) | 不适用 | 是 |
odo project list | List (odo.dev/v1alpha1) | Project (odo.dev/v1alpha1) | 是 |
odo registry list | List (odo.dev/v1alpha1) | 缺少 | 是 |
odo service create | Service | 不适用 | 是 |
odo service describe | Service | 不适用 | 是 |
odo service list | List (odo.dev/v1alpha1) | Service | 是 |
odo storage create | Storage (odo.dev/v1alpha1) | 不适用 | 是 |
odo storage delete | Status (v1) | 不适用 | 是 |
odo storage list | List (odo.dev/v1alpha1) | Storage (odo.dev/v1alpha1) | 是 |
odo url list | List (odo.dev/v1alpha1) | URL (odo.dev/v1alpha1) | 是 |
第 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
通过一个终端,使用 tkn
CLI 管理 Red Hat OpenShift Pipelines。下面的部分论述了如何在不同的平台中安装 tkn
。
在 OpenShift Container Platform web 控制台中,点右上角的 ? 图标并选 Command Line Tools。
5.1.1. 在 Linux 上安装 Red Hat OpenShift Pipelines CLI(tkn)
对于 Linux 系统,您可以直接将 CLI 下载为 tar.gz
存档。
流程
下载相关的 CLI。
解包存档:
$ tar xvzf <file>
-
把
tkn
二进制代码放到PATH
中的一个目录下。 运行以下命令可以查看
PATH
的值:$ echo $PATH
5.1.2. 使用 RPM 在 Linux 上安装 Red Hat OpenShift Pipelines CLI(tkn)
对于 Red Hat Enterprise Linux(RHEL)版本 8,您可以使用 RPM 安装 Red Hat OpenShift Pipelines CLI(tkn
)。
先决条件
- 您的红帽帐户必须具有有效的 OpenShift Container Platform 订阅。
- 您在本地系统中有 root 或者 sudo 权限。
流程
使用 Red Hat Subscription Manager 注册:
# subscription-manager register
获取最新的订阅数据:
# subscription-manager refresh
列出可用的订阅:
# subscription-manager list --available --matches '*pipelines*'
在上一命令的输出中,找到 OpenShift Container Platform 订阅的池 ID,并把订阅附加到注册的系统:
# subscription-manager attach --pool=<pool_id>
启用 Red Hat OpenShift Pipelines 所需的仓库:
Linux (x86_64, amd64)
# subscription-manager repos --enable="pipelines-1.6-for-rhel-8-x86_64-rpms"
Linux on IBM Z and LinuxONE (s390x)
# subscription-manager repos --enable="pipelines-1.6-for-rhel-8-s390x-rpms"
Linux on IBM Power Systems (ppc64le)
# subscription-manager repos --enable="pipelines-1.6-for-rhel-8-ppc64le-rpms"
安装
openshift-pipelines-client
软件包:# yum install openshift-pipelines-client
安装 CLI 后,就可以使用tkn
命令:
$ tkn version
5.1.3. 在 Windows 上安装 Red Hat OpenShift Pipelines CLI(tkn)
对于 Windows,tkn
CLI 以一个 zip
文件的形式提供。
流程
- 下载 CLI。
- 使用 ZIP 程序解压存档。
-
将
tkn.exe
文件的位置添加到PATH
环境变量中。 要查看您的
PATH
,请打开命令窗口并运行以下命令:C:\> path
5.1.4. 在 macOS 上安装 Red Hat OpenShift Pipelines CLI(tkn)
对于 macOS,tkn
CLI 以一个 tar.gz
文件的形式提供。
流程
- 下载 CLI。
- 解包和解压存档。
-
将
tkn
二进制文件迁移至 PATH 上的目录中。 要查看
PATH
,打开终端窗口并运行:$ echo $PATH
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
将文件复制到
/etc/bash_completion.d/
:$ sudo cp tkn_bash_completion /etc/bash_completion.d/
您也可以将文件保存到一个本地目录,并从您的
.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
5.3.3.2. completion [shell]
输出 shell 完成代码,必须经过评估方可提供互动完成。支持的 shell 是 bash
和 zsh
。
示例:bash
shell 完成代码
$ tkn completion bash
5.3.3.3. version
输出 tkn
CLI 的版本信息。
示例: 检查 tkn
版本
$ tkn version
5.3.4. Pipelines 管理命令
5.3.4.1. pipeline
管理管道。
示例: 显示帮助信息
$ tkn pipeline --help
5.3.4.2. pipeline delete
删除管道。
示例:从命名空间中删除 mypipeline
管道
$ tkn pipeline delete mypipeline -n myspace
5.3.4.3. pipeline describe
描述管道。
示例:描述 mypipeline
管道
$ tkn pipeline describe mypipeline
5.3.4.4. pipeline list
显示管道列表。
示例:显示管道列表
$ tkn pipeline list
5.3.4.5. pipeline logs
显示特定管道的日志。
示例:将 mypipeline
管道的 live 日志流
$ tkn pipeline logs -f mypipeline
5.3.4.6. pipeline start
启动管道。
示例:启动 mypipeline
管道
$ tkn pipeline start mypipeline
5.3.5. pipeline run 命令
5.3.5.1. pipelinerun
管理管道运行。
示例: 显示帮助信息
$ tkn pipelinerun -h
5.3.5.2. pipelinerun cancel
取消管道运行。
示例:取消从命名空间中运行的 mypipelinerun
管道
$ tkn pipelinerun cancel mypipelinerun -n myspace
5.3.5.3. pipelinerun delete
删除管道运行。
示例:删除管道从命名空间中运行
$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
示例:删除所有管道从命名空间中运行,但最近执行的管道运行除外
$ tkn pipelinerun delete -n myspace --keep 5 1
- 1
- 使用您要保留的最新执行的管道运行数量替换
5
。
示例:删除所有管道
$ 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
5.3.5.5. pipelinerun list
列出管道运行。
示例: 显示在命名空间中运行的管道列表
$ tkn pipelinerun list -n myspace
5.3.5.6. pipelinerun logs
显示管道运行的日志。
示例:显示 mypipelinerun
管道运行的日志,其中包含命名空间中的所有任务和步骤
$ tkn pipelinerun logs mypipelinerun -a -n myspace
5.3.6. 任务管理命令
5.3.6.1. task
管理任务。
示例: 显示帮助信息
$ tkn task -h
5.3.6.2. task delete
删除任务。
示例:从命名空间中删除 mytask1
和 mytask2
任务
$ tkn task delete mytask1 mytask2 -n myspace
5.3.6.3. task describe
描述任务。
示例:描述命名空间中的 mytask
任务
$ tkn task describe mytask -n myspace
5.3.6.4. task list
列出任务。
示例: 列出命名空间中的所有任务
$ tkn task list -n myspace
5.3.6.5. task logs
显示任务日志。
示例:显示 mytask
任务的 mytaskrun
任务运行的日志
$ tkn task logs mytask mytaskrun -n myspace
5.3.6.6. task start
启动一个任务。
示例: 在命名空间中启动 mytask
任务
$ tkn task start mytask -s <ServiceAccountName> -n myspace
5.3.7. task run 命令
5.3.7.1. taskrun
管理任务运行。
示例: 显示帮助信息
$ tkn taskrun -h
5.3.7.2. taskrun cancel
取消任务运行。
示例:取消从命名空间中运行的 mytaskrun
任务
$ 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 -n myspace --keep 5 1
- 1
- 将
5
替换为您要保留的最新执行任务数量。
5.3.7.4. taskrun describe
描述任务运行。
示例:描述在命名空间中运行的 mytaskrun
任务
$ tkn taskrun describe mytaskrun -n myspace
5.3.7.5. taskrun list
列出任务运行。
示例:列出所有任务在命名空间中运行
$ tkn taskrun list -n myspace
5.3.7.6. taskrun logs
显示任务运行日志.
示例:显示在命名空间中运行的 mytaskrun
任务的实时日志
$ tkn taskrun logs -f mytaskrun -n myspace
5.3.8. 条件管理命令
5.3.8.1. 条件
管理条件(Condition)。
示例: 显示帮助信息
$ tkn condition --help
5.3.8.2. 删除条件
删除一个条件。
示例:从命名空间中删除 mycondition1
Condition
$ tkn condition delete mycondition1 -n myspace
5.3.8.3. condition describe
描述条件。
示例:在命名空间中描述 mycondition1
Condition
$ tkn condition describe mycondition1 -n myspace
5.3.8.4. condition list
列出条件。
示例: 列出命名空间中的条件
$ tkn condition list -n myspace
5.3.9. Pipeline 资源管理命令
5.3.9.1. resource
管理管道资源。
示例: 显示帮助信息
$ tkn resource -h
5.3.9.2. resource create
创建一个 Pipeline 资源。
示例: 在命名空间中创建一个 Pipeline 资源
$ tkn resource create -n myspace
这是一个交互式命令,它要求输入资源名称、资源类型以及基于资源类型的值。
5.3.9.3. resource delete
删除 Pipeline 资源。
示例:从命名空间中删除 myresource
Pipeline 资源
$ tkn resource delete myresource -n myspace
5.3.9.4. resource describe
描述管道资源。
示例:描述 myresource
Pipeline 资源
$ tkn resource describe myresource -n myspace
5.3.9.5. resource list
列出管道资源。
示例: 列出命名空间中的所有管道资源
$ tkn resource list -n myspace
5.3.10. ClusterTask 管理命令
5.3.10.1. clustertask
管理 ClusterTasks。
示例: 显示帮助信息
$ tkn clustertask --help
5.3.10.2. clustertask delete
删除集群中的 ClusterTask 资源。
示例: 删除 mytask1
和 mytask2
ClusterTasks
$ tkn clustertask delete mytask1 mytask2
5.3.10.3. clustertask describe
描述 ClusterTask。
示例: 描述 mytask
ClusterTask
$ tkn clustertask describe mytask1
5.3.10.4. clustertask list
列出 ClusterTasks。
示例: 列出 ClusterTasks
$ tkn clustertask list
5.3.10.5. clustertask start
启动 ClusterTasks。
示例: 启动 mytask
ClusterTask
$ tkn clustertask start mytask
5.3.11. 触发器管理命令
5.3.11.1. eventlistener
管理 EventListeners。
示例: 显示帮助信息
$ tkn eventlistener -h
5.3.11.2. eventlistener delete
删除一个 EventListener。
示例:删除命令空间中的 mylistener1
和 mylistener2
EventListeners
$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
5.3.11.3. eventlistener describe
描述 EventListener。
示例:描述命名空间中的 mylistener
EventListener
$ tkn eventlistener describe mylistener -n myspace
5.3.11.4. eventlistener list
列出 EventListeners。
示例: 列出命名空间中的所有 EventListeners
$ tkn eventlistener list -n myspace
5.3.11.5. eventListener 日志
显示 EventListener 的日志。
示例: 在一个命名空间中显示 mylistener
EventListener 的日志
$ tkn eventlistener logs mylistener -n myspace
5.3.11.6. triggerbinding
管理 TriggerBindings。
示例: 显示 TriggerBindings 帮助信息
$ tkn triggerbinding -h
5.3.11.7. triggerbinding delete
删除 TriggerBinding。
示例:删除一个命名空间中的 mybinding1
和 mybinding2
TriggerBindings
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
5.3.11.8. triggerbinding describe
描述 TriggerBinding。
示例:描述命名空间中的 mybinding
TriggerBinding
$ tkn triggerbinding describe mybinding -n myspace
5.3.11.9. triggerbinding list
列出 TriggerBindings。
示例: 列出命名空间中的所有 TriggerBindings
$ tkn triggerbinding list -n myspace
5.3.11.10. triggertemplate
管理 TriggerTemplates。
示例: 显示 TriggerTemplate 帮助
$ tkn triggertemplate -h
5.3.11.11. triggertemplate delete
删除 TriggerTemplate。
示例:删除命名空间中的 mytemplate1
和 mytemplate2
TriggerTemplates
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
5.3.11.12. triggertemplate describe
描述 TriggerTemplate。
示例: 描述命名空间中的 mytemplate
TriggerTemplate
$ tkn triggertemplate describe mytemplate -n `myspace`
5.3.11.13. triggertemplate list
列出 TriggerTemplates。
示例: 列出命名空间中的所有 TriggerTemplates
$ tkn triggertemplate list -n myspace
5.3.11.14. clustertriggerbinding
管理 ClusterTriggerBindings。
示例: 显示 ClusterTriggerBindings 帮助信息
$ tkn clustertriggerbinding -h
5.3.11.15. clustertriggerbinding delete
删除 ClusterTriggerBinding。
示例: 删除 myclusterbinding1
和 myclusterbinding2
ClusterTriggerBindings
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
5.3.11.16. clustertriggerbinding describe
描述 ClusterTriggerBinding。
示例: 描述 myclusterbinding
ClusterTriggerBinding
$ tkn clustertriggerbinding describe myclusterbinding
5.3.11.17. clustertriggerbinding list
列出 ClusterTriggerBindings。
示例: 列出所有 ClusterTriggerBindings
$ tkn clustertriggerbinding list
5.3.12. hub 互动命令
与 Tekton Hub 交互,以获取任务和管道等资源。
5.3.12.1. hub
与 hub 交互。
示例: 显示帮助信息
$ tkn hub -h
示例:与 hub API 服务器交互
$ 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
5.3.12.3. hub get
按名称、类型、目录和版本获取资源清单。
示例:从 tekton
目录中获取 myresource
管道或任务的特定版本的清单
$ 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
5.3.12.5. hub install
按类型、名称和版本从目录安装资源。
示例:从 mynamespace
命名空间中的 tekton
目录安装 mytask
任务的特定版本
$ 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
5.3.12.7. hub search
按名称、类型和标签组合搜索资源。
示例:搜索带有标签 cli
的资源
$ tkn hub search --tags cli
5.3.12.8. hub upgrade
升级已安装的资源。
示例:将 mynamespace
命名空间中安装的 mytask
任务升级到新版本
$ tkn hub upgrade task mytask --to version -n mynamespace
第 6 章 opm CLI
6.1. 安装 opm CLI
6.1.1. 关于 opm CLI
opm
CLI 工具由 Operator Framework 提供,用于 Operator 捆绑格式。您可以通过此工具从与软件存储库类似的 Operator 捆绑包列表中创建和维护 Operator 目录。其结果是一个容器镜像,它可以存储在容器的 registry 中,然后安装到集群中。
目录包含一个指向 Operator 清单内容的指针数据库,可通过在运行容器镜像时提供的已包含 API 进行查询。在 OpenShift Container Platform 中,Operator Lifecycle Manager (OLM) 可以引用由 CatalogSource
对象定义的目录源中的镜像,它会定期轮询镜像,以对集群上安装的 Operator 进行更新。
其他资源
- 如需有关捆绑格式的更多信息,请参阅 Operator Framework 打包格式。
- 要使用 Operator SDK 创建捆绑包镜像,请参阅使用 捆绑包镜像。
6.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>
- 对于 Windows,使用 ZIP 程序解压存档。
将文件放在
PATH
中的任何位置。对于 Linux 或者 macOS:
检查
PATH
:$ echo $PATH
移动文件。例如:
$ sudo mv ./opm /usr/local/bin/
对于 Windows:
检查
PATH
:C:\> path
移动文件:
C:\> move opm.exe <directory>
验证
安装
opm
CLI 后,验证是否可用:$ opm version
输出示例
Version: version.Version{OpmVersion:"v1.18.0", GitCommit:"32eb2591437e394bdc58a58371c5cd1e6fe5e63f", BuildDate:"2021-09-21T10:41:00Z", GoOs:"linux", GoArch:"amd64"}
6.1.3. 其他资源
-
请参阅为
opm
操作管理自定义目录,包括创建、更新和修剪目录。
6.2. opm CLI 参考
opm
命令行界面 (CLI) 是用于创建和维护 Operator 目录的工具。
opm
CLI 语法
$ opm <command> [<subcommand>] [<argument>] [<flags>]
标记 | 描述 |
---|---|
| 在拉取捆绑包或索引时跳过容器镜像 registry 的 TLS 证书验证。 |
基于 SQLite 的目录格式(包括相关的 CLI 命令)是一个弃用的功能。弃用的功能仍然包含在 OpenShift Container Platform 中,并将继续被支持。但是,这个功能会在以后的发行版本中被删除,且不建议在新的部署中使用。
有关 OpenShift Container Platform 中已弃用或删除的主要功能的最新列表,请参阅 OpenShift Container Platform 发行注记中已弃用和删除的功能部分。
6.2.1. index
从预先存在的 Operator 捆绑包生成 Operator 索引容器镜像。
命令语法
$ opm index <subcommand> [<flags>]
子命令 | 描述 |
---|---|
| 将 Operator 捆绑包添加到索引中。 |
|
以 |
| 修剪除指定软件包以外的所有索引。 |
| 修剪没有与特定镜像关联的分级捆绑包索引。 |
| 从索引中删除整个 Operator。 |
6.2.1.1. add
将 Operator 捆绑包添加到索引中。
命令语法
$ opm index add [<flags>]
标记 | 描述 |
---|---|
|
on-image |
|
构建容器镜像的工具: |
| 要添加的捆绑包的逗号分隔列表。 |
|
与容器镜像交互的工具,如保存和构建: |
| 要添加到的上一个索引。 |
| 如果启用,则仅创建 Dockerfile 并将其保存到本地磁盘。 |
|
图形更新模式,用来定义通频道图形如何被更新: |
| 可选:如果生成 Dockerfile,请指定一个文件名。 |
| 允许 registry 加载错误。 |
|
拉取容器镜像的工具: |
| 正在构建的容器镜像的自定义标签。 |
6.2.1.2. export
以 appregistry
格式从索引导出 Operator。
命令语法
$ opm index export [<flags>]
标记 | 描述 |
---|---|
| 从以下位置获取包的索引: |
|
保存下载的 Operator 捆绑包的目录。默认目录已 |
|
与容器镜像交互的工具,如保存和构建: |
|
|
| 要导出的软件包以逗号分隔列表。 |
6.2.1.3. prune
修剪除指定软件包以外的所有索引。
命令语法
$ opm index prune [<flags>]
标记 | 描述 |
---|---|
|
on-image |
|
与容器镜像交互的工具,如保存和构建: |
| 到修剪的索引。 |
| 如果启用,则仅创建 Dockerfile 并将其保存到本地磁盘。 |
| 可选:如果生成 Dockerfile,请指定一个文件名。 |
| 要保留的软件包用逗号隔开。 |
| 允许 registry 加载错误。 |
| 正在构建的容器镜像的自定义标签。 |
6.2.1.4. prune-stranded
修剪没有与特定镜像关联的分级捆绑包索引。
命令语法
$ opm index prune-stranded [<flags>]
标记 | 描述 |
---|---|
|
on-image |
|
与容器镜像交互的工具,如保存和构建: |
| 到修剪的索引。 |
| 如果启用,则仅创建 Dockerfile 并将其保存到本地磁盘。 |
| 可选:如果生成 Dockerfile,请指定一个文件名。 |
| 允许 registry 加载错误。 |
| 正在构建的容器镜像的自定义标签。 |
6.2.1.5. rm
从索引中删除整个 Operator。
命令语法
$ opm index rm [<flags>]
标记 | 描述 |
---|---|
|
on-image |
|
构建容器镜像的工具: |
|
与容器镜像交互的工具,如保存和构建: |
| 从中删除的以前索引。 |
| 如果启用,则仅创建 Dockerfile 并将其保存到本地磁盘。 |
| 要删除的用逗号分开的 Operator 列表。 |
| 可选:如果生成 Dockerfile,请指定一个文件名。 |
| 允许 registry 加载错误。 |
|
拉取容器镜像的工具: |
| 正在构建的容器镜像的自定义标签。 |
6.2.2. init
生成 olm.package
声明性配置 blob。
命令语法
$ opm init <package_name> [<flags>]
标记 | 描述 |
---|---|
| 如果未指定,订阅的频道将默认为。 |
|
Operator 的 |
| 软件包图标的路径. |
|
输出格式: |
6.2.3. render
从提供的索引镜像、捆绑包镜像和 SQLite 数据库文件生成声明性配置 blob。
命令语法
$ opm render <index_image | bundle_image | sqlite_file> [<flags>]
标记 | 描述 |
---|---|
|
输出格式: |
6.2.4. validate
验证给定目录中声明性配置 JSON 文件。
命令语法
$ opm validate <directory> [<flags>]
6.2.5. serve
通过 GRPC 服务器提供声明配置。
声明性配置目录在启动时由 serving
命令加载。此命令启动后对声明配置所做的更改不会反映在提供的内容中。
命令语法
$ opm serve <source_path> [<flags>]
标记 | 描述 |
---|---|
| 启用调试日志记录。 |
|
要服务的端口号。默认: |
|
容器终止日志文件的路径。默认值: |
第 7 章 Operator SDK
7.1. 安装 Operator SDK CLI
Operator SDK 提供了一个命令行界面(CLI)工具,Operator 开发人员可使用它来构建、测试和部署 Operator。您可以在工作站上安装 Operator SDK CLI,以便准备开始编写自己的 Operator。
具有集群管理员访问权限的 operator 作者(如 OpenShift Container Platform)可以使用 Operator SDK CLI 根据 Go、Ansible 或 Helm 开发自己的 Operator。Kubebuilder 作为基于 Go 的 Operator 的构建解决方案嵌入到 Operator SDK 中,这意味着现有的 Kubebuilder 项目可以象 Operator SDK 一样使用并继续工作。
如需有关 Operator SDK 的完整文档,请参阅 Operators。
OpenShift Container Platform 4.9 及更新的版本支持 Operator SDK v1.10.1。
7.1.1. 安装 Operator SDK CLI
您可以在 Linux 上安装 OpenShift SDK CLI 工具。
先决条件
- Go v1.16+
-
docker
v17.03+、podman
v1.9.3+ 或buildah
v1.7+
流程
- 导航到 OpenShift 镜像站点。
- 从最新的 4.9.0 目录中,下载适用于 Linux 的 tarball 的最新版本。
解包存档:
$ tar xvf operator-sdk-v1.10.1-ocp-linux-x86_64.tar.gz
使文件可执行:
$ chmod +x operator-sdk
将提取的
operator-sdk
二进制文件移到PATH
中的一个目录中。提示检查
PATH
:$ echo $PATH
$ sudo mv ./operator-sdk /usr/local/bin/operator-sdk
验证
安装 Operator SDK CLI 后,验证它是否可用:
$ operator-sdk version
输出示例
operator-sdk version: "v1.10.1-ocp", ...
7.2. Operator SDK CLI 参考
Operator SDK 命令行界面(CLI)是一个开发组件,旨在更轻松地编写 Operator。
operator SDK CLI 语法
$ operator-sdk <command> [<subcommand>] [<argument>] [<flags>]
如需有关 Operator SDK 的完整文档,请参阅 Operators。
7.2.1. bundle
operator-sdk bundle
命令管理 Operator 捆绑包元数据。
7.2.1.1. validate
bundle validate
子命令会验证 Operator 捆绑包。
标记 | 描述 |
---|---|
|
|
|
拉取和解包捆绑包镜像的工具。仅在验证捆绑包镜像时使用。可用选项是 |
| 列出所有可用的可选验证器。设置后,不会运行验证器。 |
|
选择要运行的可选验证器的标签选择器。当使用 |
7.2.2. cleanup
operator-sdk cleanup
命令会销毁并删除为通过 run
命令部署的 Operator 创建的资源。
标记 | 描述 |
---|---|
|
|
|
用于 CLI 请求的 |
| 如果存在,代表在其中运行 CLI 请求的命名空间。 |
|
失败前,等待命令完成的时间。默认值为 |
7.2.3. completion
operator-sdk completion
命令生成 shell completion,以便更迅速、更轻松地发出 CLI 命令。
子命令 | 描述 |
---|---|
| 生成 bash completion。 |
| 生成 zsh completion。 |
标记 | 描述 |
---|---|
| 使用方法帮助输出。 |
例如:
$ operator-sdk completion bash
输出示例
# bash completion for operator-sdk -*- shell-script -*- ... # ex: ts=4 sw=4 et filetype=sh
7.2.4. create
operator-sdk create
命令用于创建或 scaffold Kubernetes API。
7.2.4.1. api
create api
子命令构建 Kubernetes API。子命令必须在 init
命令初始化的项目中运行。
标记 | 描述 |
---|---|
|
|
7.2.5. generate
operator-sdk generate
命令调用特定的生成器来生成代码或清单。
7.2.5.1. bundle
generate bundle
子命令为您的 Operator 项目生成一组捆绑包清单、元数据和 bundle.Dockerfile
文件。
通常,您首先运行 generate kustomize manifests
子命令来生成由 generate bundle
子命令使用的输入 Kustomize 基础。但是,您可以使用初始项目中的 make bundle
命令按顺序自动运行这些命令。
标记 | 描述 |
---|---|
|
捆绑包所属频道的以逗号分隔的列表。默认值为 |
|
|
| 捆绑包的默认频道。 |
|
Operator 清单的根目录,如部署和 RBAC。这个目录与传递给 |
|
|
|
从中读取现有捆绑包的目录。这个目录是捆绑包 |
|
包含 Kustomize 基础的目录以及用于捆绑包清单的 |
| 生成捆绑包清单。 |
| 生成捆绑包元数据和 Dockerfile。 |
| 将捆绑包写入的目录。 |
|
如果捆绑包元数据和 Dockerfile 存在,则覆盖它们。默认值为 |
| 捆绑包的软件包名称。 |
| 在静默模式下运行。 |
| 将捆绑包清单写入标准输出。 |
| 生成的捆绑包中的 Operator 语义版本。仅在创建新捆绑包或升级 Operator 时设置。 |
其他资源
-
如需了解包括使用
make bundle
命令来调用generate bundle
子命令的完整流程,请参阅捆绑 Operator 和 Operator Lifecycle Manager 部署。
7.2.5.2. kustomize
generate kustomize
子命令包含为 Operator 生成 Kustomize 数据的子命令。
7.2.5.2.1. 清单
generate kustomize manifests
子命令生成或重新生成 Kustomize 基础以及 config/manifests
目录中的 kustomization.yaml
文件,用于其他 Operator SDK 命令构建捆绑包清单。在默认情况下,这个命令会以互动方式询问 UI 元数据,即清单基础的重要组件,除非基础已存在或设置了 --interactive=false
标志。
标记 | 描述 |
---|---|
| API 类型定义的根目录。 |
|
|
| 包含现有 Kustomize 文件的目录。 |
|
当设置为 |
| 写入 Kustomize 文件的目录。 |
| 软件包名称。 |
| 在静默模式下运行。 |
7.2.6. init
operator-sdk init
命令初始化 Operator 项目,并为给定插件生成或 scaffolds 默认项目目录布局。
这个命令会写入以下文件:
- boilerplate 许可证文件
-
带有域和库的
PROJECT
文件 -
构建项目的
Makefile
-
go.mod
文件带有项目依赖项 -
用于自定义清单的
kustomization.yaml
文件 - 用于为管理器清单自定义镜像的补丁文件
- 启用 Prometheus 指标的补丁文件
-
运行的
main.go
文件
标记 | 描述 |
---|---|
|
|
|
插件的名称和可选版本,用于初始化项目。可用插件包括 |
|
项目版本。可用值为 |
7.2.7. run
operator-sdk run
命令提供可在各种环境中启动 Operator 的选项。
7.2.7.1. bundle
run bundle
子命令使用 Operator Lifecycle Manager(OLM)以捆绑包格式部署 Operator。
标记 | 描述 |
---|---|
|
在其中注入捆绑包的索引镜像。默认镜像为 |
|
安装 Operator 的集群服务版本(CSV)支持的模式,如 |
|
安装超时。默认值为 |
|
用于 CLI 请求的 |
| 如果存在,代表在其中运行 CLI 请求的命名空间。 |
|
|
其他资源
- 如需有关可能安装模式的详细信息,请参阅 Operator 组成员资格。
7.2.7.2. bundle-upgrade
run bundle-upgrade
子命令升级之前使用 Operator Lifecycle Manager(OLM)以捆绑包格式安装的 Operator。
标记 | 描述 |
---|---|
|
升级超时。默认值为 |
|
用于 CLI 请求的 |
| 如果存在,代表在其中运行 CLI 请求的命名空间。 |
|
|
7.2.8. scorecard
operator-sdk scorecard
命令运行 scorecard 工具来验证 Operator 捆绑包并提供改进建议。该命令使用一个参数,可以是捆绑包镜像,也可以是包含清单和元数据的目录。如果参数包含镜像标签,则镜像必须远程存在。
标记 | 描述 |
---|---|
|
scorecard 配置文件的路径。默认路径为 |
|
|
|
|
| 列出哪些测试可以运行。 |
| 运行测试镜像的命名空间。 |
|
结果的输出格式。可用值为 |
| 标识选择器以确定要运行哪个测试。 |
|
用于测试的服务帐户。默认值为 |
| 运行测试后禁用资源清理。 |
|
等待测试完成的时间,如 |
其他资源
- 如需有关运行scorecard 工具的详细信息,请参阅使用 scorecard 工具验证 Operator。
Legal Notice
Copyright © 2024 Red Hat, Inc.
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.