命令选项

-q

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

示例

查看或设置服务的 API 端点和 API 版本。

ibmcloud ks api \
  --endpoint ENDPOINT \
  --insecure INSECURE \
  --skip-ssl-validation IP_ADDRESS

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks api-key info --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

-f

强制此命令运行，而不显示用户提示。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--region REGION

指定要设定为目标的区域。

示例

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

ibmcloud ks api-key reset --output json --region REGION -f

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

Red Hat 高级集群管理插件。

ibmcloud ks cluster addon disable acm --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

IBM Cloud Kubernetes Service 集群自动缩放器。

ibmcloud ks cluster addon disable cluster-autoscaler --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

IBM Cloud Kubernetes Service 诊断和调试工具。

ibmcloud ks cluster addon disable debug-tool --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

用于 Red Hat OpenShift on IBM Cloud 的 IBM Cloud HPCS Router Operator 附加组件。

ibmcloud ks cluster addon disable hpcs-router --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

IBM Cloud 存储操作符附加组件。

ibmcloud ks cluster addon disable ibm-storage-operator \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

IBM Cloud Image Key Synchronizer 附加组件。

ibmcloud ks cluster addon disable image-key-synchronizer \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

Knative 无服务器框架。

ibmcloud ks cluster addon disable knative --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

IBM Cloud Kubernetes Service Web 终端。

ibmcloud ks cluster addon disable kube-terminal --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

IBM Cloud 上的“Red Hat OpenShift”数据基础组件。

ibmcloud ks cluster addon disable openshift-data-foundation \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

IBM Cloud Kubernetes Service 静态路由附加组件。

ibmcloud ks cluster addon disable static-route --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

IBM Cloud VPC 块存储器 CSI 驱动程序。

ibmcloud ks cluster addon disable vpc-block-csi-driver \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

--param PARAM

指定附加组件的安装选项。 如果未指定任何参数，那么将使用缺省值。 使用 ibmcloud ks cluster addon options 命令查看可用的选项。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

启用所有附加组件依赖性。

示例

Red Hat 高级集群管理插件。

ibmcloud ks cluster addon enable acm \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

启用所有附加组件依赖性。

示例

IBM Cloud Kubernetes Service 集群自动缩放器。

ibmcloud ks cluster addon enable cluster-autoscaler \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

启用所有附加组件依赖性。

示例

IBM Cloud Kubernetes Service 诊断和调试工具。

ibmcloud ks cluster addon enable debug-tool \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

启用所有附加组件依赖性。

示例

用于 Red Hat OpenShift on IBM Cloud 的 IBM Cloud HPCS Router Operator 附加组件。

ibmcloud ks cluster addon enable hpcs-router \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

启用所有附加组件依赖性。

示例

IBM Cloud 存储操作符附加组件。

ibmcloud ks cluster addon enable ibm-storage-operator \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

启用所有附加组件依赖性。

示例

IBM Cloud Image Key Synchronizer 附加组件。

ibmcloud ks cluster addon enable image-key-synchronizer \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

启用所有附加组件依赖性。

示例

Istio 的额外组件，包括 Grafana、Jaeger 和 Kiali。

ibmcloud ks cluster addon enable istio-extras \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

启用所有附加组件依赖性。

示例

Istio 的 BookInfo 样本应用程序。

ibmcloud ks cluster addon enable istio-sample-bookinfo \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

--param PARAM

指定附加组件的安装选项。 如果未指定任何参数，那么将使用缺省值。 使用 ibmcloud ks cluster addon options 命令查看可用的选项。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

启用所有附加组件依赖性。

示例

IBM Cloud 上的“Red Hat OpenShift”数据基础组件。

ibmcloud ks cluster addon enable openshift-data-foundation \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

启用所有附加组件依赖性。

示例

IBM Cloud Kubernetes Service 静态路由附加组件。

ibmcloud ks cluster addon enable static-route \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--addon ADDON

附加组件名称或标识。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks cluster addon get --cluster CLUSTER_NAME_OR_ID --addon ADDON --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

列出已启用的附加组件。

ibmcloud ks cluster addon ls --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--addon ADDON

附加组件名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--version VERSION

指定要显示其选项的附件组件版本。 如果未指定版本，那么将显示缺省版本的选项。

示例

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

ibmcloud ks cluster addon options --addon ADDON --version VERSION --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

Red Hat 高级集群管理插件。

ibmcloud ks cluster addon update acm \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

IBM Cloud Kubernetes Service ALB OAuth 代理程序附加组件。

ibmcloud ks cluster addon update alb-oauth-proxy \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

IBM Cloud Kubernetes Service 集群自动缩放器。

ibmcloud ks cluster addon update cluster-autoscaler \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

IBM Cloud Kubernetes Service 诊断和调试工具。

ibmcloud ks cluster addon update debug-tool \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

IBM Cloud Kubernetes Service 头灯配件。

ibmcloud ks cluster addon update headlamp \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

用于 Red Hat OpenShift on IBM Cloud 的 IBM Cloud HPCS Router Operator 附加组件。

ibmcloud ks cluster addon update hpcs-router \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

IBM Cloud 存储操作符附加组件。

ibmcloud ks cluster addon update ibm-storage-operator \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

IBM Cloud Image Key Synchronizer 附加组件。

ibmcloud ks cluster addon update image-key-synchronizer \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

受管 Istio 服务网。

ibmcloud ks cluster addon update istio \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

Istio 的额外组件，包括 Grafana、Jaeger 和 Kiali。

ibmcloud ks cluster addon update istio-extras \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

Istio 的 BookInfo 样本应用程序。

ibmcloud ks cluster addon update istio-sample-bookinfo \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

Knative 无服务器框架。

ibmcloud ks cluster addon update knative \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

IBM Cloud Kubernetes Service Web 终端。

ibmcloud ks cluster addon update kube-terminal \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

IBM Cloud 上的“Red Hat OpenShift”数据基础组件。

ibmcloud ks cluster addon update openshift-data-foundation \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

IBM Cloud Kubernetes Service 静态路由附加组件。

ibmcloud ks cluster addon update static-route \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--version VERSION

指定要安装的附件组件版本。 如果未指定版本，那么将安装缺省版本。

-y

更新所有附加组件依赖性。

示例

IBM Cloud VPC 块存储器 CSI 驱动程序。

ibmcloud ks cluster addon update vpc-block-csi-driver \
  --cluster CLUSTER_NAME_OR_ID \
  -y Y \
  --version VERSION

命令选项

--addon ADDON

指定要为其过滤版本的附加组件名称。

--offering OFFERING

指定要筛选版本的业务。 允许的值：kubernetes、openshift、openshift-vs

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--show-defaults

在输出中显示默认版本列。

示例

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

ibmcloud ks cluster addon versions \
  --output json \
  --addon ADDON \
  --show-defaults SHOW-DEFAULTS

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

为集群创建 CA 证书。

ibmcloud ks cluster ca create --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks cluster ca get --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

循环使用集群的 CA 证书，这需要预先创建 CA 证书。

ibmcloud ks cluster ca rotate --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks cluster ca status --cluster CLUSTER_NAME_OR_ID -q

命令选项

--admin

检索管理员证书和 PEM 密钥。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--endpoint ENDPOINT

要用于集群上下文的服务器 URL。 如果未包含该标志，那么将使用缺省集群服务端点。 如需了解更多信息，请访问 https://ibm.biz/context-kubeKubernetes，或 https://ibm.biz/context-ocpOpenShift 集群。 允许的值：private、link、vpe

--network

使用管理配置检索 Calico 网络配置。

--output OUTPUT

以指定的格式打印命令输出，并跳过 kubeconfig 的合并操作。 ZIP 输出文件中不包含刷新令牌。 允许的值：json、yaml、zip

-q

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

--skip-rbac

跳过添加 RBAC 角色。 仅当您管理自己的 Kubernetes RBAC 角色时才包含此选项。 如果使用 IAM 服务访问角色管理您的所有 RBAC 用户，请勿包含此选项。

示例

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

ibmcloud ks cluster config --cluster CLUSTER_NAME_OR_ID --admin --network

命令选项

--disable-disk-encrypt

在工作程序节点上禁用加密。

--entitlement ENTITLEMENT

仅当您使用具有“OpenShift”使用权的许可证（例如 Cloud Pak ）来运行此集群时，才应将此标志设置为 ocp_entitled。

--flavor FLAVOR

工作程序节点的类型模板。 要查看可用的变体，请运行 ibmcloud ks flavor ls --zone <zone name> （适用于 public. IBM Cloud 账户）或 ibmcloud ks flavor ls （适用于 IBM Cloud Dedicated 账户）。

--hardware HARDWARE

工作程序节点的硬件隔离级别。 使用 dedicated 可获得仅供您专用的物理资源；或使用 shared 允许与其他 IBM 客户共享物理资源。 对于 IBM Cloud 公共帐户，将共享缺省值。 对于专用于 IBM Cloud 的帐户，dedicated 是唯一可用的选项。

--location LOCATION

已弃用的 标志仍予以保留，以确保与早期版本的兼容性。 请改用 --zone 标志。

--name NAME

请输入集群的名称。

--no-subnet

在创建集群时，阻止创建便携式子网。 缺省情况下，公共和专用便携式子网都在关联的 VLAN 上创建，该标志可以阻止这种行为。 若要在稍后向集群添加子网，请运行 ibmcloud ks cluster subnet add。

--operating-system SYSTEM

指定操作系统的名称。

--pod-subnet SUBNET

指定定制子网 CIDR 以便为 Pod 提供专用 IP 地址。 子网必须至少为 /23 或更大。 如需了解更多信息，请参阅 https://ibm.biz/cluster-create-classic

--private-only

使用该标志以阻止创建公共 VLAN。 仅当您指定 --private-vlan 标志但未指定 --public-vlan 标志时才需要此设置。

--private-service-endpoint

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

--private-vlan VLAN

条件：指定私有VLAN的ID。 要查看可用的VLAN，请运行 ibmcloud ks vlan ls --zone <zone name>。 如果您尚未拥有专用VLAN，请不要指定此选项，因为系统会自动为您创建一个。 指定私有VLAN时，还必须同时指定 --public-vlan 标志或 --private-only 标志。

--public-service-endpoint

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

--public-vlan VLAN

条件：指定公共VLAN的ID。 要查看可用的VLAN，请运行 ibmcloud ks vlan ls --zone <zone name>。 如果您尚未拥有公共VLAN，请不要指定此选项，因为系统会自动为您创建一个。

-q

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

--service-subnet SUBNET

指定定制子网 CIDR 以便为服务提供专用 IP 地址。 子网必须至少为 /24 或更大。 如需了解更多信息，请参阅 https://ibm.biz/cluster-create-classic。 缺省值： 172.21.0.0/16

--skip-advance-permissions-check

在完成此操作之前，请跳过基础结构许可权检查。 请注意，如果您没有正确的基础结构许可权，那么此操作可能仅部分成功。

--sm-group GROUP

用于持久存储私钥的 IBM Cloud Secrets Manager 实例的私钥组标识。

--sm-instance INSTANCE

IBM Cloud Secrets Manager 实例的 CRN。

--version VERSION

