IBM Cloud Kubernetes Service CLI 参考

请参考以下命令来创建和管理 IBM Cloud Kubernetes Service 集群。

在命令行中,ibmcloud CLI 和插件更新可用时会通知您。 请务必保持 CLI 处于最新状态,以便能够使用所有可用的命令和选项。

  1. 安装 IBM Cloud CLI。 请参阅 《 IBM Cloud CLI 入门指南 》。

  2. 安装 ks 插件。

    ibmcloud plugin install ks
    

API 命令

查看当前的 API 端点。

ibmcloud ks api

查看当前的 API 端点。

ibmcloud ks api [-q]

命令选项

-q
不显示每日消息或更新提示。

示例

查看当前 API 端点

ibmcloud ks api

API密钥命令

查看有关集群的 API 密钥的信息或将其重置为新密钥。

ibmcloud ks api-key help

显示帮助

ibmcloud ks api-key help

示例

显示帮助

ibmcloud ks api-key help

ibmcloud ks api-key info

虚拟私有云 传统基础设施

查看有关集群的 API 密钥所有者的信息。

ibmcloud ks api-key info --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看有关某个集群的 API 密钥所有者的信息

ibmcloud ks api-key info --cluster CLUSTER

ibmcloud ks api-key reset

虚拟私有云 传统基础设施

替换指定的区域和目标资源组中所有集群的 API 密钥。 如果未指定目标资源组,则该命令将应用于默认资源组。 如需了解更多信息,请参阅 http://ibm.biz/api-key

ibmcloud ks api-key reset --region REGION [-f] [--output OUTPUT] [-q]

命令选项

-f
强制此命令运行,而不显示用户提示。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--region
指定要设定为目标的区域。

示例

替换指定区域内所有集群及目标资源组中的 API 密钥

ibmcloud ks api-key reset --region REGION

集群命令

查看和修改集群和集群服务设置。

ibmcloud ks cluster addon disable acm

禁用 Red Hat 高级集群管理附加组件。

ibmcloud ks cluster addon disable acm --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用 Red Hat 高级集群管理附加组件

ibmcloud ks cluster addon disable acm --cluster CLUSTER

ibmcloud ks cluster addon disable alb-oauth-proxy

虚拟私有云 经典基础设施 Satellite

禁用 ALB 的“OAuth”代理插件。

ibmcloud ks cluster addon disable alb-oauth-proxy --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用 ALB 的“OAuth”代理插件

ibmcloud ks cluster addon disable alb-oauth-proxy --cluster CLUSTER

ibmcloud ks cluster addon disable cluster-autoscaler

禁用“集群自动缩放”附加组件。

ibmcloud ks cluster addon disable cluster-autoscaler --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用集群自动缩放器插件

ibmcloud ks cluster addon disable cluster-autoscaler --cluster CLUSTER

ibmcloud ks cluster addon disable debug-tool

禁用“诊断和调试工具”加载项。

ibmcloud ks cluster addon disable debug-tool --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用“诊断和调试工具”附加组件

ibmcloud ks cluster addon disable debug-tool --cluster CLUSTER

ibmcloud ks cluster addon disable headlamp

cluster addon disable headlamp 命令是一项测试版功能。

虚拟私有云 经典基础设施 Satellite

禁用“前照灯”插件。

ibmcloud ks cluster addon disable headlamp --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用“前照灯”插件

ibmcloud ks cluster addon disable headlamp --cluster CLUSTER

ibmcloud ks cluster addon disable help

显示帮助

ibmcloud ks cluster addon disable help

示例

显示帮助

ibmcloud ks cluster addon disable help

ibmcloud ks cluster addon disable hpcs-router

禁用 OpenShift 的HPCS路由器操作员插件。

ibmcloud ks cluster addon disable hpcs-router --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用 HPCS 路由器操作员插件,用于 OpenShift

ibmcloud ks cluster addon disable hpcs-router --cluster CLUSTER

ibmcloud ks cluster addon disable ibm-storage-operator

cluster addon disable ibm-storage-operator 命令是一项测试版功能。

禁用“IBM Cloud”存储操作符附加组件。

ibmcloud ks cluster addon disable ibm-storage-operator --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用“IBM Cloud”存储操作符附加组件

ibmcloud ks cluster addon disable ibm-storage-operator --cluster CLUSTER

ibmcloud ks cluster addon disable istio

传统基础设施

禁用受管 Istio 附加组件。

ibmcloud ks cluster addon disable istio --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用受管理的 Istio 插件

ibmcloud ks cluster addon disable istio --cluster CLUSTER

ibmcloud ks cluster addon disable istio-extras

cluster addon disable istio-extras 命令已弃用。

传统基础设施

禁用 Istio 的额外组件:Grafana、Jaeger 和 Kiali。

ibmcloud ks cluster addon disable istio-extras --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用 Istio 的额外组件:Grafana、Jaeger 以及 Kiali

ibmcloud ks cluster addon disable istio-extras --cluster CLUSTER

ibmcloud ks cluster addon disable istio-sample-bookinfo

cluster addon disable istio-sample-bookinfo 命令已弃用。

传统基础设施

禁用“Istio”BookInfo 示例应用程序附加组件(已弃用)。

ibmcloud ks cluster addon disable istio-sample-bookinfo --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用“Istio”BookInfo 示例应用程序附加组件(已弃用)

ibmcloud ks cluster addon disable istio-sample-bookinfo --cluster CLUSTER

ibmcloud ks cluster addon disable knative

禁用 Knative 无服务器框架插件。

ibmcloud ks cluster addon disable knative --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用 Knative 无服务器框架附加组件

ibmcloud ks cluster addon disable knative --cluster CLUSTER

ibmcloud ks cluster addon disable kube-terminal

虚拟私有云 经典基础设施 Satellite

禁用 Kubernetes Web终端插件。

ibmcloud ks cluster addon disable kube-terminal --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用 Kubernetes Web终端插件

ibmcloud ks cluster addon disable kube-terminal --cluster CLUSTER

ibmcloud ks cluster addon disable static-route

虚拟私有云 经典基础设施 Satellite

禁用“静态路由”附加组件。

ibmcloud ks cluster addon disable static-route --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用“静态路由”附加组件

ibmcloud ks cluster addon disable static-route --cluster CLUSTER

ibmcloud ks cluster addon disable vpc-block-csi-driver

传统基础设施

禁用 VPC Block Storage CSI 驱动程序附加组件。

ibmcloud ks cluster addon disable vpc-block-csi-driver --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用 VPC Block Storage CSI 驱动程序附加组件

ibmcloud ks cluster addon disable vpc-block-csi-driver --cluster CLUSTER

ibmcloud ks cluster addon enable acm

启用 Red Hat 高级集群管理附加组件。

ibmcloud ks cluster addon enable acm --cluster CLUSTER [-f] [--param PARAM] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
--param
指定附加组件的安装选项。 如果未指定任何参数,那么将使用缺省值。 使用 ibmcloud ks cluster addon options 命令查看可用的选项。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

启用 Red Hat 高级集群管理附加组件

ibmcloud ks cluster addon enable acm --cluster CLUSTER

ibmcloud ks cluster addon enable alb-oauth-proxy

虚拟私有云 经典基础设施 Satellite

启用 ALB 的“OAuth”代理插件。

ibmcloud ks cluster addon enable alb-oauth-proxy --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

启用 ALB OAuth 代理插件

ibmcloud ks cluster addon enable alb-oauth-proxy --cluster CLUSTER

ibmcloud ks cluster addon enable cluster-autoscaler

启用“集群自动缩放”附加组件。

ibmcloud ks cluster addon enable cluster-autoscaler --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

启用“集群自动缩放”附加组件

ibmcloud ks cluster addon enable cluster-autoscaler --cluster CLUSTER

ibmcloud ks cluster addon enable debug-tool

启用“诊断和调试工具”附加组件。

ibmcloud ks cluster addon enable debug-tool --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

启用“诊断和调试工具”附加组件

ibmcloud ks cluster addon enable debug-tool --cluster CLUSTER

ibmcloud ks cluster addon enable headlamp

cluster addon enable headlamp 命令是一项测试版功能。

虚拟私有云 经典基础设施 Satellite

启用“前照灯”附加组件。

ibmcloud ks cluster addon enable headlamp --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

启用“前照灯”插件

ibmcloud ks cluster addon enable headlamp --cluster CLUSTER

ibmcloud ks cluster addon enable help

显示帮助

ibmcloud ks cluster addon enable help

示例

显示帮助

ibmcloud ks cluster addon enable help

ibmcloud ks cluster addon enable hpcs-router

为 OpenShift 启用HPCS路由器操作员附加组件。

ibmcloud ks cluster addon enable hpcs-router --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

为以下内容启用 HPCS 路由器操作员附加组件:OpenShift

ibmcloud ks cluster addon enable hpcs-router --cluster CLUSTER

ibmcloud ks cluster addon enable ibm-storage-operator

cluster addon enable ibm-storage-operator 命令是一项测试版功能。

启用 IBM Cloud 存储操作员附加组件。

ibmcloud ks cluster addon enable ibm-storage-operator --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

启用 IBM Cloud 存储操作员附加组件

ibmcloud ks cluster addon enable ibm-storage-operator --cluster CLUSTER

ibmcloud ks cluster addon enable istio

传统基础设施

启用托管版 Istio 插件。

ibmcloud ks cluster addon enable istio --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

启用托管版 Istio 插件

ibmcloud ks cluster addon enable istio --cluster CLUSTER

ibmcloud ks cluster addon enable istio-extras

cluster addon enable istio-extras 命令已弃用。

启用额外的 Istio 组件:Grafana、Jaeger 和 Kiali。

ibmcloud ks cluster addon enable istio-extras --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

启用额外的 Istio 组件:Grafana、Jaeger 以及 Kiali

ibmcloud ks cluster addon enable istio-extras --cluster CLUSTER

ibmcloud ks cluster addon enable istio-sample-bookinfo

cluster addon enable istio-sample-bookinfo 命令已弃用。

在集群上启用“Istio”示例应用程序附加组件 BookInfo (已弃用)。

ibmcloud ks cluster addon enable istio-sample-bookinfo --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

在集群上启用“Istio”示例应用程序附加组件 BookInfo (已弃用)

ibmcloud ks cluster addon enable istio-sample-bookinfo --cluster CLUSTER

ibmcloud ks cluster addon enable static-route

虚拟私有云 经典基础设施 Satellite

启用“静态路由”附加组件。

ibmcloud ks cluster addon enable static-route --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

启用“静态路由”附加组件

ibmcloud ks cluster addon enable static-route --cluster CLUSTER

ibmcloud ks cluster addon enable vpc-block-csi-driver

虚拟私有云

启用 VPC Block Storage CSI 驱动程序附加组件。

