ROSA CLI


Red Hat OpenShift Service on AWS 4

了解如何使用 Red Hat OpenShift Service on AWS 的命令行工具

Red Hat OpenShift Documentation Team

摘要

本文档介绍了安装、配置和使用 Red Hat OpenShift Service on AWS (ROSA) 的命令行工具。它还包含 CLI 命令和示例的参考。

设置并使用 Red Hat OpenShift Service on AWS (ROSA) CLI rosa

使用 Red Hat OpenShift Service on AWS (ROSA) 的 rosa 命令行工具,创建、管理和删除 Red Hat OpenShift Service on AWS 集群和资源。

1.2. 设置 ROSA CLI

使用以下步骤在安装主机上安装并配置 Red Hat OpenShift Service on AWS (ROSA) CLI rosa

流程

  1. 从 OpenShift Cluster Manager 的 Downloads 页面下载您的操作系统的 ROSA CLI (rosa)的最新版本。
  2. 从下载的存档中提取 rosa 二进制文件。以下示例从 Linux tar 归档中提取二进制文件:

    $ tar xvf rosa-linux.tar.gz
    Copy to Clipboard Toggle word wrap
  3. 在您的路径中添加 rosa。在以下示例中,/usr/local/bin 目录包含在用户的路径中:

    $ sudo mv rosa /usr/local/bin/rosa
    Copy to Clipboard Toggle word wrap
  4. 通过查询 rosa 版本来验证 ROSA CLI 是否已正确安装:

    $ rosa version
    Copy to Clipboard Toggle word wrap

    输出示例

    1.2.15
    Your ROSA CLI is up to date.
    Copy to Clipboard Toggle word wrap

  5. 可选:为 ROSA CLI 启用 tab 自动完成功能。启用 tab 自动完成功能后,您可以按 Tab 键两次来自动完成子命令并接收命令建议:

    • 在 Linux 主机上为 Bash 启用持久性 tab 自动完成功能:

      1. 为 Bash 生成 rosa 选项卡补全配置文件,并将其保存到 /etc/bash_completion.d/ 目录中:

        # rosa completion bash > /etc/bash_completion.d/rosa
        Copy to Clipboard Toggle word wrap
      2. 打开一个新的终端,以激活配置。
    • 为 macOS 主机上的 Bash 启用持久性 tab 自动完成功能:

      1. 为 Bash 生成 rosa 选项卡补全配置文件,并将其保存到 /usr/local/etc/bash_completion.d/ 目录中:

        $ rosa completion bash > /usr/local/etc/bash_completion.d/rosa
        Copy to Clipboard Toggle word wrap
      2. 打开一个新的终端,以激活配置。
    • 为 Zsh 启用持久性标签页完成:

      1. 如果没有为您的 Zsh 环境启用 tab 自动完成功能,请运行以下命令启用它:

        $ echo "autoload -U compinit; compinit" >> ~/.zshrc
        Copy to Clipboard Toggle word wrap
      2. 为 Zsh 生成 rosa 标签页完成配置文件,并将其保存到功能路径中的第一个目录中:

        $ rosa completion zsh > "${fpath[1]}/_rosa"
        Copy to Clipboard Toggle word wrap
      3. 打开一个新的终端,以激活配置。
    • 为 fish 启用持久性 tab 自动完成功能:

      1. 为方便生成 rosa 选项卡补全配置文件,并将其保存到 ~/.config/fish/completions/ 目录中:

        $ rosa completion fish > ~/.config/fish/completions/rosa.fish
        Copy to Clipboard Toggle word wrap
      2. 打开一个新的终端,以激活配置。
    • 为 PowerShell 启用持久性 tab 自动完成功能:

      1. 为 PowerShell 生成 rosa 选项卡补全配置文件,并将它保存到名为 rosa.ps1 的文件中:

        PS> rosa completion powershell | Out-String | Invoke-Expression
        Copy to Clipboard Toggle word wrap
      2. Source 来自您的 PowerShell 配置集中的 rosa.ps1 文件。
    注意

    有关配置 rosa tab 自动完成功能的更多信息,请通过运行 rosa completion --help 命令来查看帮助菜单。

1.3. 配置 ROSA CLI

使用以下命令配置 Red Hat OpenShift Service on AWS (ROSA) CLI rosa

1.3.1. login

登录到您的红帽帐户,将凭据保存到 rosa 配置文件。登录时您必须提供令牌。您可以从 Red Hat OpenShift Service on AWS token 页复制您的令牌。

ROSA CLI (rosa)按以下优先级顺序查找令牌:

  1. 命令行参数
  2. ROSA_TOKEN 环境变量
  3. rosa 配置文件
  4. 通过命令行提示符进行交互

语法