指定 Kubernetes 或 OpenShift 版本，至少包含 major.minor 版本。 如果未包含该标志，那么将使用缺省版本。 要查看可用的版本，请运行 ibmcloud ks versions。

--workers COUNT

集群工作程序节点的数量。 默认值为 1。

--zone ZONE

在多区域集群中为工作程序池指定区域。 要列出可用的区域，请运行 ibmcloud ks zone ls。

示例

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

ibmcloud ks cluster create classic \
  --private-only \
  --name NAME \
  --zone ZONE \
  --private-vlan VLAN_ID

命令选项

--enable-config-admin

授予 admin 集群访问 Satellite Config 的权限，以便管理 Kubernetes 资源。

--entitlement ENTITLEMENT

仅当您使用具有“OpenShift”使用权的许可证（例如 Cloud Pak ）来运行此集群时，才应将此标志设置为 ocp_entitled。

--host-label LABEL, --hl LABEL

请以键值对的形式输入任意标签，用于标识要分配给您的 Satellite 控制平面或 Red Hat OpenShift 集群的主机。 具有此标签且未分配的第一个主机将自动分配给控制平面或集群。 要查找可用的主机标签，请运行 ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>。

--infrastructure-topology TOPOLOGY

指定集群应运行单个工作程序节点还是缺省数量的工作程序节点。 要创建单节点集群，请指定 single-replica。 要创建一个包含多个工作节点的默认集群，请指定 highly-available``。 默认情况下，会应用 highly-available 选项。 允许的值：single-replica，highly-available

--location LOCATION

Satellite 位置的名称或标识。 要查找位置 ID 或名称，请运行 ibmcloud sat location ls。

--name NAME

请输入集群的名称。

--operating-system SYSTEM

指定操作系统的名称。

--pod-network-interface-selection SELECTION

用于选择内部 pod 网络的节点网络接口的方法。 仅当指定的 Satellite 位置已启用 Red Hat CoreOS 时，才能使用此选项。 若要提供直接的 URL 或 IP 地址，请指定 can-reach=<url> 或 can-reach=<ip_address>。 要选择网络接口，请指定 interface=<network_interface>。

--pod-subnet SUBNET

指定定制子网 CIDR 以便为 Pod 提供专用 IP 地址。 子网必须至少为 /23 或更大。 如需了解更多信息，请参阅 https://ibm.biz/cluster-create-satellite。 缺省值： 172.30.0.0/16

--pull-secret SECRET

通过提供 Red Hat 帐户拉取密钥，指定用于此集群的工作程序节点的现有 OpenShift 权利。

-q

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

--service-subnet SUBNET

指定定制子网 CIDR 以便为服务提供专用 IP 地址。 子网必须至少为 /24 或更大。 如需了解更多信息，请参阅 https://ibm.biz/cluster-create-satellite。 缺省值： 172.21.0.0/16

--sm-group GROUP

用于持久存储私钥的 IBM Cloud Secrets Manager 实例的私钥组标识。

--sm-instance INSTANCE

IBM Cloud Secrets Manager 实例的 CRN。

--version VERSION

Red Hat OpenShift on IBM Cloud 版本，至少包含 major.minor 版本。 要查看可用的版本，请运行 ibmcloud ks versions。

--workers COUNT

缺省工作程序池中每个区域的工作程序节点数。 当指定 --host-label 时，此参数为必填项。

--zone ZONE

多区域集群中缺省工作程序池的区域。 要列出您所在位置的区域，请运行 ibmcloud sat location get。

示例

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

ibmcloud ks cluster create satellite \
  --workers COUNT \
  --host-label HOSTNAME \
  --location LOCATION \
  --name NAME

命令选项

--disable-public-service-endpoint

禁用公共服务端点以阻止公开访问主节点。

--entitlement ENTITLEMENT

仅当您使用具有“OpenShift”使用权的许可证（例如 Cloud Pak ）来运行此集群时，才应将此标志设置为 ocp_entitled。

--flavor FLAVOR

工作程序节点的类型模板。 要查看可用的变体，请运行 ibmcloud ks flavor ls --zone <zone name> （适用于 public. IBM Cloud 账户）或 ibmcloud ks flavor ls （适用于 IBM Cloud Dedicated 账户）。

--name NAME

请输入集群的名称。

--operating-system SYSTEM

指定操作系统的名称。

--pod-subnet SUBNET

指定定制子网 CIDR 以便为 Pod 提供专用 IP 地址。 子网必须至少为 /23 或更大。 如需了解更多信息，请参阅 https://ibm.biz/cluster-create-vpc

-q

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

--service-subnet SUBNET

指定定制子网 CIDR 以便为服务提供专用 IP 地址。 子网必须至少为 /24 或更大。 如需了解更多信息，请参阅 https://ibm.biz/cluster-create-vpc。 缺省值： 172.21.0.0/16

--sm-group GROUP

用于持久存储私钥的 IBM Cloud Secrets Manager 实例的私钥组标识。

--sm-instance INSTANCE

IBM Cloud Secrets Manager 实例的 CRN。

--subnet-id ID

要分配给集群的 VPC 子网。 要列出可用的子网，请运行 ibmcloud ks subnets --provider vpc-classic --vpc-id <vpc-id> --zone <vpc-zone>。

--version VERSION

指定 Kubernetes 或 OpenShift 版本，至少包含 major.minor 版本。 如果未包含该标志，那么将使用缺省版本。 要查看可用的版本，请运行 ibmcloud ks versions。

--vpc-id ID

要在其中创建工作程序节点的 VPC 的标识。 要列出可用的ID，请运行 ibmcloud ks vpcs。

--workers COUNT

缺省工作程序池中每个区域的工作程序节点数。 对于 OpenShift 集群，必须将此值设置为至少 2。 对于 Kubernetes 集群，此值为可选。

--zone ZONE

在多区域集群中为工作程序池指定区域。 要列出可用的区域，请运行 ibmcloud ks zone ls。

示例

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

ibmcloud ks cluster create vpc-classic --name NAME --zone ZONE --vpc-id VPC_ID

命令选项

--cluster-security-group GROUP

可选。 请指定一个或多个安全组标识，以应用于集群上所有工作程序。 对于 OpenShift 版本（ 4.15 ）以及 Kubernetes 版本（ 1.30 及更高版本），这些安全组将在 IBM 管理的 kube-clusterID 安全组之外额外应用。 对于较早版本的集群，请指定 --cluster-security-group cluster 选项以应用 kube-clusterID 安全组。 如果未指定任何值，则会应用一组默认的安全组，其中包括 kube-clusterID。

--cni CNI

为集群设置网络插件。 Calico 默认已设置为该值。 允许的值：Calico，OVNKubernetes

--cos-instance INSTANCE

仅 OpenShift Cluster 必需。 用于在 OpenShift Cluster 中备份内部注册表的标准云对象存储器实例的 CRN。 要列出您的云对象存储实例的 CRN，请运行 ibmcloud resource service-instances --long --service-name cloud-object-storage。

--crk 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 ENTITLEMENT

仅当您使用具有“OpenShift”使用权的许可证（例如 Cloud Pak ）来运行此集群时，才应将此标志设置为 ocp_entitled。

--flavor FLAVOR

工作程序节点的类型模板。 要查看可用的变体，请运行 ibmcloud ks flavor ls --zone <zone name> （适用于 public. IBM Cloud 账户）或 ibmcloud ks flavor ls （适用于 IBM Cloud Dedicated 账户）。

--kms-account-id ID

包含要用于本地磁盘或私钥加密的 KMS 实例的帐户的标识。

--kms-instance INSTANCE

用于本地磁盘加密的 KMS 实例的标识。 要列出可用的 KMS 实例，请运行 ibmcloud ks kms instance ls。

--name NAME

请输入集群的名称。

--offering OFFERING

指定集群方案。 允许的值：kubernetes、openshift、openshift-vs

--operating-system SYSTEM

指定操作系统的名称。

--pod-subnet SUBNET

指定定制子网 CIDR 以便为 Pod 提供专用 IP 地址。 子网必须至少为 /23 或更大。 如需了解更多信息，请参阅 https://ibm.biz/cluster-create-vpc

-q

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

--secondary-storage STORAGE

类型模板的辅助存储器选项。 要查看某种配置可用的二级存储选项，请运行 ibmcloud ks flavor get --provider vpc-gen2 --zone <zone name>。

--service-subnet SUBNET

指定定制子网 CIDR 以便为服务提供专用 IP 地址。 子网必须至少为 /24 或更大。 如需了解更多信息，请参阅 https://ibm.biz/cluster-create-vpc。 缺省值： 172.21.0.0/16

--sm-group GROUP

用于持久存储私钥的 IBM Cloud Secrets Manager 实例的私钥组标识。

--sm-instance INSTANCE

IBM Cloud Secrets Manager 实例的 CRN。

--subnet-id ID

要分配给集群的 VPC 子网。 要列出可用的子网，请运行 ibmcloud ks subnets --provider vpc-gen2 --vpc-id <vpc-id> --zone <vpc-zone>。

--version VERSION

指定 Kubernetes 或 OpenShift 版本，至少包含 major.minor 版本。 如果未包含该标志，那么将使用缺省版本。 要查看可用的版本，请运行 ibmcloud ks versions。

--vpc-id ID

要在其中创建工作程序节点的 VPC 的标识。 要列出可用的ID，请运行 ibmcloud ks vpcs。

--workers COUNT

缺省工作程序池中每个区域的工作程序节点数。 对于 OpenShift 集群，必须将此值设置为至少 2。 对于 Kubernetes 集群，此值为可选。

--zone ZONE

在多区域集群中为工作程序池指定区域。 要列出可用的区域，请运行 ibmcloud ks zone ls。

示例

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

ibmcloud ks cluster create vpc-gen2 \
  --cos-instance INSTANCE_ID \
  --name NAME \
  --zone ZONE \
  --vpc-id VPC_ID

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--show-resources

显示其他集群资源，例如附加组件、VLAN 和子网。

示例

获取已注册集群的详细信息。

ibmcloud sat cluster get --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks cluster image-security disable --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

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

ibmcloud ks cluster image-security enable --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

-l LOCATION, --location LOCATION

要进行过滤的位置。 要列出可用的位置，请运行 ibmcloud ks locations。

--output OUTPUT

以提供的格式打印命令输出。 如果未包含提供商标志，则仅返回经典集群。 接受的值： json

--provider PROVIDER

过滤特定基础架构提供程序的列表。 允许的值：classic、vpc-classic、vpc-gen2、satellite

-q

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

示例

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

ibmcloud sat cluster ls --filter FILTER --limit LIMIT --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks cluster master console-oauth-access get \
  --cluster CLUSTER_NAME_OR_ID \
  --output json \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--type TYPE

指定 OpenShift Web控制台和 OAuth 服务器访问类型。 允许的值：vpe-gateway，legacy

示例

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

ibmcloud ks cluster master console-oauth-access set \
  --cluster CLUSTER_NAME_OR_ID \
  --type TYPE \
  -f

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks cluster master pod-security get \
  --cluster CLUSTER_NAME_OR_ID \
  --output json \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks cluster master pod-security policy disable --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks cluster master pod-security policy enable --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks cluster master pod-security policy get \
  --cluster CLUSTER_NAME_OR_ID \
  --output json \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--config-file FILE