ibmcloud ks cluster addon enable vpc-block-csi-driver --cluster CLUSTER [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
启用所有附加组件依赖性。

示例

启用 VPC Block Storage CSI 驱动程序附加组件

ibmcloud ks cluster addon enable vpc-block-csi-driver --cluster CLUSTER

ibmcloud ks cluster addon get

虚拟私有云 经典基础设施 Satellite

查看已安装的附加组件的详细信息。

ibmcloud ks cluster addon get --addon ADDON --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

--addon
附加组件名称或标识。
-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看已安装插件的详细信息

ibmcloud ks cluster addon get --addon ADDON --cluster CLUSTER

ibmcloud ks cluster addon help

显示帮助

ibmcloud ks cluster addon help

示例

显示帮助

ibmcloud ks cluster addon help

ibmcloud ks cluster addon ls

虚拟私有云 经典基础设施 Satellite

列出已启用的附加组件。

ibmcloud ks cluster addon ls --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

列出已启用的附加组件

ibmcloud ks cluster addon ls --cluster CLUSTER

ibmcloud ks cluster addon options

虚拟私有云 经典基础设施 Satellite

查看附加组件的安装选项。

ibmcloud ks cluster addon options --addon ADDON [--output OUTPUT] [-q] [--version VERSION]

命令选项

--addon
附加组件名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--version
指定要显示其选项的附件组件版本。 如果未指定版本,那么将显示缺省版本的选项。

示例

查看附加组件的安装选项

ibmcloud ks cluster addon options --addon ADDON

ibmcloud ks cluster addon update acm

更新 Red Hat 高级集群管理插件。

ibmcloud ks cluster addon update acm --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新 Red Hat 高级集群管理插件

ibmcloud ks cluster addon update acm --cluster CLUSTER

ibmcloud ks cluster addon update alb-oauth-proxy

更新 ALB 的“OAuth”代理插件。

ibmcloud ks cluster addon update alb-oauth-proxy --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新 ALB OAuth 代理插件

ibmcloud ks cluster addon update alb-oauth-proxy --cluster CLUSTER

ibmcloud ks cluster addon update cluster-autoscaler

更新集群自动缩放器附加组件。

ibmcloud ks cluster addon update cluster-autoscaler --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新集群自动缩放器附加组件

ibmcloud ks cluster addon update cluster-autoscaler --cluster CLUSTER

ibmcloud ks cluster addon update debug-tool

更新“诊断和调试工具”插件。

ibmcloud ks cluster addon update debug-tool --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新“诊断和调试工具”插件

ibmcloud ks cluster addon update debug-tool --cluster CLUSTER

ibmcloud ks cluster addon update headlamp

cluster addon update headlamp 命令是一项测试版功能。

更新“前大灯”插件。

ibmcloud ks cluster addon update headlamp --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新“前大灯”插件

ibmcloud ks cluster addon update headlamp --cluster CLUSTER

ibmcloud ks cluster addon update help

显示帮助

ibmcloud ks cluster addon update help

示例

显示帮助

ibmcloud ks cluster addon update help

ibmcloud ks cluster addon update hpcs-router

更新适用于 OpenShift 的HPCS路由器操作员插件。

ibmcloud ks cluster addon update hpcs-router --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新 HPCS 路由器操作员插件,适用于 OpenShift

ibmcloud ks cluster addon update hpcs-router --cluster CLUSTER

ibmcloud ks cluster addon update ibm-storage-operator

cluster addon update ibm-storage-operator 命令是一项测试版功能。

更新 IBM Cloud 存储操作员附加组件。

ibmcloud ks cluster addon update ibm-storage-operator --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新 IBM Cloud 存储操作员附加组件

ibmcloud ks cluster addon update ibm-storage-operator --cluster CLUSTER

ibmcloud ks cluster addon update image-key-synchronizer

更新“图像密钥同步器”插件。

ibmcloud ks cluster addon update image-key-synchronizer --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新“图像密钥同步器”插件

ibmcloud ks cluster addon update image-key-synchronizer --cluster CLUSTER

ibmcloud ks cluster addon update istio

更新受管 Istio 插件。

ibmcloud ks cluster addon update istio --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新托管版 Istio 插件

ibmcloud ks cluster addon update istio --cluster CLUSTER

ibmcloud ks cluster addon update istio-extras

cluster addon update istio-extras 命令已弃用。

更新 Istio 的额外组件:Grafana、Jaeger 和 Kiali。

ibmcloud ks cluster addon update istio-extras --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新 Istio 的额外组件:Grafana、Jaeger 以及 Kiali

ibmcloud ks cluster addon update istio-extras --cluster CLUSTER

ibmcloud ks cluster addon update istio-sample-bookinfo

cluster addon update istio-sample-bookinfo 命令已弃用。

更新“Istio”中的“BookInfo”示例应用程序附加组件(已弃用)。

ibmcloud ks cluster addon update istio-sample-bookinfo --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新“Istio”中的“BookInfo”示例应用程序附加组件(已弃用)

ibmcloud ks cluster addon update istio-sample-bookinfo --cluster CLUSTER

ibmcloud ks cluster addon update knative

更新 Knative 无服务器框架插件。

ibmcloud ks cluster addon update knative --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新 Knative 无服务器框架插件

ibmcloud ks cluster addon update knative --cluster CLUSTER

ibmcloud ks cluster addon update kube-terminal

更新 Kubernetes Web终端插件。

ibmcloud ks cluster addon update kube-terminal --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新 Kubernetes Web终端插件

ibmcloud ks cluster addon update kube-terminal --cluster CLUSTER

ibmcloud ks cluster addon update openshift-data-foundation

更新“OpenShift Data Foundation”插件。

ibmcloud ks cluster addon update openshift-data-foundation --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新 OpenShift Data Foundation 附加组件

ibmcloud ks cluster addon update openshift-data-foundation --cluster CLUSTER

ibmcloud ks cluster addon update static-route

更新“静态路由”插件。

ibmcloud ks cluster addon update static-route --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新“静态路由”插件

ibmcloud ks cluster addon update static-route --cluster CLUSTER

ibmcloud ks cluster addon update vpc-block-csi-driver

更新 VPC Block Storage CSI 驱动程序附加组件。

ibmcloud ks cluster addon update vpc-block-csi-driver --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--version
指定要安装的附件组件版本。 如果未指定版本,那么将安装缺省版本。
-y
更新所有附加组件依赖性。

示例

更新 VPC Block Storage CSI 驱动程序附加组件

ibmcloud ks cluster addon update vpc-block-csi-driver --cluster CLUSTER

ibmcloud ks cluster addon versions

虚拟私有云 经典基础设施 Satellite

列出受管附加组件的受支持版本。

ibmcloud ks cluster addon versions [--addon ADDON] [--offering OFFERING] [--output OUTPUT] [-q] [--show-defaults]

命令选项

--addon
指定要为其过滤版本的附加组件名称。
--offering
指定要筛选版本的业务。 允许的值:kubernetesopenshiftopenshift-vs
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--show-defaults
在输出中显示默认版本列。

示例

列出受支持的托管插件版本

ibmcloud ks cluster addon versions

ibmcloud ks cluster ca create

虚拟私有云 经典基础设施 Satellite

为集群创建 CA 证书。 然后,必须循环使用先前的证书后,才能使用新证书。

ibmcloud ks cluster ca create --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

为您的集群创建一个 CA 证书

ibmcloud ks cluster ca create --cluster CLUSTER

ibmcloud ks cluster ca get

虚拟私有云 经典基础设施 Satellite

查看集群的 CA 证书的详细信息。

ibmcloud ks cluster ca get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看集群 CA 证书的详细信息

ibmcloud ks cluster ca get --cluster CLUSTER

ibmcloud ks cluster ca help

显示帮助

ibmcloud ks cluster ca help

示例

显示帮助

ibmcloud ks cluster ca help

ibmcloud ks cluster ca rotate

虚拟私有云 经典基础设施 Satellite

循环使用集群的 CA 证书,这需要预先创建 CA 证书。 循环将使先前证书失效并刷新集群的 API 服务器。

ibmcloud ks cluster ca rotate --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

轮换集群的 CA 证书,这要求您此前已创建了 CA 证书

ibmcloud ks cluster ca rotate --cluster CLUSTER

ibmcloud ks cluster ca status

虚拟私有云 经典基础设施 Satellite

查看集群的 CA 证书的循环状态。

ibmcloud ks cluster ca status --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

查看集群中 CA 证书的轮换状态

ibmcloud ks cluster ca status --cluster CLUSTER

ibmcloud ks cluster config

虚拟私有云 经典基础设施 Satellite

下载 Kubernetes 配置文件和证书以使用 kubectl 命令连接到集群。

ibmcloud ks cluster config --cluster CLUSTER [--admin] [--endpoint ENDPOINT] [--network] [--output OUTPUT] [-q] [--skip-rbac]

命令选项

--admin
检索管理员证书和 PEM 密钥。
-c, --cluster
指定集群名称或标识。
--endpoint
要用于集群上下文的服务器 URL。 如果未包含该标志,那么将使用缺省集群服务端点。 如需了解更多信息,请访问 https://ibm.biz/context-kubeKubernetes,或 https://ibm.biz/context-ocpOpenShift 集群。 允许的值:privatelinkvpe
--network
使用管理配置检索 Calico 网络配置。
--output
以指定的格式打印命令输出,并跳过 kubeconfig 的合并操作。 ZIP 输出文件中不包含刷新令牌。 允许的值:jsonyamlzip
-q
不显示每日消息或更新提示。
--skip-rbac
跳过添加 RBAC 角色。 仅当您管理自己的 Kubernetes RBAC 角色时才包含此选项。 如果使用 IAM 服务访问角色管理您的所有 RBAC 用户,请勿包含此选项。

示例

下载 Kubernetes 配置文件和证书,以便使用kubectl命令连接到您的集群

ibmcloud ks cluster config --cluster CLUSTER

ibmcloud ks cluster create classic

传统基础设施

在经典基础架构上创建具有工作程序节点的集群。

ibmcloud ks cluster create classic --flavor FLAVOR --name NAME --zone ZONE [--disable-disk-encrypt] [--entitlement ENTITLEMENT] [--hardware HARDWARE] [--location LOCATION] [--no-subnet] [--operating-system SYSTEM] [--pod-subnet SUBNET] [--private-service-endpoint] [--private-vlan VLAN] [--public-service-endpoint] [-q] [--service-subnet SUBNET] [--skip-advance-permissions-check] [--sm-group GROUP] [--sm-instance INSTANCE] [--version VERSION] [--workers COUNT] (--private-only | --public-vlan VLAN)

命令选项

--disable-disk-encrypt
在工作程序节点上禁用加密。
--entitlement
仅当您使用包含“OpenShift”授权的许可证(例如 Cloud Pak )来运行此集群时,才应将此标志设置为 ocp_entitled
--flavor
工作程序节点的类型模板。 要查看可用的变体,请运行 ibmcloud ks flavor ls --zone <zone name> (适用于 public. IBM Cloud 账户)或 ibmcloud ks flavor ls (适用于 IBM Cloud Dedicated 账户)。
--hardware
工作程序节点的硬件隔离级别。 使用 dedicated 可获得仅供您专用的物理资源,或使用 shared 允许与其他 IBM 客户共享物理资源。 对于 IBM Cloud 公共帐户,将共享缺省值。 对于专用于 IBM Cloud 的帐户,dedicated 是唯一可用的选项。
--location
已弃用的 标志仍保留,以确保与早期版本的兼容性。 请改用 --zone 标志。
--name
请输入集群的名称。
--no-subnet
在创建集群时,阻止创建便携式子网。 缺省情况下,公共和专用便携式子网都在关联的 VLAN 上创建,该标志可以阻止这种行为。 若要在稍后向集群添加子网,请运行 ibmcloud ks cluster subnet add
--operating-system
指定操作系统的名称。
--pod-subnet
指定定制子网 CIDR 以便为 Pod 提供专用 IP 地址。 子网必须至少为 /23 或更大。 如需了解更多信息,请参阅 https://ibm.biz/cluster-create-classic
--private-only
使用该标志以阻止创建公共 VLAN。 仅当您指定 --private-vlan 标志但未指定 --public-vlan 标志时才需要此设置。
--private-service-endpoint
启用专用服务端点以使主节点可供专用访问。
--private-vlan
条件:指定私有VLAN的ID。 要查看可用的VLAN,请运行 ibmcloud ks vlan ls --zone <zone name>。 如果您尚未拥有私有VLAN,请不要指定此选项,因为系统会自动为您创建一个。 指定私有VLAN时,还必须同时指定 --public-vlan 标志或 --private-only 标志。
--public-service-endpoint
启用公共服务端点以使主节点可供公开访问。
--public-vlan
条件:指定公共VLAN的ID。 要查看可用的VLAN,请运行 ibmcloud ks vlan ls --zone <zone name>。 如果您尚未拥有公共VLAN,请不要指定此选项,因为系统会自动为您创建一个。
-q
不显示每日消息或更新提示。
--service-subnet
指定定制子网 CIDR 以便为服务提供专用 IP 地址。 子网必须至少为 /24 或更大。 如需了解更多信息,请参阅 https://ibm.biz/cluster-create-classic。 缺省值: 172.21.0.0/16
--skip-advance-permissions-check
在完成此操作之前,请跳过基础结构许可权检查。 请注意,如果您没有正确的基础结构许可权,那么此操作可能仅部分成功。
--sm-group
用于持久存储私钥的 IBM Cloud Secrets Manager 实例的私钥组标识。
--sm-instance
IBM Cloud Secrets Manager 实例的 CRN。
--version
指定 Kubernetes 或 OpenShift 版本,至少包含 major.minor 版本。 如果未包含该标志,那么将使用缺省版本。 要查看可用的版本,请运行 ibmcloud ks versions
--workers
集群工作程序节点的数量。 默认值为 1。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

在传统基础设施上创建包含工作节点的集群

ibmcloud ks cluster create classic --flavor FLAVOR --name NAME --zone ZONE --private-only

ibmcloud ks cluster create help

显示帮助

ibmcloud ks cluster create help

示例

显示帮助

ibmcloud ks cluster create help

ibmcloud ks cluster create satellite

在您自己的基础架构上创建 IBM Cloud Satellite 集群。

ibmcloud ks cluster create satellite --location LOCATION --name NAME --version VERSION [--enable-config-admin] [--entitlement ENTITLEMENT] [--host-label LABEL ...] [--infrastructure-topology TOPOLOGY] [--operating-system SYSTEM] [--pod-network-interface-selection SELECTION] [--pod-subnet SUBNET] [--pull-secret SECRET] [-q] [--service-subnet SUBNET] [--sm-group GROUP] [--sm-instance INSTANCE] [--workers COUNT] [--zone ZONE]

命令选项

--enable-config-admin
授予 admin 集群访问 Satellite Config 的权限,以便管理 Kubernetes 资源。
--entitlement
仅当您使用包含“OpenShift”授权的许可证(例如 Cloud Pak )来运行此集群时,才应将此标志设置为 ocp_entitled
--host-label, --hl
请以键值对的形式输入任意标签,用于标识要分配给您的 Satellite 控制平面或 Red Hat OpenShift 集群的主机。 具有此标签且未分配的第一个主机将自动分配给控制平面或集群。 要查找可用的主机标签,请运行 ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>
--infrastructure-topology
指定集群应运行单个工作程序节点还是缺省数量的工作程序节点。 要创建单节点集群,请指定 single-replica。 要创建一个包含多个工作节点的默认集群,请指定 highly-available。 默认情况下,会应用 highly-available 选项。 允许的值:single-replicahighly-available
--location
Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行 ibmcloud sat location ls
--name
请输入集群的名称。
--operating-system
指定操作系统的名称。
--pod-network-interface-selection
用于选择内部 pod 网络的节点网络接口的方法。 仅当指定的 Satellite 位置已启用 Red Hat CoreOS 时,才能使用此选项。 若要提供直接的 URL 或 IP 地址,请指定 can-reach=<url>can-reach=<ip_address>。 要选择网络接口,请指定 interface=<network_interface>
--pod-subnet
指定定制子网 CIDR 以便为 Pod 提供专用 IP 地址。 子网必须至少为 /23 或更大。 如需了解更多信息,请参阅 https://ibm.biz/cluster-create-satellite。 缺省值: 172.30.0.0/16
--pull-secret
通过提供 Red Hat 帐户拉取密钥,指定用于此集群的工作程序节点的现有 OpenShift 权利。
-q
不显示每日消息或更新提示。
--service-subnet
指定定制子网 CIDR 以便为服务提供专用 IP 地址。 子网必须至少为 /24 或更大。 如需了解更多信息,请参阅 https://ibm.biz/cluster-create-satellite。 缺省值: 172.21.0.0/16
--sm-group
用于持久存储私钥的 IBM Cloud Secrets Manager 实例的私钥组标识。
--sm-instance
IBM Cloud Secrets Manager 实例的 CRN。
--version
Red Hat OpenShift on IBM Cloud 版本,至少包含 major.minor 版本。 要查看可用的版本,请运行 ibmcloud ks versions
--workers
缺省工作程序池中每个区域的工作程序节点数。 当指定 --host-label 时,此参数为必填项。
--zone
多区域集群中缺省工作程序池的区域。 要列出您所在位置的区域,请运行 ibmcloud sat location get

示例

在您自己的基础设施上创建一个 IBM Cloud Satellite 集群

ibmcloud ks cluster create satellite --location LOCATION --name NAME --version VERSION

ibmcloud ks cluster create vpc-classic

在虚拟私有云 (VPC) 第 1 代基础架构上创建包含工作程序节点的集群。

ibmcloud ks cluster create vpc-classic --flavor FLAVOR --name NAME --subnet-id ID --vpc-id ID --zone ZONE [--disable-public-service-endpoint] [--entitlement ENTITLEMENT] [--operating-system SYSTEM] [--pod-subnet SUBNET] [-q] [--service-subnet SUBNET] [--sm-group GROUP] [--sm-instance INSTANCE] [--version VERSION] [--workers COUNT]

命令选项

--disable-public-service-endpoint
禁用公共服务端点以阻止公开访问主节点。
--entitlement
仅当您使用包含“OpenShift”授权的许可证(例如 Cloud Pak )来运行此集群时,才应将此标志设置为 ocp_entitled
--flavor
工作程序节点的类型模板。 要查看可用的变体,请运行 ibmcloud ks flavor ls --zone <zone name> (适用于 public. IBM Cloud 账户)或 ibmcloud ks flavor ls (适用于 IBM Cloud Dedicated 账户)。
--name
请输入集群的名称。
--operating-system
指定操作系统的名称。
--pod-subnet
指定定制子网 CIDR 以便为 Pod 提供专用 IP 地址。 子网必须至少为 /23 或更大。 如需了解更多信息,请参阅 https://ibm.biz/cluster-create-vpc
-q
不显示每日消息或更新提示。
--service-subnet
指定定制子网 CIDR 以便为服务提供专用 IP 地址。 子网必须至少为 /24 或更大。 如需了解更多信息,请参阅 https://ibm.biz/cluster-create-vpc。 缺省值: 172.21.0.0/16
--sm-group
用于持久存储私钥的 IBM Cloud Secrets Manager 实例的私钥组标识。
--sm-instance
IBM Cloud Secrets Manager 实例的 CRN。
--subnet-id
要分配给集群的 VPC 子网。 要列出可用的子网,请运行 ibmcloud ks subnets --provider vpc-classic --vpc-id <vpc-id> --zone <vpc-zone>
--version
指定 Kubernetes 或 OpenShift 版本,至少包含 major.minor 版本。 如果未包含该标志,那么将使用缺省版本。 要查看可用的版本,请运行 ibmcloud ks versions
--vpc-id
要在其中创建工作程序节点的 VPC 的标识。 要列出可用的ID,请运行 ibmcloud ks vpcs
--workers
缺省工作程序池中每个区域的工作程序节点数。 对于 OpenShift 集群,必须将此值设置为至少 2。 对于 Kubernetes 集群,此值为可选。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

在虚拟私有云(VPC)第 1 代基础设施上创建一个包含工作节点的集群

ibmcloud ks cluster create vpc-classic \
  --flavor FLAVOR \
  --name NAME \
  --subnet-id ID \
  --vpc-id ID \
  --zone ZONE

ibmcloud ks cluster create vpc-gen2

虚拟私有云

在虚拟私有云 (VPC) 第 2 代基础架构上创建包含工作程序节点的集群。

ibmcloud ks cluster create vpc-gen2 --flavor FLAVOR --name NAME --subnet-id ID --vpc-id ID --zone ZONE [--cluster-security-group GROUP ...] [--cni CNI] [--cos-instance INSTANCE] [--crk CRK] [--disable-outbound-traffic-protection] [--disable-public-service-endpoint] [--entitlement ENTITLEMENT] [--kms-account-id ID] [--kms-instance INSTANCE] [--offering OFFERING] [--operating-system SYSTEM] [--pod-subnet SUBNET] [-q] [--secondary-storage STORAGE] [--service-subnet SUBNET] [--sm-group GROUP] [--sm-instance INSTANCE] [--version VERSION] [--workers COUNT]

命令选项

--cluster-security-group
可选。 请指定一个或多个安全组标识,以应用于集群上所有工作程序。 对于 OpenShift 版本( 4.15 )以及 Kubernetes 版本( 1.30 及更高版本),这些安全组将在 IBM 管理的 kube-clusterID 安全组之外额外应用。 对于较早版本的集群,请指定 --cluster-security-group cluster 选项以应用 kube-clusterID 安全组。 如果未指定任何值,则会应用一组默认的安全组,其中包括 kube-clusterID
--cni
为集群设置网络插件。 Calico 默认已设置为该值。 允许的值:CalicoOVNKubernetes
--cos-instance
仅 OpenShift Cluster 必需。 用于在 OpenShift Cluster 中备份内部注册表的标准云对象存储器实例的 CRN。 要列出您的云对象存储实例的 CRN,请运行 ibmcloud resource service-instances --long --service-name cloud-object-storage
--crk
用于本地磁盘加密的 KMS 实例中根密钥的标识。 要列出可用的根密钥,请运行 ibmcloud ks kms crk ls --instance-id <kms_instance>
--disable-outbound-traffic-protection
启用此选项可允许集群工作节点进行公共出站访问。 默认情况下,在 OpenShift 的 4.15 及更高版本,以及 Kubernetes 的 1.30 及更高版本中,公共出站访问被阻止。
--disable-public-service-endpoint
禁用公共服务端点以阻止公开访问主节点。
--entitlement
仅当您使用包含“OpenShift”授权的许可证(例如 Cloud Pak )来运行此集群时,才应将此标志设置为 ocp_entitled
--flavor
工作程序节点的类型模板。 要查看可用的变体,请运行 ibmcloud ks flavor ls --zone <zone name> (适用于 public. IBM Cloud 账户)或 ibmcloud ks flavor ls (适用于 IBM Cloud Dedicated 账户)。
--kms-account-id
包含要用于本地磁盘或私钥加密的 KMS 实例的帐户的标识。
--kms-instance
用于本地磁盘加密的 KMS 实例的标识。 要列出可用的 KMS 实例,请运行 ibmcloud ks kms instance ls
--name
请输入集群的名称。
--offering
指定集群方案。 允许的值:kubernetesopenshiftopenshift-vs
--operating-system
指定操作系统的名称。
--pod-subnet
指定定制子网 CIDR 以便为 Pod 提供专用 IP 地址。 子网必须至少为 /23 或更大。 如需了解更多信息,请参阅 https://ibm.biz/cluster-create-vpc
-q
不显示每日消息或更新提示。
--secondary-storage
类型模板的辅助存储器选项。 要查看某种配置可用的二级存储选项,请运行 ibmcloud ks flavor get --provider vpc-gen2 --zone <zone name>
--service-subnet
指定定制子网 CIDR 以便为服务提供专用 IP 地址。 子网必须至少为 /24 或更大。 如需了解更多信息,请参阅 https://ibm.biz/cluster-create-vpc。 缺省值: 172.21.0.0/16
--sm-group
用于持久存储私钥的 IBM Cloud Secrets Manager 实例的私钥组标识。
--sm-instance
IBM Cloud Secrets Manager 实例的 CRN。
--subnet-id
要分配给集群的 VPC 子网。 要列出可用的子网,请运行 ibmcloud ks subnets --provider vpc-gen2 --vpc-id <vpc-id> --zone <vpc-zone>
--version
指定 Kubernetes 或 OpenShift 版本,至少包含 major.minor 版本。 如果未包含该标志,那么将使用缺省版本。 要查看可用的版本,请运行 ibmcloud ks versions
--vpc-id
要在其中创建工作程序节点的 VPC 的标识。 要列出可用的ID,请运行 ibmcloud ks vpcs
--workers
缺省工作程序池中每个区域的工作程序节点数。 对于 OpenShift 集群,必须将此值设置为至少 2。 对于 Kubernetes 集群,此值为可选。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

在虚拟私有云(VPC)第 2 代基础设施上创建包含工作节点的集群

ibmcloud ks cluster create vpc-gen2 \
  --flavor FLAVOR \
  --name NAME \
  --subnet-id ID \
  --vpc-id ID \
  --zone ZONE

ibmcloud ks cluster get

虚拟私有云 经典基础设施 Satellite

查看集群的详细信息。

ibmcloud ks cluster get --cluster CLUSTER [--output OUTPUT] [-q] [--show-resources]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--show-resources
显示其他集群资源,例如附加组件、VLAN 和子网。

示例

查看集群的详细信息

ibmcloud ks cluster get --cluster CLUSTER

ibmcloud ks cluster help

显示帮助

ibmcloud ks cluster help

示例

显示帮助

ibmcloud ks cluster help

ibmcloud ks cluster image-security disable

虚拟私有云 经典基础设施 Satellite

在您的集群中禁用镜像安全实施。

ibmcloud ks cluster image-security disable --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

在您的集群中禁用映像安全策略

ibmcloud ks cluster image-security disable --cluster CLUSTER

ibmcloud ks cluster image-security enable

虚拟私有云 经典基础设施 Satellite

在您的集群中启用镜像安全实施。

ibmcloud ks cluster image-security enable --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

在您的集群中启用镜像安全策略

ibmcloud ks cluster image-security enable --cluster CLUSTER

ibmcloud ks cluster image-security help

显示帮助

ibmcloud ks cluster image-security help

示例

显示帮助

ibmcloud ks cluster image-security help

ibmcloud ks cluster ls

虚拟私有云 经典基础设施 Satellite

列出 IBM Cloud 帐户中的所有集群。

ibmcloud ks cluster ls [-l LOCATION ...] [--output OUTPUT] [--provider PROVIDER] [-q]

命令选项

-l, --location
要进行过滤的位置。 要列出可用的位置,请运行 ibmcloud ks locations
--output
以提供的格式打印命令输出。 如果未包含提供商标志,则仅返回经典集群。 接受的值: json
--provider
过滤特定基础架构提供程序的列表。 允许的值:classicvpc-classicvpc-gen2satellite
-q
不显示每日消息或更新提示。

示例

列出您在 IBM Cloud 账户中的所有集群

ibmcloud ks cluster ls

ibmcloud ks cluster master audit-webhook get

传统基础设施

查看集群的 Kubernetes API 服务器的审计 Webhook 配置。 Webhook 后端将 API 服务器审计日志转发到远程服务器。

ibmcloud ks cluster master audit-webhook get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看集群中 Kubernetes API服务器的审计Webhook配置

ibmcloud ks cluster master audit-webhook get --cluster CLUSTER

ibmcloud ks cluster master audit-webhook help

显示帮助

ibmcloud ks cluster master audit-webhook help

示例

显示帮助

ibmcloud ks cluster master audit-webhook help

ibmcloud ks cluster master audit-webhook set

传统基础设施

设置集群的 Kubernetes API 服务器的审计 Webhook 配置。 Webhook 后端将 API 服务器审计日志转发到远程服务器。

ibmcloud ks cluster master audit-webhook set --cluster CLUSTER [--ca-cert CERT] [--client-cert CERT] [--client-key KEY] [--policy POLICY] [-q] [--remote-server SERVER]

命令选项

-c, --cluster
指定集群名称或标识。
--ca-cert
用于验证远程日志记录服务的 CA 证书的文件路径。
--client-cert
用于对远程日志记录服务进行认证的客户机证书的文件路径。
--client-key
用于连接到远程日志记录服务的相应客户机密钥的文件路径。
--policy
指定审计策略类型。 允许的值:defaultverbose
-q
不显示每日消息或更新提示。
--remote-server
远程日志记录服务的 URL 或 IP 地址。

示例

为集群的 Kubernetes API服务器设置审计webhook配置

ibmcloud ks cluster master audit-webhook set --cluster CLUSTER

ibmcloud ks cluster master audit-webhook unset

传统基础设施

移除集群的 Kubernetes API 服务器的审计 Webhook 配置。

ibmcloud ks cluster master audit-webhook unset --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

删除集群中 Kubernetes API服务器的审计Webhook配置

ibmcloud ks cluster master audit-webhook unset --cluster CLUSTER

ibmcloud ks cluster master console-oauth-access get

获取 OpenShift Web控制台和 OAuth 服务器访问类型。

ibmcloud ks cluster master console-oauth-access get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

获取 OpenShift Web控制台和 OAuth 服务器访问类型

ibmcloud ks cluster master console-oauth-access get --cluster CLUSTER

ibmcloud ks cluster master console-oauth-access help

显示帮助

ibmcloud ks cluster master console-oauth-access help

示例

显示帮助

ibmcloud ks cluster master console-oauth-access help

ibmcloud ks cluster master console-oauth-access set

设置 OpenShift Web控制台和 OAuth 服务器的访问类型。

ibmcloud ks cluster master console-oauth-access set --cluster CLUSTER [-f] [-q] [--type TYPE]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--type
指定 OpenShift Web控制台和 OAuth 服务器访问类型。 允许的值:vpe-gatewaylegacy

示例

设置 OpenShift Web控制台和 OAuth 服务器的访问类型

ibmcloud ks cluster master console-oauth-access set --cluster CLUSTER

ibmcloud ks cluster master help

显示帮助

ibmcloud ks cluster master help

示例

显示帮助

ibmcloud ks cluster master help

ibmcloud ks cluster master pod-security get

虚拟私有云 经典基础设施 Satellite

查看集群的 Kubernetes API 服务器的 PodSecurity 许可配置。

ibmcloud ks cluster master pod-security get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看集群中 Kubernetes API服务器的 PodSecurity 接入配置

ibmcloud ks cluster master pod-security get --cluster CLUSTER

ibmcloud ks cluster master pod-security help

显示帮助

ibmcloud ks cluster master pod-security help

示例

显示帮助

ibmcloud ks cluster master pod-security help

ibmcloud ks cluster master pod-security policy disable

虚拟私有云 经典基础设施 Satellite

对集群的 Kubernetes API 服务器禁用 PodSecurity 策略。

ibmcloud ks cluster master pod-security policy disable --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

为集群的 Kubernetes API服务器禁用 PodSecurityPolicy

ibmcloud ks cluster master pod-security policy disable --cluster CLUSTER

ibmcloud ks cluster master pod-security policy enable

虚拟私有云 经典基础设施 Satellite

对集群的 Kubernetes API 服务器启用 PodSecurity 策略。

ibmcloud ks cluster master pod-security policy enable --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

为集群的 Kubernetes API服务器启用 PodSecurityPolicy 功能

ibmcloud ks cluster master pod-security policy enable --cluster CLUSTER

ibmcloud ks cluster master pod-security policy get

虚拟私有云 经典基础设施 Satellite

查看集群的 Kubernetes API 服务器的 PodSecurity 策略配置。

ibmcloud ks cluster master pod-security policy get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看集群中 Kubernetes API服务器的 PodSecurityPolicy 配置

ibmcloud ks cluster master pod-security policy get --cluster CLUSTER

ibmcloud ks cluster master pod-security policy help

显示帮助

ibmcloud ks cluster master pod-security policy help

示例

显示帮助

ibmcloud ks cluster master pod-security policy help

ibmcloud ks cluster master pod-security set

虚拟私有云 经典基础设施 Satellite

设置并启用集群的 Kubernetes API 服务器的 PodSecurity 许可配置。

ibmcloud ks cluster master pod-security set --cluster CLUSTER [--config-file FILE] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--config-file
定制 PodSecurity 配置的文件路径。 如果未指定,那么会应用 Kubernetes 缺省值。 有关更多信息,请参阅 https://ibm.biz/BdPtUB
-q
不显示每日消息或更新提示。

示例

为集群的 Kubernetes API服务器设置并启用 PodSecurity 准入配置

ibmcloud ks cluster master pod-security set --cluster CLUSTER

ibmcloud ks cluster master pod-security unset

虚拟私有云 经典基础设施 Satellite

移除集群的 Kubernetes API 服务器的 PodSecurity 许可配置。

ibmcloud ks cluster master pod-security unset --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

删除集群中 Kubernetes API服务器的 PodSecurity 访问配置

ibmcloud ks cluster master pod-security unset --cluster CLUSTER

ibmcloud ks cluster master private-service-endpoint allowlist add

cluster master private-service-endpoint allowlist add 命令已弃用。

虚拟私有云 传统基础设施

向集群的专用服务端点允许列表中添加子网。

ibmcloud ks cluster master private-service-endpoint allowlist add --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--subnet
指定子网 CIDR。

示例

将子网添加到集群的私有服务端点白名单中

ibmcloud ks cluster master private-service-endpoint allowlist add --cluster CLUSTER --subnet SUBNET

ibmcloud ks cluster master private-service-endpoint allowlist disable

cluster master private-service-endpoint allowlist disable 命令已弃用。

虚拟私有云 传统基础设施

禁用允许列表。 禁用时,允许通过专用服务端点从任何子网向集群主节点发出的授权请求。

ibmcloud ks cluster master private-service-endpoint allowlist disable --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用白名单

ibmcloud ks cluster master private-service-endpoint allowlist disable --cluster CLUSTER

ibmcloud ks cluster master private-service-endpoint allowlist enable

cluster master private-service-endpoint allowlist enable 命令已弃用。

虚拟私有云 传统基础设施

启用允许列表。 启用后,仅允许通过专用服务端点从允许列表中的子网向集群主节点发出的授权请求。

ibmcloud ks cluster master private-service-endpoint allowlist enable --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

启用白名单

ibmcloud ks cluster master private-service-endpoint allowlist enable --cluster CLUSTER

ibmcloud ks cluster master private-service-endpoint allowlist get

cluster master private-service-endpoint allowlist get 命令已弃用。

虚拟私有云 传统基础设施

获取集群的专用服务端点允许列表。

ibmcloud ks cluster master private-service-endpoint allowlist get --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

获取集群私有服务端点的白名单

ibmcloud ks cluster master private-service-endpoint allowlist get --cluster CLUSTER

ibmcloud ks cluster master private-service-endpoint allowlist help

显示帮助

ibmcloud ks cluster master private-service-endpoint allowlist help

示例

显示帮助

ibmcloud ks cluster master private-service-endpoint allowlist help

ibmcloud ks cluster master private-service-endpoint allowlist rm

cluster master private-service-endpoint allowlist rm 命令已弃用。

虚拟私有云 传统基础设施

从集群的专用服务端点允许列表中移除子网。

ibmcloud ks cluster master private-service-endpoint allowlist rm --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--subnet
指定子网 CIDR。

示例

从集群的私有服务端点白名单中移除子网

ibmcloud ks cluster master private-service-endpoint allowlist rm --cluster CLUSTER --subnet SUBNET

ibmcloud ks cluster master private-service-endpoint enable

传统基础设施

启用专用服务端点以使主节点可供专用访问。

ibmcloud ks cluster master private-service-endpoint enable --cluster CLUSTER [-f] [-q] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
-y
如果该功能需要进一步操作(如重新装入工作程序或者刷新集群主节点),那么会在无用户提示的情况下执行这些操作。

示例

启用私有服务端点,以便私下访问主节点

ibmcloud ks cluster master private-service-endpoint enable --cluster CLUSTER

ibmcloud ks cluster master private-service-endpoint help

显示帮助

ibmcloud ks cluster master private-service-endpoint help

示例

显示帮助

ibmcloud ks cluster master private-service-endpoint help

ibmcloud ks cluster master public-service-endpoint disable

虚拟私有云 传统基础设施

禁用公共服务端点以使主节点仅可供专用访问。

ibmcloud ks cluster master public-service-endpoint disable --cluster CLUSTER [-f] [-q] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
-y
如果该功能需要进一步操作(如重新装入工作程序或者刷新集群主节点),那么会在无用户提示的情况下执行这些操作。

示例

禁用公共服务端点,使主节点仅可私下访问

ibmcloud ks cluster master public-service-endpoint disable --cluster CLUSTER

ibmcloud ks cluster master public-service-endpoint enable

虚拟私有云 传统基础设施

启用公共服务端点以使主节点可供公开访问。

ibmcloud ks cluster master public-service-endpoint enable --cluster CLUSTER [-f] [-q] [-y]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
-y
如果该功能需要进一步操作(如重新装入工作程序或者刷新集群主节点),那么会在无用户提示的情况下执行这些操作。

示例

启用公共服务端点,使主节点对公众开放

ibmcloud ks cluster master public-service-endpoint enable --cluster CLUSTER

ibmcloud ks cluster master public-service-endpoint help

显示帮助

ibmcloud ks cluster master public-service-endpoint help

示例

显示帮助

ibmcloud ks cluster master public-service-endpoint help

ibmcloud ks cluster master refresh

虚拟私有云 经典基础设施 Satellite

重新启动集群主节点以应用新的 Kubernetes API 配置更改。 但是,工作程序节点、应用程序和资源不会修改,并且会继续运行。

ibmcloud ks cluster master refresh --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

重启集群主节点以应用新的 Kubernetes API配置更改

ibmcloud ks cluster master refresh --cluster CLUSTER

ibmcloud ks cluster master satellite-service-endpoint allowlist add

将子网添加到 Satellite 集群的服务端点允许列表。

ibmcloud ks cluster master satellite-service-endpoint allowlist add --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--subnet
指定子网 CIDR。

示例

将子网添加到 Satellite 集群的服务端点白名单中

ibmcloud ks cluster master satellite-service-endpoint allowlist add \
  --cluster CLUSTER \
  --subnet SUBNET

ibmcloud ks cluster master satellite-service-endpoint allowlist disable

禁用 Satellite 集群的允许列表。 禁用时,允许通过 Satellite 服务端点从任何子网向集群主节点发出的授权请求。

ibmcloud ks cluster master satellite-service-endpoint allowlist disable --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用 Satellite 集群的白名单

ibmcloud ks cluster master satellite-service-endpoint allowlist disable --cluster CLUSTER

ibmcloud ks cluster master satellite-service-endpoint allowlist enable

对 Satellite 集群启用允许列表。 启用后,仅允许通过 Satellite 服务端点从允许列表中的子网向集群主节点发出的授权请求。

ibmcloud ks cluster master satellite-service-endpoint allowlist enable --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

为 Satellite 集群启用白名单

ibmcloud ks cluster master satellite-service-endpoint allowlist enable --cluster CLUSTER

ibmcloud ks cluster master satellite-service-endpoint allowlist get

获取 Satellite 集群的服务端点允许列表。

ibmcloud ks cluster master satellite-service-endpoint allowlist get --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

获取 Satellite 集群的服务端点白名单

ibmcloud ks cluster master satellite-service-endpoint allowlist get --cluster CLUSTER

ibmcloud ks cluster master satellite-service-endpoint allowlist help

显示帮助

ibmcloud ks cluster master satellite-service-endpoint allowlist help

示例

显示帮助

ibmcloud ks cluster master satellite-service-endpoint allowlist help

ibmcloud ks cluster master satellite-service-endpoint allowlist rm

从 Satellite 集群的服务端点允许列表中除去子网。

ibmcloud ks cluster master satellite-service-endpoint allowlist rm --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--subnet
指定子网 CIDR。

示例

从 Satellite 集群的服务端点白名单中移除子网

ibmcloud ks cluster master satellite-service-endpoint allowlist rm --cluster CLUSTER --subnet SUBNET

ibmcloud ks cluster master satellite-service-endpoint help

显示帮助

ibmcloud ks cluster master satellite-service-endpoint help

示例

显示帮助

ibmcloud ks cluster master satellite-service-endpoint help

ibmcloud ks cluster master update

虚拟私有云 经典基础设施 Satellite

将集群主节点更新至最新版本或指定的 Kubernetes 版本。

ibmcloud ks cluster master update --cluster CLUSTER [-f] [--force-update] [-q] [--version VERSION]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
--force-update
尝试更新,即使更改比工作程序节点当前版本高出两个次要版本也是如此。
-q
不显示每日消息或更新提示。
--version
指定 Kubernetes 或 OpenShift 版本,至少包含 major.minor 版本。 如果未包含该标志,那么将使用缺省版本。 要查看可用的版本,请运行 ibmcloud ks versions

示例

将集群主节点更新为最新版本或指定的 Kubernetes 版本

ibmcloud ks cluster master update --cluster CLUSTER

ibmcloud ks cluster pull-secret apply

虚拟私有云 经典基础设施 Satellite

生成并应用一个新的镜像拉取密钥,该密钥用于存储集群访问 IBM Cloud Container Registry 中镜像所需的 IAM 凭据。

ibmcloud ks cluster pull-secret apply --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

生成并应用一个新的镜像拉取密钥,该密钥用于存储集群访问镜像所需的 IAM 凭据 IBM Cloud Container Registry

ibmcloud ks cluster pull-secret apply --cluster CLUSTER

ibmcloud ks cluster pull-secret help

显示帮助

ibmcloud ks cluster pull-secret help

示例

显示帮助

ibmcloud ks cluster pull-secret help

ibmcloud ks cluster rm

虚拟私有云 经典基础设施 Satellite

删除集群。 所有工作程序节点、应用程序和容器都将永久删除。 无法撤销此操作。

ibmcloud ks cluster rm --cluster CLUSTER [--delete-openshift-registry-cos-bucket] [--delete-storage] [-f] [-q] [--skip-advance-permissions-check]

命令选项

-c, --cluster
指定集群名称或标识。
--delete-openshift-registry-cos-bucket
删除存储了 ROKS 集群中 OpenShift 注册表备份的 COS 存储桶及其关联的服务密钥
--delete-storage
强制移除集群的持久化存储。 无法恢复已删除的数据。
-f
强制此命令运行,而不显示用户提示。 除非同时指定了 delete-storage 选项,否则不会删除该集群的持久化存储。 除非同时指定了 delete-openshift-registry-cos-bucket 选项,否则不会删除COS存储桶及其关联的服务密钥。
-q
不显示每日消息或更新提示。
--skip-advance-permissions-check
在完成此操作之前,请跳过基础结构许可权检查。 请注意,如果您没有正确的基础结构许可权,那么此操作可能仅部分成功。

示例

删除一个集群

ibmcloud ks cluster rm --cluster CLUSTER

ibmcloud ks cluster service bind

虚拟私有云 经典基础设施 Satellite

通过将 IBM Cloud 服务实例绑定到 Kubernetes 名称空间,将该服务添加到集群。

ibmcloud ks cluster service bind --cluster CLUSTER --namespace NAMESPACE --service SERVICE [-q] (--key KEY | --role ROLE)

命令选项

-c, --cluster
指定集群名称或标识。
--key
指定现有服务密钥的名称或 GUID。 如果定义了服务密钥,则不能同时设置 --role 选项。
-n, --namespace
指定 Kubernetes 名称空间。
-q
不显示每日消息或更新提示。
--role
为服务密钥指定 IAM 角色。 如果指定使用现有密钥,或对于未启用 IAM 的服务(如 Cloud Foundry 服务)指定现有密钥,那么此标志不起作用。
--service
指定服务实例的名称。 要查看可用服务实例的列表,请运行 ibmcloud service list (适用于 Cloud Foundry 服务),或运行 ibmcloud resource service-instances (适用于已启用 IAM 的服务)。

示例

通过将服务实例绑定到 Kubernetes 命名空间,将一个 IBM Cloud 服务添加到集群中

ibmcloud ks cluster service bind --cluster CLUSTER --namespace NAMESPACE --service SERVICE --key KEY

ibmcloud ks cluster service help

显示帮助

ibmcloud ks cluster service help

示例

显示帮助

ibmcloud ks cluster service help

ibmcloud ks cluster service ls

虚拟私有云 经典基础设施 Satellite

列出绑定到 Kubernetes 名称空间的服务。

ibmcloud ks cluster service ls --cluster CLUSTER [--output OUTPUT] [-q] (--all-namespaces | --namespace NAMESPACE)

命令选项

--all-namespaces
包含所有 Kubernetes 名称空间。
-c, --cluster
指定集群名称或标识。
-n, --namespace
Kubernetes 名称空间。 如果未指定,将使用 default 命名空间。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

列出绑定到 Kubernetes 命名空间的服务

ibmcloud ks cluster service ls --cluster CLUSTER --all-namespaces

ibmcloud ks cluster service unbind

虚拟私有云 经典基础设施 Satellite

通过从 Kubernetes 名称空间取消绑定 IBM Cloud 服务,从集群中移除该服务。

ibmcloud ks cluster service unbind --cluster CLUSTER --namespace NAMESPACE --service SERVICE [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-n, --namespace
指定 Kubernetes 名称空间。
-q
不显示每日消息或更新提示。
--service
指定服务实例的名称。 要查看可用服务实例的列表,请运行 ibmcloud service list (适用于 Cloud Foundry 服务),或运行 ibmcloud resource service-instances (适用于已启用 IAM 的服务)。

示例

通过将其从 Kubernetes 命名空间中解除绑定,将 IBM Cloud 服务从集群中移除

ibmcloud ks cluster service unbind --cluster CLUSTER --namespace NAMESPACE --service SERVICE

ibmcloud ks cluster subnet add

传统基础设施

使 IBM Cloud 基础架构帐户中的现有公共或专用可移植子网可供经典集群使用。

ibmcloud ks cluster subnet add --cluster CLUSTER --subnet-id ID [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--subnet-id
指定子网标识。

示例

将 IBM Cloud 基础设施账户中现有的公共或私有可移植子网提供给经典集群使用

ibmcloud ks cluster subnet add --cluster CLUSTER --subnet-id ID

ibmcloud ks cluster subnet create

传统基础设施

在公共或专用 VLAN 上创建可移植子网并使其可供经典集群使用。

ibmcloud ks cluster subnet create --cluster CLUSTER --size SIZE --vlan VLAN [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--size
指定便携式子网的大小。 大小必须为 8、16、32 或 64 之一。
--vlan
指定公共或专用 VLAN 标识。

示例

在您的公共或私有 VLAN 上创建一个可移植子网,并将其提供给经典集群

ibmcloud ks cluster subnet create --cluster CLUSTER --size SIZE --vlan VLAN

ibmcloud ks cluster subnet detach

传统基础设施

从经典集群中拆离现有的公共或专用可移植子网。

ibmcloud ks cluster subnet detach --cluster CLUSTER --subnet-id ID [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--subnet-id
指定子网标识。

示例

将现有公共或私有便携子网从经典集群中分离

ibmcloud ks cluster subnet detach --cluster CLUSTER --subnet-id ID

ibmcloud ks cluster subnet help

显示帮助

ibmcloud ks cluster subnet help

示例

显示帮助

ibmcloud ks cluster subnet help

凭证命令

设置和取消设置允许您通过 IBM Cloud 帐户访问 IBM Cloud 经典基础架构产品服务组合的凭证。

ibmcloud ks credential get

传统基础设施

如果将 IBM Cloud 帐户设置为使用不同凭证来访问 IBM Cloud 经典基础架构产品服务组合,请获取基础架构用户名。 此命令适用于指定的资源组;如果未指定资源组,则适用于默认资源组。

ibmcloud ks credential get --region REGION [--output OUTPUT] [-q]

别名:ibmcloud ks credentials-get

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--region
指定要设定为目标的区域。

示例

如果您已将 IBM Cloud 账户配置为使用不同的凭据来访问 IBM Cloud 经典基础设施组合,请获取该基础设施的用户名

ibmcloud ks credential get --region REGION

ibmcloud ks credential help

显示帮助

ibmcloud ks credential help

示例

显示帮助

ibmcloud ks credential help

ibmcloud ks credential set classic

传统基础设施

设置允许您通过 IBM Cloud 帐户访问 IBM Cloud 经典基础架构产品服务组合的凭证。

ibmcloud ks credential set classic --infrastructure-api-key KEY --infrastructure-username USERNAME --region REGION [-q]

命令选项

--infrastructure-api-key
IBM Cloud 经典基础架构帐户的 API 密钥。
--infrastructure-username
IBM Cloud 经典基础架构帐户的用户名。
-q
不显示每日消息或更新提示。
--region
指定要设定为目标的区域。

示例

设置凭据,以便您通过 IBM Cloud 账户访问 IBM Cloud 经典基础设施组合

ibmcloud ks credential set classic \
  --infrastructure-api-key KEY \
  --infrastructure-username USERNAME \
  --region REGION

ibmcloud ks credential set help

显示帮助

ibmcloud ks credential set help

示例

显示帮助

ibmcloud ks credential set help

ibmcloud ks credential unset

传统基础设施

移除允许您通过 IBM Cloud 帐户访问 IBM Cloud 经典基础架构产品服务组合的凭证。 此命令适用于指定的资源组;如果未指定资源组,则适用于默认资源组。

ibmcloud ks credential unset --region REGION [-q]

别名:ibmcloud ks credentials-unset

命令选项

-q
不显示每日消息或更新提示。
--region
指定要设定为目标的区域。

示例

删除允许您通过 IBM Cloud 账户访问 IBM Cloud 经典基础设施组合的凭据

ibmcloud ks credential unset --region REGION

实验命令

[有效期至 2026-10-21] 尝试使用新命令。 重要提示:此处的命令将在其描述中指定的[日期]之后失效。

ibmcloud ks experimental help

显示帮助

ibmcloud ks experimental help

示例

显示帮助

ibmcloud ks experimental help

ibmcloud ks experimental trusted-profile default get

[有效期至 2026-10-21] 获取在资源组中创建的集群的默认受信任配置文件。

ibmcloud ks experimental trusted-profile default get --region REGION --resource-group GROUP [--output OUTPUT] [-q]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--region
资源组所在的区域。
--resource-group
要检索其默认受信任配置文件的资源组。

示例

[有效期至 2026-10-21] 获取在资源组中创建的集群的默认受信任配置文件

ibmcloud ks experimental trusted-profile default get --region REGION --resource-group GROUP

ibmcloud ks experimental trusted-profile default help

显示帮助

ibmcloud ks experimental trusted-profile default help

示例

显示帮助

ibmcloud ks experimental trusted-profile default help

ibmcloud ks experimental trusted-profile default set

[有效期至 2026-10-21] 设置在资源组中创建的集群的默认受信任配置文件。

ibmcloud ks experimental trusted-profile default set --region REGION --resource-group GROUP --trusted-profile PROFILE [--output OUTPUT] [-q]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--region
资源组所在的区域。
--resource-group
用于设置受信任配置文件的资源组 ID。
--trusted-profile
受信任的配置文件 ID。

示例

[有效期至 2026-10-21] 为在资源组中创建的集群设置默认受信任配置文件

ibmcloud ks experimental trusted-profile default set \
  --region REGION \
  --resource-group GROUP \
  --trusted-profile PROFILE

ibmcloud ks experimental trusted-profile get

[过期时间:2026-10-21] 获取集群的可信配置文件。

ibmcloud ks experimental trusted-profile get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

--cluster
用于检索受信任配置文件的集群 ID。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

[到期时间:2026-10-21] 获取集群的可信配置文件

ibmcloud ks experimental trusted-profile get --cluster CLUSTER

ibmcloud ks experimental trusted-profile help

显示帮助

ibmcloud ks experimental trusted-profile help

示例

显示帮助

ibmcloud ks experimental trusted-profile help

ibmcloud ks experimental trusted-profile set

[有效期至 2026-10-21] 在集群上设置受信任的配置文件。

ibmcloud ks experimental trusted-profile set --cluster CLUSTER --trusted-profile PROFILE [--output OUTPUT] [-q]

命令选项

--cluster
用于设置受信任配置文件的集群 ID。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--trusted-profile
受信任的配置文件 ID。

示例

[有效期至 2026-10-21] 在集群上设置受信任的配置文件

ibmcloud ks experimental trusted-profile set --cluster CLUSTER --trusted-profile PROFILE

Flavor 命令

正在获取与类型模板相关的信息。 类型将确定可供每个工作程序节点使用的虚拟 CPU、内存和磁盘空间。

ibmcloud ks flavor get

获取区域和提供者的类型模板信息。

ibmcloud ks flavor get --flavor FLAVOR --provider PROVIDER --zone ZONE [--output OUTPUT] [-q]

命令选项

--flavor
工作程序节点的类型模板。 要查看可用的变体,请运行 ibmcloud ks flavor ls --zone <zone name> (适用于 public. IBM Cloud 账户)或 ibmcloud ks flavor ls (适用于 IBM Cloud Dedicated 账户)。
--output
以提供的格式打印命令输出。 接受的值: json
--provider
指定提供程序。 可选选项包括 classicvpc-classicvpc-gen2
-q
不显示每日消息或更新提示。
--zone
指定要列出其可用类型的区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

获取某个区域和提供商的flavor信息

ibmcloud ks flavor get --flavor FLAVOR --provider PROVIDER --zone ZONE

ibmcloud ks flavor help

显示帮助

ibmcloud ks flavor help

示例

显示帮助

ibmcloud ks flavor help

ibmcloud ks flavor ls

列出某个区域的可用类型。

ibmcloud ks flavor ls --zone ZONE [--output OUTPUT] [--provider PROVIDER] [-q] [--show-os] [--show-storage]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
--provider
要获取其特色的提供程序类型。 允许的值:classicvpc-classicvpc-gen2satellite
-q
不显示每日消息或更新提示。
--show-os
列出支持的操作系统。
--show-storage
显示其他存储驱动器。
--zone
指定要列出其可用类型的区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

列出某个区域的可用口味

ibmcloud ks flavor ls --zone ZONE

Infra-permissions 命令

查看有关基础架构许可权的信息,此许可权允许您通过 IBM Cloud 帐户访问 IBM Cloud 经典基础架构产品服务组合。

ibmcloud ks infra-permissions get

传统基础设施

检查允许访问目标资源组的 IBM Cloud 经典基础架构产品服务组合的凭证是否缺少建议或必需的基础架构许可权。 此命令适用于指定的资源组;如果未指定资源组,则适用于默认资源组。

ibmcloud ks infra-permissions get [--output OUTPUT] [-q] [--region REGION]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--region
指定要设定为目标的区域。 如果尚未指定目标区域,则必须指定此参数。 要检查某个区域是否被选中,请运行 ibmcloud target

示例

请检查用于访问目标资源组所属的 IBM Cloud 经典基础设施组合的凭据,是否缺少建议或必需的基础设施权限

ibmcloud ks infra-permissions get

ibmcloud ks infra-permissions help

显示帮助

ibmcloud ks infra-permissions help

示例

显示帮助

ibmcloud ks infra-permissions help

Ingress 命令

查看和修改 Ingress 服务和设置

ibmcloud ks ingress alb autoscale get

虚拟私有云 经典基础设施 Satellite

请参阅入口 ALB 的自动缩放状态和配置。

ibmcloud ks ingress alb autoscale get --alb ALB --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

--alb
ALB 标识。 要查看可用的 ALB ID,请运行 ibmcloud ks ingress alb ls
-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看 Ingress ALB 的自动扩展状态和配置

ibmcloud ks ingress alb autoscale get --alb ALB --cluster CLUSTER

ibmcloud ks ingress alb autoscale help

显示帮助

ibmcloud ks ingress alb autoscale help

示例

显示帮助

ibmcloud ks ingress alb autoscale help

ibmcloud ks ingress alb autoscale set

虚拟私有云 经典基础设施 Satellite

为入口 ALB 配置自动缩放。

ibmcloud ks ingress alb autoscale set --alb ALB --cluster CLUSTER --max-replicas REPLICAS --min-replicas REPLICAS [--output OUTPUT] [-q] (--cpu-average-utilization PERCENT | --custom-metrics-file FILE)

命令选项

--alb
ALB 标识。 要查看可用的 ALB ID,请运行 ibmcloud ks ingress alb ls
-c, --cluster
指定集群名称或标识。
--cpu-average-utilization
平均 CPU 利用率阈值。 用于动态计算副本数。
--custom-metrics-file
定制度量文件的路径。 有关更多详细信息,请参阅 https://ibm.biz/iks-ingress-custom-metrics。
--max-replicas
给定 ALB 的最大副本数。 请确保有足够的工人。
--min-replicas
给定 ALB 的最小副本数。 必须大于或等于 1。 (为了实现高可用性,建议的最小值为 2。)
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

为 Ingress ALB 配置自动缩放

ibmcloud ks ingress alb autoscale set \
  --alb ALB \
  --cluster CLUSTER \
  --max-replicas REPLICAS \
  --min-replicas REPLICAS \
  --cpu-average-utilization PERCENT

ibmcloud ks ingress alb autoscale unset

虚拟私有云 经典基础设施 Satellite

删除入口 ALB 的自动缩放配置。

ibmcloud ks ingress alb autoscale unset --alb ALB --cluster CLUSTER [-q]

命令选项

--alb
ALB 标识。 要查看可用的 ALB ID,请运行 ibmcloud ks ingress alb ls
-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

删除 Ingress ALB 的自动扩展配置

ibmcloud ks ingress alb autoscale unset --alb ALB --cluster CLUSTER

ibmcloud ks ingress alb autoupdate disable

虚拟私有云 经典基础设施 Satellite

禁用集群中所有 Ingress ALB pod 的自动更新。

ibmcloud ks ingress alb autoupdate disable --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

禁用集群中所有 Ingress ALB Pod 的自动更新

ibmcloud ks ingress alb autoupdate disable --cluster CLUSTER

ibmcloud ks ingress alb autoupdate enable

虚拟私有云 经典基础设施 Satellite

启用集群中所有 Ingress ALB pod 的自动更新。

ibmcloud ks ingress alb autoupdate enable --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

启用集群中所有 Ingress ALB Pod 的自动更新

ibmcloud ks ingress alb autoupdate enable --cluster CLUSTER

ibmcloud ks ingress alb autoupdate get

虚拟私有云 经典基础设施 Satellite

查看集群中的 Ingress ALB pod 是否设置为自动更新,以及 ALB pod 是否为最新版本。

ibmcloud ks ingress alb autoupdate get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看集群中的 Ingress ALB Pod 是否设置为自动更新,以及 ALB Pod 是否为最新版本

ibmcloud ks ingress alb autoupdate get --cluster CLUSTER

ibmcloud ks ingress alb autoupdate help

显示帮助

ibmcloud ks ingress alb autoupdate help

示例

显示帮助

ibmcloud ks ingress alb autoupdate help

ibmcloud ks ingress alb create classic

传统基础设施

在经典集群中创建并启用 Ingress ALB。

ibmcloud ks ingress alb create classic --cluster CLUSTER --type TYPE --vlan VLAN --zone ZONE [--ip IP] [-q] [--version VERSION]

命令选项

-c, --cluster
指定集群名称或标识。
--ip
请指定一个可在 vlan 上以及要创建或启用的ALB的 zone 中使用的可移植公共或私有IP地址。
-q
不显示每日消息或更新提示。
--type
指定 ALB 的类型。 可用选项:公开、私有简体中文(大陆)
--version
指定 ALB 镜像版本。 要查看支持的图像版本,请运行 ibmcloud ks ingress alb versions
--vlan
VLAN 标识。 该 VLAN 必须与 ALB 的“type”相匹配,并且必须位于与您要创建的 ALB 相同的“zone”中。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

在经典集群中创建并启用 Ingress ALB

ibmcloud ks ingress alb create classic --cluster CLUSTER --type TYPE --vlan VLAN --zone ZONE

ibmcloud ks ingress alb create help

显示帮助

ibmcloud ks ingress alb create help

示例

显示帮助

ibmcloud ks ingress alb create help

ibmcloud ks ingress alb create vpc-gen2

虚拟私有云

在 VPC 第 2 代集群中创建并启用 Ingress ALB。

ibmcloud ks ingress alb create vpc-gen2 --cluster CLUSTER --type TYPE --zone ZONE [-q] [--version VERSION]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--type
指定 ALB 的类型。 可用选项:公开、私有简体中文(大陆)
--version
指定 ALB 镜像版本。 要查看支持的图像版本,请运行 ibmcloud ks ingress alb versions
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

在 VPC Gen 2 集群中创建并启用 Ingress ALB

ibmcloud ks ingress alb create vpc-gen2 --cluster CLUSTER --type TYPE --zone ZONE

ibmcloud ks ingress alb disable

虚拟私有云 经典基础设施 Satellite

在集群中禁用 Ingress ALB。

ibmcloud ks ingress alb disable --alb ALB --cluster CLUSTER [-q]

命令选项

--alb
ALB 标识。 要查看可用的 ALB ID,请运行 ibmcloud ks ingress alb ls
-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

禁用集群中的 Ingress ALB

ibmcloud ks ingress alb disable --alb ALB --cluster CLUSTER

ibmcloud ks ingress alb enable classic

传统基础设施

在经典集群中启用 Ingress ALB。

ibmcloud ks ingress alb enable classic --alb ALB --cluster CLUSTER [--ip IP] [-q] [--version VERSION]

命令选项

--alb
ALB 标识。 要查看可用的 ALB ID,请运行 ibmcloud ks ingress alb ls
-c, --cluster
指定集群名称或标识。
--ip
请指定一个可在 vlan 上以及要创建或启用的ALB的 zone 中使用的可移植公共或私有IP地址。
-q
不显示每日消息或更新提示。
--version
指定 ALB 镜像版本。 要查看支持的图像版本,请运行 ibmcloud ks ingress alb versions

示例

在经典集群中启用 Ingress ALB

ibmcloud ks ingress alb enable classic --alb ALB --cluster CLUSTER

ibmcloud ks ingress alb enable help

显示帮助

ibmcloud ks ingress alb enable help

示例

显示帮助

ibmcloud ks ingress alb enable help

ibmcloud ks ingress alb enable vpc-gen2

虚拟私有云

在 VPC 第 2 代集群中启用 Ingress ALB。

ibmcloud ks ingress alb enable vpc-gen2 --alb ALB --cluster CLUSTER [-q] [--version VERSION]

命令选项

--alb
ALB 标识。 要查看可用的 ALB ID,请运行 ibmcloud ks ingress alb ls
-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--version
指定 ALB 镜像版本。 要查看支持的图像版本,请运行 ibmcloud ks ingress alb versions

示例

在 VPC Gen 2 集群中启用 Ingress ALB

ibmcloud ks ingress alb enable vpc-gen2 --alb ALB --cluster CLUSTER

ibmcloud ks ingress alb get

虚拟私有云 经典基础设施 Satellite

查看集群中 Ingress ALB 的详细信息。

ibmcloud ks ingress alb get --alb ALB --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

--alb
ALB 标识。 要查看可用的 ALB ID,请运行 ibmcloud ks ingress alb ls
-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看集群中某个 Ingress ALB 的详细信息

ibmcloud ks ingress alb get --alb ALB --cluster CLUSTER

ibmcloud ks ingress alb health-checker disable

虚拟私有云 经典基础设施 Satellite

禁用 Ingress 运行状况检查程序。

ibmcloud ks ingress alb health-checker disable --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

禁用 Ingress 状态检查器

ibmcloud ks ingress alb health-checker disable --cluster CLUSTER

ibmcloud ks ingress alb health-checker enable

虚拟私有云 经典基础设施 Satellite

启用 Ingress 运行状况检查程序。

ibmcloud ks ingress alb health-checker enable --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

启用 Ingress 状态检查器

ibmcloud ks ingress alb health-checker enable --cluster CLUSTER

ibmcloud ks ingress alb health-checker get

虚拟私有云 经典基础设施 Satellite

查看 Ingress 运行状况检查程序的状态。

ibmcloud ks ingress alb health-checker get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看 Ingress 健康检查器的状态

ibmcloud ks ingress alb health-checker get --cluster CLUSTER

ibmcloud ks ingress alb health-checker help

显示帮助

ibmcloud ks ingress alb health-checker help

示例

显示帮助

ibmcloud ks ingress alb health-checker help

ibmcloud ks ingress alb help

显示帮助

ibmcloud ks ingress alb help

示例

显示帮助

ibmcloud ks ingress alb help

ibmcloud ks ingress alb ls

虚拟私有云 经典基础设施 Satellite

列出集群中的所有 Ingress ALB 标识,以及 ALB pod 是否为最新版本。

ibmcloud ks ingress alb ls --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

列出集群中所有 Ingress ALB ID,并说明 ALB Pod 是否为最新版本

ibmcloud ks ingress alb ls --cluster CLUSTER

ibmcloud ks ingress alb update

虚拟私有云 经典基础设施 Satellite

强制针对集群中的个别或所有 ALB 一次性更新 pod。

ibmcloud ks ingress alb update --cluster CLUSTER [--alb ALB ...] [--output OUTPUT] [-q] [--version VERSION]

命令选项

--alb
要更新特定 ALB,请指定 ALB 标识。 要查看可用的 ALB ID,请运行 ibmcloud ks ingress alb ls。 若要更新多个 ALB,请在每个标志中指定一个 ALB ID,例如 --alb ID_1 --alb ID_2。 要更新所有 ALB,请勿包含此标志。
-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--version
指定 ALB 镜像版本。 要查看支持的图像版本,请运行 ibmcloud ks ingress alb versions

示例

强制对集群中单个或所有 ALB 的 Pod 进行一次性更新

ibmcloud ks ingress alb update --cluster CLUSTER

ibmcloud ks ingress alb versions

虚拟私有云 经典基础设施 Satellite

列出可用的 Ingress ALB 镜像版本。

ibmcloud ks ingress alb versions [--output OUTPUT] [-q] [--region REGION]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--region
指定要设定为目标的区域。

示例

列出可用的 Ingress ALB 镜像版本

ibmcloud ks ingress alb versions

ibmcloud ks ingress domain create

为集群创建 Ingress 域。

ibmcloud ks ingress domain create --cluster CLUSTER [--crn CRN] [--domain DOMAIN] [--domain-provider PROVIDER] [--domain-zone ZONE] [--hostname HOSTNAME] [--ip IP] [--is-default] [--output OUTPUT] [-q] [--secret-namespace NAMESPACE]

命令选项

-c, --cluster
指定集群名称或标识。
--crn
IBM CIS 实例的 CRN。
--domain
Ingress 域。 要查看现有域名,请运行 ibmcloud ks ingress domain ls
--domain-provider
DNS 服务提供商。 默认的 DNS 提供商是我们内部的。 有关受支持的提供商,请参阅我们的文档:https://ibm.biz/containers-ingress-domains
--domain-zone
CIS 的 ZoneID。
--hostname
对于 VPC 集群。 要为域注册的主机名。
--ip
要为域注册的 IP 地址。
--is-default
包含此选项以将相关域设置为集群的缺省域。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--secret-namespace
要在其中创建 TLS 私钥的名称空间。

示例

为集群创建一个 Ingress 域

ibmcloud ks ingress domain create --cluster CLUSTER

ibmcloud ks ingress domain default help

显示帮助

ibmcloud ks ingress domain default help

示例

显示帮助

ibmcloud ks ingress domain default help

ibmcloud ks ingress domain default replace

更改集群的缺省 Ingress 域。

ibmcloud ks ingress domain default replace --cluster CLUSTER --domain DOMAIN [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--domain
Ingress 域。 要查看现有域名,请运行 ibmcloud ks ingress domain ls
-q
不显示每日消息或更新提示。

示例

更改集群的默认 Ingress 域

ibmcloud ks ingress domain default replace --cluster CLUSTER --domain DOMAIN

ibmcloud ks ingress domain get

查看 Ingress 域的详细信息。

ibmcloud ks ingress domain get --cluster CLUSTER --domain DOMAIN [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--domain
Ingress 域。 要查看现有域名,请运行 ibmcloud ks ingress domain ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看《Ingress》领地的详细信息

ibmcloud ks ingress domain get --cluster CLUSTER --domain DOMAIN

ibmcloud ks ingress domain help

显示帮助

ibmcloud ks ingress domain help

示例

显示帮助

ibmcloud ks ingress domain help

ibmcloud ks ingress domain ls

列出集群的所有 Ingress 域。

ibmcloud ks ingress domain ls --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

列出某个集群的所有 Ingress 域

ibmcloud ks ingress domain ls --cluster CLUSTER

ibmcloud ks ingress domain rm

从集群中移除 Ingress 域。

ibmcloud ks ingress domain rm --cluster CLUSTER --domain DOMAIN [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--domain
Ingress 域。 要查看现有域名,请运行 ibmcloud ks ingress domain ls
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

从集群中移除一个 Ingress 域

ibmcloud ks ingress domain rm --cluster CLUSTER --domain DOMAIN

ibmcloud ks ingress domain secret help

显示帮助

ibmcloud ks ingress domain secret help

示例

显示帮助

ibmcloud ks ingress domain secret help

ibmcloud ks ingress domain secret regenerate

为 Ingress 域重新生成证书。

ibmcloud ks ingress domain secret regenerate --cluster CLUSTER --domain DOMAIN [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--domain
Ingress 域。 要查看现有域名,请运行 ibmcloud ks ingress domain ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

为 Ingress 域名重新生成证书

ibmcloud ks ingress domain secret regenerate --cluster CLUSTER --domain DOMAIN

ibmcloud ks ingress domain secret rm

删除 Ingress 域的私钥,并阻止将来更新证书。

ibmcloud ks ingress domain secret rm --cluster CLUSTER --domain DOMAIN [-f] [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--domain
Ingress 域。 要查看现有域名,请运行 ibmcloud ks ingress domain ls
-f
强制此命令运行,而不显示用户提示。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

删除 Ingress 域的密钥,并阻止证书在未来续期

ibmcloud ks ingress domain secret rm --cluster CLUSTER --domain DOMAIN

ibmcloud ks ingress domain update

更新集群的 Ingress 域。 传入的记录将完全替换当前与域关联的记录。 如果不传入任何记录,那么将从域中注销当前记录。

ibmcloud ks ingress domain update --cluster CLUSTER --domain DOMAIN [--hostname HOSTNAME] [--ip IP] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--domain
Ingress 域。 要查看现有域名,请运行 ibmcloud ks ingress domain ls
--hostname
对于 VPC 集群。 要为域注册的主机名。
--ip
要为域注册的 IP 地址。
-q
不显示每日消息或更新提示。

示例

更新集群的 Ingress 域

ibmcloud ks ingress domain update --cluster CLUSTER --domain DOMAIN

ibmcloud ks ingress help

显示帮助

ibmcloud ks ingress help

示例

显示帮助

ibmcloud ks ingress help

ibmcloud ks ingress instance default help

显示帮助

ibmcloud ks ingress instance default help

示例

显示帮助

ibmcloud ks ingress instance default help

ibmcloud ks ingress instance default set

虚拟私有云 经典基础设施 Satellite

将已注册的 IBM Cloud Secrets Manager 实例设置为缺省实例。 如果现有缺省实例存在,那么将取消设置该实例。

ibmcloud ks ingress instance default set --cluster CLUSTER --name NAME [-q] [--secret-group GROUP]

命令选项

-c, --cluster
指定集群名称或标识。
--name
已注册的 IBM Cloud Secret Manager 实例的名称。
-q
不显示每日消息或更新提示。
--secret-group
用于持久存储私钥的 IBM Cloud Secret Manager 实例的私钥组标识。

示例

将一个已注册的 IBM Cloud Secrets Manager 实例设置为默认值

ibmcloud ks ingress instance default set --cluster CLUSTER --name NAME

ibmcloud ks ingress instance default unset

虚拟私有云 经典基础设施 Satellite

从缺省值取消设置已注册的 IBM Cloud Secrets Manager 实例。

ibmcloud ks ingress instance default unset --cluster CLUSTER --name NAME [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--name
已注册的 IBM Cloud Secret Manager 实例的名称。
-q
不显示每日消息或更新提示。

示例

将已注册的 IBM Cloud Secrets Manager 实例从默认设置中移除

ibmcloud ks ingress instance default unset --cluster CLUSTER --name NAME

ibmcloud ks ingress instance get

虚拟私有云 经典基础设施 Satellite

查看已注册到集群的 IBM Cloud Secrets Manager 实例的详细信息。

ibmcloud ks ingress instance get --cluster CLUSTER --name NAME [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--name
已注册的 IBM Cloud Secret Manager 实例的名称。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看注册到某个集群的 IBM Cloud Secrets Manager 实例的详细信息

ibmcloud ks ingress instance get --cluster CLUSTER --name NAME

ibmcloud ks ingress instance help

显示帮助

ibmcloud ks ingress instance help

示例

显示帮助

ibmcloud ks ingress instance help

ibmcloud ks ingress instance ls

虚拟私有云 经典基础设施 Satellite

列出已注册到某个集群的 IBM Cloud Secrets Manager 实例。

ibmcloud ks ingress instance ls --cluster CLUSTER [--output OUTPUT] [-q] [--show-deleted]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--show-deleted
显示已从集群注销的 IBM Cloud Secret Manager 实例。

示例

列出已注册到某个集群的 IBM Cloud Secrets Manager 实例

ibmcloud ks ingress instance ls --cluster CLUSTER

ibmcloud ks ingress instance register

虚拟私有云 经典基础设施 Satellite

将 IBM Cloud Secrets Manager 实例注册到集群。

ibmcloud ks ingress instance register --cluster CLUSTER --crn CRN [--is-default] [-q] [--secret-group GROUP]

命令选项

-c, --cluster
指定集群名称或标识。
--crn
IBM Cloud Secret Manager 实例的 CRN。
--is-default
将 IBM Cloud Secrets Manager 实例设置为缺省实例。 如果现有缺省实例存在,那么将取消设置该实例。
-q
不显示每日消息或更新提示。
--secret-group
用于持久存储私钥的 IBM Cloud Secret Manager 实例的私钥组标识。

示例

将一个 IBM Cloud Secrets Manager 实例注册到集群中

ibmcloud ks ingress instance register --cluster CLUSTER --crn CRN

ibmcloud ks ingress instance unregister

虚拟私有云 经典基础设施 Satellite

从集群中取消注册 IBM Cloud Secrets Manager 实例。

ibmcloud ks ingress instance unregister --cluster CLUSTER --name NAME [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--name
已注册的 IBM Cloud Secret Manager 实例的名称。
-q
不显示每日消息或更新提示。

示例

从集群中注销 IBM Cloud Secrets Manager 实例

ibmcloud ks ingress instance unregister --cluster CLUSTER --name NAME

ibmcloud ks ingress load-balancer backend help

显示帮助

ibmcloud ks ingress load-balancer backend help

示例

显示帮助

ibmcloud ks ingress load-balancer backend help

ibmcloud ks ingress load-balancer backend set

虚拟私有云

为暴露集群 Ingress 控制器的 VPC ALB 负载均衡器设置私有和/或公共后端。

ibmcloud ks ingress load-balancer backend set --cluster CLUSTER [--private-backend BACKEND] [--public-backend BACKEND] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--private-backend
私有负载均衡器的后端
--public-backend
公共负载均衡器的后端
-q
不显示每日消息或更新提示。

示例

为暴露集群 Ingress 控制器的 VPC ALB 负载均衡器设置私有和/或公共后端

ibmcloud ks ingress load-balancer backend set --cluster CLUSTER

ibmcloud ks ingress load-balancer get

虚拟私有云 传统基础设施

获取在集群中公开 Ingress ALB 的负载均衡器的配置。

ibmcloud ks ingress load-balancer get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

获取集群中公开 Ingress ALB 的负载均衡器的配置

ibmcloud ks ingress load-balancer get --cluster CLUSTER

ibmcloud ks ingress load-balancer help

显示帮助

ibmcloud ks ingress load-balancer help

示例

显示帮助

ibmcloud ks ingress load-balancer help

ibmcloud ks ingress load-balancer proxy-protocol disable

虚拟私有云

在 Ingress ALB 上禁用 PROXY 协议。

ibmcloud ks ingress load-balancer proxy-protocol disable --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

在 Ingress ALB 上禁用 PROXY 协议

ibmcloud ks ingress load-balancer proxy-protocol disable --cluster CLUSTER

ibmcloud ks ingress load-balancer proxy-protocol enable

虚拟私有云

启用 PROXY 协议,以便将请求头中的客户机连接信息传递到 ALB。

ibmcloud ks ingress load-balancer proxy-protocol enable --cluster CLUSTER [--cidr CIDR ...] [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--cidr
负载均衡器的 IP 地址范围采用 CIDR 格式。 不会处理其他 IP 地址范围内的负载均衡器转发的 PROXY 头。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

启用 PROXY 协议,以便将客户端连接信息通过请求头传递给 ALB

ibmcloud ks ingress load-balancer proxy-protocol enable --cluster CLUSTER

ibmcloud ks ingress load-balancer proxy-protocol help

显示帮助

ibmcloud ks ingress load-balancer proxy-protocol help

示例

显示帮助

ibmcloud ks ingress load-balancer proxy-protocol help

ibmcloud ks ingress secret create

虚拟私有云 经典基础设施 Satellite

在集群中为存储在 IBM Cloud Secret Manager 中的密钥创建 Ingress 密钥。

ibmcloud ks ingress secret create --cluster CLUSTER --name NAME [--cert-crn CRN] [--field FIELD] [--namespace NAMESPACE] [--persist] [-q] [--type TYPE]

命令选项

-c, --cluster
指定集群名称或标识。
--cert-crn
证书 CRN。
--field
要包含为字段的私钥 CRN。 若要拉取该私有仓库而不指定名称,请使用 --field <crn>。 要指定字段名称,请使用 --field name=<crn>。 若要将 IBM Cloud Secrets Manager 密钥用作前缀,请使用 --field prefix=<crn>
-n, --namespace
指定 Kubernetes 名称空间。
--name
在集群中创建的 Ingress 密钥的名称。
--persist
将密钥持久存储在集群中,以便无法将其删除。
-q
不显示每日消息或更新提示。
--type
Ingress 密钥类型。 可以为 TLS 或 Opaque。 如果未指定任何选项,那么缺省情况下会应用 TLS。

示例

在集群中为存储在 IBM Cloud 密钥管理器中的密钥创建一个Ingress密钥

ibmcloud ks ingress secret create --cluster CLUSTER --name NAME

ibmcloud ks ingress secret field add

虚拟私有云 经典基础设施 Satellite

将字段添加到现有 Ingress 密钥。

ibmcloud ks ingress secret field add --cluster CLUSTER --name NAME --namespace NAMESPACE [--field FIELD] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--field
要包含为字段的私钥 CRN。 若要拉取该私有仓库而不指定名称,请使用 --field <crn>。 要指定字段名称,请使用 --field name=<crn>。 若要将 IBM Cloud Secrets Manager 密钥用作前缀,请使用 --field prefix=<crn>
-n, --namespace
指定 Kubernetes 名称空间。
--name
在集群中创建的 Ingress 密钥的名称。
-q
不显示每日消息或更新提示。

示例

向现有的 Ingress 密钥添加字段

ibmcloud ks ingress secret field add --cluster CLUSTER --name NAME --namespace NAMESPACE

ibmcloud ks ingress secret field help

显示帮助

ibmcloud ks ingress secret field help

示例

显示帮助

ibmcloud ks ingress secret field help

ibmcloud ks ingress secret field ls

虚拟私有云 经典基础设施 Satellite

查看 Ingress 密钥的字段。

ibmcloud ks ingress secret field ls --cluster CLUSTER --name NAME --namespace NAMESPACE [--output OUTPUT] [-q] [--show-crn]

命令选项

-c, --cluster
指定集群名称或标识。
-n, --namespace
指定 Kubernetes 名称空间。
--name
在集群中创建的 Ingress 密钥的名称。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--show-crn
显示密钥的 CRN 值。

示例

查看 Ingress 密钥的字段

ibmcloud ks ingress secret field ls --cluster CLUSTER --name NAME --namespace NAMESPACE

ibmcloud ks ingress secret field rm

虚拟私有云 经典基础设施 Satellite

从现有 Ingress 密钥中移除字段。

ibmcloud ks ingress secret field rm --cluster CLUSTER --name NAME --namespace NAMESPACE [--field-name NAME] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--field-name
要从私钥中移除的字段的名称。
-n, --namespace
指定 Kubernetes 名称空间。
--name
在集群中创建的 Ingress 密钥的名称。
-q
不显示每日消息或更新提示。

示例

从现有的 Ingress 密钥中删除字段

ibmcloud ks ingress secret field rm --cluster CLUSTER --name NAME --namespace NAMESPACE

ibmcloud ks ingress secret get

虚拟私有云 经典基础设施 Satellite

查看 Ingress 密钥的详细信息。

ibmcloud ks ingress secret get --cluster CLUSTER --name NAME --namespace NAMESPACE [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-n, --namespace
指定 Kubernetes 名称空间。
--name
在集群中创建的 Ingress 密钥的名称。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看《Ingress》秘密的详细信息

ibmcloud ks ingress secret get --cluster CLUSTER --name NAME --namespace NAMESPACE

ibmcloud ks ingress secret help

显示帮助

ibmcloud ks ingress secret help

示例

显示帮助

ibmcloud ks ingress secret help

ibmcloud ks ingress secret ls

虚拟私有云 经典基础设施 Satellite

列出集群中的所有 Ingress 密钥。

ibmcloud ks ingress secret ls --cluster CLUSTER [--output OUTPUT] [-q] [--show-crn] [--show-deleted]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--show-crn
显示密钥的 CRN 值。
--show-deleted
显示已从集群中删除的私钥。

示例

列出集群中的所有 Ingress 秘密

ibmcloud ks ingress secret ls --cluster CLUSTER

ibmcloud ks ingress secret rm

虚拟私有云 经典基础设施 Satellite

从集群中移除 Ingress 密钥。

ibmcloud ks ingress secret rm --cluster CLUSTER --name NAME --namespace NAMESPACE [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-n, --namespace
指定 Kubernetes 名称空间。
--name
在集群中创建的 Ingress 密钥的名称。
-q
不显示每日消息或更新提示。

示例

从集群中删除一个 Ingress 密钥

ibmcloud ks ingress secret rm --cluster CLUSTER --name NAME --namespace NAMESPACE

ibmcloud ks ingress secret update

虚拟私有云 经典基础设施 Satellite

更新现有的 Ingress 密钥。

ibmcloud ks ingress secret update --cluster CLUSTER --name NAME --namespace NAMESPACE [--cert-crn CRN] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--cert-crn
证书 CRN。
-n, --namespace
指定 Kubernetes 名称空间。
--name
在集群中创建的 Ingress 密钥的名称。
-q
不显示每日消息或更新提示。

示例

更新现有的 Ingress 密钥

ibmcloud ks ingress secret update --cluster CLUSTER --name NAME --namespace NAMESPACE

ibmcloud ks ingress security help

显示帮助

ibmcloud ks ingress security help

示例

显示帮助

ibmcloud ks ingress security help

ibmcloud ks ingress security port80 disable

请在您的集群中禁用端口 80。

ibmcloud ks ingress security port80 disable --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

在您的集群中禁用端口 80

ibmcloud ks ingress security port80 disable --cluster CLUSTER

ibmcloud ks ingress security port80 enable

在您的集群中启用端口 80。

ibmcloud ks ingress security port80 enable --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

在您的集群中启用端口 80

ibmcloud ks ingress security port80 enable --cluster CLUSTER

ibmcloud ks ingress security port80 get

获取集群中 80 端口的安全配置。

ibmcloud ks ingress security port80 get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

获取集群中端口 80 的安全配置

ibmcloud ks ingress security port80 get --cluster CLUSTER

ibmcloud ks ingress security port80 help

显示帮助

ibmcloud ks ingress security port80 help

示例

显示帮助

ibmcloud ks ingress security port80 help

ibmcloud ks ingress status-report disable

虚拟私有云 经典基础设施 Satellite

禁用集群中的 Ingress 组件状态报告。

ibmcloud ks ingress status-report disable --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

禁用集群中 Ingress 组件的状态报告

ibmcloud ks ingress status-report disable --cluster CLUSTER

ibmcloud ks ingress status-report enable

虚拟私有云 经典基础设施 Satellite

启用集群中的 Ingress 组件状态报告。

ibmcloud ks ingress status-report enable --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

为集群中的 Ingress 组件启用状态报告

ibmcloud ks ingress status-report enable --cluster CLUSTER

ibmcloud ks ingress status-report get

虚拟私有云 经典基础设施 Satellite

获取集群中的 Ingress 组件状态报告。

ibmcloud ks ingress status-report get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

获取集群中 Ingress 组件的状态报告

ibmcloud ks ingress status-report get --cluster CLUSTER

ibmcloud ks ingress status-report help

显示帮助

ibmcloud ks ingress status-report help

示例

显示帮助

ibmcloud ks ingress status-report help

ibmcloud ks ingress status-report ignored-errors add

虚拟私有云 经典基础设施 Satellite

抑制某个集群的 Ingress 状态报告中的警告。

ibmcloud ks ingress status-report ignored-errors add --cluster CLUSTER --code CODE [--code CODE ...] [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--code
要忽略的警告的代码。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

抑制集群的 Ingress 状态报告中的警告

ibmcloud ks ingress status-report ignored-errors add --cluster CLUSTER --code CODE

ibmcloud ks ingress status-report ignored-errors help

显示帮助

ibmcloud ks ingress status-report ignored-errors help

示例

显示帮助

ibmcloud ks ingress status-report ignored-errors help

ibmcloud ks ingress status-report ignored-errors ls

虚拟私有云 经典基础设施 Satellite

列出集群的 Ingress 状态当前忽略的警告。

ibmcloud ks ingress status-report ignored-errors ls --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

列出当前被集群的 Ingress 状态忽略的警告

ibmcloud ks ingress status-report ignored-errors ls --cluster CLUSTER

ibmcloud ks ingress status-report ignored-errors rm

虚拟私有云 经典基础设施 Satellite

除去集群的 Ingress 状态当前忽略的警告。

ibmcloud ks ingress status-report ignored-errors rm --cluster CLUSTER --code CODE [--code CODE ...] [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--code
要除去的警告的代码。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

删除当前被集群的 Ingress 状态忽略的警告

ibmcloud ks ingress status-report ignored-errors rm --cluster CLUSTER --code CODE

Kms 命令

查看和配置密钥管理服务集成。

ibmcloud ks kms crk help

显示帮助

ibmcloud ks kms crk help

示例

显示帮助

ibmcloud ks kms crk help

ibmcloud ks kms crk ls

虚拟私有云 经典基础设施 Satellite

列出密钥管理服务实例的可用根密钥。

ibmcloud ks kms crk ls --instance-id ID [--output OUTPUT] [-q]

命令选项

--instance-id
KMS 实例标识。 要查看可用的 KMS 实例,请运行 ibmcloud ks kms instance ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

列出某个密钥管理服务实例的可用根密钥

ibmcloud ks kms crk ls --instance-id ID

ibmcloud ks kms enable

虚拟私有云 经典基础设施 Satellite

在集群中启用密钥管理服务 (KMS) 以加密密钥。

ibmcloud ks kms enable --cluster CLUSTER --crk CRK --instance-id ID [--kms-account-id ID] [--public-endpoint] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--crk
KMS 实例中的根密钥标识。 要列出可用的根密钥,请运行 ibmcloud ks kms crk ls --instance-id <kms_instance>
--instance-id
KMS 实例标识。 要查看可用的 KMS 实例,请运行 ibmcloud ks kms instance ls
--kms-account-id
包含要用于本地磁盘或私钥加密的 KMS 实例的帐户的标识。
--public-endpoint
指定此选项以使用 KMS 公共服务端点。 否则,将使用 KMS 专用服务端点。
-q
不显示每日消息或更新提示。

示例

在集群中启用密钥管理服务(KMS)以对密钥进行加密

ibmcloud ks kms enable --cluster CLUSTER --crk CRK --instance-id ID

ibmcloud ks kms help

显示帮助

ibmcloud ks kms help

示例

显示帮助

ibmcloud ks kms help

ibmcloud ks kms instance help

显示帮助

ibmcloud ks kms instance help

示例

显示帮助

ibmcloud ks kms instance help

ibmcloud ks kms instance ls

虚拟私有云 经典基础设施 Satellite

列出可用的密钥管理服务实例。

ibmcloud ks kms instance ls [--output OUTPUT] [-q]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

列出可用的密钥管理服务实例

ibmcloud ks kms instance ls

位置命令

列出受支持的 IBM Cloud Kubernetes Service 位置。

ibmcloud ks locations

列出受支持的 IBM Cloud Kubernetes Service 位置。

ibmcloud ks locations

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
--provider
过滤特定基础架构提供程序的列表。 允许的值:classicvpc-classicvpc-gen2satellite
-q
不显示每日消息或更新提示。
--show-flavors
在 VPC 的区域中显示可用的工作程序节点特色。

示例

列出支持的 IBM Cloud Kubernetes Service 地点

ibmcloud ks locations

日志记录命令

从集群转发日志。

ibmcloud ks logging autoupdate disable

虚拟私有云 传统基础设施

禁用集群中所有 Fluentd pod 的自动更新。

ibmcloud ks logging autoupdate disable --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

禁用集群中所有 Fluentd Pod的自动更新

ibmcloud ks logging autoupdate disable --cluster CLUSTER

ibmcloud ks logging autoupdate enable

虚拟私有云 传统基础设施

启用集群中所有 Fluentd 仓的自动更新。

ibmcloud ks logging autoupdate enable --cluster CLUSTER [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。

示例

启用集群中所有 Fluentd Pod的自动更新

ibmcloud ks logging autoupdate enable --cluster CLUSTER

ibmcloud ks logging autoupdate get

虚拟私有云 传统基础设施

查看 Fluentd pod 是否设置为在集群中自动更新。

ibmcloud ks logging autoupdate get --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看集群中您的 Fluentd Pod是否已设置为自动更新

ibmcloud ks logging autoupdate get --cluster CLUSTER

ibmcloud ks logging autoupdate help

显示帮助

ibmcloud ks logging autoupdate help

示例

显示帮助

ibmcloud ks logging autoupdate help

ibmcloud ks logging config create

虚拟私有云 传统基础设施

创建日志记录配置。 如果您使用的是专用账户,则必须登录到公共端点 IBM Cloud,并将目标设置为您的公共组织和空间,才能启用日志转发功能。

ibmcloud ks logging config create --cluster CLUSTER --logsource LOGSOURCE --type TYPE [--force-update] [--hostname HOSTNAME] [--output OUTPUT] [--port PORT] [-q] (--ca-cert CERT --syslog-protocol PROTOCOL --verify-mode MODE | --org ORG --skip-validation --space SPACE) (--namespace NAMESPACE | -C CONTAINER -p PATH)

命令选项

-C, --app-container
指定要为其收集日志的容器。 若要指定多个路径,请使用多个标志,例如 -C container1 -C container2。 此选项是 application 日志源的必填项。 如果未提供,那么将从传递的应用程序日志路径中的所有容器收集日志。
-c, --cluster
指定集群名称或标识。
--ca-cert
当日志类型为“syslog”且协议为“tls”时,包含证书颁发机构证书的 Kubernetes 密钥名称。
--force-update
强制将集群中的 Fluentd 仓更新到最新版本。
--hostname
当日志类型为 syslog 时,日志收集器的主机名或IP地址。 当日志类型为 ibm (已弃用)时,日志采集端点。 如果不提供日志记录采集端点,那么将使用当前区域的端点。
--logsource
要转发的日志源。 支持的值包括:containerapplicationingressworkerstorage 以及 kubernetes。 此自变量支持日志源的逗号分隔列表。 如果您未指定日志源,则会转发 containeringress 的日志。
-n, --namespace
想要应用到日志转发配置的名称空间。 仅在与 container 日志源配合使用时,或者未指定日志源的情况下,才应使用此标志。 如果不指定名称空间,那么所有名称空间都使用此配置。
--org
已弃用 用于发送日志的组织名称。 只有当日志类型为 ibm 时,此标志才有效。 指定空间名称时,组织名称是必需的。 如果不指定空间名称,那么将在帐户级别转发日志。
--output
以提供的格式打印命令输出。 接受的值: json
-p, --app-path
指定绝对文件路径,以便从容器内部收集日志。 若要指定多个路径,请使用多个标志,例如 -p path1 -p path2。 在为日志源指定 application 时,此参数为必填项。 允许使用诸如 /var/log/*.log 这样的通配符,但不允许使用诸如 /var/log/**/test.log 这样的递归通配符。
--port
日志收集器的端口。 如果您未指定端口,则数据导入端点的默认端口为 ibm (已弃用),而 syslog 则使用 514
-q
不显示每日消息或更新提示。
--skip-validation
指定组织和空间名称时跳过对它们的验证。 如果值无效,那么这可能会导致日志记录配置中断,但将花费较少的时间来处理。
--space
已弃用:用于发送日志的空间名称。 只有当日志类型为 ibm 时,此标志才有效。 指定组织名称时,空间名称是必需的。 如果不指定空间名称,那么将在帐户级别转发日志。
--syslog-protocol
当日志类型为 syslog 时,传输层协议。 支持的值包括 tlstcp 以及默认值 udp。 当使用 UDP 协议转发到 rsyslog 服务器时,将截断大小超过 1KB 的日志。
--type
您要使用的日志转发协议。 唯一支持的值是 syslog
--verify-mode
当日志类型为 syslog 且协议为tls时,验证模式。 支持的值包括 verify-peer,默认值为 verify-none

示例

创建日志配置

ibmcloud ks logging config create \
  --cluster CLUSTER \
  --logsource LOGSOURCE \
  --type TYPE \
  --ca-cert CERT \
  --syslog-protocol PROTOCOL \
  --verify-mode MODE \
  --namespace NAMESPACE

ibmcloud ks logging config get

虚拟私有云 传统基础设施

查看集群的日志转发配置。

ibmcloud ks logging config get --cluster CLUSTER [--logsource LOGSOURCE] [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--logsource
要过滤的日志源的类型。 允许的值包括:containerapplicationingressworkerstoragekubernetes。 如果未传入日志源,则会返回该集群的所有日志配置。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看集群的日志转发配置

ibmcloud ks logging config get --cluster CLUSTER

ibmcloud ks logging config help

显示帮助

ibmcloud ks logging config help

示例

显示帮助

ibmcloud ks logging config help

ibmcloud ks logging config rm

虚拟私有云 传统基础设施

从集群中删除日志转发配置。

ibmcloud ks logging config rm --cluster CLUSTER [--force-update] [-q] (--all | --id ID | --namespace NAMESPACE)

命令选项

--all
移除所有日志转发配置。
-c, --cluster
指定集群名称或标识。
--force-update
强制将集群中的 Fluentd 仓更新到最新版本。
--id
指定日志记录配置的标识。
-n, --namespace
要从中除去日志转发配置的名称空间。 如果同一个命名空间有多个配置,请改用 --id <logging configuration ID> 标志。
-q
不显示每日消息或更新提示。

示例

从集群中删除日志转发配置

ibmcloud ks logging config rm --cluster CLUSTER --all

ibmcloud ks logging config update

虚拟私有云 传统基础设施

更新集群的日志转发配置。

ibmcloud ks logging config update --cluster CLUSTER --id ID --logsource LOGSOURCE --type TYPE [--force-update] [--hostname HOSTNAME] [--output OUTPUT] [--port PORT] [-q] (--ca-cert CERT --syslog-protocol PROTOCOL --verify-mode MODE | --org ORG --skip-validation --space SPACE) (--namespace NAMESPACE | -C CONTAINER -p PATH)

命令选项

-C, --app-container
指定要为其收集日志的容器。 若要指定多个路径,请使用多个标志,例如 -C container1 -C container2。 此选项是 application 日志源的必填项。 如果未提供,那么将从传递的应用程序日志路径中的所有容器收集日志。
-c, --cluster
指定集群名称或标识。
--ca-cert
当日志类型为“syslog”且协议为“tls”时,包含证书颁发机构证书的 Kubernetes 密钥名称。
--force-update
强制将集群中的 Fluentd 仓更新到最新版本。
--hostname
当日志类型为 syslog 时,日志收集器的主机名或IP地址。 当日志类型为 ibm (已弃用)时,日志采集端点。 如果不提供日志记录采集端点,那么将使用当前区域的端点。
--id
指定日志记录配置的标识。
--logsource
要转发的日志源。 支持的值包括:containerapplicationingressworkerstorage 以及 kubernetes。 此自变量支持日志源的逗号分隔列表。 如果您未指定日志源,则会转发 containeringress 的日志。
-n, --namespace
想要应用到日志转发配置的名称空间。 仅在与 container 日志源配合使用时,或者未指定日志源的情况下,才应使用此标志。 如果不指定名称空间,那么所有名称空间都使用此配置。
--org
已弃用 用于发送日志的组织名称。 只有当日志类型为 ibm 时,此标志才有效。 指定空间名称时,组织名称是必需的。 如果不指定空间名称,那么将在帐户级别转发日志。
--output
以提供的格式打印命令输出。 接受的值: json
-p, --app-path
指定绝对文件路径,以便从容器内部收集日志。 若要指定多个路径,请使用多个标志,例如 -p path1 -p path2。 在为日志源指定 application 时,此参数为必填项。 允许使用诸如 /var/log/*.log 这样的通配符,但不允许使用诸如 /var/log/**/test.log 这样的递归通配符。
--port
日志收集器的端口。 如果您未指定端口,则数据导入端点的默认端口为 ibm (已弃用),而 syslog 则使用 514
-q
不显示每日消息或更新提示。
--skip-validation
指定组织和空间名称时跳过对它们的验证。 如果值无效,那么这可能会导致日志记录配置中断,但将花费较少的时间来处理。
--space
已弃用:用于发送日志的空间名称。 只有当日志类型为 ibm 时,此标志才有效。 指定组织名称时,空间名称是必需的。 如果不指定空间名称,那么将在帐户级别转发日志。
--syslog-protocol
当日志类型为 syslog 时,传输层协议。 支持的值包括 tlstcp 以及默认值 udp。 当使用 UDP 协议转发到 rsyslog 服务器时,将截断大小超过 1KB 的日志。
--type
您要使用的日志转发协议。 唯一支持的值是 syslog
--verify-mode
当日志类型为 syslog 且协议为tls时,验证模式。 支持的值包括 verify-peer,默认值为 verify-none

示例

更新集群的日志转发配置

ibmcloud ks logging config update \
  --cluster CLUSTER \
  --id ID \
  --logsource LOGSOURCE \
  --type TYPE \
  --ca-cert CERT \
  --syslog-protocol PROTOCOL \
  --verify-mode MODE \
  --namespace NAMESPACE

ibmcloud ks logging filter create

虚拟私有云 传统基础设施

创建一个过滤器,以排除某些日志行,使其不被转发。

ibmcloud ks logging filter create --cluster CLUSTER [--container CONTAINER] [--force-update] [--lc LOGGING-CONFIG ...] [--level LEVEL] [--namespace NAMESPACE] [--output OUTPUT] [-q] [--type TYPE] (--message MESSAGE | --regex-message MESSAGE)

命令选项

-c, --cluster
指定集群名称或标识。
--container
要从中过滤掉日志的容器的名称。 仅当使用日志类型容器时,该标志才适用。
--force-update
强制将集群中的 Fluentd 仓更新到最新版本。
--lc, --logging-config
日志记录配置标识。 如果未提供,则该过滤器将应用于传递给该过滤器的所有集群日志配置。 可使用 --show-matching-configs 标志以及该命令来查看与过滤器匹配的日志配置。
--level
过滤掉处于指定级别及更低级别的日志。 可接收的值按规范次序依次为致命、错误、警告、参考、调试和跟踪。 例如,如果过滤掉参考级别的日志,那么还将过滤掉调试和跟踪级别的日志。 :仅当日志消息为 JSON 格式且包含 level 字段时,才能使用此标志。 输出示例:{"log": "hello", "level": "info"}
--message
过滤掉在日志中任何位置包含指定消息的任何日志。 消息按字面值进行匹配,而不作为表达式进行匹配。 示例:消息“Hello”、“!”和“Hello, World!”将匹配日志“Hello, World!”。
-n, --namespace
要从中过滤日志的 Kubernetes 名称空间。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--regex-message
过滤出在日志中包含指定消息正则表达式模式的任何日志。 消息以正则表达式形式进行匹配。 示例:模式“hello [0-9]”将匹配“hello 1”、“hello 2”和“hello 9”
--type
要应用过滤器的日志的类型。 当前,支持所有容器和主机。

示例

创建一个过滤器,以排除不需转发的日志行

ibmcloud ks logging filter create --cluster CLUSTER --message MESSAGE

ibmcloud ks logging filter get

虚拟私有云 传统基础设施

查看日志记录过滤器配置。

ibmcloud ks logging filter get --cluster CLUSTER [--id ID] [--output OUTPUT] [-q] [--show-covering-filters] [--show-matching-configs]

命令选项

-c, --cluster
指定集群名称或标识。
--id
指定日志记录过滤器的标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--show-covering-filters
显示导致先前过滤器过时的日志记录过滤器。
--show-matching-configs
显示与要查看的配置相匹配的日志记录配置。

示例

查看日志过滤器配置

ibmcloud ks logging filter get --cluster CLUSTER

ibmcloud ks logging filter help

显示帮助

ibmcloud ks logging filter help

示例

显示帮助

ibmcloud ks logging filter help

ibmcloud ks logging filter rm

虚拟私有云 传统基础设施

删除日志记录过滤器。

ibmcloud ks logging filter rm --cluster CLUSTER [--force-update] [-q] (--all | --id ID)

命令选项

--all
删除所有日志转发过滤器。
-c, --cluster
指定集群名称或标识。
--force-update
强制将集群中的 Fluentd 仓更新到最新版本。
--id
指定日志记录过滤器的标识。
-q
不显示每日消息或更新提示。

示例

删除日志过滤器

ibmcloud ks logging filter rm --cluster CLUSTER --all

ibmcloud ks logging filter update

虚拟私有云 传统基础设施

更新日志记录过滤器。

ibmcloud ks logging filter update --cluster CLUSTER --id ID [--container CONTAINER] [--force-update] [--lc LOGGING-CONFIG ...] [--level LEVEL] [--namespace NAMESPACE] [--output OUTPUT] [-q] [--type TYPE] (--message MESSAGE | --regex-message MESSAGE)

命令选项

-c, --cluster
指定集群名称或标识。
--container
要从中过滤掉日志的容器的名称。 仅当使用日志类型容器时,该标志才适用。
--force-update
强制将集群中的 Fluentd 仓更新到最新版本。
--id
指定日志记录过滤器的标识。
--lc, --logging-config
日志记录配置标识。 如果未提供,则该过滤器将应用于传递给该过滤器的所有集群日志配置。 可使用 --show-matching-configs 标志以及该命令来查看与过滤器匹配的日志配置。
--level
过滤掉处于指定级别及更低级别的日志。 可接收的值按规范次序依次为致命、错误、警告、参考、调试和跟踪。 例如,如果过滤掉参考级别的日志,那么还将过滤掉调试和跟踪级别的日志。 :仅当日志消息为 JSON 格式且包含 level 字段时,才能使用此标志。 输出示例:{"log": "hello", "level": "info"}
--message
过滤掉在日志中任何位置包含指定消息的任何日志。 消息按字面值进行匹配,而不作为表达式进行匹配。 示例:消息“Hello”、“!”和“Hello, World!”将匹配日志“Hello, World!”。
-n, --namespace
要从中过滤日志的 Kubernetes 名称空间。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--regex-message
过滤出在日志中包含指定消息正则表达式模式的任何日志。 消息以正则表达式形式进行匹配。 示例:模式“hello [0-9]”将匹配“hello 1”、“hello 2”和“hello 9”
--type
要应用过滤器的日志的类型。 当前,支持所有容器和主机。

示例

更新日志过滤器

ibmcloud ks logging filter update --cluster CLUSTER --id ID --message MESSAGE

ibmcloud ks logging help

显示帮助

ibmcloud ks logging help

示例

显示帮助

ibmcloud ks logging help

ibmcloud ks logging refresh

虚拟私有云 传统基础设施

刷新集群的日志记录配置。

ibmcloud ks logging refresh --cluster CLUSTER [--force-update] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--force-update
强制将集群中的 Fluentd 仓更新到最新版本。
-q
不显示每日消息或更新提示。

示例

刷新集群的日志配置

ibmcloud ks logging refresh --cluster CLUSTER

消息命令

查看当前用户消息。

ibmcloud ks messages

查看当前用户消息。

ibmcloud ks messages [-q]

命令选项

-q
不显示每日消息或更新提示。

示例

查看当前用户的消息

ibmcloud ks messages

Nlb-dns 命令

在集群中创建并管理网络负载均衡器 (NLB) IP 地址的主机名,并管理主机名的运行状况检查监视器。

ibmcloud ks nlb-dns add

传统基础设施

将一个 NLB IP 地址添加到您使用 ibmcloud ks nlb-dns create 创建的现有主机名中。

ibmcloud ks nlb-dns add --cluster CLUSTER --ip IP [--ip IP ...] --nlb-host HOST [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--ip
一个或多个 NLB IP 地址。 要查看负载均衡器的 IP 地址,请运行 kubectl get svc -n <namespace>
--nlb-host
主机名。 要查看现有的主机名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

将一个 NLB IP 地址添加到您使用以下命令创建的现有主机名中:ibmcloud ks nlb-dns create

ibmcloud ks nlb-dns add --cluster CLUSTER --ip IP --nlb-host HOST

ibmcloud ks nlb-dns create classic

传统基础设施

创建 DNS 主机名以在经典集群中注册一个或多个 NLB IP。

ibmcloud ks nlb-dns create classic --cluster CLUSTER --ip IP [--ip IP ...] [--output OUTPUT] [-q] [--secret-namespace NAMESPACE]

命令选项

-c, --cluster
指定集群名称或标识。
--ip
一个或多个 NLB IP 地址。 要查看负载均衡器的 IP 地址,请运行 kubectl get svc -n <namespace>
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--secret-namespace
要在其中创建 SSL 密钥的名称空间。 如果未指定此标志,则密钥将创建在 default.

示例

创建一个 DNS 主机名,用于在经典集群中注册一个或多个 NLB IP 地址

ibmcloud ks nlb-dns create classic --cluster CLUSTER --ip IP

ibmcloud ks nlb-dns create help

显示帮助

ibmcloud ks nlb-dns create help

示例

显示帮助

ibmcloud ks nlb-dns create help

ibmcloud ks nlb-dns create vpc-gen2

虚拟私有云

创建 DNS 记录以在 VPC 集群中注册负载均衡器主机名或负载均衡器 IP 地址。

ibmcloud ks nlb-dns create vpc-gen2 --cluster CLUSTER [--output OUTPUT] [-q] [--secret-namespace NAMESPACE] (--ip IP | --lb-host HOST)

命令选项

-c, --cluster
指定集群名称或标识。
--ip
一个或多个 NLB IP 地址。 要查看负载均衡器的 IP 地址,请运行 kubectl get svc -n <namespace>
--lb-host
VPC 负载均衡器主机名。 要查看负载均衡器的主机名,请运行 kubectl get svc -n <namespace>
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--secret-namespace
要在其中创建 SSL 密钥的名称空间。 如果未指定此标志,则密钥将创建在 default.

示例

创建一个 DNS 记录,用于在 VPC 集群中注册负载均衡器的主机名或 IP 地址

ibmcloud ks nlb-dns create vpc-gen2 --cluster CLUSTER --ip IP

ibmcloud ks nlb-dns get

虚拟私有云 经典基础设施 Satellite

查看集群中注册的 NLB 主机名的详细信息。

ibmcloud ks nlb-dns get --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--nlb-subdomain
子域。 要查看现有的子域名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看集群中已注册的 NLB 主机名的详细信息

ibmcloud ks nlb-dns get --cluster CLUSTER --nlb-subdomain SUBDOMAIN

ibmcloud ks nlb-dns help

显示帮助

ibmcloud ks nlb-dns help

示例

显示帮助

ibmcloud ks nlb-dns help

ibmcloud ks nlb-dns ls

列出集群中的已注册 NLB 主机名和 IP 地址。

ibmcloud ks nlb-dns ls --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

列出集群中已注册的 NLB 主机名和 IP 地址

ibmcloud ks nlb-dns ls --cluster CLUSTER

ibmcloud ks nlb-dns monitor configure

在集群中为现有 NLB 主机名配置运行状况检查监视器。 要启用监视器,请包含 --enable 标志。 要更新现有监视器,请仅包含要更改的设置所对应的标志。

ibmcloud ks nlb-dns monitor configure --cluster CLUSTER --nlb-host HOST [--enable] [--header HEADER ...] [--interval INTERVAL] [--output OUTPUT] [--path PATH] [--port PORT] [-q] [--timeout TIMEOUT] [--type TYPE]

命令选项

-c, --cluster
指定集群名称或标识。
--enable
为主机名启用运行状况检查监视器。
--header
HTTP 健康检查的请求头仅限于 Host 头。 此标志仅适用于 HTTPHTTPS 类型。 该标志接受以下格式的值:--header Header-Name=value。 更新监视器时,指定的头将替换现有头。 要删除所有现有标题,请将标志设置为空值:--header ""
--interval
各个运行状况检查之间的时间间隔(以秒为单位)。 较短的时间间隔可缩短故障转移时间,但会增加 IP 上的负载。 必须在 [60 到 300] 之间。 缺省值: 60
--nlb-host
主机名。 要查看现有的主机名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
--path
运行状况检查所依据的端点路径。 此标志仅适用于 HTTPHTTPS 类型。 缺省值: /
--port
进行运行状况检查时要连接到的端口号。 如果类型为 TCP,那么此标志是必需的。 如果类型为 HTTP 或 HTTPS,此标志仅用于除 80(针对 HTTP)或 443(针对 HTTPS)以外的端口。 HTTP 默认:80。 HTTPS 默认:443
-q
不显示每日消息或更新提示。
--timeout
超时(以秒为单位),在此时间后 IP 会被视为运行状况欠佳。 必须在 [1 到 60] 之间。 缺省值: 5
--type
用于运行状况检查的协议。 允许的值:httphttpstcp

示例

为集群中现有的 NLB 主机名配置健康检查监视器

ibmcloud ks nlb-dns monitor configure --cluster CLUSTER --nlb-host HOST

ibmcloud ks nlb-dns monitor disable

传统基础设施

在集群中为 NLB 主机名禁用现有运行状况检查监视器...

ibmcloud ks nlb-dns monitor disable --cluster CLUSTER --nlb-host HOST [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--nlb-host
主机名。 要查看现有的主机名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

禁用集群中某个 NLB 主机名的现有健康检查监视器

ibmcloud ks nlb-dns monitor disable --cluster CLUSTER --nlb-host HOST

ibmcloud ks nlb-dns monitor enable

传统基础设施

在集群中为 NLB 主机名启用运行状况检查监视器。 注意:您必须先通过 ibmcloud ks nlb-dns monitor configure 配置该监控器。

ibmcloud ks nlb-dns monitor enable --cluster CLUSTER --nlb-host HOST [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--nlb-host
主机名。 要查看现有的主机名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

为集群中的 NLB 主机名启用健康检查监视器

ibmcloud ks nlb-dns monitor enable --cluster CLUSTER --nlb-host HOST

ibmcloud ks nlb-dns monitor get

传统基础设施

查看现有运行状况检查监视器的设置。

ibmcloud ks nlb-dns monitor get --cluster CLUSTER --nlb-host HOST [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--nlb-host
主机名。 要查看现有的主机名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

查看现有健康检查监视器的设置

ibmcloud ks nlb-dns monitor get --cluster CLUSTER --nlb-host HOST

ibmcloud ks nlb-dns monitor help

显示帮助

ibmcloud ks nlb-dns monitor help

示例

显示帮助

ibmcloud ks nlb-dns monitor help

ibmcloud ks nlb-dns monitor ls

传统基础设施

列出集群中每个 NLB 主机名的运行状况检查监视器设置。

ibmcloud ks nlb-dns monitor ls --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

列出集群中每个 NLB 主机名的健康检查监视器设置

ibmcloud ks nlb-dns monitor ls --cluster CLUSTER

ibmcloud ks nlb-dns replace

虚拟私有云

通过替换 VPC 集群中与现有 DNS 主机名相关联的负载均衡器主机名,更新该 DNS 主机名。

ibmcloud ks nlb-dns replace --cluster CLUSTER --lb-host HOST --nlb-subdomain SUBDOMAIN [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--lb-host
VPC 负载均衡器主机名。 要查看负载均衡器的主机名,请运行 kubectl get svc -n <namespace>
--nlb-subdomain
子域。 要查看现有的子域名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

通过在 VPC 集群中替换与其关联的负载均衡器主机名,来更新现有的 DNS 主机名

ibmcloud ks nlb-dns replace --cluster CLUSTER --lb-host HOST --nlb-subdomain SUBDOMAIN

ibmcloud ks nlb-dns rm classic

传统基础设施

从 NLB 主机名中移除 NLB IP 地址。 如果从主机名中除去所有 IP,该主机名仍然会存在,但没有与之关联的 IP。

ibmcloud ks nlb-dns rm classic --cluster CLUSTER --ip IP --nlb-host HOST [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--ip
一个 NLB IP 地址。 要查看与该主机名关联的 NLB IP 地址,请运行 ibmcloud ks nlb-dns ls
--nlb-host
主机名。 要查看现有的主机名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

从 NLB 主机名中删除一个 NLB IP 地址

ibmcloud ks nlb-dns rm classic --cluster CLUSTER --ip IP --nlb-host HOST

ibmcloud ks nlb-dns rm help

显示帮助

ibmcloud ks nlb-dns rm help

示例

显示帮助

ibmcloud ks nlb-dns rm help

ibmcloud ks nlb-dns rm vpc-gen2

虚拟私有云

从 VPC 集群的 DNS 记录中移除负载均衡器主机名或 IP 地址。

ibmcloud ks nlb-dns rm vpc-gen2 --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--ip IP] [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--ip
一个 NLB IP 地址。 要查看与该主机名关联的 NLB IP 地址,请运行 ibmcloud ks nlb-dns ls
--nlb-subdomain
子域。 要查看现有的子域名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

从 VPC 集群中的 DNS 记录中删除负载均衡器的主机名或 IP 地址

ibmcloud ks nlb-dns rm vpc-gen2 --cluster CLUSTER --nlb-subdomain SUBDOMAIN

ibmcloud ks nlb-dns secret help

显示帮助

ibmcloud ks nlb-dns secret help

示例

显示帮助

ibmcloud ks nlb-dns secret help

ibmcloud ks nlb-dns secret regenerate

虚拟私有云 经典基础设施 Satellite

重新生成 NLB 子域的证书和密钥。

ibmcloud ks nlb-dns secret regenerate --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--nlb-subdomain
子域。 要查看现有的子域名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

为 NLB 子域重新生成证书和密钥

ibmcloud ks nlb-dns secret regenerate --cluster CLUSTER --nlb-subdomain SUBDOMAIN

ibmcloud ks nlb-dns secret rm

虚拟私有云 经典基础设施 Satellite

从 NLB 子域中删除密钥,并阻止证书的未来续订。

ibmcloud ks nlb-dns secret rm --cluster CLUSTER --nlb-subdomain SUBDOMAIN [-f] [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
--nlb-subdomain
子域。 要查看现有的子域名,请运行 ibmcloud ks nlb-dns ls
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

从 NLB 子域中删除一个密钥,并阻止证书在未来续期

ibmcloud ks nlb-dns secret rm --cluster CLUSTER --nlb-subdomain SUBDOMAIN

配额命令

查看 IBM Cloud 帐户中集群相关资源的配额和限制。

ibmcloud ks quota help

显示帮助

ibmcloud ks quota help

示例

显示帮助

ibmcloud ks quota help

ibmcloud ks quota ls

虚拟私有云 经典基础设施 Satellite

列出 IBM Cloud 帐户中集群相关资源的所有配额和限制。

ibmcloud ks quota ls [--output OUTPUT] [--provider PROVIDER] [-q]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
--provider
过滤特定基础架构提供程序的列表。 允许的值:classicvpc-classicvpc-gen2satellite
-q
不显示每日消息或更新提示。

示例

列出您在 IBM Cloud 账户中与集群相关的所有资源配额和限制

ibmcloud ks quota ls

脚本命令

重写调用 IBM Cloud Kubernetes Service 插件命令的脚本。 将旧结构的命令替换为 Beta 结构的命令。

ibmcloud ks script help

显示帮助

ibmcloud ks script help

示例

显示帮助

ibmcloud ks script help

ibmcloud ks script update

虚拟私有云 传统基础设施

重写调用 IBM Cloud Kubernetes Service 插件命令的脚本。 将旧结构的命令替换为 Beta 结构的命令。

ibmcloud ks script update [--in-place] FILE [FILE ...]

命令选项

--in-place
使用更新的命令结构来重写源文件。
-q
不显示每日消息或更新提示。

示例

重写调用 IBM Cloud Kubernetes Service 插件命令的脚本

ibmcloud ks script update FILE

安全组命令

对安全组运行操作。

ibmcloud ks security-group help

显示帮助

ibmcloud ks security-group help

示例

显示帮助

ibmcloud ks security-group help

ibmcloud ks security-group ls

列出与某个集群关联的所有安全组。

ibmcloud ks security-group ls --cluster CLUSTER [--attached-to ATTACHED] [--managed-by MANAGER] [--output OUTPUT] [-q] [--scope SCOPE]

命令选项

--attached-to
按安全组所关联的组件对安全组进行筛选。 允许的值:clusterload-balancervpcvpe-gatewayworker-pool
-c, --cluster
指定集群名称或标识。
--managed-by
指定 user 可返回用户创建的安全组。 指定 ibm 仅返回由 IBM 管理的安全组。 允许的值:ibmuser
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--scope
指定 cluster 以返回作用域限定于该集群的安全组。 指定 vpc 以返回作用域覆盖整个 VPC 的安全组。 允许的值:clustervpc

示例

列出与某个集群关联的所有安全组

ibmcloud ks security-group ls --cluster CLUSTER

ibmcloud ks security-group reset

虚拟私有云 传统基础设施

删除所有现有安全组规则,然后重新应用缺省规则。

ibmcloud ks security-group reset --cluster CLUSTER --security-group GROUP [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--security-group, --sg
指定安全组标识。

示例

删除所有现有的安全组规则,并重新应用默认规则

ibmcloud ks security-group reset --cluster CLUSTER --security-group GROUP

ibmcloud ks security-group sync

虚拟私有云 传统基础设施

重新应用不存在的缺省安全组规则。 不删除任何预先存在的规则。

ibmcloud ks security-group sync --cluster CLUSTER --security-group GROUP [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
--security-group, --sg
指定安全组标识。

示例

重新应用不存在的默认安全组规则

ibmcloud ks security-group sync --cluster CLUSTER --security-group GROUP

存储器命令

查看和修改存储资源。

ibmcloud ks storage attachment create

storage attachment create 命令是一项测试版功能。

虚拟私有云

将存储卷连接到工作程序节点。

ibmcloud ks storage attachment create --cluster CLUSTER --volume VOLUME --worker WORKER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--volume
指定卷标识。 要列出可用的卷,请运行 ibmcloud ks storage volume ls
-w, --worker
指定工作程序标识。 要列出可用的工作者,请运行 ibmcloud ks workers

示例

将存储卷挂载到工作节点上

ibmcloud ks storage attachment create --cluster CLUSTER --volume VOLUME --worker WORKER_ID

ibmcloud ks storage attachment get

storage attachment get 命令是一项测试版功能。

虚拟私有云

获取集群中卷连接的详细信息。

ibmcloud ks storage attachment get --attachment ATTACHMENT --cluster CLUSTER --worker WORKER [--output OUTPUT] [-q]

命令选项

--attachment
指定卷连接标识。 要列出可用的附件,请运行 ibmcloud ks storage attachment ls
-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
-w, --worker
指定工作程序标识。 要列出可用的工作者,请运行 ibmcloud ks workers

示例

获取集群中卷挂载的详细信息

ibmcloud ks storage attachment get --attachment ATTACHMENT --cluster CLUSTER --worker WORKER_ID

ibmcloud ks storage attachment help

显示帮助

ibmcloud ks storage attachment help

示例

显示帮助

ibmcloud ks storage attachment help

ibmcloud ks storage attachment ls

storage attachment ls 命令是一项测试版功能。

虚拟私有云

列出集群中工作程序的所有存储卷连接。

ibmcloud ks storage attachment ls --cluster CLUSTER --worker WORKER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
-w, --worker
指定工作程序标识。 要列出可用的工作者,请运行 ibmcloud ks workers

示例

列出集群中某个工作节点的所有存储卷挂载

ibmcloud ks storage attachment ls --cluster CLUSTER --worker WORKER_ID

ibmcloud ks storage attachment rm

storage attachment rm 命令是一项测试版功能。

虚拟私有云

从工作程序节点中删除卷连接。

ibmcloud ks storage attachment rm --attachment ATTACHMENT --cluster CLUSTER --worker WORKER [-q]

命令选项

--attachment
指定卷连接标识。 要列出可用的附件,请运行 ibmcloud ks storage attachment ls
-c, --cluster
指定集群名称或标识。
-q
不显示每日消息或更新提示。
-w, --worker
指定工作程序标识。 要列出可用的工作者,请运行 ibmcloud ks workers

示例

从工作节点中删除卷挂载

ibmcloud ks storage attachment rm --attachment ATTACHMENT --cluster CLUSTER --worker WORKER_ID

ibmcloud ks storage help

显示帮助

ibmcloud ks storage help

示例

显示帮助

ibmcloud ks storage help

ibmcloud ks storage volume get

storage volume get 命令是一项测试版功能。

虚拟私有云 传统基础设施

获取卷的详细信息。

ibmcloud ks storage volume get --volume VOLUME [--output OUTPUT] [-q]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--volume
指定卷标识。 要列出可用的卷,请运行 ibmcloud ks storage volume ls

示例

获取卷的详细信息

ibmcloud ks storage volume get --volume VOLUME

ibmcloud ks storage volume help

显示帮助

ibmcloud ks storage volume help

示例

显示帮助

ibmcloud ks storage volume help

ibmcloud ks storage volume ls

storage volume ls 命令是一项测试版功能。

虚拟私有云 传统基础设施

列出卷的详细信息。

ibmcloud ks storage volume ls [--cluster CLUSTER] [--output OUTPUT] [--provider PROVIDER] [-q] [--zone ZONE]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
--provider
过滤特定基础架构提供程序的列表。 允许的值:classicvpc-classicvpc-gen2satellite
-q
不显示每日消息或更新提示。
--zone
要进行过滤的区域。 要列出可用的区域,请运行 ibmcloud ks locations

示例

列出卷的详细信息

ibmcloud ks storage volume ls

子网命令

列出 IBM Cloud 基础架构帐户中的可用便携式子网。

ibmcloud ks subnets

列出 IBM Cloud 基础架构帐户中的可用便携式子网。

ibmcloud ks subnets --provider PROVIDER [-l LOCATION ...] [--output OUTPUT] [-q] [--vpc-id ID] [--zone ZONE]

命令选项

-l, --location
要进行过滤的位置。 要列出可用的位置,请运行 ibmcloud ks locations
--output
以提供的格式打印命令输出。 接受的值: json
--provider
过滤特定基础架构提供程序的列表。 可用选项:classic、vpc-classic、vpc-gen2
-q
不显示每日消息或更新提示。
--vpc-id
对于提供商类型 vpc-classicvpc-gen2,此字段为必填项:要列出其子网的 VPC 的 ID。 要列出 VPC 标识,请运行 ibmcloud ks vpcs
--zone
对于提供商类型 vpc-classicvpc-gen2,此字段为必填项:要列出其 VPC 子网的区域。 要列出可用的区域,请运行 ibmcloud ks zone ls --provider vpc-classic|vpc-gen2

示例

列出您 IBM Cloud 基础设施账户中可用的可移植子网

ibmcloud ks subnets --provider PROVIDER

“版本”命令

列出可用于 IBM Cloud Kubernetes Service 集群的所有容器平台版本。

ibmcloud ks versions

列出可用于 IBM Cloud Kubernetes Service 集群的所有容器平台版本。

ibmcloud ks versions [--output OUTPUT] [-q] [--show-version VERSION]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--show-version
仅显示指定容器平台的版本。 允许的值:OpenShiftKubernetes

示例

列出适用于 IBM Cloud Kubernetes Service 集群的所有可用容器平台版本

ibmcloud ks versions

VLAN 命令

列出专区的公用和专用 VLAN,并查看 VLAN 生成状态。

ibmcloud ks vlan help

显示帮助

ibmcloud ks vlan help

示例

显示帮助

ibmcloud ks vlan help

ibmcloud ks vlan ls

传统基础设施

为区域列出可用的公共和专用 VLAN。

ibmcloud ks vlan ls --zone ZONE [--output OUTPUT] [-q]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

列出某个区域中可用的公共和私有VLAN

ibmcloud ks vlan ls --zone ZONE

ibmcloud ks vlan spanning get

传统基础设施

查看 IBM Cloud 经典基础架构帐户的 VLAN 生成状态。

ibmcloud ks vlan spanning get [--output OUTPUT] [-q] [--region REGION]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--region
指定要设定为目标的区域。 如果尚未指定目标区域,则必须指定此参数。 要检查某个区域是否被选中,请运行 ibmcloud target

示例

查看您的 IBM Cloud 经典基础设施账户的VLAN跨域状态

ibmcloud ks vlan spanning get

ibmcloud ks vlan spanning help

显示帮助

ibmcloud ks vlan spanning help

示例

显示帮助

ibmcloud ks vlan spanning help

Vni 命令

在工作节点上挂载、卸载和列出虚拟网络接口。

ibmcloud ks vni attach baremetal

虚拟私有云

将虚拟网络接口连接到裸机工作节点或集群。

ibmcloud ks vni attach baremetal --vlan VLAN --vni VNI [--auto-delete] [--output OUTPUT] [-q] (--cluster-id ID | --worker WORKER)

命令选项

--auto-delete
当 VNI 从集群中移除时,自动将其删除。
-c, --cluster-id
集群的ID。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--vlan
裸机节点连接的VLAN ID。 每个 VPC 子网必须唯一。 来自同一子网的多个 VNI 可以复用同一 VLAN ID。 有效范围:1-500。
--vni
要连接的虚拟网络接口的 ID。 您必须指定当前没有目标资源的 VNI。 要列出所有 VNI,请运行 ibmcloud is vnis。 要检查某个特定的 VNI 是否已绑定到资源上,请查看 'ibmcloud is vni <VNI_ID>' 中的“Target”字段。
-w, --worker
工作节点的ID。

示例

将虚拟网络接口连接到裸机 worker 节点或集群

ibmcloud ks vni attach baremetal --vlan VLAN --vni VNI --cluster-id CLUSTER_NAME_OR_ID

ibmcloud ks vni attach help

显示帮助

ibmcloud ks vni attach help

示例

显示帮助

ibmcloud ks vni attach help

ibmcloud ks vni detach

虚拟私有云

将虚拟网络接口从工作节点或集群中分离。

ibmcloud ks vni detach --vni VNI [-f] [--output OUTPUT] [-q] (--cluster-id ID | --worker WORKER)

命令选项

-c, --cluster-id
集群的ID。
-f
强制此命令运行,而不显示用户提示。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--vni
要断开连接的虚拟网络接口的 ID。
-w, --worker
工作节点的ID。

示例

从工作节点或集群中分离虚拟网络接口

ibmcloud ks vni detach --vni VNI --cluster-id CLUSTER_NAME_OR_ID

ibmcloud ks vni help

显示帮助

ibmcloud ks vni help

示例

显示帮助

ibmcloud ks vni help

ibmcloud ks vni ls

虚拟私有云

列出连接到集群或工作节点的虚拟网络接口。

ibmcloud ks vni ls [--after AFTER] [--first FIRST] [--output OUTPUT] [-q] (--cluster-id ID | --worker WORKER)

命令选项

--after
在指定光标位置后显示虚拟网络接口。
-c, --cluster-id
集群的ID。
--first
查看后续的虚拟网络接口,直至前几个VNI。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
-w, --worker
工作节点的ID。

示例

列出连接到集群或工作节点的虚拟网络接口

ibmcloud ks vni ls --cluster-id CLUSTER_NAME_OR_ID

Vpc 命令

了解有关 VPC 的信息并管理 VPC 集群。

ibmcloud ks vpc help

显示帮助

ibmcloud ks vpc help

示例

显示帮助

ibmcloud ks vpc help

ibmcloud ks vpc ls

列出目标资源组中的所有 VPC。 如果未指定资源组,则会列出该账户中的所有 VPC。

ibmcloud ks vpc ls [--output OUTPUT] [--provider PROVIDER] [-q]

命令选项

--output
以提供的格式打印命令输出。 接受的值: json
--provider
VPC 基础结构提供程序类型。 支持的值包括 vpc-classicvpc-gen2。 缺省情况下,将返回所有提供程序类型的 VPC。
-q
不显示每日消息或更新提示。

示例

列出目标资源组中的所有 VPC

ibmcloud ks vpc ls

ibmcloud ks vpc outbound-traffic-protection disable

禁用“默认安全”VPC 集群的出站流量保护。

ibmcloud ks vpc outbound-traffic-protection disable --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

禁用“默认安全”VPC 集群的出站流量保护

ibmcloud ks vpc outbound-traffic-protection disable --cluster CLUSTER

ibmcloud ks vpc outbound-traffic-protection enable

为“默认安全”VPC 集群启用出站流量保护。

ibmcloud ks vpc outbound-traffic-protection enable --cluster CLUSTER [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

为“默认安全”VPC 集群启用出站流量保护

ibmcloud ks vpc outbound-traffic-protection enable --cluster CLUSTER

ibmcloud ks vpc outbound-traffic-protection help

显示帮助

ibmcloud ks vpc outbound-traffic-protection help

示例

显示帮助

ibmcloud ks vpc outbound-traffic-protection help

ibmcloud ks vpc secure-by-default enable

为使用传统安全组的 VPC 集群启用“默认安全”VPC 网络。

ibmcloud ks vpc secure-by-default enable --cluster CLUSTER [--disable-outbound-traffic-protection] [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--disable-outbound-traffic-protection
启用此选项可允许集群工作节点进行公共出站访问。 默认情况下,公共出站访问被阻止。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。

示例

为使用传统安全组的 VPC 集群启用“默认安全”VPC 网络

ibmcloud ks vpc secure-by-default enable --cluster CLUSTER

ibmcloud ks vpc secure-by-default help

显示帮助

ibmcloud ks vpc secure-by-default help

示例

显示帮助

ibmcloud ks vpc secure-by-default help

Webhook-create 命令

在集群中注册 Webhook。

ibmcloud ks webhook-create

在集群中注册 Webhook。

ibmcloud ks webhook-create --cluster CLUSTER --type TYPE --url URL [--level LEVEL] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--level
设置通知级别。 允许的值是 NormalWarning。 默认值为 Warning
-q
不显示每日消息或更新提示。
--type
要使用的 Webhook 的类型。 目前支持 slack
--url
Webhook URL。

示例

在集群中注册一个 webhook

ibmcloud ks webhook-create --cluster CLUSTER --type TYPE --url URL

工人的指令

查看和修改集群的工作程序节点。

ibmcloud ks worker get

虚拟私有云 经典基础设施 Satellite

查看工作程序节点的详细信息。

ibmcloud ks worker get --cluster CLUSTER --worker WORKER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
-w, --worker
指定工作程序标识。 要列出可用的工作者,请运行 ibmcloud ks workers

示例

查看工作节点的详细信息

ibmcloud ks worker get --cluster CLUSTER --worker WORKER_ID

ibmcloud ks worker help

显示帮助

ibmcloud ks worker help

示例

显示帮助

ibmcloud ks worker help

ibmcloud ks worker ls

虚拟私有云 经典基础设施 Satellite

列出一个集群中的所有工作程序节点。

ibmcloud ks worker ls --cluster CLUSTER [--output OUTPUT] [-q] [--show-delete-reason] [--show-deleted] [--show-pools] [--worker-pool POOL]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-p, --worker-pool
仅显示属于您指定的工作程序池的工作程序节点。
-q
不显示每日消息或更新提示。
--show-delete-reason
显示工作程序节点删除原因。
--show-deleted
显示已从集群删除的工作程序节点。
--show-pools
查看每个工作程序所属的工作程序池。

示例

列出集群中的所有工作节点

ibmcloud ks worker ls --cluster CLUSTER

ibmcloud ks worker reboot

虚拟私有云 经典基础设施 Satellite

重新启动工作程序节点。

ibmcloud ks worker reboot --cluster CLUSTER --worker WORKER [--worker WORKER ...] [-f] [--hard] [-q] [--skip-master-health]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
--hard
通过切断工作程序节点的电源来强制硬重新启动该工作程序节点。 如果工作程序节点无响应或工作程序节点有一个 Docker 挂起,请使用此选项。
-q
不显示每日消息或更新提示。
--skip-master-health
在启动操作之前跳过检查主节点运行状况。
-w, --worker
指定一个或多个工作程序标识。

示例

重启一个工作节点

ibmcloud ks worker reboot --cluster CLUSTER --worker WORKER_ID

ibmcloud ks worker reload

虚拟私有云 经典基础设施 Satellite

在一个或多个工作节点上删除数据、重新映像,并重新安装带有最新补丁版本的 Kubernetes。 无法撤销此操作。 支持经典节点和裸机 VPC 节点。

ibmcloud ks worker reload --worker WORKER [--worker WORKER ...] [-f] [-q] [--skip-master-health]

命令选项

-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--skip-master-health
在启动操作之前跳过检查主节点运行状况。
-w, --worker
指定一个或多个工作程序标识。

示例

在一个或多个工作节点上删除数据、重新映像,并重新安装带最新补丁版本的 Kubernetes

ibmcloud ks worker reload --worker WORKER_ID

ibmcloud ks worker replace

虚拟私有云 经典基础设施 Satellite

删除工作程序节点,并将其替换为同一工作程序池中的新工作程序节点。

ibmcloud ks worker replace --cluster CLUSTER --worker WORKER [-f] [-q] [--update]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
--update
将工作程序节点更新至主节点相同的主要版本和次要版本以及最新补丁。 如果工作池的操作系统已更新,则也会更新操作系统。
-w, --worker
指定工作程序标识。 要列出可用的工作者,请运行 ibmcloud ks workers

示例

删除一个工作节点,并用同一工作池中的新工作节点替换它

ibmcloud ks worker replace --cluster CLUSTER --worker WORKER_ID

ibmcloud ks worker rm

虚拟私有云 经典基础设施 Satellite

从集群中移除工作程序节点。

ibmcloud ks worker rm --cluster CLUSTER --worker WORKER [--worker WORKER ...] [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
-w, --worker
指定一个或多个工作程序标识。

示例

从集群中移除一个工作节点

ibmcloud ks worker rm --cluster CLUSTER --worker WORKER_ID

ibmcloud ks worker update

传统基础设施

将经典集群中的一个或多个工作程序节点更新至新的 Kubernetes 版本。 在更新期间,会使用最新镜像来更新工作程序节点;如果数据未存储在持久存储器上,那么会永久删除这些数据。

ibmcloud ks worker update --cluster CLUSTER --worker WORKER [--worker WORKER ...] [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-q
不显示每日消息或更新提示。
-w, --worker
指定一个或多个工作程序标识。

示例

将经典集群中的一个或多个工作节点升级到新的 Kubernetes 版本

ibmcloud ks worker update --cluster CLUSTER --worker WORKER_ID

工作池命令

查看和修改集群的工作程序池。

ibmcloud ks worker-pool create classic

传统基础设施

将工作程序池添加到经典集群。 在将区域添加到工作程序池之前,不会创建任何工作程序节点。

ibmcloud ks worker-pool create classic --cluster CLUSTER --flavor FLAVOR --name NAME --size-per-zone SIZE [--disable-disk-encrypt] [--entitlement ENTITLEMENT] [--hardware HARDWARE] [--label LABEL ...] [--operating-system SYSTEM] [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--disable-disk-encrypt
在工作程序节点上禁用加密。
--entitlement
仅当您使用包含“OpenShift”授权的许可证(例如 Cloud Pak )来运行此集群时,才应将此标志设置为 ocp_entitled
--flavor
工作程序节点的类型模板。 要查看可用的变体,请运行 ibmcloud ks flavor ls --zone <zone name> (适用于 public. IBM Cloud 账户)或 ibmcloud ks flavor ls (适用于 IBM Cloud Dedicated 账户)。
--hardware
工作程序节点的硬件隔离级别。 使用 dedicated 可获得仅供您专用的物理资源,或使用 shared 允许与其他 IBM 客户共享物理资源。 对于 IBM Cloud 公共帐户,将共享缺省值。 对于专用于 IBM Cloud 的帐户,dedicated 是唯一可用的选项。
-l, --label
在工作程序池中的所有工作程序上设置标签。
--name
输入工作程序池的名称。
--operating-system
指定操作系统的名称。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--size-per-zone
指定在该工作程序池中每个区域所期望的工作程序数量。

示例

将工作节点池添加到经典集群中

ibmcloud ks worker-pool create classic \
  --cluster CLUSTER \
  --flavor FLAVOR \
  --name NAME \
  --size-per-zone SIZE

ibmcloud ks worker-pool create help

显示帮助

ibmcloud ks worker-pool create help

示例

显示帮助

ibmcloud ks worker-pool create help

ibmcloud ks worker-pool create satellite

将工作程序池添加到 IBM Cloud Satellite 集群。 在将区域添加到工作程序池之前,不会创建任何工作程序节点。

ibmcloud ks worker-pool create satellite --cluster CLUSTER --host-label LABEL [--host-label LABEL ...] --name NAME --size-per-zone SIZE --zone ZONE [--entitlement ENTITLEMENT] [--label LABEL ...] [--operating-system SYSTEM] [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--entitlement
仅当您使用包含“OpenShift”授权的许可证(例如 Cloud Pak )来运行此集群时,才应将此标志设置为 ocp_entitled
--host-label, --hl
请以键值对的形式输入任意标签,用于标识要分配给您的 Satellite 控制平面或 Red Hat OpenShift 集群的主机。 具有此标签且未分配的第一个主机将自动分配给控制平面或集群。 要查找可用的主机标签,请运行 ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>
-l, --label
在工作程序池中的所有工作程序上设置标签。
--name
输入工作程序池的名称。
--operating-system
指定操作系统的名称。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--size-per-zone
指定在该工作程序池中每个区域所期望的工作程序数量。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

将一个工作节点池添加到 IBM Cloud Satellite 集群中

ibmcloud ks worker-pool create satellite \
  --cluster CLUSTER \
  --host-label LABEL \
  --name NAME \
  --size-per-zone SIZE \
  --zone ZONE

ibmcloud ks worker-pool create vpc-classic

将工作程序池添加到 VPC 第 1 代集群。 在将区域添加到工作程序池之前,不会创建任何工作程序节点。

ibmcloud ks worker-pool create vpc-classic --cluster CLUSTER --flavor FLAVOR --name NAME --size-per-zone SIZE [--entitlement ENTITLEMENT] [--label LABEL ...] [--operating-system SYSTEM] [--output OUTPUT] [-q] [--vpc-id ID]

命令选项

-c, --cluster
指定集群名称或标识。
--entitlement
仅当您使用包含“OpenShift”授权的许可证(例如 Cloud Pak )来运行此集群时,才应将此标志设置为 ocp_entitled
--flavor
工作程序节点的类型模板。 要查看可用的变体,请运行 ibmcloud ks flavor ls --zone <zone name> (适用于 public. IBM Cloud 账户)或 ibmcloud ks flavor ls (适用于 IBM Cloud Dedicated 账户)。
-l, --label
在工作程序池中的所有工作程序上设置标签。
--name
输入工作程序池的名称。
--operating-system
指定操作系统的名称。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--size-per-zone
指定在该工作程序池中每个区域所期望的工作程序数量。
--vpc-id
要在其中创建工作程序节点的 VPC 的标识,此标识必须匹配集群所在的 VPC。 要列出集群的 VPC ID,请运行 ibmcloud ks cluster get -c <cluster_name_or_ID>。 如果未提供此标志,那么工作程序池缺省设置为集群中现有工作程序池的 VPC 标识。

示例

将工作节点池添加到 VPC Gen 1 集群中

ibmcloud ks worker-pool create vpc-classic \
  --cluster CLUSTER \
  --flavor FLAVOR \
  --name NAME \
  --size-per-zone SIZE

ibmcloud ks worker-pool create vpc-gen2

虚拟私有云

将工作程序池添加到 VPC 第 2 代集群。 在将区域添加到工作程序池之前,不会创建任何工作程序节点。

ibmcloud ks worker-pool create vpc-gen2 --cluster CLUSTER --flavor FLAVOR --name NAME --size-per-zone SIZE [--crk CRK] [--disable-disk-encrypt] [--entitlement ENTITLEMENT] [--kms-account-id ID] [--kms-instance INSTANCE] [--label LABEL ...] [--operating-system SYSTEM] [--output OUTPUT] [-q] [--secondary-storage STORAGE] [--security-group GROUP ...] [--vpc-id ID]

命令选项

-c, --cluster
指定集群名称或标识。
--crk
用于本地磁盘加密的 KMS 实例中根密钥的标识。 要列出可用的根密钥,请运行 ibmcloud ks kms crk ls --instance-id <kms_instance>
--disable-disk-encrypt
在工作程序节点上禁用加密。
--entitlement
仅当您使用包含“OpenShift”授权的许可证(例如 Cloud Pak )来运行此集群时,才应将此标志设置为 ocp_entitled
--flavor
工作程序节点的类型模板。 要查看可用的变体,请运行 ibmcloud ks flavor ls --zone <zone name> (适用于 public. IBM Cloud 账户)或 ibmcloud ks flavor ls (适用于 IBM Cloud Dedicated 账户)。
--kms-account-id
包含要用于本地磁盘或私钥加密的 KMS 实例的帐户的标识。
--kms-instance
用于本地磁盘加密的 KMS 实例的标识。 要列出可用的 KMS 实例,请运行 ibmcloud ks kms instance ls
-l, --label
在工作程序池中的所有工作程序上设置标签。
--name
输入工作程序池的名称。
--operating-system
指定操作系统的名称。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--secondary-storage
类型模板的辅助存储器选项。 要查看某种配置可用的二级存储选项,请运行 ibmcloud ks flavor get --provider vpc-gen2 --zone <zone name>
--security-group
可选。 指定多达 5 个安全组标识以应用于工作程序池中的所有工作程序。
--size-per-zone
指定在该工作程序池中每个区域所期望的工作程序数量。
--vpc-id
要在其中创建工作程序节点的 VPC 的标识,此标识必须匹配集群所在的 VPC。 要列出集群的 VPC ID,请运行 ibmcloud ks cluster get -c <cluster_name_or_ID>。 如果未提供此标志,那么工作程序池缺省设置为集群中现有工作程序池的 VPC 标识。

示例

向 VPC Gen 2 集群添加一个工作节点池

ibmcloud ks worker-pool create vpc-gen2 \
  --cluster CLUSTER \
  --flavor FLAVOR \
  --name NAME \
  --size-per-zone SIZE

ibmcloud ks worker-pool get

虚拟私有云 经典基础设施 Satellite

列出工作程序池的详细信息。

ibmcloud ks worker-pool get --cluster CLUSTER --worker-pool POOL [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-p, --worker-pool
指定工作程序池。
-q
不显示每日消息或更新提示。

示例

列出工作者池的详细信息

ibmcloud ks worker-pool get --cluster CLUSTER --worker-pool POOL

ibmcloud ks worker-pool help

显示帮助

ibmcloud ks worker-pool help

示例

显示帮助

ibmcloud ks worker-pool help

ibmcloud ks worker-pool label help

显示帮助

ibmcloud ks worker-pool label help

示例

显示帮助

ibmcloud ks worker-pool label help

ibmcloud ks worker-pool label rm

虚拟私有云 经典基础设施 Satellite

从工作程序池的所有工作程序节点中移除所有定制 Kubernetes 标签。

ibmcloud ks worker-pool label rm --cluster CLUSTER --worker-pool POOL [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-p, --worker-pool
指定工作程序池。
-q
不显示每日消息或更新提示。

示例

从工作池中的所有工作节点中移除所有自定义的 Kubernetes 标签

ibmcloud ks worker-pool label rm --cluster CLUSTER --worker-pool POOL

ibmcloud ks worker-pool label set

虚拟私有云 经典基础设施 Satellite

为工作程序池中的所有工作程序节点设置定制 Kubernetes 标签。

ibmcloud ks worker-pool label set --cluster CLUSTER --label LABEL [--label LABEL ...] --worker-pool POOL [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-l, --label
为工作池中的所有工作节点设置自定义 Kubernetes 标签,格式为 key=value。 对于多个标签,请重复此标志。 要在工作程序池中保留任何现有定制标签,请将这些标签与此标志放在一起。
-p, --worker-pool
指定工作程序池。
-q
不显示每日消息或更新提示。

示例

为工作池中的所有工作节点设置自定义 Kubernetes 标签

ibmcloud ks worker-pool label set --cluster CLUSTER --label LABEL --worker-pool POOL

ibmcloud ks worker-pool ls

虚拟私有云 经典基础设施 Satellite

列出一个集群中的所有工作程序池。

ibmcloud ks worker-pool ls --cluster CLUSTER [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。

示例

列出集群中的所有工作节点池

ibmcloud ks worker-pool ls --cluster CLUSTER

ibmcloud ks worker-pool operating-system help

显示帮助

ibmcloud ks worker-pool operating-system help

示例

显示帮助

ibmcloud ks worker-pool operating-system help

ibmcloud ks worker-pool operating-system set

设置操作系统。 设置好操作系统后,您必须通过运行 ibmcloud ks worker updateibmcloud ks worker replace 来更新工作节点。

ibmcloud ks worker-pool operating-system set --cluster CLUSTER --operating-system SYSTEM --worker-pool POOL [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--operating-system
指定操作系统的名称。
-p, --worker-pool
指定工作程序池。
-q
不显示每日消息或更新提示。

示例

设置操作系统

ibmcloud ks worker-pool operating-system set \
  --cluster CLUSTER \
  --operating-system SYSTEM \
  --worker-pool POOL

ibmcloud ks worker-pool rebalance

虚拟私有云 经典基础设施 Satellite

重新平衡集群中的工作程序池。 重新平衡会根据各区域的工作节点池大小,相应地增加或移除工作节点。 Satellite 如果节点与工作者池的主机标签不匹配,工作者池可能会将其手动移除。

ibmcloud ks worker-pool rebalance --cluster CLUSTER --worker-pool POOL [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-p, --worker-pool
指定工作程序池。
-q
不显示每日消息或更新提示。

示例

重新平衡集群中的工作者池

ibmcloud ks worker-pool rebalance --cluster CLUSTER --worker-pool POOL

ibmcloud ks worker-pool resize

虚拟私有云 经典基础设施 Satellite

将工作程序池的大小调整为您指定的每个区域的工作程序数量。

ibmcloud ks worker-pool resize --cluster CLUSTER --size-per-zone SIZE --worker-pool POOL [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-p, --worker-pool
指定工作程序池。
-q
不显示每日消息或更新提示。
--size-per-zone
指定在该工作程序池中每个区域所期望的工作程序数量。

示例

将工作进程池的规模调整为您指定的每个区域的工作进程数量

ibmcloud ks worker-pool resize --cluster CLUSTER --size-per-zone SIZE --worker-pool POOL

ibmcloud ks worker-pool rm

虚拟私有云 经典基础设施 Satellite

从集群移除工作程序池。

ibmcloud ks worker-pool rm --cluster CLUSTER --worker-pool POOL [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-p, --worker-pool
指定工作程序池。
-q
不显示每日消息或更新提示。

示例

从集群中移除一个工作节点池

ibmcloud ks worker-pool rm --cluster CLUSTER --worker-pool POOL

ibmcloud ks worker-pool taint help

显示帮助

ibmcloud ks worker-pool taint help

示例

显示帮助

ibmcloud ks worker-pool taint help

ibmcloud ks worker-pool taint rm

虚拟私有云 经典基础设施 Satellite

从工作程序池的所有工作程序节点中移除所有 Kubernetes 标记污点。

ibmcloud ks worker-pool taint rm --cluster CLUSTER --worker-pool POOL [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-p, --worker-pool
指定工作程序池。
-q
不显示每日消息或更新提示。

示例

从工作池中的所有工作节点中移除所有 Kubernetes 污点

ibmcloud ks worker-pool taint rm --cluster CLUSTER --worker-pool POOL

ibmcloud ks worker-pool taint set

虚拟私有云 经典基础设施 Satellite

为工作程序池中的所有工作程序节点设置 Kubernetes 标记污点。 标记污点阻止无匹配容差的 pod 在工作程序节点上运行。

ibmcloud ks worker-pool taint set --cluster CLUSTER --taint TAINT [--taint TAINT ...] --worker-pool POOL [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-p, --worker-pool
指定工作程序池。
-q
不显示每日消息或更新提示。
--taint
在工作程序池中的所有工作程序上设置标记污点。 请以 key=value:effect 的格式指定 Kubernetes 污点。 key=value 是一对键值对(例如 env=prod ),用于管理工作节点污点(taint)及其对应的 Pod 容忍度(toleration)。 effect 是一个 Kubernetes 污点效果,例如 NoSchedule,该页面详细说明了该污点的工作原理。

示例

为工作池中的所有工作节点设置 Kubernetes 污点

ibmcloud ks worker-pool taint set --cluster CLUSTER --taint TAINT --worker-pool POOL

ibmcloud ks worker-pool zones

虚拟私有云 经典基础设施 Satellite

查看连接到工作程序池的专区。

ibmcloud ks worker-pool zones --cluster CLUSTER --worker-pool POOL [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-p, --worker-pool
指定工作程序池。
-q
不显示每日消息或更新提示。

示例

查看与工作者池关联的区域

ibmcloud ks worker-pool zones --cluster CLUSTER --worker-pool POOL

区域命令

列出可用性区域并修改附加到工作程序池的区域。

ibmcloud ks zone add classic

传统基础设施

将区域添加到经典集群中的一个或多个工作程序池。

ibmcloud ks zone add classic --cluster CLUSTER --worker-pool POOL [--worker-pool POOL ...] --zone ZONE [--output OUTPUT] [--private-vlan VLAN] [-q] (--private-only | --public-vlan VLAN)

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-p, --worker-pool
要修改的工作程序池的名称。 要指定多个工作程序池,请使用多个标志,例如 -p pool1 -p pool2
--private-only
使用该标志以阻止创建公共 VLAN。 仅当您指定 --private-vlan 标志但未指定 --public-vlan 标志时才需要此设置。
--private-vlan
指定私有VLAN的ID。 要查看可用的VLAN,请运行'. 指定私有VLAN时,还必须同时指定 --public-vlan 标志或 '--private-only' 标志。
--public-vlan
指定公共VLAN的ID。 要查看可用的VLAN,请运行'.
-q
不显示每日消息或更新提示。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

将一个区域添加到经典集群中的一个或多个工作池中

ibmcloud ks zone add classic --cluster CLUSTER --worker-pool POOL --zone ZONE --private-only

ibmcloud ks zone add help

显示帮助

ibmcloud ks zone add help

示例

显示帮助

ibmcloud ks zone add help

ibmcloud ks zone add satellite

将区域添加到 Satellite 集群中的一个或多个工作程序池。

ibmcloud ks zone add satellite --cluster CLUSTER --worker-pool POOL [--worker-pool POOL ...] --zone ZONE [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-p, --worker-pool
要修改的工作程序池的名称。 要指定多个工作程序池,请使用多个标志,例如 -p pool1 -p pool2
-q
不显示每日消息或更新提示。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

将一个区域添加到 Satellite 集群中的一个或多个工作池中

ibmcloud ks zone add satellite --cluster CLUSTER --worker-pool POOL --zone ZONE

ibmcloud ks zone add vpc-classic

将区域添加到 VPC 第 1 代集群中的一个或多个工作程序池。

ibmcloud ks zone add vpc-classic --cluster CLUSTER --subnet-id ID --worker-pool POOL --zone ZONE [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--subnet-id
要分配给集群的 VPC 子网。 要列出可用的子网,请运行 ibmcloud ks subnets --provider vpc-classic --vpc-id <vpc-id> --zone <vpc-zone>
--worker-pool
指定工作程序池。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

将一个区域添加到 VPC Gen 1 集群中的一个或多个工作池中

ibmcloud ks zone add vpc-classic --cluster CLUSTER --subnet-id ID --worker-pool POOL --zone ZONE

ibmcloud ks zone add vpc-gen2

虚拟私有云

将区域添加到 VPC 第 2 代集群中的一个或多个工作程序池。

ibmcloud ks zone add vpc-gen2 --cluster CLUSTER --subnet-id ID --worker-pool POOL --zone ZONE [--output OUTPUT] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
--output
以提供的格式打印命令输出。 接受的值: json
-q
不显示每日消息或更新提示。
--subnet-id
要分配给集群的 VPC 子网。 要列出可用的子网,请运行 ibmcloud ks subnets --provider vpc-gen2 --vpc-id <vpc-id> --zone <vpc-zone>
--worker-pool
指定工作程序池。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

将一个区域添加到 VPC Gen 2 集群中的一个或多个工作池中

ibmcloud ks zone add vpc-gen2 --cluster CLUSTER --subnet-id ID --worker-pool POOL --zone ZONE

ibmcloud ks zone help

显示帮助

ibmcloud ks zone help

示例

显示帮助

ibmcloud ks zone help

ibmcloud ks zone ls

虚拟私有云 经典基础设施 Satellite

列出区域中的所有可用性区域。

ibmcloud ks zone ls --provider PROVIDER [-l LOCATION ...] [--output OUTPUT] [-q] [--region-only] [--show-flavors]

命令选项

-l, --location
要进行过滤的位置。 要列出可用的位置,请运行 ibmcloud ks locations
--output
以提供的格式打印命令输出。 接受的值: json
--provider
过滤特定基础架构提供程序的列表。 可用选项:classic、vpc-classic、vpc-gen2、satellite
-q
不显示每日消息或更新提示。
--region-only
仅显示区域数据中心。
--show-flavors
在 VPC 的区域中显示可用的工作程序节点特色。

示例

列出某个区域中的所有可用区

ibmcloud ks zone ls --provider PROVIDER

ibmcloud ks zone network-set

传统基础设施

在经典集群中,为给定工作程序池在特定区域中设置网络元数据。

ibmcloud ks zone network-set --cluster CLUSTER --private-vlan VLAN --worker-pool POOL [--worker-pool POOL ...] --zone ZONE [-f] [-q] (--private-only | --public-vlan VLAN)

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-p, --worker-pool
要修改的工作程序池的名称。 要指定多个工作程序池,请使用多个标志,例如 -p pool1 -p pool2
--private-only
取消设置公共 VLAN,以使此区域中的工作程序仅连接至专用 VLAN。
--private-vlan
指定私有VLAN的ID。 要查看可用的VLAN,请运行'.
--public-vlan
指定公共VLAN的ID。 要查看可用的VLAN,请运行'.
-q
不显示每日消息或更新提示。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

在经典集群中,为给定的工作池设置特定区域中的网络元数据

ibmcloud ks zone network-set \
  --cluster CLUSTER \
  --private-vlan VLAN \
  --worker-pool POOL \
  --zone ZONE \
  --private-only

ibmcloud ks zone rm

虚拟私有云 经典基础设施 Satellite

从集群中的一个或多个工作程序池移除区域。

ibmcloud ks zone rm --cluster CLUSTER --worker-pool POOL [--worker-pool POOL ...] --zone ZONE [-f] [-q]

命令选项

-c, --cluster
指定集群名称或标识。
-f
强制此命令运行,而不显示用户提示。
-p, --worker-pool
要修改的工作程序池的名称。 要指定多个工作程序池,请使用多个标志,例如 -p pool1 -p pool2
-q
不显示每日消息或更新提示。
--zone
在多区域集群中为工作程序池指定区域。 要列出可用的区域,请运行 ibmcloud ks zone ls

示例

从集群中的一个或多个工作池中移除一个区域

ibmcloud ks zone rm --cluster CLUSTER --worker-pool POOL --zone ZONE