7.2. 使用 ROSA CLI 管理对象
使用 Red Hat OpenShift Service on AWS (ROSA) CLI 管理对象 rosa
,如添加 dedicated-admin
用户、管理集群和调度集群升级。
要访问只能通过 HTTP 代理服务器访问的集群,您可以设置 HTTP_PROXY
、HTTPS_PROXY
和 NO_PROXY
变量。这些环境变量由 rosa
CLI 尊重,以便所有与集群的通信都通过 HTTP 代理进行。
7.2.1. 常用命令和参数 复制链接链接已复制到粘贴板!
这些常用命令和参数可用于 Red Hat OpenShift Service on AWS (ROSA) CLI。
7.2.1.1. debug 复制链接链接已复制到粘贴板!
为父命令启用调试模式,以帮助进行故障排除。
示例
rosa create cluster --cluster-name=<cluster_name> --debug
$ rosa create cluster --cluster-name=<cluster_name> --debug
7.2.1.2. 下载 复制链接链接已复制到粘贴板!
将指定软件的最新兼容版本下载到存档文件中的当前目录。提取存档的内容并在您的路径中添加内容以使用软件。要下载最新的 ROSA CLI,请指定 rosa
。要下载最新的 OpenShift CLI,请指定 oc
。
示例
rosa download <software>
$ rosa download <software>
7.2.1.3. 帮助 复制链接链接已复制到粘贴板!
显示 ROSA CLI (rosa
)和可用命令列表的常规帮助信息。此选项也可以用作参数来显示父命令(如 version
或 create
)的帮助信息。
例子
显示 ROSA CLI 的常规帮助。
rosa --help
$ rosa --help
显示 版本
的常规帮助。
rosa version --help
$ rosa version --help
7.2.1.4. interactive 复制链接链接已复制到粘贴板!
启用交互模式。
示例
rosa create cluster --cluster-name=<cluster_name> --interactive
$ rosa create cluster --cluster-name=<cluster_name> --interactive
7.2.1.5. 配置集 复制链接链接已复制到粘贴板!
从凭证文件中指定 AWS 配置集。
示例
rosa create cluster --cluster-name=<cluster_name> --profile=myAWSprofile
$ rosa create cluster --cluster-name=<cluster_name> --profile=myAWSprofile
7.2.1.6. version 复制链接链接已复制到粘贴板!
显示 rosa
版本,并检查是否有新版本可用。
示例
rosa version [arguments]
$ rosa version [arguments]
输出示例
当有新版本的 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/
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/
7.2.2. 父命令 复制链接链接已复制到粘贴板!
Red Hat OpenShift Service on AWS (ROSA) CLI rosa
使用父命令和子命令来管理对象。父命令是 create
, edit
, delete
, list
, 和 describe
。并非所有父命令都可用于所有子命令。如需更多信息,请参阅描述子命令的特定参考主题。
7.2.2.1. create 复制链接链接已复制到粘贴板!
使用子命令对对象或资源时创建对象或资源。
示例
rosa create cluster --cluster-name=mycluster
$ rosa create cluster --cluster-name=mycluster
7.2.2.2. edit 复制链接链接已复制到粘贴板!
对对象的编辑选项,如使集群私有。
示例
rosa edit cluster --cluster=mycluster --private
$ rosa edit cluster --cluster=mycluster --private
7.2.2.3. delete 复制链接链接已复制到粘贴板!
使用子命令对对象或资源时删除对象或资源。
示例
rosa delete ingress --cluster=mycluster
$ rosa delete ingress --cluster=mycluster
7.2.2.4. list 复制链接链接已复制到粘贴板!
列出特定集群的集群或资源。
示例
rosa list users --cluster=mycluster
$ rosa list users --cluster=mycluster
7.2.2.5. describe 复制链接链接已复制到粘贴板!
显示集群的详情。
示例
rosa describe cluster --cluster=mycluster
$ rosa describe cluster --cluster=mycluster
7.2.3. 创建对象 复制链接链接已复制到粘贴板!
要创建 Hosted Control Plane 集群,请根据需要包含 '--hosted-cp' 标志。
本节论述了集群和资源的 create
命令
7.2.3.1. 创建 account-roles 复制链接链接已复制到粘贴板!
为集群创建所需的集群范围的角色和策略资源。
语法
rosa create account-roles [flags]
$ rosa create account-roles [flags]
选项 | 定义 |
---|---|
--debug | 启用调试模式。 |
-i, --interactive | 启用交互模式。 |
-m,--mode 字符串 | 如何执行操作。有效选项有:
|
--path string | 集群范围的角色和策略的 Amazon 资源名称(ARN)路径,包括 Operator 策略。 |
--permissions-boundary 字符串 | 用于为帐户角色设置权限边界的策略 ARN。 |
--prefix 字符串 |
所有生成的 AWS 资源的用户定义前缀。默认值为 |
--profile string | 使用您的凭证文件中的特定 AWS 配置集。 |
-y,--yes | 自动回答 yes 以确认操作。 |
7.2.3.2. 创建管理员 复制链接链接已复制到粘贴板!
使用自动生成的密码创建集群管理员,以便登录到集群。
语法
rosa create admin --cluster=<cluster_name>|<cluster_id>
$ rosa create admin --cluster=<cluster_name>|<cluster_id>
选项 | 定义 |
---|---|
--cluster <cluster_name>|<cluster_id> | 必需。要添加到身份提供程序(IDP)的集群名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile string | 从您的凭证文件中指定一个 AWS 配置集。 |
示例
创建一个集群管理员,可登录到名为 mycluster
的集群。
rosa create admin --cluster=mycluster
$ rosa create admin --cluster=mycluster
7.2.3.3. 创建 breakuildDefaults 凭证 复制链接链接已复制到粘贴板!
为启用了外部身份验证的托管 control plane 集群创建一个 breakfish 凭证。
语法
rosa create break-glass-credential --cluster=<cluster_name> [arguments]
$ rosa create break-glass-credential --cluster=<cluster_name> [arguments]
选项 | 定义 |
---|---|
--cluster <cluster_name>|<cluster_id> | 必需。将添加 break visualization 凭据的集群的名称或 ID。 |
--expiration | 可选:在过期前可以使用 breakerior 凭证的时间。过期持续时间必须至少为 10 分钟,最多 24 小时。如果没有输入值,则过期持续时间默认为 24 小时。 |
--username | 可选。中断简介凭据的用户名。如果没有输入值,则会为您生成一个随机用户名。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
--region |
指定一个 AWS 区域,覆盖 |
--yes |
自动回答 |
例子
向名为 mycluster
的集群添加 breakfish 凭据。
语法
rosa create break-glass-credential --cluster=mycluster
$ rosa create break-glass-credential --cluster=mycluster
使用交互模式,向名为 mycluster
的集群添加 breakfish 凭据。
语法
rosa create break-glass-credential --cluster=mycluster -i
$ rosa create break-glass-credential --cluster=mycluster -i
7.2.3.4. 创建集群 复制链接链接已复制到粘贴板!
创建新集群。
语法
rosa create cluster --cluster-name=<cluster_name> [arguments]
$ rosa create cluster --cluster-name=<cluster_name> [arguments]
选项 | 定义 |
---|---|
--additional-compute-security-group-ids <sec_group_id> | 与与集群一起创建的标准机器池一起使用的一个或多个额外安全组的标识符。有关其他安全组的更多信息,请参阅附加资源 中的 安全组 要求。 |
--additional-infra-security-group-ids <sec_group_id> | 与与集群一起创建 infra 节点一起使用的一个或多个额外安全组的标识符。有关额外安全组的更多信息,请参阅附加资源 下 安全组 的要求。 |
--additional-control-plane-security-group-ids <sec_group_id> | 与与集群创建的 control plane 节点一起使用的一个或多个额外安全组的标识符。有关额外安全组的更多信息,请参阅附加资源 下 安全组 的要求。 |
--additional-allowed-principals <arn> | 以逗号分隔的额外允许主体 ARN 列表,添加到托管的 control plane 的 VPC 端点服务中,以便自动接受额外的 VPC 端点连接请求。 |
--cluster-name <cluster_name> |
必需。集群的名称。与 |
--compute-machine-type <instance_type> | 集群中计算节点的实例类型。这决定了分配给每个计算节点的内存和 vCPU 数量。有关有效实例类型的更多信息,请参阅 ROSA 服务定义中的 AWS 实例类型。 |
--controlplane-iam-role <arn> | 附加到 control plane 实例的 IAM 角色的 ARN。 |
--create-cluster-admin |
可选。作为集群创建的一部分,为集群创建本地管理员用户( |
--cluster-admin-user |
可选。指定与- |
--cluster-admin-password |
可选。指定与- |
--disable-scp-checks | 指明在尝试安装集群时是否禁用了云权限检查。 |
--dry-run | 模拟创建集群。 |
--domain-prefix |
可选:当与 |
--ec2-metadata-http-tokens string |
为 EC2 实例配置 IMDSv2。有效值为 |
--enable-autoscaling |
启用计算节点自动扩展。默认情况下,自动缩放设置为 |
--etcd-encryption | 在 Red Hat OpenShift Service on AWS (classical architecture)集群上启用 ETCD 键值加密。 |
--etcd-encryption-kms-arn | 使用在 AWS 密钥管理服务中管理的客户管理的密钥启用 ETCD 存储加密。 |
--external-id <arn_string> | 在另一个帐户中假定角色时可能需要的可选唯一标识符。 |
--host-prefix <subnet> |
分配给每个节点的子网前缀长度,作为整数。例如,如果主机前缀设置为 |
--machine-cidr <address_block> |
安装集群时使用的 IP 地址块(ipNet),如 重要
OVN-Kubernetes 是 ROSA 4.11 及之后的版本中的默认网络供应商,在内部使用 |
--max-replicas <number_of_nodes> |
指定启用自动扩展时的最大计算节点数量。默认: |
--min-replicas <number_of_nodes> |
指定启用自动扩展时的最小计算节点数量。默认: |
--no-cni | 创建没有 Container Network Interface (CNI)插件的集群。然后,用户可以获取自己的 CNI 插件,并在集群创建后安装它。 |
--operator-roles-prefix <string> | 用于 OpenShift 安装程序中操作员使用的所有 IAM 角色的前缀。如果没有指定前缀,则会自动生成前缀。 |
--pod-cidr <address_block> |
从中分配 Pod IP 地址的 IP 地址块,例如 重要
OVN-Kubernetes 是 ROSA 4.11 及之后的版本中的默认网络供应商,在内部使用 |
--private | 限制主 API 端点和应用程序路由来直接、专用连接。 |
--region <region_name> |
worker 池将位于的 AWS 区域的名称,如 |
--replicas n |
每个可用区要置备的 worker 节点数量。单区集群至少需要 2 个节点。多区集群至少需要 3 个节点。默认 :用于单区集群的 |
--role-arn <arn> | OpenShift Cluster Manager 用来创建集群的安装程序角色的 ARN。如果您还没有创建帐户角色,则需要此项。 |
--service-cidr <address_block> |
服务的 IP 地址块(ipNet),如 重要
OVN-Kubernetes 是 ROSA 4.11 及之后的版本中的默认网络供应商,在内部使用 |
--sts | 指定使用 AWS 安全令牌服务(STS)凭证来部署集群。 |
--subnet-ids <aws_subnet_id> |
安装集群时使用的 AWS 子网 ID,如
将-- |
--support-role-arn string | Red Hat Site Reliability engineerss (SRE)使用的角色 ARN,以启用对集群帐户的访问提供支持。 |
--tags | 在 AWS 中由 Red Hat OpenShift Service on AWS 创建的资源中使用的标签。标签可帮助您管理、识别、组织、搜索和过滤 AWS 中的资源。标签用逗号分开,例如:"key value, foo bar"。 重要 Red Hat OpenShift Service on AWS 只支持在集群创建过程中对 Red Hat OpenShift 资源的自定义标签。添加后,无法删除或编辑标签。红帽添加的标签是集群遵守红帽生产服务级别协议(SLA)所需的标签。这些标签不能被删除。 Red Hat OpenShift Service on AWS 不支持在 ROSA 集群管理的资源外添加额外的标签。当 AWS 资源由 ROSA 集群管理时,这些标签可能会丢失。在这些情况下,您可能需要自定义解决方案或工具来协调标签并保持不变。 |
--version string |
用于安装集群或集群资源的 ROSA 版本。对于 |
--worker-iam-role 字符串 | 附加到计算实例的 IAM 角色的 ARN。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
例子
创建名为 mycluster
的集群。
rosa create cluster --cluster-name=mycluster
$ rosa create cluster --cluster-name=mycluster
使用特定 AWS 区域创建集群。
rosa create cluster --cluster-name=mycluster --region=us-east-2
$ rosa create cluster --cluster-name=mycluster --region=us-east-2
创建在默认 worker 机器池上启用自动扩展的集群。
rosa create cluster --cluster-name=mycluster -region=us-east-1 --enable-autoscaling --min-replicas=2 --max-replicas=5
$ rosa create cluster --cluster-name=mycluster -region=us-east-1 --enable-autoscaling --min-replicas=2 --max-replicas=5
7.2.3.5. 创建 external-auth-provider 复制链接链接已复制到粘贴板!
添加外部身份提供程序而不是 OpenShift OAuth2 服务器。
您只能在 ROSA 中使用外部身份验证供应商 HCP 集群。
语法
rosa create external-auth-provider --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa create external-auth-provider --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--claim-mapping-groups-claim <string> | 必需。描述如何将信息从 ID 令牌转换为集群身份的规则。 |
--claim-validation-rule <strings> |
应用到验证令牌声明的规则来验证用户身份。输入将采用 < |
--claim-mapping-username-claim <string> | 应该用于为集群身份构建用户名的声明名称。 |
--cluster <cluster_name>|<cluster_id> | 必需。添加 IDP 的集群的名称或 ID。 |
--console-client-id <string> | OpenShift Cluster Manager Web 控制台的 OIDC 供应商中的 OIDC 客户端的标识符。 |
--console-client-secret <string> | 与控制台应用程序注册关联的 secret。 |
--issuer-audiences <strings> | 一个 audiences 数组,用于检查传入的令牌。有效令牌必须在其 audience 声明中包含至少一个这些值。 |
--issuer-ca-file <string> | 向服务器发出请求时使用的 PEM 编码证书文件的路径。 |
--issuer-url <string> | 令牌签发者的服务 URL。 |
--name <string> | 用于引用外部身份验证提供程序的名称。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集字符串。 |
例子
将 Microsoft Entra ID 身份提供程序添加到名为 mycluster
的集群。
rosa create external-auth-provider --cluster=mycluster --name <provider_name> --issuer-audiences <audience_id> --issuer-url <issuing id> --claim-mapping-username-claim email --claim-mapping-groups-claim groups
$ rosa create external-auth-provider --cluster=mycluster --name <provider_name> --issuer-audiences <audience_id> --issuer-url <issuing id> --claim-mapping-username-claim email --claim-mapping-groups-claim groups
7.2.3.6. 创建 idp 复制链接链接已复制到粘贴板!
添加身份提供程序 (IDP) 以定义用户如何登录到集群。
语法
rosa create idp --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa create idp --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster <cluster_name>|<cluster_id> | 必需。添加 IDP 的集群的名称或 ID。 |
--ca <path_to_file> |
向服务器发出请求时使用的 PEM 编码证书文件的路径,例如 |
--client-id | 注册的应用程序中的客户端 ID (字符串)。 |
--client-secret | 来自注册的应用程序的客户端 secret(字符串)。 |
--mapping-method |
指定在用户登录时如何将新身份(字符串)映射到用户。默认: |
--name | 身份提供程序的名称(字符串)。 |
--type |
身份提供程序的类型(字符串)。选择: |
选项 | 定义 |
---|---|
--hostname | 与托管 GitHub Enterprise 实例一起使用的可选域(字符串)。 |
--organizations | 指定用于登录访问的组织。只有至少是一个所列机构(字符串)成员的用户才能登录。 |
--teams |
指定用于登录访问的团队。只有至少属于列出的团队(字符串)的成员的用户才能登录。格式为 |
选项 | 定义 |
---|---|
--host-url |
GitLab 提供程序的主机 URL (字符串)。默认: |
选项 | 定义 |
---|---|
--hosted-domain | 将用户限制为 Google Apps 域(字符串)。 |
选项 | 定义 |
---|---|
--bind-dn | 在搜索阶段要绑定的域名(字符串)。 |
--bind-password | 在搜索阶段要绑定到的密码(字符串)。 |
--email-attributes | 列表(字符串)应用作电子邮件地址的属性。 |
--id-attributes |
列表(字符串)值应用作用户 ID 的属性。默认: |
--insecure | 不使 TLS 连接到服务器。 |
--name-attributes |
列表(字符串)值应用作显示名称的属性。默认: |
--url | RFC 2255 URL (字符串),用于指定使用的 LDAP 搜索参数。 |
--username-attributes |
列表(字符串)值应用作首选用户名的属性。默认: |
选项 | 定义 |
---|---|
--email-claims | 用作电子邮件地址的声明的列表(字符串)。 |
--extra-scopes |
在授权令牌请求期间,除了 |
--issuer-url | OpenID 供应商断言为签发者标识符的 URL (字符串)。它必须使用没有 URL 查询参数或片段的 HTTPS 方案。 |
--name-claims | 用作显示名称的声明的列表(字符串)。 |
--username-claims | 在置备用户时用作首选用户名的声明的列表(字符串)。 |
--groups-claims | 用作组名称的声明的列表(字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
例子
将 GitHub 身份提供程序添加到名为 mycluster
的集群。
rosa create idp --type=github --cluster=mycluster
$ rosa create idp --type=github --cluster=mycluster
根据交互式提示添加身份提供程序。
rosa create idp --cluster=mycluster --interactive
$ rosa create idp --cluster=mycluster --interactive
7.2.3.7. 创建入口 复制链接链接已复制到粘贴板!
添加入口端点以启用集群的 API 访问。
语法
rosa create ingress --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa create ingress --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster <cluster_name>|<cluster_id> | 必需:将添加入口的集群的名称或 ID。 |
--label-match | ingress 的标签匹配(字符串)。格式必须是用逗号分开的 key=value 对列表。如果没有指定标签,则在两个路由器上都公开所有路由。 |
--private | 将应用程序路由限制为直接、私有连接。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
例子
将内部入口添加到名为 mycluster
的集群。
rosa create ingress --private --cluster=mycluster
$ rosa create ingress --private --cluster=mycluster
将公共入口添加到名为 mycluster
的集群。
rosa create ingress --cluster=mycluster
$ rosa create ingress --cluster=mycluster
使用路由选择器标签匹配添加 ingress。
rosa create ingress --cluster=mycluster --label-match=foo=bar,bar=baz
$ rosa create ingress --cluster=mycluster --label-match=foo=bar,bar=baz
7.2.3.8. 创建 kubeletconfig 复制链接链接已复制到粘贴板!
创建自定义 KubeletConfig
对象,以允许自定义节点配置
语法
rosa create kubeletconfig --cluster=<cluster_name|cluster_id> --name=<kubeletconfig_name> --pod-pids-limit=<number> [flags]
$ rosa create kubeletconfig --cluster=<cluster_name|cluster_id> --name=<kubeletconfig_name> --pod-pids-limit=<number> [flags]
选项 | 定义 |
---|---|
--pod-pids-limit <number> | 必需。中每个节点的 PID 数量上限 |
-c, --cluster <cluster_name>|<cluster_id> |
必需。创建 |
--name |
为 |
-i, --interactive | 启用交互模式。 |
-h, --help | 显示此命令的帮助信息。 |
有关为集群设置 PID 限制的更多信息,请参阅配置 PID 限制。
7.2.3.9. 创建 machinepool 复制链接链接已复制到粘贴板!
将机器池添加到现有集群。
机器池也称为托管 control plane 集群上的节点池。
语法
rosa create machinepool --cluster=<cluster_name> | <cluster_id> --replicas=<number> --name=<machinepool_name> [arguments]
$ rosa create machinepool --cluster=<cluster_name> | <cluster_id> --replicas=<number> --name=<machinepool_name> [arguments]
选项 | 定义 |
---|---|
--additional-security-group-ids <sec_group_id> | 与这个机器池的默认安全组一起使用的一个或多个额外安全组的标识符。有关其他安全组的更多信息,请参阅附加资源 中的 安全组 要求。 |
--cluster <cluster_name>|<cluster_id> | 必需:将添加到机器池的集群的名称或 ID。 |
--disk-size | 在 Gib 或 TiB 中设置机器池的磁盘大小。默认值为 300 GiB。 对于 {rosa-classic} 集群版本 4.13 或更早版本,最小磁盘大小为 128 GiB,最大值为 1 TiB。对于集群版本 4.14 及更新的版本,最小值为 128 GiB,最大值为 16 TiB。 对于带有 HCP 集群的 ROSA,最小磁盘大小为 75 GiB,最大值为 16,384 GiB。 |
--enable-autoscaling |
启用或禁用计算节点的自动扩展。若要启用自动扩展,请使用此参数及 |
--instance-type |
应该使用的实例类型(字符串)。默认值: |
--kubelet-configs <kubeletconfig_name> |
对于 Red Hat OpenShift Service on AWS 集群,适用于机器池节点的任何 |
--labels | 机器池的标签(字符串)。格式必须是用逗号分开的 key=value 对列表。此列表会持续覆盖对节点标签所做的任何修改。 |
--max-replicas | 指定启用自动扩展时的最大计算节点数量。 |
--min-replicas | 指定启用自动扩展时的最小计算节点数量。 |
--max-surge |
对于 Red Hat OpenShift Service on AWS 集群,
默认值为 |
--max-unavailable |
对于 Red Hat OpenShift Service on AWS 集群,
默认值为 |
--name | 必需:机器池的名称(字符串)。 |
--replicas | 没有配置自动扩展时需要。此机器池的机器数量(整数)。 |
--tags |
将用户定义的标签应用到 AWS 中由 ROSA 创建的所有资源。标签用逗号分开,例如: |
--taints |
机器池的污点。此字符串值应该以逗号分隔的 |
--autorepair |
为机器池的 AutoRepair 设置以布尔值 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
例子
交互式将机器池添加到名为 mycluster
的集群。
rosa create machinepool --cluster=mycluster --interactive
$ rosa create machinepool --cluster=mycluster --interactive
将名为 mp-1
的机器池添加到启用了自动扩展的集群。
rosa create machinepool --cluster=mycluster --enable-autoscaling --min-replicas=2 --max-replicas=5 --name=mp-1
$ rosa create machinepool --cluster=mycluster --enable-autoscaling --min-replicas=2 --max-replicas=5 --name=mp-1
添加名为 mp-1
的机器池,并将 3 个副本设为 m5.xlarge
到集群。
rosa create machinepool --cluster=mycluster --replicas=3 --instance-type=m5.xlarge --name=mp-1
$ rosa create machinepool --cluster=mycluster --replicas=3 --instance-type=m5.xlarge --name=mp-1
将机器池(mp-1
)添加到 Red Hat OpenShift Service on AWS 集群中,配置 6 个副本和以下升级行为:
- 在升级过程中最多可以置备 2 个超额节点。
- 确保在升级过程中没有超过 3 个节点。
rosa create machinepool --cluster=mycluster --replicas=6 --name=mp-1 --max-surge=2 --max-unavailable=3
$ rosa create machinepool --cluster=mycluster --replicas=6 --name=mp-1 --max-surge=2 --max-unavailable=3
在集群中添加带有标签的机器池。
rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz --name=mp-1
$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz --name=mp-1
在集群中添加带有标签的机器池。
rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --tags='foo bar,bar baz' --name=mp-1
$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --tags='foo bar,bar baz' --name=mp-1
7.2.3.10. 创建网络 复制链接链接已复制到粘贴板!
创建网络,以通过 AWS CloudFormation 模板创建任何必要的 AWS 资源。此帮助程序命令旨在帮助创建和配置 VPC 以用于 HCP 的 ROSA。此命令还支持出口零集群。
运行此命令会在 AWS 帐户中创建资源。
对于自定义或高级配置,强烈建议您直接使用 aws cloudformation
命令或创建带有所需配置的新自定义模板。如果您使用带有 ROSA CLI 的自定义 CloudFormation 模板,则最低版本为 1.2.47 或更高版本。
语法
rosa create network [flags]
$ rosa create network [flags]
选项 | 定义 |
---|---|
<template-name> |
允许您使用自定义模板。模板必须位于模板文件夹中,构建为 |
默认 CloudFormation 模板
选项 | 定义 |
---|---|
--template-dir |
允许您指定模板目录的路径。覆盖 |
--param name | 定义网络的名称。使用自定义模板文件时所需的参数。 |
--param Region | 定义网络的区域。使用自定义模板文件时所需的参数。 |
--param <various> |
可用的参数取决于模板。当模板目录中查找可用参数时,请使用- |
--mode=manual | 提供 AWS 命令以创建网络堆栈。 |
Example
使用常规参数和标志创建基本网络。
rosa create network rosa-quickstart-default-vpc --param Tags=key1=value1,key2=value2 --param Name=example-stack --param Region=us-west-2
$ rosa create network rosa-quickstart-default-vpc --param Tags=key1=value1,key2=value2 --param Name=example-stack --param Region=us-west-2
默认模板中提供了完整的参数列表。
模板示例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.2.3.11. 创建 ocm-role 复制链接链接已复制到粘贴板!
为集群创建所需的 ocm-role 资源。
语法
rosa create ocm-role [flags]
$ rosa create ocm-role [flags]
选项 | 定义 |
---|---|
--admin | 为角色启用管理功能。 |
--debug | 启用调试模式。 |
-i, --interactive | 启用交互模式。 |
-m,--mode 字符串 | 如何执行操作。有效选项有:
|
--path string | OCM 角色和策略的 ARN 路径。 |
--permissions-boundary 字符串 | 用于为 OCM 角色设置权限边界的策略 ARN。 |
--prefix 字符串 |
所有生成的 AWS 资源的用户定义前缀。默认值为 |
--profile string | 使用您的凭证文件中的特定 AWS 配置集。 |
-y,--yes | 自动回答 yes 以确认操作。 |
有关使用 rosa create ocm-role
命令创建的 OCM 角色的更多信息,请参阅 帐户范围的 IAM 角色和策略引用。
7.2.3.12. 创建 user-role 复制链接链接已复制到粘贴板!
为集群创建所需的 user-role 资源。
语法
rosa create user-role [flags]
$ rosa create user-role [flags]
选项 | 定义 |
---|---|
--debug | 启用调试模式。 |
-i, --interactive | 启用交互模式。 |
-m,--mode 字符串 | 如何执行操作。有效选项有:
|
--path string | 用户角色和策略的 ARN 路径。 |
--permissions-boundary 字符串 | 用于为用户角色设置权限边界的策略 ARN。 |
--prefix 字符串 |
所有生成的 AWS 资源的用户定义前缀默认为 |
--profile string | 使用您的凭证文件中的特定 AWS 配置集。 |
-y,--yes | 自动回答 yes 以确认操作。 |
有关使用 rosa create user-role
命令创建的用户角色的更多信息,请参阅了解 AWS 帐户关联。
7.2.3.13. Create iamserviceaccount 复制链接链接已复制到粘贴板!
创建 AWS Identity and Access Management (IAM)角色,该角色可使用 OpenID Connect (OIDC)身份联邦来假定 Red Hat OpenShift Service on AWS 服务帐户。
语法
rosa create iamserviceaccount --cluster=<cluster_name> | <cluster_id> --name=<service_account_name> [arguments]
$ rosa create iamserviceaccount --cluster=<cluster_name> | <cluster_id> --name=<service_account_name> [arguments]
选项 | 定义 |
---|---|
--cluster <cluster_name>|<cluster_id> | 必需。创建 IAM 服务帐户角色的集群的名称或 ID。 |
--name <service_account_name> | 必需。Red Hat OpenShift Service on AWS 服务帐户的名称。此标志可以多次用于为多个服务帐户创建角色。 |
--namespace <namespace_name> |
服务帐户的 Red Hat OpenShift Service on AWS 命名空间。默认值: |
--role-name <role_name> |
要创建的 IAM 角色的名称。如果没有指定,则使用模式 |
--attach-policy-arn <policy_arn> | 要附加到角色的 IAM 策略的 ARN。此标志可以多次使用来附加多个策略。 |
--inline-policy <policy_document> |
JSON 格式的内联策略文档,或者前缀为 |
--permissions-boundary <boundary_arn> | IAM 策略的 ARN,用作角色的权限边界。 |
--path <iam_path> |
角色的 IAM 路径。默认: |
-m, --mode string | 如何执行操作。有效选项有:
|
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile string | 从您的凭证文件中指定一个 AWS 配置集。 |
--yes |
自动回答 |
例子
在 default
命名空间中创建一个名为 my-app
的服务帐户的 IAM 角色,具有 S3 只读访问权限。
rosa create iamserviceaccount --cluster=mycluster --name=my-app --attach-policy-arn=arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess
$ rosa create iamserviceaccount --cluster=mycluster --name=my-app --attach-policy-arn=arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess
使用自定义名称和多个策略创建一个 IAM 角色。
rosa create iamserviceaccount --cluster=mycluster --name=my-app --namespace=production --role-name=my-custom-role --attach-policy-arn=arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess --attach-policy-arn=arn:aws:iam::aws:policy/AmazonEC2ReadOnlyAccess
$ rosa create iamserviceaccount --cluster=mycluster --name=my-app --namespace=production --role-name=my-custom-role --attach-policy-arn=arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess --attach-policy-arn=arn:aws:iam::aws:policy/AmazonEC2ReadOnlyAccess
从文件中创建带有内联策略的 IAM 角色。
rosa create iamserviceaccount --cluster=mycluster --name=my-app --inline-policy=file://my-policy.json
$ rosa create iamserviceaccount --cluster=mycluster --name=my-app --inline-policy=file://my-policy.json
7.2.4. 编辑对象 复制链接链接已复制到粘贴板!
本节论述了集群和资源的 edit
命令。
7.2.4.1. 编辑集群 复制链接链接已复制到粘贴板!
允许对现有集群进行编辑。
语法
rosa edit cluster --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa edit cluster --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--additional-allowed-principals <arn> | 以逗号分隔的额外允许主体 ARN 列表,添加到 Hosted Control Plane 的 VPC 端点服务中,以便自动接受额外的 VPC 端点连接请求。 |
--cluster | 必需:要编辑的集群的名称或 ID (字符串)。 |
--private | 限制主 API 端点直接和专用连接。 |
--enable-delete-protection=true | 启用删除保护功能。 |
--enable-delete-protection=false | 禁用删除保护功能。 |
--billing-account-string | 指定用于从 AWS 市场购买的计费订阅的帐户。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
例子
编辑名为 mycluster
的集群使其私有。
rosa edit cluster --cluster=mycluster --private
$ rosa edit cluster --cluster=mycluster --private
在名为 mycluster
的集群中以交互方式编辑所有集群选项。
rosa edit cluster --cluster=mycluster --interactive
$ rosa edit cluster --cluster=mycluster --interactive
7.2.4.2. edit ingress 复制链接链接已复制到粘贴板!
编辑集群的默认应用程序路由器。
有关编辑非默认应用程序路由器的详情,请参考 其他资源。
语法
rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:将添加入口的集群的名称或 ID (字符串)。 |
--cluster-routes-hostname | OAuth、控制台和下载的组件路由主机名。 |
--cluster-routes-tls-secret-ref | 组件路由 OAuth、控制台和下载的 TLS secret 引用。 |
--excluded-namespaces |
ingress 排除的命名空间。格式是一个用逗号分开的列表 |
--label-match | ingress 的标签匹配(字符串)。格式必须是用逗号分开的 key=value 对列表。如果没有指定标签,则在两个路由器上都公开所有路由。 |
--lb-type |
Load Balancer 的类型。选项为 |
--namespace-ownership-policy |
入口的命名空间所有权策略。选项为 |
--private | 将应用程序路由限制为直接、私有连接。 |
--route-selector | ingress 的路由 Selector。格式是用逗号分开的 key=value 列表。如果没有指定标签,则所有路由都会在两个路由器上公开。对于传统的 ingress 支持,它们会被包含标签,否则它们被视为排除标签。 |
--wildcard-policy |
ingress 的通配符策略。选项为 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
例子
在名为 mycluster
的集群上,创建一个 ID 为 a1b2
的额外入口作为私有连接。
rosa edit ingress --private --cluster=mycluster a1b2
$ rosa edit ingress --private --cluster=mycluster a1b2
使用名为 mycluster
的集群上的 ID a1b2
更新额外入口的路由器选择器。
rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2
$ rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2
使用名为 mycluster
的集群中的子域标识符 应用程序
更新默认入口。
rosa edit ingress --private=false --cluster=mycluster apps
$ rosa edit ingress --private=false --cluster=mycluster apps
更新 apps2
入口的负载均衡器类型。
rosa edit ingress --lb-type=nlb --cluster=mycluster apps2
$ rosa edit ingress --lb-type=nlb --cluster=mycluster apps2
7.2.4.3. 编辑 kubeletconfig 复制链接链接已复制到粘贴板!
编辑一个自定义 KubeletConfig
对象
语法
rosa edit kubeletconfig --cluster=<cluster_name|cluster_id> --name=<kubeletconfig_name> --pod-pids-limit=<number> [flags]
$ rosa edit kubeletconfig --cluster=<cluster_name|cluster_id> --name=<kubeletconfig_name> --pod-pids-limit=<number> [flags]
选项 | 定义 |
---|---|
-c, --cluster <cluster_name>|<cluster_id> |
必需。编辑 |
-i, --interactive | 启用交互模式。 |
--pod-pids-limit <number> | 必需。中每个节点的 PID 数量上限 |
--name |
为 |
-h, --help | 显示此命令的帮助信息。 |
有关为集群设置 PID 限制的更多信息,请参阅配置 PID 限制。
7.2.4.4. edit machinepool 复制链接链接已复制到粘贴板!
编辑集群中的机器池。
语法
rosa edit machinepool --cluster=<cluster_name_or_id> <machinepool_name> [arguments]
$ rosa edit machinepool --cluster=<cluster_name_or_id> <machinepool_name> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:要编辑额外机器池的集群的名称或 ID (字符串)。 |
--enable-autoscaling |
启用或禁用计算节点的自动扩展。若要启用自动扩展,请使用此参数及 |
--labels | 机器池的标签(字符串)。格式必须是用逗号分开的 key=value 对列表。编辑此值只会影响机器池的新创建的节点,这通过增加节点号创建,而不影响现有节点。此列表会持续覆盖对节点标签所做的任何修改。 |
--kubelet-configs <kubeletconfig_name> |
对于 Red Hat OpenShift Service on AWS 集群,适用于机器池节点的任何 |
--max-replicas | 指定启用自动扩展时的最大计算节点数量。 |
--min-replicas | 指定启用自动扩展时的最小计算节点数量。 |
--max-surge |
对于 Red Hat OpenShift Service on AWS 集群,
默认值为 |
--max-unavailable |
对于 Red Hat OpenShift Service on AWS 集群,
默认值为 |
--node-drain-grace-period | 指定在升级或替换机器池时节点排空宽限期。(这仅用于带有 HCP 集群的 ROSA。) |
--replicas | 没有配置自动扩展时需要。此机器池的机器数量(整数)。 |
--taints |
机器池的污点。此字符串值应该以逗号分隔的 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
例子
在名为 mycluster
的集群上,设置一个名为 mp1
的机器池上的 4 个副本。
rosa edit machinepool --cluster=mycluster --replicas=4 mp1
$ rosa edit machinepool --cluster=mycluster --replicas=4 mp1
在名为 mycluster
的集群上,启用名为 mp1
的机器池上的自动扩展。
rosa edit machinepool --cluster=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 mp1
$ rosa edit machinepool --cluster=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 mp1
在名为 mycluster
的集群上,禁用名为 mp1
的机器池上的自动扩展。
rosa edit machinepool --cluster=mycluster --enable-autoscaling=false --replicas=3 mp1
$ rosa edit machinepool --cluster=mycluster --enable-autoscaling=false --replicas=3 mp1
在名为 mycluster
的集群上,修改名为 mp1
的机器池上的自动扩展范围。
rosa edit machinepool --max-replicas=9 --cluster=mycluster mp1
$ rosa edit machinepool --max-replicas=9 --cluster=mycluster mp1
在 Red Hat OpenShift Service on AWS 集群中,编辑 mp1
机器池,以在升级过程中添加以下行为:
- 在升级过程中最多可以置备 2 个超额节点。
- 确保在升级过程中没有超过 3 个节点。
rosa edit machinepool --cluster=mycluster mp1 --max-surge=2 --max-unavailable=3
$ rosa edit machinepool --cluster=mycluster mp1 --max-surge=2 --max-unavailable=3
将 KubeletConfig
对象与带有 HCP 集群的 ROSA 上的现有 high-pid-pool
机器池关联。
rosa edit machinepool -c mycluster --kubelet-configs=set-high-pids high-pid-pool
$ rosa edit machinepool -c mycluster --kubelet-configs=set-high-pids high-pid-pool
7.2.6. 删除对象 复制链接链接已复制到粘贴板!
本节论述了集群和资源的 delete
命令。
7.2.6.1. 删除管理员 复制链接链接已复制到粘贴板!
从指定的集群删除集群管理员。
语法
rosa delete admin --cluster=<cluster_name> | <cluster_id>
$ rosa delete admin --cluster=<cluster_name> | <cluster_id>
选项 | 定义 |
---|---|
--cluster | 必需:要添加到身份提供程序(IDP)的集群名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
从名为 mycluster
的集群中删除集群管理员。
rosa delete admin --cluster=mycluster
$ rosa delete admin --cluster=mycluster
7.2.6.2. 删除集群 复制链接链接已复制到粘贴板!
删除集群。
语法
rosa delete cluster --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa delete cluster --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:要删除的集群的名称或 ID (字符串)。 |
--watch | 监视集群卸载日志。 |
--best-effort |
跳过已知导致集群删除过程的集群销毁链中的步骤。您应该谨慎使用这个选项,并建议您手动检查 AWS 帐户在使用- |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
--yes |
自动回答 |
例子
删除名为 mycluster
的集群。
rosa delete cluster --cluster=mycluster
$ rosa delete cluster --cluster=mycluster
7.2.6.3. 删除 external-auth-provider 复制链接链接已复制到粘贴板!
从集群中删除外部身份验证供应商。
语法
rosa delete external-auth-provider <name_of_external_auth_provider> --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa delete external-auth-provider <name_of_external_auth_provider> --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需。外部 auth 供应商将从中删除集群的名称或 ID 字符串。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集字符串。 |
--yes |
自动回答 |
Example
从名为 mycluster
的集群中删除名为 exauth-1
的身份提供程序。
rosa delete external-auth-provider exauth-1 --cluster=mycluster
$ rosa delete external-auth-provider exauth-1 --cluster=mycluster
7.2.6.4. 删除 idp 复制链接链接已复制到粘贴板!
从集群中删除特定的身份提供程序 (IDP)。
语法
rosa delete idp --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa delete idp --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:删除 IDP 的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
--yes |
自动回答 |
示例
从名为 mycluster
的集群中删除名为 github
的身份供应商。
rosa delete idp github --cluster=mycluster
$ rosa delete idp github --cluster=mycluster
7.2.6.5. delete iamserviceaccount 复制链接链接已复制到粘贴板!
删除为 Red Hat OpenShift Service on AWS 服务帐户创建的 AWS Identity and Access Management (IAM)角色。
语法
rosa delete iamserviceaccount --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa delete iamserviceaccount --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster <cluster_name>|<cluster_id> | 必需。从中删除 IAM 服务帐户角色的集群名称或 ID。 |
--name <service_account_name> |
Red Hat OpenShift Service on AWS 服务帐户的名称。未指定 |
--namespace <namespace_name> |
服务帐户的 Red Hat OpenShift Service on AWS 命名空间。默认值: |
--role-name <role_name> | 要删除的 IAM 角色的名称。如果未指定,则使用服务帐户详细信息自动探测到角色名称。 |
-m,--mode 字符串 | 如何执行操作。有效选项有:
|
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 从您的凭证文件中指定一个 AWS 配置集。 |
--yes |
自动回答 |
例子
删除 default
命名空间中名为 my-app
的服务帐户的 IAM 角色。
rosa delete iamserviceaccount --cluster=mycluster --name=my-app
$ rosa delete iamserviceaccount --cluster=mycluster --name=my-app
通过直接指定角色名称来删除 IAM 角色。
rosa delete iamserviceaccount --cluster=mycluster --role-name=my-custom-role --yes
$ rosa delete iamserviceaccount --cluster=mycluster --role-name=my-custom-role --yes
7.2.6.6. 删除入口 复制链接链接已复制到粘贴板!
从集群中删除非默认应用程序路由器(入口)。
语法
rosa delete ingress --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa delete ingress --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:要删除入口的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
--yes |
自动回答 |
例子
从名为 mycluster
的集群中删除 ID 为 a1b2
的 ingress。
rosa delete ingress --cluster=mycluster a1b2
$ rosa delete ingress --cluster=mycluster a1b2
从名为 mycluster
的集群中删除子域名称 apps2
的二级入口。
rosa delete ingress --cluster=mycluster apps2
$ rosa delete ingress --cluster=mycluster apps2
7.2.6.7. 删除 kubeletconfig 复制链接链接已复制到粘贴板!
从集群中删除自定义 KubeletConfig
对象。
语法
rosa delete kubeletconfig --cluster=<cluster_name|cluster_id> [flags]
$ rosa delete kubeletconfig --cluster=<cluster_name|cluster_id> [flags]
选项 | 定义 |
---|---|
-c, --cluster <cluster_name>|<cluster_id> |
必需。要删除 |
-h, --help | 显示此命令的帮助信息。 |
--name |
为 |
-y,--yes |
自动回答 |
7.2.6.8. delete machinepool 复制链接链接已复制到粘贴板!
从集群中删除机器池。
语法
rosa delete machinepool --cluster=<cluster_name> | <cluster_id> <machine_pool_id>
$ rosa delete machinepool --cluster=<cluster_name> | <cluster_id> <machine_pool_id>
选项 | 定义 |
---|---|
--cluster | 必需:将从中删除机器池的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--interactive | 启用交互模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
--yes |
自动回答 |
示例
从名为 mycluster
的集群中删除 ID 为 mp-1
的机器池。
rosa delete machinepool --cluster=mycluster mp-1
$ rosa delete machinepool --cluster=mycluster mp-1
7.2.7. 安装和卸载附加组件 复制链接链接已复制到粘贴板!
本节论述了如何在集群中安装和卸载 Red Hat managed service add-ons。
7.2.7.1. 安装附加组件 复制链接链接已复制到粘贴板!
在集群上安装受管服务附加组件。
语法
rosa install addon --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa install addon --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:安装附加组件的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 使用您的凭据文件中的特定 AWS 配置集(字符串)。 |
--yes |
自动回答 |
示例
将 dbaas-operator
附加组件安装添加到名为 mycluster
的集群。
rosa install addon --cluster=mycluster dbaas-operator
$ rosa install addon --cluster=mycluster dbaas-operator
7.2.7.2. 卸载附加组件 复制链接链接已复制到粘贴板!
从集群中删除受管服务附加组件。
语法
rosa uninstall addon --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa uninstall addon --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:将从中卸载附加组件的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 使用您的凭据文件中的特定 AWS 配置集(字符串)。 |
--yes |
自动回答 |
示例
从名为 mycluster
的集群中删除 dbaas-operator
附加组件安装。
rosa uninstall addon --cluster=mycluster dbaas-operator
$ rosa uninstall addon --cluster=mycluster dbaas-operator
7.2.8. 列出和描述对象 复制链接链接已复制到粘贴板!
本节介绍了集群和资源的 list
和 describe
命令。
7.2.8.1. 列出附加组件 复制链接链接已复制到粘贴板!
列出受管服务附加组件安装。
语法
rosa list addons --cluster=<cluster_name> | <cluster_id>
$ rosa list addons --cluster=<cluster_name> | <cluster_id>
选项 | 定义 |
---|---|
--cluster | 必需:要列出附加组件的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
7.2.8.2. 列出断镜凭证 复制链接链接已复制到粘贴板!
列出集群的所有中断镜凭据。
语法
rosa list break-glass-credential [arguments]
$ rosa list break-glass-credential [arguments]
选项 | 定义 |
---|---|
--cluster <cluster_name>|<cluster_id> | 必需。添加 breakfish 凭据的集群的名称或 ID。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
Example
列出名为 mycluster
的集群的所有分组镜凭据。
rosa list break-glass-credential --cluster=mycluster
$ rosa list break-glass-credential --cluster=mycluster
7.2.8.3. 列出集群 复制链接链接已复制到粘贴板!
列出所有集群。
语法
rosa list clusters [arguments]
$ rosa list clusters [arguments]
选项 | 定义 |
---|---|
--count |
要显示的集群数量(整数)。默认: |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
7.2.8.4. 列出 external-auth-provider 复制链接链接已复制到粘贴板!
列出集群的任何外部身份验证供应商。
语法
rosa list external-auth-provider --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list external-auth-provider --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:列出外部身份验证供应商的集群的名称或 ID 字符串。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集字符串。 |
示例
列出名为 mycluster
的集群的任何外部身份验证供应商。
rosa list external-auth-provider --cluster=mycluster
$ rosa list external-auth-provider --cluster=mycluster
7.2.8.5. list idps 复制链接链接已复制到粘贴板!
列出集群的所有身份提供程序 (IDP)。
语法
rosa list idps --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list idps --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:为其列出 IDP 的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
列出名为 mycluster
的集群的所有身份提供程序 (IDP)。
rosa list idps --cluster=mycluster
$ rosa list idps --cluster=mycluster
7.2.8.6. list iamserviceaccounts 复制链接链接已复制到粘贴板!
列出为 OpenShift 服务帐户创建的 IAM 角色。
语法
rosa list iamserviceaccounts [arguments]
$ rosa list iamserviceaccounts [arguments]
选项 | 定义 |
---|---|
--cluster <cluster_name>|<cluster_id> | 用于过滤服务帐户角色的集群的名称或 ID。 |
--namespace <namespace_name> | 用于过滤服务帐户角色的 OpenShift 命名空间。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--output |
输出格式。允许的格式是 |
--profile | 从您的凭证文件中指定一个 AWS 配置集。 |
例子
列出所有 IAM 服务帐户角色。
rosa list iamserviceaccounts
$ rosa list iamserviceaccounts
列出特定集群的 IAM 服务帐户角色。
rosa list iamserviceaccounts --cluster=mycluster
$ rosa list iamserviceaccounts --cluster=mycluster
列出集群中特定命名空间的 IAM 服务帐户角色。
rosa list iamserviceaccounts --cluster=mycluster --namespace=production
$ rosa list iamserviceaccounts --cluster=mycluster --namespace=production
7.2.8.7. describe iamserviceaccount 复制链接链接已复制到粘贴板!
显示为 OpenShift 服务帐户创建的 IAM 角色的详细信息。
语法
rosa describe iamserviceaccount --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa describe iamserviceaccount --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster <cluster_name>|<cluster_id> | 必需。集群的名称或 ID。 |
--name <service_account_name> |
OpenShift 服务帐户的名称。未指定 |
--namespace <namespace_name> |
服务帐户的 OpenShift 命名空间。默认值: |
--role-name <role_name> | 要描述的 IAM 角色的名称。如果未指定,则使用服务帐户详细信息自动探测到角色名称。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--output |
输出格式。允许的格式是 |
--profile | 从您的凭证文件中指定一个 AWS 配置集。 |
例子
描述 default
命名空间中名为 my-app
的服务帐户的 IAM 角色。
rosa describe iamserviceaccount --cluster=mycluster --name=my-app
$ rosa describe iamserviceaccount --cluster=mycluster --name=my-app
通过直接指定角色名称来描述 IAM 角色。
rosa describe iamserviceaccount --cluster=mycluster --role-name=my-custom-role
$ rosa describe iamserviceaccount --cluster=mycluster --role-name=my-custom-role
7.2.8.8. 列出 ingresses 复制链接链接已复制到粘贴板!
列出集群的所有 API 和入口端点。
语法
rosa list ingresses --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list ingresses --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:为其列出 IDP 的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
列出名为 mycluster
的集群的所有 API 和入口端点。
rosa list ingresses --cluster=mycluster
$ rosa list ingresses --cluster=mycluster
7.2.8.9. list instance-types 复制链接链接已复制到粘贴板!
列出用于 ROSA 的所有可用实例类型。可用性基于帐户的 AWS 配额。
语法
rosa list instance-types [arguments]
$ rosa list instance-types [arguments]
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--output |
输出格式。允许的格式是 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
列出所有实例类型。
rosa list instance-types
$ rosa list instance-types
7.2.8.10. 列出 kubeletconfigs 复制链接链接已复制到粘贴板!
列出集群上配置的 KubeletConfig
对象。
语法
rosa list kubeletconfigs --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list kubeletconfigs --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:列出机器池用于的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
Example
列出名为 mycluster
的集群中的所有 KubeletConfig
对象。
rosa list kubeletconfigs --cluster=mycluster
$ rosa list kubeletconfigs --cluster=mycluster
7.2.8.11. list machinepools 复制链接链接已复制到粘贴板!
列出集群上配置的机器池。
语法
rosa list machinepools --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list machinepools --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:列出机器池用于的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
列出名为 mycluster
的集群中的所有机器池。
rosa list machinepools --cluster=mycluster
$ rosa list machinepools --cluster=mycluster
7.2.8.12. 列出区域 复制链接链接已复制到粘贴板!
列出当前 AWS 帐户的所有可用区域。
语法
rosa list regions [arguments]
$ rosa list regions [arguments]
选项 | 定义 |
---|
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
列出所有可用的区域。
rosa list regions
$ rosa list regions
7.2.8.13. 列出升级 复制链接链接已复制到粘贴板!
列出所有可用的和已调度的集群版本升级。
语法
rosa list upgrades --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list upgrades --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:列出可用升级的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
列出名为 mycluster
的集群的所有可用升级。
rosa list upgrades --cluster=mycluster
$ rosa list upgrades --cluster=mycluster
7.2.8.14. 列出用户 复制链接链接已复制到粘贴板!
列出指定集群的集群管理员和专用管理员用户。
语法
rosa list users --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list users --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:集群管理员要列出的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
列出名为 mycluster
的集群的所有集群管理员和专用管理员。
rosa list users --cluster=mycluster
$ rosa list users --cluster=mycluster
7.2.8.15. 列出版本 复制链接链接已复制到粘贴板!
列出所有可用于创建集群的 OpenShift 版本。
语法
rosa list versions [arguments]
$ rosa list versions [arguments]
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
列出所有 OpenShift Container Platform 版本。
rosa list versions
$ rosa list versions
7.2.8.16. 描述管理员 复制链接链接已复制到粘贴板!
显示指定 cluster-admin
用户以及要登录到集群的命令的详细信息。
语法
rosa describe admin --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa describe admin --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需: cluster-admin 所属集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
描述名为 mycluster
的集群的 cluster-admin
用户。
rosa describe admin --cluster=mycluster
$ rosa describe admin --cluster=mycluster
7.2.8.17. 描述附加组件 复制链接链接已复制到粘贴板!
显示托管服务附加组件的详细信息。
语法
rosa describe addon <addon_id> | <addon_name> [arguments]
$ rosa describe addon <addon_id> | <addon_name> [arguments]
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
示例
描述名为 dbaas-operator
的附加组件。
rosa describe addon dbaas-operator
$ rosa describe addon dbaas-operator
7.2.8.18. 描述 breakfish 凭证 复制链接链接已复制到粘贴板!
显示了特定集群的中断图形凭据的详细信息。
语法
rosa describe break-glass-credential --id=<break_glass_credential_id> --cluster=<cluster_name>| <cluster_id> [arguments]
$ rosa describe break-glass-credential --id=<break_glass_credential_id> --cluster=<cluster_name>| <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:集群的名称或 ID (字符串)。 |
--id | 必需: breakfish 凭证的 ID (字符串)。 |
--kubeconfig | 可选:从 breakfish 凭证中检索 kubeconfig。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
7.2.8.19. 描述集群 复制链接链接已复制到粘贴板!
显示集群的详情。
语法
rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--external-id <arn_string> | 在另一个帐户中假定角色时可能需要的可选唯一标识符。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
--get-role-policy-bindings | 列出附加到分配给集群的 STS 角色的策略。 |
Example
描述名为 mycluster
的集群。
rosa describe cluster --cluster=mycluster
$ rosa describe cluster --cluster=mycluster
7.2.8.20. 描述 kubeletconfig 复制链接链接已复制到粘贴板!
显示自定义 KubeletConfig
对象的详情。
语法
rosa describe kubeletconfig --cluster=<cluster_name|cluster_id> [flags]
$ rosa describe kubeletconfig --cluster=<cluster_name|cluster_id> [flags]
选项 | 定义 |
---|---|
-c, --cluster <cluster_name>|<cluster_id> |
必需。要查看 |
-h, --help | 显示此命令的帮助信息。 |
--name |
必需。指定要描述的 |
-o, --output string | -o, --output string |
7.2.8.21. 描述 machinepool 复制链接链接已复制到粘贴板!
描述在集群中配置的特定机器池。
语法
rosa describe machinepool --cluster=[<cluster_name>|<cluster_id>] --machinepool=<machinepool_name> [arguments]
$ rosa describe machinepool --cluster=[<cluster_name>|<cluster_id>] --machinepool=<machinepool_name> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:集群的名称或 ID (字符串)。 |
--machinepool | 必需: machinepool 的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
Example
描述名为 mycluster
的集群上名为 mymachinepool
的机器池。
rosa describe machinepool --cluster=mycluster --machinepool=mymachinepool
$ rosa describe machinepool --cluster=mycluster --machinepool=mymachinepool
7.2.9. 撤销对象 复制链接链接已复制到粘贴板!
本节论述了集群和资源的 revoke
命令。
7.2.9.1. revoke-break-glass-credential 复制链接链接已复制到粘贴板!
从启用了外部身份验证的指定的托管 control plane 集群中撤销所有中断镜凭据。
语法
rosa revoke break-glass-credential --cluster=<cluster_name> | <cluster_id>
$ rosa revoke break-glass-credential --cluster=<cluster_name> | <cluster_id>
选项 | 定义 |
---|---|
--cluster | 必需:将删除 breakfish 凭据的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
--yes |
自动回答 |
Example
从名为 mycluster
的集群撤销 breakfish 凭据。
rosa revoke break-glass-credential --cluster=mycluster
$ rosa revoke break-glass-credential --cluster=mycluster
7.2.10. 升级和删除对象的升级 复制链接链接已复制到粘贴板!
本节论述了对象的 upgrade
命令用法。
7.2.10.1. 升级集群 复制链接链接已复制到粘贴板!
调度集群升级。
语法
rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]
选项 | 定义 |
---|---|
--cluster | 必需:要调度升级的集群的名称或 ID (字符串)。 |
--interactive | 启用交互模式。 |
--version | 集群要升级到的 OpenShift Container Platform 的版本(字符串)。 |
--schedule-date |
升级将在协调通用时间(UTC)中指定的时间运行时的下一个日期(字符串)。格式: |
--schedule-time |
下次升级将在 Coordinated Universal Time (UTC)中的指定日期上运行。格式: |
--node-drain-grace-period [1] |
设置一个宽限期(字符串),以便在升级过程中遵守 pod 中断预算保护的工作负载的时间。在此宽限期后,任何无法从节点成功排空的 pod 中断预算保护的所有工作负载都会强制被驱除。默认: |
--control-plane [2] | 升级集群的托管 control plane。 |
- 仅限经典集群
- 只使用 HCP 集群的 ROSA
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
例子
在名为 mycluster
的集群上以交互方式调度升级。
rosa upgrade cluster --cluster=mycluster --interactive
$ rosa upgrade cluster --cluster=mycluster --interactive
在名为 mycluster
的集群上,一小时内调度集群升级。
rosa upgrade cluster --cluster=mycluster --version 4.5.20
$ rosa upgrade cluster --cluster=mycluster --version 4.5.20
7.2.10.2. 删除集群升级 复制链接链接已复制到粘贴板!
取消调度的集群升级。
语法
rosa delete upgrade --cluster=<cluster_name> | <cluster_id>
$ rosa delete upgrade --cluster=<cluster_name> | <cluster_id>
选项 | 定义 |
---|---|
--cluster | 必需:将取消升级的集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--yes |
自动回答 |
7.2.10.3. 升级 machinepool 复制链接链接已复制到粘贴板!
升级在使用 HCP 集群的 ROSA 上配置的特定机器池。
machinepools 的 upgrade
命令只适用于 HCP 集群的 ROSA。
语法
rosa upgrade machinepool --cluster=<cluster_name> <machinepool_name>
$ rosa upgrade machinepool --cluster=<cluster_name> <machinepool_name>
选项 | 定义 |
---|---|
--cluster | 必需:集群的名称或 ID (字符串)。 |
--schedule-date |
升级将在协调通用时间(UTC)中指定的时间运行时的下一个日期(字符串)。格式: |
--schedule-time |
下次升级将在 Coordinated Universal Time (UTC)中的指定日期上运行。格式: |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |
Example
在名为 mycluster
的集群上升级机器池。
rosa upgrade machinepool --cluster=mycluster
$ rosa upgrade machinepool --cluster=mycluster
7.2.10.4. 删除 machinepool 升级 复制链接链接已复制到粘贴板!
取消调度的 machinepool 升级。
语法
rosa delete upgrade --cluster=<cluster_name> <machinepool_name>
$ rosa delete upgrade --cluster=<cluster_name> <machinepool_name>
选项 | 定义 |
---|---|
--cluster | 必需:集群的名称或 ID (字符串)。 |
选项 | 定义 |
---|---|
--help | 显示此命令的帮助信息。 |
--debug | 启用调试模式。 |
--profile | 指定来自您的凭证文件中的 AWS 配置集(字符串)。 |