定制 PodSecurity 配置的文件路径。 如果未指定，那么会应用 Kubernetes 缺省值。 有关更多信息，请参阅 https://ibm.biz/BdPtUB

-q

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

示例

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

ibmcloud ks cluster master pod-security set \
  --cluster CLUSTER_NAME_OR_ID \
  --config-file FILE_PATH \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks cluster master pod-security unset --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--subnet SUBNET

指定子网 CIDR。

示例

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

ibmcloud ks cluster master private-service-endpoint allowlist add \
  --cluster CLUSTER_NAME_OR_ID \
  --subnet SUBNET_CIDR \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

禁用允许列表。

ibmcloud ks cluster master private-service-endpoint allowlist disable \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

启用允许列表。

ibmcloud ks cluster master private-service-endpoint allowlist enable \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks cluster master private-service-endpoint allowlist get \
  --cluster CLUSTER_NAME_OR_ID \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--subnet SUBNET

指定子网 CIDR。

示例

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

ibmcloud ks cluster master private-service-endpoint allowlist rm \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  --subnet SUBNET_CIDR

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

-y

如果该功能需要进一步操作（如重新装入工作程序或者刷新集群主节点），那么会在无用户提示的情况下执行这些操作。

示例

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

ibmcloud ks cluster master private-service-endpoint enable \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -y Y

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

-y

如果该功能需要进一步操作（如重新装入工作程序或者刷新集群主节点），那么会在无用户提示的情况下执行这些操作。

示例

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

ibmcloud ks cluster master public-service-endpoint disable \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -y Y

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

-y

如果该功能需要进一步操作（如重新装入工作程序或者刷新集群主节点），那么会在无用户提示的情况下执行这些操作。

示例

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

ibmcloud ks cluster master public-service-endpoint enable \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -y Y

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks cluster master refresh --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--subnet SUBNET

指定子网 CIDR。

示例

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

ibmcloud ks cluster master satellite-service-endpoint allowlist add \
  --cluster CLUSTER_NAME_OR_ID \
  --subnet SUBNET_CIDR \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

禁用卫星服务端点的白名单。

ibmcloud ks cluster master satellite-service-endpoint allowlist disable \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

启用卫星服务端点的白名单。

ibmcloud ks cluster master satellite-service-endpoint allowlist enable \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

获取集群的卫星服务端点白名单。

ibmcloud ks cluster master satellite-service-endpoint allowlist get \
  --cluster CLUSTER_NAME_OR_ID \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--subnet SUBNET

指定子网 CIDR。

示例

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

ibmcloud ks cluster master satellite-service-endpoint allowlist rm \
  --cluster CLUSTER_NAME_OR_ID \
  --subnet SUBNET_CIDR \
  -f \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

--force-update

尝试更新，即使更改比工作程序节点当前版本高出两个次要版本也是如此。

-q

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

--version VERSION

指定 Kubernetes 或 OpenShift 版本，至少包含 major.minor 版本。 如果未包含该标志，那么将使用缺省版本。 要查看可用的版本，请运行 ibmcloud ks versions。

示例

将集群主节点更新为最新版本。

ibmcloud ks cluster master update \
  --cluster CLUSTER_NAME_OR_ID \
  --force-update FORCE-UPDATE \
  -f

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

生成一个新的镜像拉取密钥，用于存储集群访问 IBM Cloud 容器注册表中镜像所需的IAM凭证。

ibmcloud ks cluster pull-secret apply --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -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_NAME_OR_ID -f --delete-storage DELETE-STORAGE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--key KEY

指定现有服务密钥的名称或 GUID。 如果定义了服务密钥，则不能同时设置 --role 选项。

--namespace NAMESPACE, -n NAMESPACE

指定 Kubernetes 名称空间。

-q

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

--role ROLE

为服务密钥指定 IAM 角色。 如果指定使用现有密钥，或对于未启用 IAM 的服务（如 Cloud Foundry 服务）指定现有密钥，那么此标志不起作用。

--service SERVICE

指定服务实例的名称。 要查看可用服务实例的列表，请运行 ibmcloud service list （适用于 Cloud Foundry 服务），或运行 ibmcloud resource service-instances （适用于已启用 IAM 的服务）。

示例

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

ibmcloud ks cluster service bind \
  --cluster CLUSTER_NAME_OR_ID \
  --namespace NAME \
  --key KEY

命令选项

--all-namespaces

包含所有 Kubernetes 名称空间。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--namespace NAMESPACE, -n NAMESPACE

Kubernetes 名称空间。 如果未指定，将使用 default 命名空间。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks cluster service ls \
  --cluster CLUSTER_NAME_OR_ID \
  --namespace NAME \
  --all-namespaces NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--namespace NAMESPACE, -n NAMESPACE

指定 Kubernetes 名称空间。

-q

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

--service SERVICE

指定服务实例的名称。 要查看可用服务实例的列表，请运行 ibmcloud service list （适用于 Cloud Foundry 服务），或运行 ibmcloud resource service-instances （适用于已启用 IAM 的服务）。

示例

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

ibmcloud ks cluster service unbind \
  --cluster CLUSTER_NAME_OR_ID \
  --namespace NAME \
  --service SERVICE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--subnet-id ID

指定子网标识。

示例

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

ibmcloud ks cluster subnet add --cluster CLUSTER_NAME_OR_ID --subnet-id SUBNET_CIDR -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--size SIZE

指定便携式子网的大小。 大小必须为 8、16、32 或 64 之一。

--vlan VLAN

指定公共或专用 VLAN 标识。

示例

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

ibmcloud ks cluster subnet create \
  --cluster CLUSTER_NAME_OR_ID \
  --size SIZE \
  --vlan VLAN_ID

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--subnet-id ID

指定子网标识。

示例

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

ibmcloud ks cluster subnet detach \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  --subnet-id SUBNET_CIDR

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--region REGION

指定要设定为目标的区域。

示例

如果您将 IBM Cloud 账户配置为使用不同的凭据来访问 IBM Cloud 经典基础设施组合，

ibmcloud ks credential get --output json --region REGION -q

命令选项

--infrastructure-api-key KEY

IBM Cloud 经典基础架构帐户的 API 密钥。

--infrastructure-username USERNAME

IBM Cloud 经典基础架构帐户的用户名。

-q

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

--region REGION

指定要设定为目标的区域。

示例

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

ibmcloud ks credential set classic \
  --infrastructure-username NAME \
  --infrastructure-api-key INFRASTRUCTURE-API-KEY \
  --region REGION

命令选项

-q

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

--region REGION

指定要设定为目标的区域。

示例

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

ibmcloud ks credential unset --region REGION -q

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--region REGION

资源组所在的区域。

--resource-group GROUP

要检索其默认受信任配置文件的资源组。

示例

获取在资源组中创建的集群的默认受信任配置文件。

ibmcloud ks experimental trusted-profile default get \
  --resource-group RESOURCE_GROUP \
  --region REGION \
  --output json

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--region REGION

资源组所在的区域。

--resource-group GROUP

用于设置受信任配置文件的资源组 ID。

--trusted-profile PROFILE

受信任的配置文件 ID。

示例

为在资源组中创建的集群设置默认受信任配置文件。

ibmcloud ks experimental trusted-profile default set \
  --resource-group RESOURCE_GROUP \
  --trusted-profile FILE_PATH \
  --region REGION

命令选项

--cluster CLUSTER

用于检索受信任配置文件的集群 ID。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

获取集群的可信配置文件。

ibmcloud ks experimental trusted-profile get \
  --cluster CLUSTER_NAME_OR_ID \
  --output json \
  -q

命令选项

--cluster CLUSTER

用于设置受信任配置文件的集群 ID。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--trusted-profile PROFILE

受信任的配置文件 ID。

示例

在集群上设置受信任配置文件。

ibmcloud ks experimental trusted-profile set \
  --cluster CLUSTER_NAME_OR_ID \
  --trusted-profile FILE_PATH \
  --output json

命令选项

--auto-delete

当 VNI 从集群中移除时，自动将其删除。

--cluster-id ID, -c ID

集群的ID。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--vlan VLAN

裸机节点连接的VLAN ID。 每个 VPC 子网必须具有唯一的名称。 来自同一子网的多个 VNI 可以复用同一 VLAN ID。 有效范围：1-500。

--vni VNI

要连接的虚拟网络接口的 ID。 您必须指定当前没有目标资源的 VNI。 要列出所有 VNI，请运行 ibmcloud is vnis。 要检查某个特定的 VNI 是否已绑定到资源上，请查看 'ibmcloud is vni <VNI_ID>' 中的“目标”字段。

--worker WORKER, -w WORKER

工作节点的ID。

示例

将虚拟网络接口连接到裸机工作节点或集群。

ibmcloud ks experimental vni attach baremetal \
  --cluster-id CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --vni VNI

命令选项

--auto-delete

当 VNI 从集群中移除时，自动将其删除。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--vni VNI

要连接的虚拟网络接口的 ID。 您必须指定当前没有目标资源的 VNI。 要列出所有 VNI，请运行 ibmcloud is vnis。 要检查某个特定的 VNI 是否已绑定到资源上，请查看 'ibmcloud is vni <VNI_ID>' 中的“目标”字段。

--worker WORKER, -w WORKER

工作节点的ID。

示例

将一个虚拟网络接口连接到虚拟工作节点。

ibmcloud ks experimental vni attach virtual \
  --vni VNI \
  --worker WORKER_ID \
  --auto-delete AUTO-DELETE

命令选项

--cluster-id ID, -c ID

集群的ID。

-f

强制此命令运行，而不显示用户提示。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--vni VNI

要断开连接的虚拟网络接口的 ID。

--worker WORKER, -w WORKER

工作节点的ID。

示例

将虚拟网络接口从工作节点或集群中分离。

ibmcloud ks experimental vni detach \
  --cluster-id CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --vni VNI

命令选项

--after AFTER

在指定光标位置后显示虚拟网络接口。

--cluster-id ID, -c ID

集群的ID。

--first FIRST

查看后续的虚拟网络接口，直至前几个VNI。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--worker WORKER, -w WORKER

工作节点的ID。

示例

列出连接到某个集群的虚拟网络接口。

ibmcloud ks experimental vni ls --cluster-id ID

列出连接到工作节点的虚拟网络接口。

ibmcloud ks experimental vni ls --worker WORKER

命令选项

--flavor FLAVOR

工作程序节点的类型模板。 要查看可用的变体，请运行 ibmcloud ks flavor ls --zone <zone name> （适用于 public. IBM Cloud 账户）或 ibmcloud ks flavor ls （适用于 IBM Cloud Dedicated 账户）。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

--provider PROVIDER

指定提供程序。 可选选项包括 classic、vpc-classic 和 vpc-gen2。

-q

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

--zone ZONE

指定要列出其可用类型的区域。 要列出可用的区域，请运行 ibmcloud ks zone ls。

示例

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

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

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

--provider PROVIDER

要获取其特色的提供程序类型。 允许的值：classic、vpc-classic、vpc-gen2、satellite

-q

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

--show-os

列出支持的操作系统。

--show-storage

显示其他存储驱动器。

--zone ZONE

指定要列出其可用类型的区域。 要列出可用的区域，请运行 ibmcloud ks zone ls。