$ rosa login [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 1.1. 参数
选项定义

--client-id

OpenID 客户端标识符(字符串)。默认: cloud-services

--client-secret

OpenID 客户端 secret (字符串)。

--insecure

启用与服务器的不安全通信。这禁用 TLS 证书和主机名验证。

--scope

OpenID 范围(字符串)。如果使用这个选项,它将替换默认的范围。这可以重复多次以指定多个范围。默认:openid

--token

访问或刷新令牌(字符串)。

--token-url

OpenID 令牌 URL (字符串)。默认: https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token

Expand
表 1.2. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

1.3.2. logout

rosa 注销。注销也会移除 rosa 配置文件。

语法

$ rosa logout [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 1.3. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

1.3.3. 验证权限

验证创建 ROSA 集群所需的 AWS 权限是否已正确配置:

语法

$ rosa verify permissions [arguments]
Copy to Clipboard Toggle word wrap

注意

此命令只验证没有使用 AWS 安全令牌服务 (STS) 的集群的权限。

Expand
表 1.4. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--region

在其中运行命令的 AWS 区域(字符串)。这个值会覆盖 AWS_REGION 环境变量。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

验证 AWS 权限是否已正确配置:

$ rosa verify permissions
Copy to Clipboard Toggle word wrap

验证 AWS 权限是否在特定区域中正确配置:

$ rosa verify permissions --region=us-west-2
Copy to Clipboard Toggle word wrap

1.3.4. 验证配额

验证您的默认区域是否正确配置了 AWS 配额。

语法

$ rosa verify quota [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 1.5. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--region

在其中运行命令的 AWS 区域(字符串)。这个值会覆盖 AWS_REGION 环境变量。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

验证默认区域是否正确配置了 AWS 配额:

$ rosa verify quota
Copy to Clipboard Toggle word wrap

验证 AWS 配额是否在特定区域中正确配置:

$ rosa verify quota --region=us-west-2
Copy to Clipboard Toggle word wrap

1.3.5. 下载 rosa

下载 ROSA CLI 的最新兼容版本。

下载 rosa 后,提取存档的内容并将其添加到您的路径中。如需了解更多详细信息 ,请参阅设置 ROSA CLI

语法

$ rosa download rosa [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 1.6. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

1.3.6. 下载 oc

下载 OpenShift Container Platform CLI (oc) 的最新版本。

下载 oc 后,您必须提取存档的内容并将其添加到您的路径中。

语法

$ rosa download oc [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 1.7. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

示例

下载 oc 客户端工具:

$ rosa download oc
Copy to Clipboard Toggle word wrap

1.3.7. 验证 oc

验证 OpenShift Container Platform CLI (oc)是否已正确安装。

语法

$ rosa verify oc [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 1.8. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

示例

验证 oc 客户端工具:

$ rosa verify oc
Copy to Clipboard Toggle word wrap

1.4. 初始化 Red Hat OpenShift Service on AWS

仅在使用非STS 时,使用 init 命令在 AWS (ROSA)上初始化 Red Hat OpenShift Service。

1.4.1. init

执行一系列检查,以验证您是否已准备好在 AWS 集群上部署 Red Hat OpenShift Service。

检查列表包括:

  • 检查您是否已登录(请参阅 登录
  • 检查 AWS 凭证是否有效
  • 检查您的 AWS 权限是否有效(请参阅验证权限
  • 检查 AWS 配额级别是否足够高(请参阅验证配额
  • 运行集群模拟,以确保集群创建可以如预期执行
  • 检查您的 AWS 帐户中已创建了 osdCcsAdmin 用户
  • 检查 OpenShift Container Platform 命令行工具是否在您的系统中可用

语法

$ rosa init [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 1.9. 参数
选项定义

--region

验证配额和权限的 AWS 区域(字符串)。此值仅在运行 init 命令时覆盖 AWS_REGION 环境变量,但不会更改 AWS CLI 配置。

--delete

删除在 init 命令期间应用到 AWS 帐户的堆栈模板。

--client-id

OpenID 客户端标识符(字符串)。默认: cloud-services

--client-secret

OpenID 客户端 secret (字符串)。

--insecure

启用与服务器的不安全通信。这禁用 TLS 证书和主机名验证。

--scope

OpenID 范围(字符串)。如果使用这个选项,它会完全替代默认范围。这可以重复多次以指定多个范围。默认:openid

--token

访问或刷新令牌(字符串)。

--token-url

OpenID 令牌 URL (字符串)。默认: https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token

Expand
表 1.10. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

将您的 AWS 帐户配置为允许 ROSA 集群:

$ rosa init
Copy to Clipboard Toggle word wrap

使用预先存在的 OpenShift Cluster Manager 凭证配置新的 AWS 帐户:

$ rosa init --token=$OFFLINE_ACCESS_TOKEN
Copy to Clipboard Toggle word wrap

1.5. 使用 Bash 脚本

这是如何将 Bash 脚本与 Red Hat OpenShift Service on AWS (ROSA) CLI rosa 搭配使用的示例工作流。

前提条件

确保 AWS 凭证已作为以下选项之一可用:

  • AWS 配置集
  • 环境变量 (AWS_ACCESS_KEY_ID,AWS_SECRET_ACCESS_KEY)

流程

  1. 使用来自红帽的 Red Hat OpenShift Cluster Manager 离线令牌初始化 rosa

    $ rosa init --token=<token>
    Copy to Clipboard Toggle word wrap
  2. 在 AWS (ROSA)集群上创建 Red Hat OpenShift Service:

    $ rosa create cluster --cluster-name=<cluster_name>
    Copy to Clipboard Toggle word wrap
  3. 添加身份提供程序 (IDP):

    $ rosa create idp --cluster=<cluster_name> --type=<identity_provider> [arguments]
    Copy to Clipboard Toggle word wrap
  4. 添加 dedicated-admin 用户:

    $ rosa grant user dedicated-admin --user=<idp_user_name> --cluster=<cluster_name>
    Copy to Clipboard Toggle word wrap

1.6. 更新 ROSA CLI

更新至 Red Hat OpenShift Service on AWS (ROSA) CLI rosa 的最新兼容版本。

流程

  1. 确认可以使用 ROSA CLI (rosa)的新版本:

    $ rosa version
    Copy to Clipboard Toggle word wrap

    输出示例

    1.2.12
    There is a newer release version '1.2.15', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
    Copy to Clipboard Toggle word wrap

  2. 下载 ROSA CLI 的最新兼容版本:

    $ rosa download rosa
    Copy to Clipboard Toggle word wrap

    此命令将名为 rosa114.tar.gz 的存档下载到当前目录中。该文件的确切名称取决于您的操作系统和系统架构。

  3. 提取存档的内容:

    $ tar -xzf rosa-linux.tar.gz
    Copy to Clipboard Toggle word wrap
  4. 通过将提取的文件移到您的路径中,安装 ROSA CLI 的新版本。在以下示例中,/usr/local/bin 目录包含在用户的路径中:

    $ sudo mv rosa /usr/local/bin/rosa
    Copy to Clipboard Toggle word wrap

验证

  • 验证是否安装了新版本的 ROSA。

    $ rosa version
    Copy to Clipboard Toggle word wrap

    输出示例

    1.2.15
    Your ROSA CLI is up to date.
    Copy to Clipboard Toggle word wrap

第 2 章 使用 ROSA CLI 管理对象

使用 Red Hat OpenShift Service on AWS (ROSA) CLI ( rosa )管理对象,如添加 dedicated-admin 用户、管理集群和调度集群升级。

2.1. 常用命令和参数

这些常用命令和参数可用于 Red Hat OpenShift Service on AWS (ROSA) CLI rosa

2.1.1. debug

为父命令启用调试模式,以帮助进行故障排除。

示例

$ rosa create cluster --cluster-name=<cluster_name> --debug
Copy to Clipboard Toggle word wrap

2.1.2. 下载

将指定软件的最新兼容版本下载到存档文件中的当前目录中。提取存档的内容,并将内容添加到您的路径中以使用软件。要下载最新的 Red Hat OpenShift Service on AWS CLI,请指定 rosa。要下载最新的 OpenShift CLI,请指定 oc

示例

$ rosa download <software>
Copy to Clipboard Toggle word wrap

2.1.3. 帮助

显示 ROSA CLI (rosa)和可用命令列表的常规帮助信息。此选项也可以用作参数来显示父命令(如 versioncreate)的帮助信息。

例子

显示 ROSA CLI 的常规帮助。

$ rosa --help
Copy to Clipboard Toggle word wrap

显示 版本 的一般帮助。

$ rosa version --help
Copy to Clipboard Toggle word wrap

2.1.4. interactive

启用交互模式。

示例

$ rosa create cluster --cluster-name=<cluster_name> --interactive
Copy to Clipboard Toggle word wrap

2.1.5. 配置集

从凭证文件中指定 AWS 配置集。

示例

$ rosa create cluster --cluster-name=<cluster_name> --profile=myAWSprofile
Copy to Clipboard Toggle word wrap

2.1.6. version

显示 rosa 版本,并检查较新的版本是否可用。

示例

$ rosa version [arguments]
Copy to Clipboard Toggle word wrap

输出示例

当有较新版本的 ROSA CLI 可用时显示。

1.2.12
There is a newer release version '1.2.15', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
Copy to Clipboard Toggle word wrap

2.2. 父命令

Red Hat OpenShift Service on AWS (ROSA) CLI rosa 使用带有子命令的父命令来管理对象。父命令是 create, edit, delete, list, 和 describe。并非所有父命令都可用于所有子命令。如需更多信息,请参阅描述子命令的特定参考主题。

2.2.1. create

使用子命令对对象或资源时创建对象或资源。

示例

$ rosa create cluster --cluster-name=mycluster
Copy to Clipboard Toggle word wrap

2.2.2. edit

对对象的编辑选项,如使集群私有。

示例

$ rosa edit cluster --cluster=mycluster --private
Copy to Clipboard Toggle word wrap

2.2.3. delete

使用子命令对对象或资源时删除对象或资源。

示例

$ rosa delete ingress --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.2.4. list

列出特定集群的集群或资源。

示例

$ rosa list users --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.2.5. describe

显示集群的详情。

示例

$ rosa describe cluster --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.3. 创建对象

本节论述了集群和资源的 create 命令

2.3.1. 创建 account-roles

为集群创建所需的集群范围的角色和策略资源。

语法

$ rosa create account-roles [flags]
Copy to Clipboard Toggle word wrap

Expand
表 2.1. 标记
选项定义

--debug

启用调试模式。

-i, --interactive

启用交互模式。

-m, --mode string

如何执行操作。有效选项有:

auto
资源更改将使用当前的 AWS 帐户自动应用。
manual
修改 AWS 资源所需的命令将手动运行。

--path string

帐户范围的角色和策略的 ARN 路径,包括 Operator 策略。

--permissions-boundary string

用于为帐户角色设置权限边界的策略 ARN。

--prefix string

所有生成的 AWS 资源的用户定义的前缀。默认值为 ManagedOpenShift

--profile string

使用凭证文件中的特定 AWS 配置集。

-y, --yes

自动回答 yes 以确认操作。

2.3.2. 创建管理员

使用自动生成的密码创建集群管理员,以便登录到集群。

语法

$ rosa create admin --cluster=<cluster_name>|<cluster_id>
Copy to Clipboard Toggle word wrap

Expand
表 2.2. 参数
选项定义

--cluster <cluster_name>|<cluster_id>

必需。要添加到身份提供程序(IDP)的集群的名称或 ID (字符串)。

Expand
表 2.3. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile string

从您的凭证文件中指定 AWS 配置集。

示例

创建一个集群管理员,可以登录到名为 mycluster 的集群。

$ rosa create admin --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.3.3. 创建集群

创建新集群。

语法

$ rosa create cluster --cluster-name=<cluster_name> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.4. 参数
选项定义

--cluster-name <cluster_name>

必需。集群的名称。与 create cluster 命令一起使用时,此参数用于设置集群名称,并在 openshiftapps.com 上为集群生成子域。此参数的值必须在您的机构中唯一。

--compute-machine-type <instance_type>

集群中计算节点的实例类型。这决定了分配给每个计算节点的内存和 vCPU 数量。如需有关有效实例类型的更多信息,请参阅 Red Hat OpenShift Service on AWS 服务定义的 AWS 实例类型

--compute-nodes n

每个可用区要置备的 worker 节点数量。单区集群至少需要 2 个节点。多区集群至少需要 3 个节点。默认: 2 代表单区集群; 3 代表多区集群。

--controlplane-iam-role <arn>

附加到 control plane 实例的 IAM 角色的 Amazon 资源名称(ARN)。

--disable-scp-checks

指明在尝试安装集群时是否禁用了云权限检查。

--dry-run

模拟创建集群。

--enable-autoscaling

启用计算节点自动扩展。默认情况下,自动缩放设置为 2 个节点。要设置非默认节点限值,请将此参数与 --min-replicas--max-replicas 参数搭配使用。

--host-prefix <subnet>

分配给每个节点的子网前缀长度,作为整数。例如,如果主机前缀设置为 23,则每个节点从给定的 CIDR 中分配一个 /23 子网。

--machine-cidr <address_block>

安装集群时 Red Hat OpenShift Service on AWS 使用的 IP 地址块(ipNet),例如 10.0.0.0/16

重要

OVN-Kubernetes 是 Red Hat OpenShift Service on AWS 4.11 及之后的版本中的默认网络供应商,在内部使用 100.64.0.0/16 IP 地址范围。如果您的集群使用 OVN-Kubernetes,请不要在集群中的任何 CIDR 定义中包含 100.64.0.0/16 IP 地址范围。

--max-replicas <number_of_nodes>

指定启用自动扩展时的最大计算节点数量。默认: 2

--min-replicas <number_of_nodes>

指定启用自动扩展时的最小计算节点数量。默认: 2

--multi-az

部署到多个数据中心。

--operator-roles-prefix <string>

用于 OpenShift 安装程序中所需 Operator 使用的所有 IAM 角色的前缀。如果没有指定前缀,则会自动生成前缀。

--pod-cidr <address_block>

从中分配 Pod IP 地址的 IP 地址块(ipNet),例如 10.128.0.0/14

重要

OVN-Kubernetes 是 Red Hat OpenShift Service on AWS 4.11 及之后的版本中的默认网络供应商,在内部使用 100.64.0.0/16 IP 地址范围。如果您的集群使用 OVN-Kubernetes,请不要在集群中的任何 CIDR 定义中包含 100.64.0.0/16 IP 地址范围。

--private

限制主 API 端点和应用程序路由来直接、专用连接。

--private-link

指定使用 AWS PrivateLink 提供 VPC 和服务间的私有连接。使用 --private-link 时需要 --subnet-ids 参数。

--region <region_name>

您的 worker 池将位于的 AWS 区域的名称,如 us-east-1。此参数覆盖 AWS_REGION 环境变量。

--role-arn <arn>

OpenShift Cluster Manager 用于创建集群的安装程序角色的 Amazon 资源名称(ARN)。如果您还没有创建帐户角色,则需要此项。

--service-cidr <address_block>

服务的 IP 地址块(ipNet),如 172.30.0.0/16

重要

OVN-Kubernetes 是 Red Hat OpenShift Service on AWS 4.11 及之后的版本中的默认网络供应商,在内部使用 100.64.0.0/16 IP 地址范围。如果您的集群使用 OVN-Kubernetes,请不要在集群中的任何 CIDR 定义中包含 100.64.0.0/16 IP 地址范围。

--sts | --non-sts

指定是否使用 AWS 安全令牌服务(STS)或 IAM 凭证(非STS)来部署集群。

--subnet-ids <aws_subnet_id>

安装集群时使用的 AWS 子网 ID,如 subnet-01abc234d5678ef9a。子网 ID 必须与一个私有子网 ID 和每个可用区一个公共子网 ID 进行对。子网以逗号分隔,如 --subnet-ids=subnet-1,subnet-2。保留为安装程序置备的子网 ID 的值为空。

使用 --private-link 时,需要 --subnet-ids 参数,并且每个区只允许一个私有子网。

--support-role-arn string

Red Hat Site Reliabilty Engineers (SRE)使用的角色的 Amazon 资源名称(ARN),以便访问集群帐户以提供支持。

--version 字符串

用于安装集群或集群资源的 Red Hat OpenShift Service on AWS 版本。对于 集群,使用 X.Y.Z 格式,如 4.12.9。对于 account-role,使用 X.Y 格式,如 4.12

--worker-iam-role string

将附加到计算实例的 IAM 角色的 Amazon 资源名称(ARN)。

Expand
表 2.5. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

创建名为 mycluster 的集群。

$ rosa create cluster --cluster-name=mycluster
Copy to Clipboard Toggle word wrap

使用特定 AWS 区域创建集群。

$ rosa create cluster --cluster-name=mycluster --region=us-east-2
Copy to Clipboard Toggle word wrap

创建在默认 worker 机器池上启用自动扩展的集群。

$ rosa create cluster --cluster-name=mycluster -region=us-east-1 --enable-autoscaling --min-replicas=2 --max-replicas=5
Copy to Clipboard Toggle word wrap

2.3.4. 创建 idp

添加身份提供程序 (IDP) 以定义用户如何登录到集群。

语法

$ rosa create idp --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.6. 参数
选项定义

--cluster <cluster_name>|<cluster_id>

必需。添加 IDP 的集群的名称或 ID。

--ca <path_to_file>

向服务器发出请求时使用的 PEM 编码证书文件的路径,如 /usr/share/cert.pem

--client-id

注册的应用程序中的客户端 ID (字符串)。

--client-secret

来自注册的应用程序的客户端 secret(字符串)。

--mapping-method

指定在用户登录时如何将新身份(字符串)映射到用户。默认:claim

--name

身份提供程序的名称(字符串)。

--type

身份提供程序的类型(字符串)。选择:github, gitlab, google, ldap, openid

Expand
表 2.7. GitHub 参数
选项定义

--hostname

与托管 GitHub Enterprise 实例一起使用的可选域(字符串)。

--organizations

指定用于登录访问的组织。只有至少是一个所列机构(字符串)成员的用户才能登录。

--teams

指定用于登录访问的团队。只有至少属于列出的团队(字符串)的成员的用户才能登录。格式为 <org>/<team>

Expand
表 2.8. GitLab 参数
选项定义

--host-url

GitLab 提供程序的主机 URL (字符串)。默认:https://gitlab.com

Expand
表 2.9. Google 参数
选项定义

--hosted-domain

将用户限制为 Google Apps 域(字符串)。

Expand
表 2.10. LDAP 参数
选项定义

--bind-dn

在搜索阶段要绑定的域名(字符串)。

--bind-password

在搜索阶段要绑定到的密码(字符串)。

--email-attributes

列表(字符串)应用作电子邮件地址的属性。

--id-attributes

列表(字符串)值应用作用户 ID 的属性。默认:dn

--insecure

不使 TLS 连接到服务器。

--name-attributes

列表(字符串)值应用作显示名称的属性。默认:cn

--url

RFC 2255 URL (字符串),指定要使用的 LDAP 搜索参数。

--username-attributes

列表(字符串)值应用作首选用户名的属性。默认: uid

Expand
表 2.11. OpenID 参数
选项定义

--email-claims

用作电子邮件地址的声明的列表(字符串)。

--extra-scopes

在授权令牌请求期间,除了 openid 范围外,还列出请求的范围(字符串)。

--issuer-url

OpenID 供应商断言为签发者标识符的 URL (字符串)。它必须使用没有 URL 查询参数或片段的 HTTPS 方案。

--name-claims

用作显示名称的声明的列表(字符串)。

--username-claims

在置备用户时用作首选用户名的声明列表(字符串)。

Expand
表 2.12. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

将 GitHub 身份提供程序添加到名为 mycluster 的集群。

$ rosa create idp --type=github --cluster=mycluster
Copy to Clipboard Toggle word wrap

按照交互式提示添加身份提供程序。

$ rosa create idp --cluster=mycluster --interactive
Copy to Clipboard Toggle word wrap

2.3.5. 创建入口

添加入口端点以启用集群的 API 访问。

语法

$ rosa create ingress --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.13. 参数
选项定义

--cluster <cluster_name>|<cluster_id>

必需:将添加入口的集群的名称或 ID。

--label-match

ingress 的标签匹配(字符串)。格式必须是用逗号分开的 key=value 对列表。如果没有指定标签,则在两个路由器上都公开所有路由。

--private

将应用程序路由限制为直接、私有连接。

Expand
表 2.14. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

将内部入口添加到名为 mycluster 的集群。

$ rosa create ingress --private --cluster=mycluster
Copy to Clipboard Toggle word wrap

向名为 mycluster 的集群添加公共入口。

$ rosa create ingress --cluster=mycluster
Copy to Clipboard Toggle word wrap

使用路由选择器标签匹配添加 ingress。

$ rosa create ingress --cluster=mycluster --label-match=foo=bar,bar=baz
Copy to Clipboard Toggle word wrap

2.3.6. 创建 machinepool

将机器池添加到现有集群。

语法

$ rosa create machinepool --cluster=<cluster_name> | <cluster_id> --replicas=<number> --name=<machinepool_name> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.15. 参数
选项定义

--cluster <cluster_name>|<cluster_id>

必需:将添加机器池的集群的名称或 ID。

--enable-autoscaling

启用或禁用计算节点的自动扩展。若要启用自动扩展,请使用此参数及 --min-replicas--max-replicas 参数。要禁用自动扩展,请使用带有 --replicas 参数的 --enable-autoscaling=false

--instance-type

应该使用的实例类型(字符串)。默认值: m5.xlarge

--labels

机器池的标签(字符串)。格式必须是用逗号分开的 key=value 对列表。此列表会持续覆盖对节点标签所做的任何修改。

--max-replicas

指定启用自动扩展时的最大计算节点数量。

--min-replicas

指定启用自动扩展时的最小计算节点数量。

--name

必需:机器池的名称(字符串)。

--replicas

没有配置自动扩展时需要。此机器池的机器数量(整数)。

--taints

机器池的污点。此字符串值应该以逗号分隔的 key=value:ScheduleType 列表的形式。此列表将永久覆盖对节点污点所做的任何修改。

Expand
表 2.16. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

交互式将机器池添加到名为 mycluster 的集群。

$ rosa create machinepool --cluster=mycluster --interactive
Copy to Clipboard Toggle word wrap

将名为 mp-1 的机器池添加到启用了自动扩展的集群。

$ rosa create machinepool --cluster=mycluster --enable-autoscaling --min-replicas=2 --max-replicas=5 --name=mp-1
Copy to Clipboard Toggle word wrap

添加名为 mp-1 的机器池,并将 3 个副本为 m5.xlarge 到集群。

$ rosa create machinepool --cluster=mycluster --replicas=3 --instance-type=m5.xlarge --name=mp-1
Copy to Clipboard Toggle word wrap

在集群中添加带有标签的机器池。

$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz --name=mp-1
Copy to Clipboard Toggle word wrap

2.3.7. 创建 ocm-role

为集群创建所需的 ocm-role 资源。

语法

$ rosa create ocm-role [flags]
Copy to Clipboard Toggle word wrap

Expand
表 2.17. 标记
选项定义

--admin

为角色启用管理功能。

--debug

启用调试模式。

-i, --interactive

启用交互模式。

-m, --mode string

如何执行操作。有效选项有:

  • auto :资源更改将使用当前的 AWS 帐户自动应用
  • 手动 :修改 AWS 资源所需的命令将输出手动运行

--path string

OCM 角色和策略的 ARN 路径。

--permissions-boundary string

用于为 OCM 角色设置权限边界的策略 ARN。

--prefix string

所有生成的 AWS 资源的用户定义的前缀。默认值为 ManagedOpenShift

--profile string

使用凭证文件中的特定 AWS 配置集。

-y, --yes

自动回答 yes 以确认操作。

有关使用 rosa create ocm-role 命令创建的 OCM 角色的更多信息,请参阅 帐户范围内的 IAM 角色和策略引用

2.3.8. 创建 user-role

为集群创建所需的 user-role 资源。

语法

$ rosa create user-role [flags]
Copy to Clipboard Toggle word wrap

Expand
表 2.18. 标记
选项定义

--debug

启用调试模式。

-i, --interactive

启用交互模式。

-m, --mode string

如何执行操作。有效选项有:

  • auto :资源更改将使用当前的 AWS 帐户自动应用
  • 手动 :修改 AWS 资源所需的命令将输出手动运行

--path string

用户角色和策略的 ARN 路径。

--permissions-boundary string

用于为用户角色设置权限边界的策略的 ARN。

--prefix string

所有生成的 AWS 资源的用户定义前缀为 ManagedOpenShift

--profile string

使用凭证文件中的特定 AWS 配置集。

-y, --yes

自动回答 yes 以确认操作。

有关使用 rosa create user-role 命令创建的用户角色的更多信息,请参阅了解 AWS 帐户关联

2.5. 编辑对象

本节论述了集群和资源的 edit 命令。

2.5.1. 编辑集群

允许对现有集群进行编辑。

语法

$ rosa edit cluster --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.19. 参数
选项定义

--cluster

必需:要编辑的集群的名称或 ID (字符串)。

--private

限制主 API 端点直接和专用连接。

Expand
表 2.20. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

编辑名为 mycluster 的集群使其私有。

$ rosa edit cluster --cluster=mycluster --private
Copy to Clipboard Toggle word wrap

在名为 mycluster 的集群中以交互方式编辑所有集群选项。

$ rosa edit cluster --cluster=mycluster --interactive
Copy to Clipboard Toggle word wrap

2.5.2. edit ingress

为集群编辑额外的非默认应用程序路由器。

语法

$ rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.21. 参数
选项定义

--cluster

必需:将添加入口的集群的名称或 ID (字符串)。

--label-match

ingress 的标签匹配(字符串)。格式必须是用逗号分开的 key=value 对列表。如果没有指定标签,则在两个路由器上都公开所有路由。

--private

将应用程序路由限制为直接、私有连接。

Expand
表 2.22. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

在名为 mycluster 的集群上,创建一个 ID 为 a1b2 的额外入口作为私有连接。

$ rosa edit ingress --private --cluster=mycluster a1b2
Copy to Clipboard Toggle word wrap

使用名为 mycluster 的集群上的 ID a1b2 更新额外入口的路由器选择器。

$ rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2
Copy to Clipboard Toggle word wrap

使用名为 mycluster 的集群中的子域标识符 应用程序 更新默认入口。

$ rosa edit ingress --private=false --cluster=mycluster apps
Copy to Clipboard Toggle word wrap

2.5.3. edit machinepool

编辑集群中的机器池。

语法

$ rosa edit machinepool --cluster=<cluster_name> | <cluster_id> <machinepool_ID> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.23. 参数
选项定义

--cluster

必需:要编辑额外机器池的集群的名称或 ID (字符串)。

--enable-autoscaling

启用或禁用计算节点的自动扩展。若要启用自动扩展,请使用此参数及 --min-replicas--max-replicas 参数。要禁用自动扩展,请使用带有 --replicas 参数的 --enable-autoscaling=false

--labels

机器池的标签(字符串)。格式必须是用逗号分开的 key=value 对列表。编辑此值只会影响机器池的新创建的节点,这通过增加节点号创建,而不影响现有节点。此列表会持续覆盖对节点标签所做的任何修改。

--max-replicas

指定启用自动扩展时的最大计算节点数量。

--min-replicas

指定启用自动扩展时的最小计算节点数量。

--replicas

没有配置自动扩展时需要。此机器池的机器数量(整数)。

--taints

机器池的污点。此字符串值应该以逗号分隔的 key=value:ScheduleType 列表的形式。编辑此值只会影响机器池的新创建的节点,这通过增加节点号创建,而不影响现有节点。此列表会永久覆盖对节点污点所做的任何修改。

Expand
表 2.24. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

在名为 mycluster 的集群上,设置一个名为 mp1 的机器池上的 4 个副本。

$ rosa edit machinepool --cluster=mycluster --replicas=4 --name=mp1
Copy to Clipboard Toggle word wrap

在名为 mycluster 的集群上,启用名为 mp1 的机器池上的自动扩展。

$ rosa edit machinepool --cluster=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 --name=mp1
Copy to Clipboard Toggle word wrap

在名为 mycluster 的集群上,禁用名为 mp1 的机器池上的自动扩展。

$ rosa edit machinepool --cluster=mycluster  --enable-autoscaling=false --replicas=3 --name=mp1
Copy to Clipboard Toggle word wrap

在名为 mycluster 的集群上,修改名为 mp1 的机器池上的自动扩展范围。

$ rosa edit machinepool --max-replicas=9 --cluster=mycluster --name=mp1
Copy to Clipboard Toggle word wrap

2.6. 删除对象

本节论述了集群和资源的 delete 命令。

2.6.1. 删除管理员

从指定的集群删除集群管理员。

语法

$ rosa delete admin --cluster=<cluster_name> | <cluster_id>
Copy to Clipboard Toggle word wrap

Expand
表 2.25. 参数
选项定义

--cluster

必需:要添加到身份提供程序(IDP)的集群名称或 ID (字符串)。

Expand
表 2.26. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

从名为 mycluster 的集群中删除集群管理员。

$ rosa delete admin --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.6.2. 删除集群

删除集群。

语法

$ rosa delete cluster --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.27. 参数
选项定义

--cluster

必需:要删除的集群的名称或 ID (字符串)。

--watch

监视集群卸载日志。

Expand
表 2.28. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

--yes

自动回答 yes 以确认操作。

例子

删除名为 mycluster 的集群。

$ rosa delete cluster --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.6.3. 删除 idp

从集群中删除特定的身份提供程序 (IDP)。

语法

$ rosa delete idp --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.29. 参数
选项定义

--cluster

必需:删除 IDP 的集群的名称或 ID (字符串)。

Expand
表 2.30. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

--yes

自动回答 yes 以确认操作。

示例

从名为 mycluster 的集群中删除名为 github 的身份供应商。

$ rosa delete idp github --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.6.4. 删除入口

从集群中删除非默认应用程序路由器(入口)。

语法

$ rosa delete ingress --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.31. 参数
选项定义

--cluster

必需:要删除入口的集群的名称或 ID (字符串)。

Expand
表 2.32. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

--yes

自动回答 yes 以确认操作。

例子

从名为 mycluster 的集群中删除 ID 为 a1b2 的 ingress。

$ rosa delete ingress --cluster=mycluster a1b2
Copy to Clipboard Toggle word wrap

从名为 mycluster 的集群中删除子域名称 apps2 的二级入口。

$ rosa delete ingress --cluster=mycluster apps2
Copy to Clipboard Toggle word wrap

2.6.5. delete machinepool

从集群中删除机器池。

语法

$ rosa delete machinepool --cluster=<cluster_name> | <cluster_id> <machine_pool_id>
Copy to Clipboard Toggle word wrap

Expand
表 2.33. 参数
选项定义

--cluster

必需:将从中删除机器池的集群的名称或 ID (字符串)。

Expand
表 2.34. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--interactive

启用交互模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

--yes

自动回答 yes 以确认操作。

示例

从名为 mycluster 的集群中删除 ID 为 mp-1 的机器池。

$ rosa delete machinepool --cluster=mycluster mp-1
Copy to Clipboard Toggle word wrap

2.7. 安装和卸载附加组件

这部分论述了如何在集群中安装和卸载 Red Hat managed service add-ons。

2.7.1. 安装附加组件

在集群上安装受管服务附加组件。

语法

$ rosa install addon --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.35. 参数
选项定义

--cluster

必需:安装附加组件的集群的名称或 ID (字符串)。

Expand
表 2.36. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

使用您的凭据文件中的特定 AWS 配置集(字符串)。

--yes

自动回答 yes 以确认操作。

示例

dbaas-operator 附加组件安装添加到名为 mycluster 的集群。

$ rosa install addon --cluster=mycluster dbaas-operator
Copy to Clipboard Toggle word wrap

2.7.2. 卸载附加组件

从集群中删除受管服务附加组件。

语法

$ rosa uninstall addon --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.37. 参数
选项定义

--cluster

必需:将从中卸载附加组件的集群的名称或 ID (字符串)。

Expand
表 2.38. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

使用您的凭据文件中的特定 AWS 配置集(字符串)。

--yes

自动回答 yes 以确认操作。

示例

从名为 mycluster 的集群中删除 dbaas-operator 附加组件安装。

$ rosa uninstall addon --cluster=mycluster dbaas-operator
Copy to Clipboard Toggle word wrap

2.8. 列出和描述对象

本节介绍了集群和资源的 listdescribe 命令。

2.8.1. 列出附加组件

列出受管服务附加组件安装。

语法

$ rosa list addons --cluster=<cluster_name> | <cluster_id>
Copy to Clipboard Toggle word wrap

Expand
表 2.39. 参数
选项定义

--cluster

必需:要列出附加组件的集群的名称或 ID (字符串)。

Expand
表 2.40. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

2.8.2. 列出集群

列出所有集群。

语法

$ rosa list clusters [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.41. 参数
选项定义

--count

要显示的集群数量(整数)。默认: 100

Expand
表 2.42. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

2.8.3. list idps

列出集群的所有身份提供程序 (IDP)。

语法

$ rosa list idps --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.43. 参数
选项定义

--cluster

必需:为其列出 IDP 的集群的名称或 ID (字符串)。

Expand
表 2.44. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

列出名为 mycluster 的集群的所有身份提供程序 (IDP)。

$ rosa list idps --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.8.4. 列出 ingresses

列出集群的所有 API 和入口端点。

语法

$ rosa list ingresses --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.45. 参数
选项定义

--cluster

必需:为其列出 IDP 的集群的名称或 ID (字符串)。

Expand
表 2.46. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

列出名为 mycluster 的集群的所有 API 和入口端点。

$ rosa list ingresses --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.8.5. list instance-types

列出用于 AWS 上的 Red Hat OpenShift Service 的所有可用实例类型。可用性基于帐户的 AWS 配额。

语法

$ rosa list instance-types [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.47. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--output

输出格式。允许的格式是 jsonyaml

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

列出所有实例类型。

$ rosa list instance-types
Copy to Clipboard Toggle word wrap

2.8.6. list machinepools

列出集群上配置的机器池。

语法

$ rosa list machinepools --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.48. 参数
选项定义

--cluster

必需:列出机器池用于的集群的名称或 ID (字符串)。

Expand
表 2.49. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

列出名为 mycluster 的集群中的所有机器池。

$ rosa list machinepools --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.8.7. 列出区域

列出当前 AWS 帐户的所有可用区域。

语法

$ rosa list regions [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.50. 参数
选项定义

--multi-az

列出为多个可用区支持的区域。

Expand
表 2.51. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

列出所有可用区域。

$ rosa list regions
Copy to Clipboard Toggle word wrap

2.8.8. 列出升级

列出所有可用的和已调度的集群版本升级。

语法

$ rosa list upgrades --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.52. 参数
选项定义

--cluster

必需:列出可用升级的集群的名称或 ID (字符串)。

Expand
表 2.53. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

列出名为 mycluster 的集群的所有可用升级。

$ rosa list upgrades --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.8.9. 列出用户

列出指定集群的集群管理员和专用管理员用户。

语法

$ rosa list users --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.54. 参数
选项定义

--cluster

必需:集群管理员要列出的集群的名称或 ID (字符串)。

Expand
表 2.55. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

列出名为 mycluster 的集群的所有集群管理员和专用管理员。

$ rosa list users --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.8.10. 列出版本

列出所有可用于创建集群的 OpenShift 版本。

语法

$ rosa list versions [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.56. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

列出所有 OpenShift Container Platform 版本。

$ rosa list versions
Copy to Clipboard Toggle word wrap

2.8.11. 描述管理员

显示指定 cluster-admin 用户以及要登录到集群的命令的详细信息。

语法

$ rosa describe admin --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.57. 参数
选项定义

--cluster

必需: cluster-admin 所属集群的名称或 ID (字符串)。

Expand
表 2.58. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

描述名为 mycluster 的集群的 cluster-admin 用户。

$ rosa describe admin --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.8.12. 描述附加组件

显示托管服务附加组件的详细信息。

语法

$ rosa describe addon <addon_id> | <addon_name> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.59. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

描述名为 dbaas-operator 的附加组件。

$ rosa describe addon dbaas-operator
Copy to Clipboard Toggle word wrap

2.8.13. 描述集群

显示集群的详情。

语法

$ rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.60. 参数
选项定义

--cluster

必需:集群的名称或 ID (字符串)。

Expand
表 2.61. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

描述名为 mycluster 的集群。

$ rosa describe cluster --cluster=mycluster
Copy to Clipboard Toggle word wrap

2.9. 升级和删除集群的升级

本节论述了集群的 upgrade 命令用法。

2.9.1. 升级集群

调度集群升级。

语法

$ rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 2.62. 参数
选项定义

--cluster

必需:要调度升级的集群的名称或 ID (字符串)。

--interactive

启用交互模式。

--version

集群要升级到的 OpenShift Container Platform 的版本(字符串)。

--schedule-date

升级将在指定时间运行时的下一个日期(字符串)。格式: yyyy-mm-dd

--schedule-time

下次升级将在指定的日期中运行。格式: HH:mm

--node-drain-grace-period

设置一个宽限期(字符串),以便在升级过程中遵守 pod 中断预算保护的工作负载的时间。在此宽限期后,任何无法从节点成功排空的 pod 中断预算保护的所有工作负载都会强制被驱除。默认: 1 小时

Expand
表 2.63. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

例子

在名为 mycluster 的集群上以交互方式调度升级。

$ rosa upgrade cluster --cluster=mycluster --interactive
Copy to Clipboard Toggle word wrap

在名为 mycluster 的集群上一小时内调度集群升级。

$ rosa upgrade cluster --cluster=mycluster --version 4.5.20
Copy to Clipboard Toggle word wrap

2.9.2. 删除升级

取消调度的集群升级。

语法

$ rosa delete upgrade --cluster=<cluster_name> | <cluster_id>
Copy to Clipboard Toggle word wrap

Expand
表 2.64. 参数
选项定义

--cluster

必需:将取消升级的集群的名称或 ID (字符串)。

Expand
表 2.65. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--yes

自动回答 yes 以确认操作。

第 3 章 使用 ROSA CLI 检查帐户和版本信息

3.1. 使用 ROSA CLI 检查帐户和版本信息

使用以下命令,使用 Red Hat OpenShift Service on AWS (ROSA) CLI rosa 检查您的帐户和版本信息。

3.1.1. whoami

显示有关 AWS 和 Red Hat 账户的信息。

语法

$ rosa whoami [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 3.1. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

$ rosa whoami
Copy to Clipboard Toggle word wrap

3.1.2. version

显示 Red Hat OpenShift Service on AWS (ROSA) CLI 版本 rosa

语法

$ rosa version [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 3.2. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

$ rosa version
Copy to Clipboard Toggle word wrap

第 4 章 使用 ROSA CLI 检查日志

4.1. 使用 ROSA CLI 检查日志

您可以使用 Red Hat OpenShift Service on AWS (ROSA) CLI rosa 检查日志。使用以下命令检查您的安装和卸载日志。

4.1.1. 日志安装

显示集群安装日志。

语法

$ rosa logs install --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 4.1. 参数
选项定义

--cluster

必需:要获取日志的集群名称或 ID (字符串)。

--tail

从日志末尾获取的行数(整数)。默认: 2000

--watch

监视获取日志后的更改。

Expand
表 4.2. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

例子

显示名为 mycluster 的集群的最后 100 个安装日志行:

$ rosa logs install mycluster --tail=100
Copy to Clipboard Toggle word wrap

显示名为 mycluster 的集群的安装日志:

$ rosa logs install --cluster=mycluster
Copy to Clipboard Toggle word wrap

4.1.2. 日志卸载

显示集群卸载日志。

语法

$ rosa logs uninstall --cluster=<cluster_name> | <cluster_id> [arguments]
Copy to Clipboard Toggle word wrap

Expand
表 4.3. 参数
选项定义

--cluster

集群的名称或 ID (字符串)来获取日志。

--tail

从日志末尾获取的行数(整数)。默认: 2000

--watch

监视获取日志后的更改。

Expand
表 4.4. 从父命令继承的可选参数
选项定义

--help

显示此命令的帮助信息。

--debug

启用调试模式。

--profile

指定来自您的凭证文件中的 AWS 配置集(字符串)。

示例

显示名为 mycluster 的集群的最后 100 卸载日志:

$ rosa logs uninstall --cluster=mycluster --tail=100
Copy to Clipboard Toggle word wrap

Legal Notice

Copyright © 2025 Red Hat

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2026 Red Hat