示例

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

ibmcloud ks flavor ls --zone ZONE --show-storage SHOW-STORAGE --show-os SHOW-OS

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--region REGION

指定要设定为目标的区域。 如果尚未指定目标区域，则必须指定此参数。 要检查某个区域是否被选中，请运行 ibmcloud target。

示例

请检查用于访问目标资源的 IBM Cloud 经典基础设施组合的凭据。

ibmcloud ks infra-permissions get --output json --region REGION -q

命令选项

--alb ALB

ALB 标识。 要查看可用的 ALB ID，请运行 ibmcloud ks ingress alb ls。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress alb autoscale get \
  --cluster CLUSTER_NAME_OR_ID \
  --alb ALB_ID \
  --output json

命令选项

--alb ALB

ALB 标识。 要查看可用的 ALB ID，请运行 ibmcloud ks ingress alb ls。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--cpu-average-utilization PERCENT

平均 CPU 利用率阈值。 用于动态计算副本数。

--custom-metrics-file FILE

定制度量文件的路径。 有关更多详细信息，请参阅 https://ibm.biz/iks-ingress-custom-metrics。

--max-replicas REPLICAS

给定 ALB 的最大副本数。 请确保有足够的工人。

--min-replicas REPLICAS

给定 ALB 的最小副本数。 必须大于或等于 1。 （为了实现高可用性，建议的最小值为 2。）

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

为入口 ALB 配置自动缩放。

ibmcloud ks ingress alb autoscale set \
  --cluster CLUSTER_NAME_OR_ID \
  --alb ALB_ID \
  --max-replicas MAX-REPLICAS

命令选项

--alb ALB

ALB 标识。 要查看可用的 ALB ID，请运行 ibmcloud ks ingress alb ls。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks ingress alb autoscale unset --cluster CLUSTER_NAME_OR_ID --alb ALB_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks ingress alb autoupdate disable --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks ingress alb autoupdate enable --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress alb autoupdate get --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--ip IP

请指定一个可在 vlan 上使用且包含在待创建或启用的ALB的 zone 中的可移植公共或私有IP地址。

-q

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

--type TYPE

指定 ALB 的类型。 可用选项：公开、私有简体中文（大陆）

--version VERSION

指定 ALB 镜像版本。 要查看支持的图像版本，请运行 ibmcloud ks ingress alb versions。

--vlan VLAN

VLAN 标识。 该 VLAN 必须与 ALB 的“type”匹配，并且必须位于与您要创建的 ALB 相同的“zone”中。

--zone ZONE

在多区域集群中为工作程序池指定区域。 要列出可用的区域，请运行 ibmcloud ks zone ls。

示例

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

ibmcloud ks ingress alb create classic \
  --cluster CLUSTER_NAME_OR_ID \
  --zone ZONE \
  --type TYPE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--type TYPE

指定 ALB 的类型。 可用选项：公开、私有简体中文（大陆）

--version VERSION

指定 ALB 镜像版本。 要查看支持的图像版本，请运行 ibmcloud ks ingress alb versions。

--zone ZONE

在多区域集群中为工作程序池指定区域。 要列出可用的区域，请运行 ibmcloud ks zone ls。

示例

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

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

命令选项

--alb ALB

ALB 标识。 要查看可用的 ALB ID，请运行 ibmcloud ks ingress alb ls。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

在集群中禁用 Ingress ALB。

ibmcloud ks ingress alb disable --cluster CLUSTER_NAME_OR_ID --alb ALB_ID -q

命令选项

--alb ALB

ALB 标识。 要查看可用的 ALB ID，请运行 ibmcloud ks ingress alb ls。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--ip IP

请指定一个可在 vlan 上使用且包含在待创建或启用的ALB的 zone 中的可移植公共或私有IP地址。

-q

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

--version VERSION

指定 ALB 镜像版本。 要查看支持的图像版本，请运行 ibmcloud ks ingress alb versions。

示例

在经典集群中启用 Ingress ALB。

ibmcloud ks ingress alb enable classic \
  --cluster CLUSTER_NAME_OR_ID \
  --alb ALB_ID \
  --version VERSION

命令选项

--alb ALB

ALB 标识。 要查看可用的 ALB ID，请运行 ibmcloud ks ingress alb ls。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--version VERSION

指定 ALB 镜像版本。 要查看支持的图像版本，请运行 ibmcloud ks ingress alb versions。

示例

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

ibmcloud ks ingress alb enable vpc-gen2 \
  --cluster CLUSTER_NAME_OR_ID \
  --alb ALB_ID \
  --version VERSION

命令选项

--alb ALB

ALB 标识。 要查看可用的 ALB ID，请运行 ibmcloud ks ingress alb ls。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress alb get --cluster CLUSTER_NAME_OR_ID --alb ALB_ID --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks ingress alb health-checker disable --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks ingress alb health-checker enable --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress alb health-checker get --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress alb ls --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--alb ALB

要更新特定 ALB，请指定 ALB 标识。 要查看可用的 ALB ID，请运行 ibmcloud ks ingress alb ls。 若要更新多个 ALB，请在每个标志中指定一个 ALB ID，例如 --alb ID_1 --alb ID_2。 要更新所有 ALB，请勿包含此标志。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--version VERSION

指定 ALB 镜像版本。 要查看支持的图像版本，请运行 ibmcloud ks ingress alb versions。

示例

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

ibmcloud ks ingress alb update \
  --cluster CLUSTER_NAME_OR_ID \
  --version VERSION \
  --alb ALB_ID

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--region REGION

指定要设定为目标的区域。

示例

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

ibmcloud ks ingress alb versions --region REGION --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--crn CRN

IBM CIS 实例的 CRN。

--domain DOMAIN

Ingress 域。 要查看现有域名，请运行 ibmcloud ks ingress domain ls。

--domain-provider PROVIDER

DNS 服务提供商。 默认的 DNS 提供商是我们内部的。 有关受支持的提供商，请参阅我们的文档：https://ibm.biz/containers-ingress-domains

--domain-zone ZONE

CIS 的 ZoneID。

--hostname HOSTNAME

对于 VPC 集群。 要为域注册的主机名。

--ip IP

要为域注册的 IP 地址。

--is-default

包含此选项以将相关域设置为集群的缺省域。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--secret-namespace NAMESPACE

要在其中创建 TLS 私钥的名称空间。

示例

为集群创建 Ingress 域。

ibmcloud ks ingress domain create \
  --cluster CLUSTER_NAME_OR_ID \
  --domain DOMAIN \
  --domain-provider DOMAIN

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--domain DOMAIN

Ingress 域。 要查看现有域名，请运行 ibmcloud ks ingress domain ls。

-q

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

示例

更改集群的缺省 Ingress 域。

ibmcloud ks ingress domain default replace \
  --cluster CLUSTER_NAME_OR_ID \
  --domain DOMAIN \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--domain DOMAIN

Ingress 域。 要查看现有域名，请运行 ibmcloud ks ingress domain ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

查看 Ingress 域的详细信息。

ibmcloud ks ingress domain get \
  --cluster CLUSTER_NAME_OR_ID \
  --domain DOMAIN \
  --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

列出集群的所有 Ingress 域。

ibmcloud ks ingress domain ls --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--domain DOMAIN

Ingress 域。 要查看现有域名，请运行 ibmcloud ks ingress domain ls。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

从集群中移除 Ingress 域。

ibmcloud ks ingress domain rm --cluster CLUSTER_NAME_OR_ID --domain DOMAIN -f

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--domain DOMAIN

Ingress 域。 要查看现有域名，请运行 ibmcloud ks ingress domain ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

为 Ingress 域重新生成证书。

ibmcloud ks ingress domain secret regenerate \
  --cluster CLUSTER_NAME_OR_ID \
  --domain DOMAIN \
  --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--domain DOMAIN

Ingress 域。 要查看现有域名，请运行 ibmcloud ks ingress domain ls。

-f

强制此命令运行，而不显示用户提示。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress domain secret rm --cluster CLUSTER_NAME_OR_ID --domain DOMAIN -f

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--domain DOMAIN

Ingress 域。 要查看现有域名，请运行 ibmcloud ks ingress domain ls。

--hostname HOSTNAME

对于 VPC 集群。 要为域注册的主机名。

--ip IP

要为域注册的 IP 地址。

-q

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

示例

更新集群的 Ingress 域。

ibmcloud ks ingress domain update \
  --cluster CLUSTER_NAME_OR_ID \
  --domain DOMAIN \
  --ip IP_ADDRESS

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--name NAME

已注册的 IBM Cloud Secret Manager 实例的名称。

-q

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

--secret-group GROUP

用于持久存储私钥的 IBM Cloud Secret Manager 实例的私钥组标识。

示例

将已注册的 IBM Cloud Secrets Manager 实例设置为缺省实例。

ibmcloud ks ingress instance default set \
  --cluster CLUSTER_NAME_OR_ID \
  --name NAME \
  --secret-group GROUP

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--name NAME

已注册的 IBM Cloud Secret Manager 实例的名称。

-q

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

示例

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

ibmcloud ks ingress instance default unset --cluster CLUSTER_NAME_OR_ID --name NAME -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--name NAME

已注册的 IBM Cloud Secret Manager 实例的名称。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

查看 IBM Cloud Secrets Manager 实例的详细信息。

ibmcloud ks ingress instance get \
  --cluster CLUSTER_NAME_OR_ID \
  --name NAME \
  --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--show-deleted

显示已从集群注销的 IBM Cloud Secret Manager 实例。

示例

列出 IBM Cloud Secrets Manager 的所有实例。

ibmcloud ks ingress instance ls \
  --cluster CLUSTER_NAME_OR_ID \
  --output json \
  --show-deleted

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--crn CRN

IBM Cloud Secret Manager 实例的 CRN。

--is-default

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

-q

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

--secret-group GROUP

用于持久存储私钥的 IBM Cloud Secret Manager 实例的私钥组标识。

示例

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

ibmcloud ks ingress instance register \
  --cluster CLUSTER_NAME_OR_ID \
  --crn CRN \
  --is-default IS-DEFAULT

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--name NAME

已注册的 IBM Cloud Secret Manager 实例的名称。

-q

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

示例

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

ibmcloud ks ingress instance unregister --cluster CLUSTER_NAME_OR_ID --name NAME -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--private-backend BACKEND

私有负载均衡器的后端

--public-backend BACKEND

公共负载均衡器的后端

-q

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

示例

设置当前由 VPC ALB 负载均衡器对外暴露的 Ingress 控制器。

ibmcloud ks ingress load-balancer backend set \
  --cluster CLUSTER_NAME_OR_ID \
  --private-backend PRIVATE-BACKEND \
  --public-backend PUBLIC-BACKEND

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress load-balancer get --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

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

ibmcloud ks ingress load-balancer proxy-protocol disable \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -q

命令选项

--cidr CIDR

负载均衡器的 IP 地址范围采用 CIDR 格式。 不会处理其他 IP 地址范围内的负载均衡器转发的 PROXY 头。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

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

ibmcloud ks ingress load-balancer proxy-protocol enable \
  --cluster CLUSTER_NAME_OR_ID \
  --cidr CIDR_ID \
  -f

命令选项

--cert-crn CRN

证书 CRN。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--field FIELD

要包含为字段的私钥 CRN。 若要拉取该私有仓库而无需指定名称，请使用 --field <crn>。 要指定字段名称，请使用 --field name=<crn>。 若要将 IBM Cloud Secrets Manager 密钥用作前缀，请使用 --field prefix=<crn>。

--name NAME

在集群中创建的 Ingress 密钥的名称。

--namespace NAMESPACE, -n NAMESPACE

指定 Kubernetes 名称空间。

--persist

将密钥持久存储在集群中，以便无法将其删除。

-q

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

--type TYPE

Ingress 密钥类型。 可以为 TLS 或 Opaque。 如果未指定任何选项，那么缺省情况下会应用 TLS。

示例

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

ibmcloud ks ingress secret create \
  --cluster CLUSTER_NAME_OR_ID \
  --name NAME \
  --namespace NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--field FIELD

要包含为字段的私钥 CRN。 若要拉取该私有仓库而无需指定名称，请使用 --field <crn>。 要指定字段名称，请使用 --field name=<crn>。 若要将 IBM Cloud Secrets Manager 密钥用作前缀，请使用 --field prefix=<crn>。

--name NAME

在集群中创建的 Ingress 密钥的名称。

--namespace NAMESPACE, -n NAMESPACE

指定 Kubernetes 名称空间。

-q

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

示例

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

ibmcloud ks ingress secret field add \
  --cluster CLUSTER_NAME_OR_ID \
  --name NAME \
  --namespace NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--name NAME

在集群中创建的 Ingress 密钥的名称。

--namespace NAMESPACE, -n NAMESPACE

指定 Kubernetes 名称空间。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--show-crn

显示密钥的 CRN 值。

示例

查看 Ingress 密钥的字段。

ibmcloud ks ingress secret field ls \
  --cluster CLUSTER_NAME_OR_ID \
  --name NAME \
  --namespace NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--field-name NAME

要从私钥中移除的字段的名称。

--name NAME

在集群中创建的 Ingress 密钥的名称。

--namespace NAMESPACE, -n NAMESPACE

指定 Kubernetes 名称空间。

-q

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

示例

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

ibmcloud ks ingress secret field rm \
  --cluster CLUSTER_NAME_OR_ID \
  --name NAME \
  --namespace NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--name NAME

在集群中创建的 Ingress 密钥的名称。

--namespace NAMESPACE, -n NAMESPACE

指定 Kubernetes 名称空间。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

查看 Ingress 密钥的详细信息。

ibmcloud ks ingress secret get \
  --cluster CLUSTER_NAME_OR_ID \
  --name NAME \
  --namespace NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--show-crn

显示密钥的 CRN 值。

--show-deleted

显示已从集群中删除的私钥。

示例

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

ibmcloud ks ingress secret ls --cluster CLUSTER_NAME_OR_ID --show-deleted --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--name NAME

在集群中创建的 Ingress 密钥的名称。

--namespace NAMESPACE, -n NAMESPACE

指定 Kubernetes 名称空间。

-q

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

示例

从集群中移除 Ingress 密钥。

ibmcloud ks ingress secret rm \
  --cluster CLUSTER_NAME_OR_ID \
  --name NAME \
  --namespace NAME

命令选项

--cert-crn CRN

证书 CRN。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--name NAME

在集群中创建的 Ingress 密钥的名称。

--namespace NAMESPACE, -n NAMESPACE

指定 Kubernetes 名称空间。

-q

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

示例

更新现有的 Ingress 密钥。

ibmcloud ks ingress secret update \
  --cluster CLUSTER_NAME_OR_ID \
  --name NAME \
  --namespace NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

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

ibmcloud ks ingress security port80 disable --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

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

ibmcloud ks ingress security port80 enable --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress security port80 get --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress status-report disable --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress status-report enable --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress status-report get --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--code CODE

要忽略的警告的代码。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

添加集群的 Ingress 状态要忽略的警告。

ibmcloud ks ingress status-report ignored-errors add \
  --code CODE \
  --cluster CLUSTER_NAME_OR_ID \
  --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress status-report ignored-errors ls \
  --cluster CLUSTER_NAME_OR_ID \
  --output json \
  -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--code CODE

要除去的警告的代码。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks ingress status-report ignored-errors rm \
  --code CODE \
  --cluster CLUSTER_NAME_OR_ID \
  --output json

命令选项

--instance-id ID

KMS 实例标识。 要查看可用的 KMS 实例，请运行 ibmcloud ks kms instance ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks kms crk ls --output json --instance-id INSTANCE_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--crk CRK

KMS 实例中的根密钥标识。 要列出可用的根密钥，请运行 ibmcloud ks kms crk ls --instance-id <kms_instance>。

--instance-id ID

KMS 实例标识。 要查看可用的 KMS 实例，请运行 ibmcloud ks kms instance ls。

--kms-account-id ID

包含要用于本地磁盘或私钥加密的 KMS 实例的帐户的标识。

--public-endpoint

指定此选项以使用 KMS 公共服务端点。 否则，将使用 KMS 专用服务端点。

-q

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

示例

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

ibmcloud ks kms enable \
  --cluster CLUSTER_NAME_OR_ID \
  --instance-id INSTANCE_ID \
  --crk CRK

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks kms instance ls --output json -q

命令选项

--output

以提供的格式打印命令输出。 接受的值： json

--provider

过滤特定基础架构提供程序的列表。 允许的值：classic、vpc-classic、vpc-gen2、satellite

-q

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

--show-flavors

在 VPC 的区域中显示可用的工作程序节点特色。

示例

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

ibmcloud ks locations --provider PROVIDER_ID --show-flavors FLAVOR --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks logging autoupdate disable --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

示例

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

ibmcloud ks logging autoupdate enable --cluster CLUSTER_NAME_OR_ID -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

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

ibmcloud ks logging autoupdate get --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

-C CONTAINER, --app-container CONTAINER

指定要为其收集日志的容器。 若要指定多个路径，请使用多个参数，例如 -C container1 -C container2。 对于“application”日志源，此选项是必需的。 如果未提供，那么将从传递的应用程序日志路径中的所有容器收集日志。

--ca-cert CERT

当日志记录类型为“syslog”且协议为“tls”时，包含证书颁发机构证书的 Kubernetes 密钥名称。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--force-update

强制将集群中的 Fluentd 仓更新到最新版本。

--hostname HOSTNAME

当日志类型为 syslog 时，日志收集器的主机名或IP地址。 当日志类型为 ibm （已弃用）时，日志采集端点。 如果不提供日志记录采集端点，那么将使用当前区域的端点。

--logsource LOGSOURCE

要转发的日志源。 支持的值包括：container、application、ingress、worker、storage 以及 kubernetes。 此自变量支持日志源的逗号分隔列表。 如果您未指定日志源，系统将转发 container 和 ingress 的日志。

--namespace NAMESPACE, -n NAMESPACE

想要应用到日志转发配置的名称空间。 仅在与 container 日志源配合使用时，或未指定日志源时，才应使用此标志。 如果不指定名称空间，那么所有名称空间都使用此配置。

--org ORG

已弃用：用于发送日志的组织名称。 只有当日志类型为 ibm 时，此标志才有效。 指定空间名称时，组织名称是必需的。 如果不指定空间名称，那么将在帐户级别转发日志。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-p PATH, --app-path PATH

指定绝对文件路径，以便从容器内部收集日志。 若要指定多个路径，请使用多个参数，例如 -p path1 -p path2。 在为日志源指定 application 时，此参数为必填项。 允许使用诸如 /var/log/*.log 这样的通配符，但不允许使用诸如 /var/log/**/test.log 这样的递归通配符。

--port PORT

日志收集器的端口。 如果您未指定端口，则 ibm （已弃用）将使用摄入端点的默认端口，而 syslog 将使用 514。

-q

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

--skip-validation

指定组织和空间名称时跳过对它们的验证。 如果值无效，那么这可能会导致日志记录配置中断，但将花费较少的时间来处理。

--space SPACE

已弃用 用于发送日志的空间名称。 只有当日志类型为 ibm 时，此标志才有效。 指定组织名称时，空间名称是必需的。 如果不指定空间名称，那么将在帐户级别转发日志。

--syslog-protocol PROTOCOL

当日志类型为 syslog 时，传输层协议。 支持的值包括 tls、tcp 以及默认值 udp。 当使用 UDP 协议转发到 rsyslog 服务器时，将截断大小超过 1KB 的日志。

--type TYPE

您要使用的日志转发协议。 唯一支持的值是 syslog。

--verify-mode MODE

当日志类型为 syslog 且协议为tls时，验证模式。 支持的值包括 verify-peer，默认值为 verify-none。

示例

创建日志记录配置。

ibmcloud ks logging config create \
  --org ORG \
  --space SPACE \
  -C C \
  -p POOL_NAME \
  --cluster CLUSTER_NAME_OR_ID \
  --namespace NAME \
  --logsource LOGSOURCE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--logsource LOGSOURCE

要过滤的日志源的类型。 允许的值包括：container、application、ingress、worker、storage 和 kubernetes。 如果未传入日志源，则将返回该集群的所有日志配置。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

查看集群的日志转发配置。

ibmcloud ks logging config get \
  --cluster CLUSTER_NAME_OR_ID \
  --logsource LOGSOURCE \
  --output json

命令选项

--all

移除所有日志转发配置。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--force-update

强制将集群中的 Fluentd 仓更新到最新版本。

--id ID

指定日志记录配置的标识。

--namespace NAMESPACE, -n NAMESPACE

要从中除去日志转发配置的名称空间。 如果同一个命名空间有多个配置，请改用 --id <logging configuration ID> 标志。

-q

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

示例

从集群中删除日志转发配置。

ibmcloud ks logging config rm --cluster CLUSTER_NAME_OR_ID --namespace NAME

命令选项

-C CONTAINER, --app-container CONTAINER

指定要为其收集日志的容器。 若要指定多个路径，请使用多个参数，例如 -C container1 -C container2。 对于“application”日志源，此选项是必需的。 如果未提供，那么将从传递的应用程序日志路径中的所有容器收集日志。

--ca-cert CERT

当日志记录类型为“syslog”且协议为“tls”时，包含证书颁发机构证书的 Kubernetes 密钥名称。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--force-update

强制将集群中的 Fluentd 仓更新到最新版本。

--hostname HOSTNAME

当日志类型为 syslog 时，日志收集器的主机名或IP地址。 当日志类型为 ibm （已弃用）时，日志采集端点。 如果不提供日志记录采集端点，那么将使用当前区域的端点。

--id ID

指定日志记录配置的标识。

--logsource LOGSOURCE

要转发的日志源。 支持的值包括：container、application、ingress、worker、storage 以及 kubernetes。 此自变量支持日志源的逗号分隔列表。 如果您未指定日志源，系统将转发 container 和 ingress 的日志。

--namespace NAMESPACE, -n NAMESPACE

想要应用到日志转发配置的名称空间。 仅在与 container 日志源配合使用时，或未指定日志源时，才应使用此标志。 如果不指定名称空间，那么所有名称空间都使用此配置。

--org ORG

已弃用：用于发送日志的组织名称。 只有当日志类型为 ibm 时，此标志才有效。 指定空间名称时，组织名称是必需的。 如果不指定空间名称，那么将在帐户级别转发日志。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-p PATH, --app-path PATH

指定绝对文件路径，以便从容器内部收集日志。 若要指定多个路径，请使用多个参数，例如 -p path1 -p path2。 在为日志源指定 application 时，此参数为必填项。 允许使用诸如 /var/log/*.log 这样的通配符，但不允许使用诸如 /var/log/**/test.log 这样的递归通配符。

--port PORT

日志收集器的端口。 如果您未指定端口，则 ibm （已弃用）将使用摄入端点的默认端口，而 syslog 将使用 514。

-q

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

--skip-validation

指定组织和空间名称时跳过对它们的验证。 如果值无效，那么这可能会导致日志记录配置中断，但将花费较少的时间来处理。

--space SPACE

已弃用 用于发送日志的空间名称。 只有当日志类型为 ibm 时，此标志才有效。 指定组织名称时，空间名称是必需的。 如果不指定空间名称，那么将在帐户级别转发日志。

--syslog-protocol PROTOCOL

当日志类型为 syslog 时，传输层协议。 支持的值包括 tls、tcp 以及默认值 udp。 当使用 UDP 协议转发到 rsyslog 服务器时，将截断大小超过 1KB 的日志。

--type TYPE

您要使用的日志转发协议。 唯一支持的值是 syslog。

--verify-mode MODE

当日志类型为 syslog 且协议为tls时，验证模式。 支持的值包括 verify-peer，默认值为 verify-none。

示例

更新集群的日志转发配置。

ibmcloud ks logging config update \
  --org ORG \
  --space SPACE \
  -C C \
  -p POOL_NAME \
  --cluster CLUSTER_NAME_OR_ID \
  --id <_id> \
  --namespace NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--container CONTAINER

要从中过滤掉日志的容器的名称。 仅当使用日志类型容器时，该标志才适用。

--force-update

强制将集群中的 Fluentd 仓更新到最新版本。

--lc LOGGING-CONFIG, --logging-config LOGGING-CONFIG

日志记录配置标识。 如果未提供，则该过滤器将应用于传递给该过滤器的所有集群日志配置。 可使用 --show-matching-configs 标志以及该命令来查看与过滤器匹配的日志配置。

--level LEVEL

过滤掉处于指定级别及更低级别的日志。 可接收的值按规范次序依次为致命、错误、警告、参考、调试和跟踪。 例如，如果过滤掉参考级别的日志，那么还将过滤掉调试和跟踪级别的日志。 注：仅当日志消息为 JSON 格式且包含 level 字段时，才能使用此标志。 输出示例：{"log": "hello", "level": "info"}

--message MESSAGE

过滤掉在日志中任何位置包含指定消息的任何日志。 消息按字面值进行匹配，而不作为表达式进行匹配。 示例：消息“Hello”、“!”和“Hello, World!”将匹配日志“Hello, World!”。

--namespace NAMESPACE, -n NAMESPACE

要从中过滤日志的 Kubernetes 名称空间。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--regex-message MESSAGE

过滤出在日志中包含指定消息正则表达式模式的任何日志。 消息以正则表达式形式进行匹配。 示例：模式“hello [0-9]”将匹配“hello 1”、“hello 2”和“hello 9”

--type TYPE

要应用过滤器的日志的类型。 当前，支持所有容器和主机。

示例

过滤掉根据日志记录配置转发的日志。

ibmcloud ks logging filter create \
  --cluster CLUSTER_NAME_OR_ID \
  --type TYPE \
  --namespace NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--id ID

指定日志记录过滤器的标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--show-covering-filters

显示导致先前过滤器过时的日志记录过滤器。

--show-matching-configs

显示与要查看的配置相匹配的日志记录配置。

示例

查看日志记录过滤器配置。

ibmcloud ks logging filter get \
  --cluster CLUSTER_NAME_OR_ID \
  --id <_id> \
  --show-matching-configs SHOW-MATCHING-CONFIGS

命令选项

--all

删除所有日志转发过滤器。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--force-update

强制将集群中的 Fluentd 仓更新到最新版本。

--id ID

指定日志记录过滤器的标识。

-q

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

示例

删除日志记录过滤器。

ibmcloud ks logging filter rm --cluster CLUSTER_NAME_OR_ID --id FILTER_ID

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--container CONTAINER

要从中过滤掉日志的容器的名称。 仅当使用日志类型容器时，该标志才适用。

--force-update

强制将集群中的 Fluentd 仓更新到最新版本。

--id ID

指定日志记录过滤器的标识。

--lc LOGGING-CONFIG, --logging-config LOGGING-CONFIG

日志记录配置标识。 如果未提供，则该过滤器将应用于传递给该过滤器的所有集群日志配置。 可使用 --show-matching-configs 标志以及该命令来查看与过滤器匹配的日志配置。

--level LEVEL

过滤掉处于指定级别及更低级别的日志。 可接收的值按规范次序依次为致命、错误、警告、参考、调试和跟踪。 例如，如果过滤掉参考级别的日志，那么还将过滤掉调试和跟踪级别的日志。 注：仅当日志消息为 JSON 格式且包含 level 字段时，才能使用此标志。 输出示例：{"log": "hello", "level": "info"}

--message MESSAGE

过滤掉在日志中任何位置包含指定消息的任何日志。 消息按字面值进行匹配，而不作为表达式进行匹配。 示例：消息“Hello”、“!”和“Hello, World!”将匹配日志“Hello, World!”。

--namespace NAMESPACE, -n NAMESPACE

要从中过滤日志的 Kubernetes 名称空间。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--regex-message MESSAGE

过滤出在日志中包含指定消息正则表达式模式的任何日志。 消息以正则表达式形式进行匹配。 示例：模式“hello [0-9]”将匹配“hello 1”、“hello 2”和“hello 9”

--type TYPE

要应用过滤器的日志的类型。 当前，支持所有容器和主机。

示例

更新日志记录过滤器。

ibmcloud ks logging filter update --cluster CLUSTER_NAME_OR_ID --id FILTER_ID --type TYPE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--force-update

强制将集群中的 Fluentd 仓更新到最新版本。

-q

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

示例

刷新集群的日志记录配置。

ibmcloud ks logging refresh \
  --cluster CLUSTER_NAME_OR_ID \
  --force-update FORCE-UPDATE \
  -q

命令选项

-q

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

示例

查看当前用户消息。

ibmcloud sat messages -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--ip IP

一个或多个 NLB IP 地址。 要查看负载均衡器的 IP 地址，请运行 kubectl get svc -n <namespace>。

--nlb-host HOST

主机名。 要查看现有的主机名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

将一个 NLB IP 地址添加到您使用 ibmcloud ks nlb-dns create 创建的现有主机名中。

ibmcloud ks nlb-dns add \
  --cluster CLUSTER_NAME_OR_ID \
  --ip IP_ADDRESS \
  --nlb-host HOSTNAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--ip IP

一个或多个 NLB IP 地址。 要查看负载均衡器的 IP 地址，请运行 kubectl get svc -n <namespace>。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--secret-namespace NAMESPACE

要在其中创建 SSL 密钥的名称空间。 如果未指定此标志，则密钥将创建在 default.

示例

创建 DNS 主机名以在经典集群中注册一个或多个 NLB IP。

ibmcloud ks nlb-dns create classic \
  --cluster CLUSTER_NAME_OR_ID \
  --ip IP_ADDRESS \
  --secret-namespace NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--ip IP

一个或多个 NLB IP 地址。 要查看负载均衡器的 IP 地址，请运行 kubectl get svc -n <namespace>。

--lb-host HOST

VPC 负载均衡器主机名。 要查看负载均衡器的主机名，请运行 kubectl get svc -n <namespace>。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--secret-namespace NAMESPACE

要在其中创建 SSL 密钥的名称空间。 如果未指定此标志，则密钥将创建在 default.

示例

创建 DNS 记录以在 VPC 集群中注册负载均衡器主机名或负载均衡器 IP 地址。

ibmcloud ks nlb-dns create vpc-gen2 \
  --cluster CLUSTER_NAME_OR_ID \
  --lb-host HOSTNAME \
  --secret-namespace NAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--nlb-subdomain SUBDOMAIN

子域。 要查看现有的子域名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

查看集群中注册的 NLB 主机名的详细信息。

ibmcloud ks nlb-dns get \
  --cluster CLUSTER_NAME_OR_ID \
  --nlb-subdomain DOMAIN \
  --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

列出集群中的已注册 NLB 主机名和 IP 地址。

ibmcloud ks nlb-dns ls --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--enable

为主机名启用运行状况检查监视器。

--header HEADER

HTTP 健康检查的请求头仅限于 Host 头。 此标志仅适用于类型为 HTTP 或 HTTPS 的情况。 该标志支持以下格式的值：--header Header-Name=value。 更新监视器时，指定的头将替换现有头。 若要删除所有现有标题，请将标志设置为空值：--header ""。

--interval INTERVAL

各个运行状况检查之间的时间间隔（以秒为单位）。 较短的时间间隔可缩短故障转移时间，但会增加 IP 上的负载。 必须在 [60 到 300] 之间。 缺省值： 60

--nlb-host HOST

主机名。 要查看现有的主机名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

--path PATH

运行状况检查所依据的端点路径。 此标志仅适用于类型为 HTTP 或 HTTPS 的情况。 缺省值： /

--port PORT

进行运行状况检查时要连接到的端口号。 如果类型为 TCP，那么此标志是必需的。 如果类型为 HTTP 或 HTTPS，此标志仅用于除 80（针对 HTTP）或 443（针对 HTTPS）以外的端口。 HTTP 默认：80。 HTTPS 默认：443。

-q

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

--timeout TIMEOUT

超时（以秒为单位），在此时间后 IP 会被视为运行状况欠佳。 必须在 [1 到 60] 之间。 缺省值： 5

--type TYPE

用于运行状况检查的协议。 允许的值：http、https、tcp

示例

在集群中为现有 NLB 主机名配置运行状况检查监视器。

ibmcloud ks nlb-dns monitor configure \
  --port PORT \
  --cluster CLUSTER_NAME_OR_ID \
  --nlb-host HOSTNAME \
  --type TYPE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--nlb-host HOST

主机名。 要查看现有的主机名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

禁用集群中某个 NLB 主机名的现有健康检查监视器。

ibmcloud ks nlb-dns monitor disable \
  --cluster CLUSTER_NAME_OR_ID \
  --nlb-host HOSTNAME \
  --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--nlb-host HOST

主机名。 要查看现有的主机名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

在集群中为 NLB 主机名启用运行状况检查监视器。

ibmcloud ks nlb-dns monitor enable \
  --cluster CLUSTER_NAME_OR_ID \
  --nlb-host HOSTNAME \
  --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--nlb-host HOST

主机名。 要查看现有的主机名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

查看现有运行状况检查监视器的设置。

ibmcloud ks nlb-dns monitor get \
  --cluster CLUSTER_NAME_OR_ID \
  --nlb-host HOSTNAME \
  --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

列出集群中每个 NLB 主机名的运行状况检查监视器设置。

ibmcloud ks nlb-dns monitor ls --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--lb-host HOST

VPC 负载均衡器主机名。 要查看负载均衡器的主机名，请运行 kubectl get svc -n <namespace>。

--nlb-subdomain SUBDOMAIN

子域。 要查看现有的子域名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

通过替换 VPC 集群中与现有 DNS 主机名相关联的负载均衡器主机名，更新该 DNS 主机名。

ibmcloud ks nlb-dns replace \
  --cluster CLUSTER_NAME_OR_ID \
  --nlb-subdomain DOMAIN \
  --lb-host HOSTNAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--ip IP

一个 NLB IP 地址。 要查看与该主机名关联的 NLB IP 地址，请运行 ibmcloud ks nlb-dns ls。

--nlb-host HOST

主机名。 要查看现有的主机名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

从 NLB 主机名中移除 NLB IP 地址。

ibmcloud ks nlb-dns rm classic \
  --cluster CLUSTER_NAME_OR_ID \
  --ip IP_ADDRESS \
  --nlb-host HOSTNAME

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--ip IP

一个 NLB IP 地址。 要查看与该主机名关联的 NLB IP 地址，请运行 ibmcloud ks nlb-dns ls。

--nlb-subdomain SUBDOMAIN

子域。 要查看现有的子域名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

从 VPC 集群的 DNS 记录中移除负载均衡器主机名或 IP 地址。

ibmcloud ks nlb-dns rm vpc-gen2 \
  --cluster CLUSTER_NAME_OR_ID \
  --nlb-subdomain DOMAIN \
  --ip IP_ADDRESS

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--nlb-subdomain SUBDOMAIN

子域。 要查看现有的子域名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

重新生成 NLB 子域的证书和密钥。

ibmcloud ks nlb-dns secret regenerate \
  --cluster CLUSTER_NAME_OR_ID \
  --nlb-subdomain DOMAIN \
  --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

--nlb-subdomain SUBDOMAIN

子域。 要查看现有的子域名，请运行 ibmcloud ks nlb-dns ls。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

从 NLB 子域中删除密钥，并阻止证书的未来续订。

ibmcloud ks nlb-dns secret rm --cluster CLUSTER_NAME_OR_ID --nlb-subdomain DOMAIN -f

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

--provider PROVIDER

过滤特定基础架构提供程序的列表。 允许的值：classic、vpc-classic、vpc-gen2、satellite

-q

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

示例

列出 IBM Cloud 帐户中集群相关资源的所有配额和限制。

ibmcloud ks quota ls --output json --provider PROVIDER_ID -q

命令选项

--in-place FILE FILE

使用更新的命令结构来重写源文件。

-q

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

示例

重写调用 IBM Cloud Kubernetes Service 插件命令的脚本。

ibmcloud ks script update --in-place IN-PLACE -q

命令选项

--attached-to ATTACHED

按安全组所关联的组件对安全组进行筛选。 允许的值：cluster、load-balancer、vpc、vpe-gateway、worker-pool

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--managed-by MANAGER

指定 user 可返回用户创建的安全组。 指定 ibm 仅返回由 IBM 管理的安全组。 允许的值：ibm，user

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--scope SCOPE

指定 cluster 以返回作用域限定在该集群内的安全组。 指定 vpc 以返回作用域覆盖整个 VPC 的安全组。 允许的值：cluster，vpc

示例

列出与某个集群关联的所有安全组。

ibmcloud ks security-group ls \
  --cluster CLUSTER_NAME_OR_ID \
  --attached-to ATTACHED-TO \
  --scope SCOPE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--security-group GROUP, --sg GROUP

指定安全组标识。

示例

删除所有现有安全组规则，然后重新应用缺省规则。

ibmcloud ks security-group reset \
  --cluster CLUSTER_NAME_OR_ID \
  --security-group GROUP \
  -f

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--security-group GROUP, --sg GROUP

指定安全组标识。

示例

重新应用不存在的缺省安全组规则。

ibmcloud ks security-group sync --cluster CLUSTER_NAME_OR_ID --security-group GROUP -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--volume VOLUME

指定卷标识。 要列出可用的卷，请运行 ibmcloud ks storage volume ls。

--worker WORKER, -w WORKER

指定工作程序标识。 要列出可用的工作者，请运行 ibmcloud ks workers。

示例

将存储卷连接到工作程序节点。

ibmcloud ks storage attachment create \
  --cluster CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --volume VOLUME

命令选项

--attachment ATTACHMENT

指定卷连接标识。 要列出可用的附件，请运行 ibmcloud ks storage attachment ls。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--worker WORKER, -w WORKER

指定工作程序标识。 要列出可用的工作者，请运行 ibmcloud ks workers。

示例

获取集群中卷连接的详细信息。

ibmcloud ks storage attachment get \
  --cluster CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --attachment ATTACHMENT

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--worker WORKER, -w WORKER

指定工作程序标识。 要列出可用的工作者，请运行 ibmcloud ks workers。

示例

列出集群中工作程序的所有存储卷连接。

ibmcloud ks storage attachment ls \
  --cluster CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --output json

命令选项

--attachment ATTACHMENT

指定卷连接标识。 要列出可用的附件，请运行 ibmcloud ks storage attachment ls。

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--worker WORKER, -w WORKER

指定工作程序标识。 要列出可用的工作者，请运行 ibmcloud ks workers。

示例

从工作程序节点中删除卷连接。

ibmcloud ks storage attachment rm \
  --cluster CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --attachment ATTACHMENT

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--volume VOLUME

指定卷标识。 要列出可用的卷，请运行 ibmcloud ks storage volume ls。

示例

获取卷的详细信息。

ibmcloud ks storage volume get --volume VOLUME --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

--provider PROVIDER

过滤特定基础架构提供程序的列表。 允许的值：classic、vpc-classic、vpc-gen2、satellite

-q

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

--zone ZONE

要进行过滤的区域。 要列出可用的区域，请运行 ibmcloud ks locations。

示例

列出卷的详细信息。

ibmcloud ks storage volume ls \
  --cluster CLUSTER_NAME_OR_ID \
  --provider PROVIDER_ID \
  --zone ZONE

命令选项

-l LOCATION, --location LOCATION

要进行过滤的位置。 要列出可用的位置，请运行 ibmcloud ks locations。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

--provider PROVIDER

过滤特定基础架构提供程序的列表。 可用选项：classic、vpc-classic、vpc-gen2

-q

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

--vpc-id ID

对于提供商类型 vpc-classic 和 vpc-gen2，此字段为必填项：要列出其子网的 VPC 的 ID。 要列出 VPC 标识，请运行 ibmcloud ks vpcs。

--zone ZONE

对于提供商类型 vpc-classic 和 vpc-gen2，此字段为必填项：要列出其 VPC 子网的区域。 要列出可用的区域，请运行 ibmcloud ks zone ls --provider vpc-classic|vpc-gen2。

示例

列出 IBM Cloud 基础架构帐户中的可用便携式子网。

ibmcloud ks subnets \
  --vpc-id VPC_ID \
  --zone ZONE \
  --output json \
  --provider PROVIDER_ID \
  -l L

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--show-version VERSION

仅显示指定容器平台的版本。 允许的值：OpenShift，Kubernetes

示例

列出可用于 IBM Cloud Kubernetes Service 集群的所有容器平台版本。

ibmcloud ks versions --output json --show-version VERSION -q

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--zone ZONE

在多区域集群中为工作程序池指定区域。 要列出可用的区域，请运行 ibmcloud ks zone ls。

示例

为区域列出可用的公共和专用 VLAN。

ibmcloud ks vlan ls --zone ZONE --output json -q

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--region REGION

指定要设定为目标的区域。 如果尚未指定目标区域，则必须指定此参数。 要检查某个区域是否被选中，请运行 ibmcloud target。

示例

查看 IBM Cloud 经典基础架构帐户的 VLAN 生成状态。

ibmcloud ks vlan spanning get --output json --region REGION -q

命令选项

--auto-delete

当 VNI 从集群中移除时，自动将其删除。

--cluster-id ID, -c ID

集群的ID。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--vlan VLAN

裸机节点连接的VLAN ID。 每个 VPC 子网必须具有唯一的名称。 来自同一子网的多个 VNI 可以复用同一 VLAN ID。 有效范围：1-500。

--vni VNI

要连接的虚拟网络接口的 ID。 您必须指定当前没有目标资源的 VNI。 要列出所有 VNI，请运行 ibmcloud is vnis。 要检查某个特定的 VNI 是否已绑定到资源上，请查看 'ibmcloud is vni <VNI_ID>' 中的“目标”字段。

--worker WORKER, -w WORKER

工作节点的ID。

示例

将虚拟网络接口连接到裸机工作节点或集群。

ibmcloud ks vni attach baremetal \
  --cluster-id CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --vni VNI

命令选项

--cluster-id ID, -c ID

集群的ID。

-f

强制此命令运行，而不显示用户提示。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--vni VNI

要断开连接的虚拟网络接口的 ID。

--worker WORKER, -w WORKER

工作节点的ID。

示例

将虚拟网络接口从工作节点或集群中分离。

ibmcloud ks vni detach --cluster-id CLUSTER_NAME_OR_ID --worker WORKER_ID --vni VNI

命令选项

--after AFTER

在指定光标位置后显示虚拟网络接口。

--cluster-id ID, -c ID

集群的ID。

--first FIRST

查看后续的虚拟网络接口，直至前几个VNI。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--worker WORKER, -w WORKER

工作节点的ID。

示例

列出连接到某个集群的虚拟网络接口。

ibmcloud ks vni ls --cluster-id ID

列出连接到工作节点的虚拟网络接口。

ibmcloud ks vni ls --worker WORKER

命令选项

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

--provider PROVIDER

VPC 基础结构提供程序类型。 支持的值包括 vpc-classic 和 vpc-gen2。 缺省情况下，将返回所有提供程序类型的 VPC。

-q

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

示例

列出目标资源组中的所有 VPC。

ibmcloud ks vpc ls --provider PROVIDER_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

禁用“默认安全”VPC 集群的出站流量保护。

ibmcloud ks vpc outbound-traffic-protection disable --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

为“默认安全”VPC 集群启用出站流量保护。

ibmcloud ks vpc outbound-traffic-protection enable --cluster CLUSTER_NAME_OR_ID -f -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--disable-outbound-traffic-protection

启用此选项可允许集群工作节点向外进行公共访问。 默认情况下，公共出站访问被阻止。

-f

强制此命令运行，而不显示用户提示。

-q

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

示例

为使用传统安全组的 VPC 集群启用“默认安全”VPC 网络。

ibmcloud ks vpc secure-by-default enable \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  --disable-outbound-traffic-protection DISABLE-OUTBOUND-TRAFFIC-PROTECTION

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--level LEVEL

设置通知级别。 允许的取值为 Normal 或 Warning。 默认值为 Warning。

-q

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

--type TYPE

要使用的 Webhook 的类型。 目前支持 slack。

--url URL

Webhook URL。

示例

在集群中注册 Webhook。

ibmcloud ks webhook-create --cluster CLUSTER_NAME_OR_ID --type TYPE --url URL

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--worker WORKER, -w WORKER

指定工作程序标识。 要列出可用的工作者，请运行 ibmcloud ks workers。

示例

查看工作程序节点的详细信息。

ibmcloud ks worker get --cluster CLUSTER_NAME_OR_ID --worker WORKER_ID --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--show-delete-reason

显示工作程序节点删除原因。

--show-deleted

显示已从集群删除的工作程序节点。

--show-pools

查看每个工作程序所属的工作程序池。

--worker-pool POOL, -p POOL

仅显示属于您指定的工作程序池的工作程序节点。

示例

列出一个集群中的所有工作程序节点。

ibmcloud ks worker ls \
  --cluster CLUSTER_NAME_OR_ID \
  --worker-pool POOL_NAME \
  --show-pools

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

--hard

通过切断工作程序节点的电源来强制硬重新启动该工作程序节点。 如果工作程序节点无响应或工作程序节点有一个 Docker 挂起，请使用此选项。

-q

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

--skip-master-health

在启动操作之前跳过检查主节点运行状况。

--worker WORKER, -w WORKER

指定一个或多个工作程序标识。

示例

重新启动工作程序节点。

ibmcloud ks worker reboot \
  --cluster CLUSTER_NAME_OR_ID \
  --hard HARD \
  --skip-master-health IP_ADDRESS

命令选项

-f

强制此命令运行，而不显示用户提示。

-q

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

--skip-master-health

在启动操作之前跳过检查主节点运行状况。

--worker WORKER, -w WORKER

指定一个或多个工作程序标识。

示例

在一个或多个工作节点上删除数据，重新映像，并重新安装带最新补丁版本的 Kubernetes。

ibmcloud ks worker reload --skip-master-health IP_ADDRESS -f --worker WORKER_ID

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--update

将工作程序节点更新至主节点相同的主要版本和次要版本以及最新补丁。 如果工作池的操作系统已更新，则也会更新操作系统。

--worker WORKER, -w WORKER

指定工作程序标识。 要列出可用的工作者，请运行 ibmcloud ks workers。

示例

删除工作程序节点，并将其替换为同一工作程序池中的新工作程序节点。

ibmcloud ks worker replace \
  --cluster CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --update UPDATE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--worker WORKER, -w WORKER

指定一个或多个工作程序标识。

示例

从集群中移除工作程序节点。

ibmcloud ks worker rm --cluster CLUSTER_NAME_OR_ID -f --worker WORKER_ID

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--worker WORKER, -w WORKER

指定一个或多个工作程序标识。

示例

将经典集群中的一个或多个工作程序节点更新至新的 Kubernetes 版本。

ibmcloud ks worker update --cluster CLUSTER_NAME_OR_ID -f --worker WORKER_ID

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--disable-disk-encrypt

在工作程序节点上禁用加密。

--entitlement ENTITLEMENT

仅当您使用具有“OpenShift”使用权的许可证（例如 Cloud Pak ）来运行此集群时，才应将此标志设置为 ocp_entitled。

--flavor FLAVOR

工作程序节点的类型模板。 要查看可用的变体，请运行 ibmcloud ks flavor ls --zone <zone name> （适用于 public. IBM Cloud 账户）或 ibmcloud ks flavor ls （适用于 IBM Cloud Dedicated 账户）。

--hardware HARDWARE

工作程序节点的硬件隔离级别。 使用 dedicated 可获得仅供您专用的物理资源；或使用 shared 允许与其他 IBM 客户共享物理资源。 对于 IBM Cloud 公共帐户，将共享缺省值。 对于专用于 IBM Cloud 的帐户，dedicated 是唯一可用的选项。

--label LABEL, -l LABEL

在工作程序池中的所有工作程序上设置标签。

--name NAME

输入工作程序池的名称。

--operating-system SYSTEM

指定操作系统的名称。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--size-per-zone SIZE

指定在该工作程序池中每个区域所期望的工作程序数量。

示例

将工作程序池添加到经典集群。

ibmcloud ks worker-pool create classic \
  --name NAME \
  --cluster CLUSTER_NAME_OR_ID \
  --size-per-zone ZONE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--entitlement ENTITLEMENT

仅当您使用具有“OpenShift”使用权的许可证（例如 Cloud Pak ）来运行此集群时，才应将此标志设置为 ocp_entitled。

--host-label LABEL, --hl LABEL

请以键值对的形式输入任意标签，用于标识要分配给您的 Satellite 控制平面或 Red Hat OpenShift 集群的主机。 具有此标签且未分配的第一个主机将自动分配给控制平面或集群。 要查找可用的主机标签，请运行 ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>。

--label LABEL, -l LABEL

在工作程序池中的所有工作程序上设置标签。

--name NAME

输入工作程序池的名称。

--operating-system SYSTEM

指定操作系统的名称。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--size-per-zone SIZE

指定在该工作程序池中每个区域所期望的工作程序数量。

--zone ZONE

在多区域集群中为工作程序池指定区域。 要列出可用的区域，请运行 ibmcloud ks zone ls。

示例

将工作程序池添加到 IBM Cloud Satellite 集群。

ibmcloud ks worker-pool create satellite \
  --name NAME \
  --cluster CLUSTER_NAME_OR_ID \
  --zone ZONE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--entitlement ENTITLEMENT

仅当您使用具有“OpenShift”使用权的许可证（例如 Cloud Pak ）来运行此集群时，才应将此标志设置为 ocp_entitled。

--flavor FLAVOR

工作程序节点的类型模板。 要查看可用的变体，请运行 ibmcloud ks flavor ls --zone <zone name> （适用于 public. IBM Cloud 账户）或 ibmcloud ks flavor ls （适用于 IBM Cloud Dedicated 账户）。

--label LABEL, -l LABEL

在工作程序池中的所有工作程序上设置标签。

--name NAME

输入工作程序池的名称。

--operating-system SYSTEM

指定操作系统的名称。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--size-per-zone SIZE

指定在该工作程序池中每个区域所期望的工作程序数量。

--vpc-id ID

要在其中创建工作程序节点的 VPC 的标识，此标识必须匹配集群所在的 VPC。 要列出集群的 VPC ID，请运行 ibmcloud ks cluster get -c <cluster_name_or_ID>。 如果未提供此标志，那么工作程序池缺省设置为集群中现有工作程序池的 VPC 标识。

示例

将工作程序池添加到 VPC 第 1 代集群。

ibmcloud ks worker-pool create vpc-classic \
  --name NAME \
  --cluster CLUSTER_NAME_OR_ID \
  --flavor FLAVOR

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--crk CRK

用于本地磁盘加密的 KMS 实例中根密钥的标识。 要列出可用的根密钥，请运行 ibmcloud ks kms crk ls --instance-id <kms_instance>。

--disable-disk-encrypt

在工作程序节点上禁用加密。

--entitlement ENTITLEMENT

仅当您使用具有“OpenShift”使用权的许可证（例如 Cloud Pak ）来运行此集群时，才应将此标志设置为 ocp_entitled。

--flavor FLAVOR

工作程序节点的类型模板。 要查看可用的变体，请运行 ibmcloud ks flavor ls --zone <zone name> （适用于 public. IBM Cloud 账户）或 ibmcloud ks flavor ls （适用于 IBM Cloud Dedicated 账户）。

--kms-account-id ID

包含要用于本地磁盘或私钥加密的 KMS 实例的帐户的标识。

--kms-instance INSTANCE

用于本地磁盘加密的 KMS 实例的标识。 要列出可用的 KMS 实例，请运行 ibmcloud ks kms instance ls。

--label LABEL, -l LABEL

在工作程序池中的所有工作程序上设置标签。

--name NAME

输入工作程序池的名称。

--operating-system SYSTEM

指定操作系统的名称。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--secondary-storage STORAGE

类型模板的辅助存储器选项。 要查看某种配置可用的二级存储选项，请运行 ibmcloud ks flavor get --provider vpc-gen2 --zone <zone name>。

--security-group GROUP

可选。 指定多达 5 个安全组标识以应用于工作程序池中的所有工作程序。

--size-per-zone SIZE

指定在该工作程序池中每个区域所期望的工作程序数量。

--vpc-id ID

要在其中创建工作程序节点的 VPC 的标识，此标识必须匹配集群所在的 VPC。 要列出集群的 VPC ID，请运行 ibmcloud ks cluster get -c <cluster_name_or_ID>。 如果未提供此标志，那么工作程序池缺省设置为集群中现有工作程序池的 VPC 标识。

示例

将工作程序池添加到 VPC 第 2 代集群。

ibmcloud ks worker-pool create vpc-gen2 \
  --name NAME \
  --cluster CLUSTER_NAME_OR_ID \
  --flavor FLAVOR

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

--worker-pool POOL, -p POOL

指定工作程序池。

示例

列出工作程序池的详细信息。

ibmcloud ks worker-pool get \
  --cluster CLUSTER_NAME_OR_ID \
  --worker-pool POOL_NAME \
  --output json

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--worker-pool POOL, -p POOL

指定工作程序池。

示例

从工作程序池的所有工作程序节点中移除所有定制 Kubernetes 标签。

ibmcloud ks worker-pool label rm \
  --cluster CLUSTER_NAME_OR_ID \
  --worker-pool POOL_NAME \
  -f

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

--label LABEL, -l LABEL

为工作池中的所有工作节点设置自定义 Kubernetes 标签，格式为 key=value。 对于多个标签，请重复此标志。 要在工作程序池中保留任何现有定制标签，请将这些标签与此标志放在一起。

-q

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

--worker-pool POOL, -p POOL

指定工作程序池。

示例

为工作程序池中的所有工作程序节点设置定制 Kubernetes 标签。

ibmcloud ks worker-pool label set \
  --cluster CLUSTER_NAME_OR_ID \
  --worker-pool POOL_NAME \
  --label <key=value>

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--output OUTPUT

以提供的格式打印命令输出。 接受的值： json

-q

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

示例

列出一个集群中的所有工作程序池。

ibmcloud ks worker-pool ls --cluster CLUSTER_NAME_OR_ID --output json -q

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

--operating-system SYSTEM

指定操作系统的名称。

-q

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

--worker-pool POOL, -p POOL

指定工作程序池。

示例

设置操作系统。

ibmcloud ks worker-pool operating-system set \
  --cluster CLUSTER_NAME_OR_ID \
  --worker-pool POOL_NAME \
  --operating-system OS

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--worker-pool POOL, -p POOL

指定工作程序池。

示例

重新平衡集群中的工作程序池。

ibmcloud ks worker-pool rebalance \
  --cluster CLUSTER_NAME_OR_ID \
  --worker-pool POOL_NAME \
  -f

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-q

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

--size-per-zone SIZE

指定在该工作程序池中每个区域所期望的工作程序数量。

--worker-pool POOL, -p POOL

指定工作程序池。

示例

将工作程序池的大小调整为您指定的每个区域的工作程序数量。

ibmcloud ks worker-pool resize \
  --cluster CLUSTER_NAME_OR_ID \
  --worker-pool POOL_NAME \
  --size-per-zone ZONE

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--worker-pool POOL, -p POOL

指定工作程序池。

示例

从集群移除工作程序池。

ibmcloud ks worker-pool rm --cluster CLUSTER_NAME_OR_ID --worker-pool POOL_NAME -f

命令选项

--cluster CLUSTER, -c CLUSTER

指定集群名称或标识。

-f

强制此命令运行，而不显示用户提示。

-q

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

--worker-pool POOL, -p POOL

指定工作程序池。