コマンド・オプション

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

サービスの API エンドポイントおよび API バージョンを表示または設定します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Red Hat の「Advanced Cluster Management」アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud Kubernetes Service ALB OAuth プロキシー・アドオン。

ibmcloud ks cluster addon disable alb-oauth-proxy --cluster CLUSTER_NAME_OR_ID -f -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud Kubernetes Service クラスター自動スケーラー。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud Kubernetes Service 診断およびデバッグ・ツール。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

「 IBM Cloud Kubernetes Service 」ヘッドランプ用アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud 上の Red Hat OpenShift 用の IBM Cloud HPCS Router Operator アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud Storage オペレーター・アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

管理対象 Istio サービス・メッシュ。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Grafana、Jaeger、および Kiali を含む、Istio の追加コンポーネント。

ibmcloud ks cluster addon disable istio-extras --cluster CLUSTER_NAME_OR_ID -f -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Istio の BookInfo サンプル・アプリケーション。

ibmcloud ks cluster addon disable istio-sample-bookinfo \
  --cluster CLUSTER_NAME_OR_ID \
  -f \
  -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Knative サーバーレス・フレームワーク。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud Kubernetes Service 静的ルート・アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--param PARAM

アドオンのインストール・オプションを指定します。 パラメーターが指定されていない場合、デフォルト値が使用されます。 ibmcloud ks cluster addon options コマンドを使用して、利用可能なオプションを確認してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を有効にします。

例

Red Hat の「Advanced Cluster Management」アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を有効にします。

例

IBM Cloud Kubernetes Service ALB OAuth プロキシー・アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を有効にします。

例

「 IBM Cloud Kubernetes Service 」ヘッドランプ用アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を有効にします。

例

IBM Cloud 上の Red Hat OpenShift 用の 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

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を有効にします。

例

IBM Cloud Storage オペレーター・アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を有効にします。

例

管理対象 Istio サービス・メッシュ。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を有効にします。

例

Grafana、Jaeger、および Kiali を含む、Istio の追加コンポーネント。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を有効にします。

例

IBM Cloud Kubernetes Service 静的ルート・アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を有効にします。

例

IBM Cloud VPC ブロック・ストレージ CSI ドライバー。

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

コマンド・オプション

--addon ADDON

アドオン名または ID。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

インストール済みアドオンの詳細を表示します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

有効なアドオンをリストします。

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

コマンド・オプション

--addon ADDON

アドオン名または ID。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

オプションを表示する対象のアドオン・バージョンを指定します。 バージョンが指定されない場合は、デフォルト・バージョンのオプションが表示されます。

例

アドオンのインストール・オプションを表示します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を更新します。

例

Red Hat の「Advanced Cluster Management」アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を更新します。

例

IBM Cloud 上の Red Hat OpenShift 用の 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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を更新します。

例

IBM Cloud Storage オペレーター・アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を更新します。

例

Grafana、Jaeger、および Kiali を含む、Istio の追加コンポーネント。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

インストールするアドオンのバージョンを指定します。 バージョンが指定されない場合は、デフォルトのバージョンがインストールされます。

-y

すべてのアドオン依存関係を更新します。

例

IBM Cloud の「 Red Hat OpenShift Data Foundation」アドオン。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターの CA 証明書を作成します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターの CA 証明書の詳細を表示します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターの CA 証明書をローテーションします。それには、CA 証明書が事前に作成済みである必要があります。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターの CA 証明書のローテーション状況を表示します。

ibmcloud ks cluster ca status --cluster CLUSTER_NAME_OR_ID -q

コマンド・オプション

--admin

管理者証明書および PEM 鍵を取得します。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--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 役割を管理している場合のみ、このオプションを組み込んでください。 すべての RBAC ユーザーの管理に IAM サービス・アクセス役割を使用している場合は、このオプションを組み込まないでください。

例

kubectl コマンドを使用して、クラスターに接続するための Kubernetes 構成ファイルと証明書をダウンロードします。

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

コマンド・オプション

--disable-disk-encrypt

ワーカー・ノードでの暗号化を無効にします。

--entitlement ENTITLEMENT

このフラグを「 ocp_entitled 」に設定するのは、このクラスターを、「 OpenShift 」の権限を持つ「 Cloud Pak 」などのライセンスとともに使用する場合に限ります。

--flavor FLAVOR

ワーカー・ノードのフレーバー。 利用可能なフレーバーを確認するには、 ibmcloud ks flavor ls --zone <zone name> （ IBM Cloud アカウントの場合）または ibmcloud ks flavor ls （ IBM Cloud Dedicated アカウントの場合）を実行してください。

--hardware HARDWARE

ワーカー・ノードのハードウェア分離のレベル。 使用可能な物理リソースを自分専用にする場合は dedicated を使用し、他の IBM のお客様と物理リソースを共有することを許可する場合は shared を使用します。 IBM Cloud パブリック・アカウントの場合には、デフォルト値は「shared」です。 IBM Cloud 専用アカウントの場合には、「dedicated」が唯一の使用可能なオプションです。

--location LOCATION

{: tag-deprecated} フラグは、以前のバージョンとの互換性を保つために維持されていますが、 [非推奨となっています]。 代わりに、 --zone フラグを使用してください。

--name NAME

クラスターの名前を入力してください。

--no-subnet

クラスターの作成時にポータブル・サブネットが作成されるのを防止します。 デフォルトでは、関連付けられた VLAN 上にパブリックとプライベートの両方のポータブル・サブネットが作成されますが、このフラグはその動作を防止します。 後でクラスターにサブネットを追加するには、 ibmcloud ks cluster subnet add を実行してください。

--operating-system SYSTEM

オペレーティング・システムの名前を指定します。

--pod-subnet SUBNET

カスタム・サブネット CIDR を指定して、ポッドのプライベート IP アドレスを提供します。 サブネットは、少なくとも /23 以上のサイズでなければなりません。 詳細については、以下をご覧ください。 https://ibm.biz/cluster-create-classic

--private-only

このフラグは、パブリック VLAN が作成されるのを防止するために使用します。 これは、 --public-vlan フラグを指定せずに --private-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 インスタンスのシークレット・グループ ID。

--sm-instance INSTANCE

IBM Cloud Secrets Manager インスタンスの CRN。

--version VERSION

少なくとも major.minor バージョンを含めて、Kubernetes または OpenShift のバージョンを指定します。 このフラグを含めない場合は、デフォルトのバージョンが使用されます。 使用可能なバージョンを確認するには、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 クラスタに、 Kubernetes リソースを管理するための Satellite Config へのアクセス権を付与します。

--entitlement ENTITLEMENT

このフラグを「 ocp_entitled 」に設定するのは、このクラスターを、「 OpenShift 」の権限を持つ「 Cloud Pak 」などのライセンスとともに使用する場合に限ります。

--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。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--name NAME

クラスターの名前を入力してください。

--operating-system SYSTEM

オペレーティング・システムの名前を指定します。

--pod-network-interface-selection SELECTION

内部ポッド・ネットワークのノード・ネットワーク・インターフェースを選択する方法。 このオプションは、指定した Satellite ロケーションで Red Hat CoreOS が有効になっている場合にのみ使用できます。 URL またはIPアドレスを直接指定するには、 can-reach=<url> または can-reach=<ip_address> を指定してください。 ネットワークインターフェースを選択するには、 interface=<network_interface> を指定してください。

--pod-subnet SUBNET

カスタム・サブネット CIDR を指定して、ポッドのプライベート 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 インスタンスのシークレット・グループ ID。

--sm-instance INSTANCE

IBM Cloud Secrets Manager インスタンスの CRN。

--version VERSION

少なくとも major.minor バージョンを含む、IBM Cloud バージョンの Red Hat OpenShift。 使用可能なバージョンを確認するには、ibmcloud ks versions を実行します。

--workers COUNT

デフォルトのワーカー・プールの 1 ゾーンあたりのワーカー・ノード数。 --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

このフラグを「 ocp_entitled 」に設定するのは、このクラスターを、「 OpenShift 」の権限を持つ「 Cloud Pak 」などのライセンスとともに使用する場合に限ります。

--flavor FLAVOR

ワーカー・ノードのフレーバー。 利用可能なフレーバーを確認するには、 ibmcloud ks flavor ls --zone <zone name> （ IBM Cloud アカウントの場合）または ibmcloud ks flavor ls （ IBM Cloud Dedicated アカウントの場合）を実行してください。

--name NAME

クラスターの名前を入力してください。

--operating-system SYSTEM

オペレーティング・システムの名前を指定します。

--pod-subnet SUBNET

カスタム・サブネット CIDR を指定して、ポッドのプライベート 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 インスタンスのシークレット・グループ ID。

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

少なくとも major.minor バージョンを含めて、Kubernetes または OpenShift のバージョンを指定します。 このフラグを含めない場合は、デフォルトのバージョンが使用されます。 使用可能なバージョンを確認するには、ibmcloud ks versions を実行します。

--vpc-id ID

ワーカー・ノードを作成する対象の VPC の ID。 使用可能な ID をリストするには、ibmcloud ks vpcs を実行します。

--workers COUNT

デフォルトのワーカー・プールの 1 ゾーンあたりのワーカー・ノード数。 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

オプション。 クラスター上のすべてのワーカーに適用する 1 つ以上のセキュリティー・グループ ID を指定します。 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 クラスターにのみ必要です。 OpenShift クラスター内の内部レジストリーをバックアップするための標準クラウド・オブジェクト・ストレージ・インスタンスの CRN。 クラウドオブジェクトストレージインスタンスのCRNを一覧表示するには、 ibmcloud resource service-instances --long --service-name cloud-object-storage を実行してください。

--crk CRK

ローカル・ディスクの暗号化に使用する、KMS インスタンス内のルート・キーの ID。 利用可能なルートキーの一覧を表示するには、 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

このフラグを「 ocp_entitled 」に設定するのは、このクラスターを、「 OpenShift 」の権限を持つ「 Cloud Pak 」などのライセンスとともに使用する場合に限ります。

--flavor FLAVOR

ワーカー・ノードのフレーバー。 利用可能なフレーバーを確認するには、 ibmcloud ks flavor ls --zone <zone name> （ IBM Cloud アカウントの場合）または ibmcloud ks flavor ls （ IBM Cloud Dedicated アカウントの場合）を実行してください。

--kms-account-id ID

ローカル・ディスクまたは秘密暗号化に使用する KMS インスタンスが含まれているアカウントの ID。

--kms-instance INSTANCE

ローカル・ディスクの暗号化に使用する KMS インスタンスの ID。 使用可能な KMS インスタンスを確認するには、ibmcloud ks kms instance ls を実行します。

--name NAME

クラスターの名前を入力してください。

--offering OFFERING

クラスタの提供内容を指定してください。 有効な値： kubernetes、 openshift、 openshift-vs

--operating-system SYSTEM

オペレーティング・システムの名前を指定します。

--pod-subnet SUBNET

カスタム・サブネット CIDR を指定して、ポッドのプライベート IP アドレスを提供します。 サブネットは、少なくとも /23 以上のサイズでなければなりません。 詳細については、以下をご覧ください。 https://ibm.biz/cluster-create-vpc

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--secondary-storage STORAGE

フレーバーの 2 次ストレージ・オプション。 あるフレーバーで利用可能なセカンダリストレージのオプションを確認するには、 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 インスタンスのシークレット・グループ ID。

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

少なくとも major.minor バージョンを含めて、Kubernetes または OpenShift のバージョンを指定します。 このフラグを含めない場合は、デフォルトのバージョンが使用されます。 使用可能なバージョンを確認するには、ibmcloud ks versions を実行します。

--vpc-id ID

ワーカー・ノードを作成する対象の VPC の ID。 使用可能な ID をリストするには、ibmcloud ks vpcs を実行します。

--workers COUNT

デフォルトのワーカー・プールの 1 ゾーンあたりのワーカー・ノード数。 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

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--show-resources

アドオン、VLAN、サブネットなどの追加のクラスタリソースを表示します。

例

登録済みクラスターの詳細を取得します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターでイメージ・セキュリティー適用を無効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターの Kubernetes API サーバーの監査 Webhook 構成を表示します。

ibmcloud ks cluster master audit-webhook get \
  --cluster CLUSTER_NAME_OR_ID \
  --output json \
  -q

コマンド・オプション

--ca-cert CERT

リモート・ロギング・サービスの検証に使用される CA 証明書のファイル・パス。

--client-cert CERT

リモート・ロギング・サービスに対する認証に使用されるクライアント証明書のファイル・パス。

--client-key KEY

リモート・ロギング・サービスへの接続に使用される、対応するクライアント・キーのファイル・パス。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--policy POLICY

監査ポリシー・タイプを指定します。 有効な値： default、 verbose

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--remote-server SERVER

リモート・ロギング・サービスの URL または IP アドレス。

例

クラスターの Kubernetes API サーバーの監査 Webhook 構成を設定します。

ibmcloud ks cluster master audit-webhook set \
  --cluster CLUSTER_NAME_OR_ID \
  --remote-server REMOTE-SERVER \
  --ca-cert CERT

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターの Kubernetes API サーバー用の監査 Webhook 構成を削除します。

ibmcloud ks cluster master audit-webhook unset --cluster CLUSTER_NAME_OR_ID -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターの Kubernetes API サーバーの PodSecurity ポリシーを無効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターの Kubernetes API サーバーの PodSecurity ポリシーを有効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターの Kubernetes API サーバーの PodSecurity アドミッション構成を削除します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

許可リストを無効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

許可リストを有効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターのプライベート・サービス・エンドポイント許可リストを取得します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

-y

フィーチャーがワーカーの再ロードやクラスター・マスターのリフレッシュなどの追加のアクションを必要とする場合、ユーザー・プロンプトを表示せずにそれらのアクションを実行します。

例

マスターをプライベートにアクセス可能にするためにプライベート・サービス・エンドポイントを有効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

-y

フィーチャーがワーカーの再ロードやクラスター・マスターのリフレッシュなどの追加のアクションを必要とする場合、ユーザー・プロンプトを表示せずにそれらのアクションを実行します。

例

マスターのみをプライベートにアクセス可能にするためにパブリック・サービス・エンドポイントを無効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

-y

フィーチャーがワーカーの再ロードやクラスター・マスターのリフレッシュなどの追加のアクションを必要とする場合、ユーザー・プロンプトを表示せずにそれらのアクションを実行します。

例

マスターをパブリックにアクセス可能にするためにパブリック・サービス・エンドポイントを有効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター・マスター・ノードを再始動して、新しい Kubernetes API 構成変更を適用します。

ibmcloud ks cluster master refresh --cluster CLUSTER_NAME_OR_ID -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

衛星サービスのエンドポイント許可リストを無効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

衛星サービスエンドポイントの許可リストを有効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスタのサテライト・サービス・エンドポイントの許可リストを取得します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--force-update

変更がワーカー・ノードの現行バージョンよりも 2 マイナー・バージョンを超える場合でも、更新を試行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

少なくとも major.minor バージョンを含めて、Kubernetes または OpenShift のバージョンを指定します。 このフラグを含めない場合は、デフォルトのバージョンが使用されます。 使用可能なバージョンを確認するには、ibmcloud ks versions を実行します。

例

クラスター・マスターを最新バージョンに更新します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud コンテナレジストリ内のイメージにクラスターからアクセスするためのIAM認証情報を格納する、新しいイメージプルシークレットを生成します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--key KEY

既存のサービス・キーの名前または GUID を指定します。 サービスキーを定義する場合、 --role オプションを同時に設定することはできません。

--namespace NAMESPACE, -n NAMESPACE

Kubernetes 名前空間を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--role ROLE

サービス・キーの IAM 役割を指定します。 このフラグは、使用する既存キーが指定された場合には機能せず、Cloud Foundry サービスなど、IAM 対応でないサービスに対しても機能しません。

--service SERVICE

サービス・インスタンスの名前を指定します。 利用可能なサービスインスタンスの一覧を表示するには、 Cloud Foundry サービスの場合は ibmcloud service list を、IAM対応サービスの場合は ibmcloud resource service-instances を実行してください。

例

IBM Cloud サービスをクラスターに追加するために、そのサービス・インスタンスを Kubernetes 名前空間にバインドします。

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

コマンド・オプション

--all-namespaces

すべての Kubernetes 名前空間を含みます。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--namespace NAMESPACE, -n NAMESPACE

Kubernetes 名前空間を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--service SERVICE

サービス・インスタンスの名前を指定します。 利用可能なサービスインスタンスの一覧を表示するには、 Cloud Foundry サービスの場合は ibmcloud service list を、IAM対応サービスの場合は ibmcloud resource service-instances を実行してください。

例

クラスターから IBM Cloud サービスを削除するために、Kubernetes 名前空間からそのサービスをアンバインドします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--subnet-id ID

サブネット ID を指定します。

例

IBM Cloud インフラストラクチャアカウント内の既存のパブリックまたはプライベートなポータブルサブネットを、クラシッククラスタで利用できるようにします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--size SIZE

ポータブル・サブネットのサイズを指定します。 サイズは 8、16、32、64 のいずれかでなければなりません。

--vlan VLAN

パブリック VLAN ID またはプライベート VLAN ID を指定します。

例

パブリック VLAN またはプライベート VLAN 上にポータブル・サブネットを作成し、それをクラシック・クラスターで使用できるようにします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--subnet-id 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>' の「Target」フィールドを確認してください。

--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>' の「Target」フィールドを確認してください。

--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> （ 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 ID。 利用可能なALB IDを確認するには、 ibmcloud ks ingress alb ls を実行してください。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Ingress ALB の自動スケーリングの状況と構成を参照してください。

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

コマンド・オプション

--alb ALB

ALB ID。 利用可能なALB IDを確認するには、 ibmcloud ks ingress alb ls を実行してください。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

その日のメッセージを表示せず、リマインダーも更新しません。

例

Ingress ALB の自動スケーリングを構成します。

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

コマンド・オプション

--alb ALB

ALB ID。 利用可能なALB IDを確認するには、 ibmcloud ks ingress alb ls を実行してください。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Ingress ALB の自動スケーリング構成を削除します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内のすべての Ingress ALB ポッドの自動更新を無効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内のすべての Ingress ALB ポッドの自動更新を有効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスタ内のIngress ALBポッドが自動更新に設定されているかどうか、およびALBポッドが最新バージョンになっているかどうかを確認します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--ip IP

作成または有効化するALBの「 vlan 」および「 zone 」で利用可能な、ポータブルなパブリックIPアドレスまたはプライベートIPアドレスを指定してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--type TYPE

ALB のタイプを指定します。 利用可能なオプション：公開、非公開

--version VERSION

ALB イメージのバージョンを指定します。 対応している画像バージョンを確認するには、 ibmcloud ks ingress alb versions を実行してください。

--vlan VLAN

VLAN ID。 この 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

クラスター名またはクラスター ID を指定します。

-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 ID。 利用可能なALB IDを確認するには、 ibmcloud ks ingress alb ls を実行してください。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内の Ingress ALB を無効にします。

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

コマンド・オプション

--alb ALB

ALB ID。 利用可能なALB IDを確認するには、 ibmcloud ks ingress alb ls を実行してください。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--ip IP

作成または有効化するALBの「 vlan 」および「 zone 」で利用可能な、ポータブルなパブリックIPアドレスまたはプライベート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 ID。 利用可能なALB IDを確認するには、 ibmcloud ks ingress alb ls を実行してください。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-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 ID。 利用可能なALB IDを確認するには、 ibmcloud ks ingress alb ls を実行してください。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Ingress ヘルス・チェッカーを無効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Ingress ヘルス・チェッカーを有効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Ingress ヘルス・チェッカーの状況を表示します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内のすべての Ingress ALB ID および ALB ポッドが最新バージョンであるかどうかをリストします。

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

コマンド・オプション

--alb ALB

特定の ALB を更新するには、ALB ID を指定します。 利用可能なALB IDを確認するには、 ibmcloud ks ingress alb ls を実行してください。 複数のALBを更新するには、各フラグに1つのALB IDを指定します（例： --alb ID_1 --alb ID_2 ）。 すべての ALB を更新するには、このフラグを含めないようにします。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version VERSION

ALB イメージのバージョンを指定します。 対応している画像バージョンを確認するには、 ibmcloud ks ingress alb versions を実行してください。

例

クラスター内の個々またはすべての ALB のポッドを強制的に一回限り更新します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターのすべての Ingress ドメインをリストします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--name NAME

登録済みの IBM Cloud Secret Manager インスタンスの名前。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--secret-group GROUP

シークレットが保持される IBM Cloud Secret Manager インスタンスのシークレット・グループ ID。

例

登録済みの IBM Cloud Secrets Manager インスタンスをデフォルトとして設定します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--crn CRN

IBM Cloud Secret Manager インスタンスの CRN。

--is-default

IBM Cloud Secrets Manager インスタンスをデフォルトとして設定します。 既存のデフォルト・インスタンスが存在する場合、その設定は解除されます。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--secret-group GROUP

シークレットが保持される IBM Cloud Secret Manager インスタンスのシークレット・グループ ID。

例

IBM Cloud Secrets Manager インスタンスをクラスターに登録します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内で Ingress ALB を公開するロード・バランサーの構成を取得します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クライアント接続情報が要求ヘッダーで ALB に渡されなくなるように、PROXY プロトコルを無効にします。

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

コマンド・オプション

--cidr CIDR

CIDR フォーマットでのロード・バランサーの IP アドレス範囲。 他の IP 範囲内のロード・バランサーによって転送される PROXY ヘッダーは処理されません。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クライアント接続情報が要求ヘッダーで ALB に渡されるように、PROXY プロトコルを有効にします。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスタ内でポート 80 の使用を無効にしてください。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスタでポート 80 の使用を有効にしてください。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスタ内のポート80のセキュリティ設定を取得してください。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内の Ingress コンポーネントの状況レポートを無効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内の Ingress コンポーネントの状況レポートを有効にします。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内の Ingress コンポーネントの状況レポートを取得します。

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--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 インスタンス ID。 利用可能な 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

クラスター名またはクラスター ID を指定します。

--crk CRK

KMS インスタンスのルート・キー ID。 利用可能なルートキーの一覧を表示するには、 ibmcloud ks kms crk ls --instance-id <kms_instance> を実行してください。

--instance-id ID

KMS インスタンス ID。 利用可能な KMS インスタンスを確認するには、 ibmcloud ks kms instance ls を実行してください。

--kms-account-id ID

ローカル・ディスクまたは秘密暗号化に使用する KMS インスタンスが含まれているアカウントの ID。

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

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内のすべての Fluentd ポッドの自動更新を無効にします。

ibmcloud ks logging autoupdate disable --cluster CLUSTER_NAME_OR_ID -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内のすべての Fluentd ポッドの自動更新を有効にします。

ibmcloud ks logging autoupdate enable --cluster CLUSTER_NAME_OR_ID -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内でご使用の Fluentd ポッドが自動更新されるように設定されているかどうかを表示します。

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」の場合、認証局（CA）証明書を含む「 Kubernetes 」という名前のシークレット。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--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 サーバーに転送されるときに、1 KB を超過しているログは、超過している部分が切り捨てられます。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--force-update

クラスター内の Fluentd ポッドを最新バージョンに強制的に更新します。

--id 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」の場合、認証局（CA）証明書を含む「 Kubernetes 」という名前のシークレット。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--force-update

クラスター内の Fluentd ポッドを最新バージョンに強制的に更新します。

--hostname HOSTNAME

ログの種類が「 syslog 」の場合、ログコレクターのホスト名またはIPアドレス。 ロギングタイプが「 ibm 」（非推奨）の場合、ロギングの取り込みエンドポイント。 ロギング取り込みエンドポイントを指定しないと、現在の地域のエンドポイントが使用されます。

--id 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 サーバーに転送されるときに、1 KB を超過しているログは、超過している部分が切り捨てられます。

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

クラスター名またはクラスター ID を指定します。

--container CONTAINER

ログをフィルターで除外するコンテナーの名前。 このフラグは、ログ・タイプ container を使用しているときにのみ適用されます。

--force-update

クラスター内の Fluentd ポッドを最新バージョンに強制的に更新します。

--lc LOGGING-CONFIG, --logging-config LOGGING-CONFIG

ロギング構成 ID。 指定しない場合、フィルターに渡されたすべてのクラスター・ロギング構成にフィルターが適用されます。 コマンドの実行時に --show-matching-configs フラグを使用すると、フィルターと一致するログ構成を表示できます。

--level LEVEL

指定したレベル以下のログをフィルターで除外します。 許容される値を正規の順序で列挙すると、fatal、error、warn/warning、info、debug、および trace となります。 例えば、info レベルでログをフィルターに掛けた場合、debug と trace もフィルターに掛けられます。 注: このフラグは、ログ・メッセージが JSON 形式で、レベル・フィールドを含んでいる場合にのみ使用できます。 出力例: {"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

フィルターを適用するログのタイプ。 現在は、all、container、および host がサポートされています。

例

ご使用のロギング構成によって転送されるログをフィルターで除外します。

ibmcloud ks logging filter create \
  --cluster CLUSTER_NAME_OR_ID \
  --type TYPE \
  --namespace NAME

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--id 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

クラスター名またはクラスター ID を指定します。

--force-update

クラスター内の Fluentd ポッドを最新バージョンに強制的に更新します。

--id ID

ロギング・フィルターの ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

ロギング・フィルターを削除します。

ibmcloud ks logging filter rm --cluster CLUSTER_NAME_OR_ID --id FILTER_ID

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--container CONTAINER

ログをフィルターで除外するコンテナーの名前。 このフラグは、ログ・タイプ container を使用しているときにのみ適用されます。

--force-update

クラスター内の Fluentd ポッドを最新バージョンに強制的に更新します。

--id ID

ロギング・フィルターの ID を指定します。

--lc LOGGING-CONFIG, --logging-config LOGGING-CONFIG

ロギング構成 ID。 指定しない場合、フィルターに渡されたすべてのクラスター・ロギング構成にフィルターが適用されます。 コマンドの実行時に --show-matching-configs フラグを使用すると、フィルターと一致するログ構成を表示できます。

--level LEVEL

指定したレベル以下のログをフィルターで除外します。 許容される値を正規の順序で列挙すると、fatal、error、warn/warning、info、debug、および trace となります。 例えば、info レベルでログをフィルターに掛けた場合、debug と trace もフィルターに掛けられます。 注: このフラグは、ログ・メッセージが JSON 形式で、レベル・フィールドを含んでいる場合にのみ使用できます。 出力例: {"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

フィルターを適用するログのタイプ。 現在は、all、container、および host がサポートされています。

例

ロギング・フィルターを更新します。

ibmcloud ks logging filter update --cluster CLUSTER_NAME_OR_ID --id FILTER_ID --type TYPE

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--ip IP

1 個以上の NLB IP アドレス。 ロードバランサーのIPアドレスを確認するには、 kubectl get svc -n <namespace> を実行してください。

--nlb-host HOST

ホスト名。 既存のホスト名を確認するには、 ibmcloud ks nlb-dns ls を実行してください。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

ibmcloud ks nlb-dns create で作成した既存のホスト名に、NLB IPを追加します。

ibmcloud ks nlb-dns add \
  --cluster CLUSTER_NAME_OR_ID \
  --ip IP_ADDRESS \
  --nlb-host HOSTNAME

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--ip IP

1 個以上の NLB IP アドレス。 ロードバランサーのIPアドレスを確認するには、 kubectl get svc -n <namespace> を実行してください。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--secret-namespace NAMESPACE

SSL の秘密が作成される名前空間。 このフラグが指定されていない場合、シークレットは default.

例

クラシック・クラスターに 1 個以上の NLB IP を登録する DNS ホスト名を作成します。

ibmcloud ks nlb-dns create classic \
  --cluster CLUSTER_NAME_OR_ID \
  --ip IP_ADDRESS \
  --secret-namespace NAME

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--ip IP

1 個以上の 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.

例

VPC クラスターにロード・バランサー・ホスト名またはロード・バランサー IP アドレスを登録する DNS レコードを作成します。

ibmcloud ks nlb-dns create vpc-gen2 \
  --cluster CLUSTER_NAME_OR_ID \
  --lb-host HOSTNAME \
  --secret-namespace NAME

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内の登録済み NLB ホスト名および IP アドレスをリストします。

ibmcloud ks nlb-dns ls --cluster CLUSTER_NAME_OR_ID --output json -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--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 の場合、HTTP のポートが「80」以外または HTTPS のポートが「443」以外の場合にのみこのフラグを使用します。 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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスター内の各 NLB ホスト名のヘルス・チェック・モニター設定をリストします。

ibmcloud ks nlb-dns monitor ls --cluster CLUSTER_NAME_OR_ID --output json -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--lb-host HOST

VPC ロード・バランサーのホスト名。 ロードバランサーのホスト名を確認するには、 kubectl get svc -n <namespace> を実行してください。

--nlb-subdomain SUBDOMAIN

サブドメイン。 既存のサブドメインを表示するには、ibmcloud ks nlb-dns ls を実行します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

既存の DNS ホスト名を更新するために、VPC クラスター内で関連付けられているロード・バランサーのホスト名を置き換えます。

ibmcloud ks nlb-dns replace \
  --cluster CLUSTER_NAME_OR_ID \
  --nlb-subdomain DOMAIN \
  --lb-host HOSTNAME

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--ip IP

1 つの 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

クラスター名またはクラスター ID を指定します。

--ip IP

1 つの 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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

-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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--security-group GROUP, --sg GROUP

セキュリティー・グループ ID を指定します。

例

既存のセキュリティー・グループ・ルールをすべて削除し、デフォルト・ルールを再適用します。

ibmcloud ks security-group reset \
  --cluster CLUSTER_NAME_OR_ID \
  --security-group GROUP \
  -f

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--security-group GROUP, --sg GROUP

セキュリティー・グループ ID を指定します。

例

存在しないデフォルトのセキュリティー・グループ・ルールを再適用します。

ibmcloud ks security-group sync --cluster CLUSTER_NAME_OR_ID --security-group GROUP -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--volume VOLUME

ボリューム ID を指定します。 使用可能なボリュームをリストするには、ibmcloud ks storage volume ls を実行します。

--worker WORKER, -w WORKER

ワーカー ID を指定します。 利用可能なワーカーの一覧を表示するには、 ibmcloud ks workers を実行してください。

例

ワーカー・ノードにストレージ・ボリュームを接続します。

ibmcloud ks storage attachment create \
  --cluster CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --volume VOLUME

コマンド・オプション

--attachment ATTACHMENT

ボリューム接続 ID を指定します。 使用可能な接続をリストするには、ibmcloud ks storage attachment ls を実行します。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--worker WORKER, -w WORKER

ワーカー ID を指定します。 利用可能なワーカーの一覧を表示するには、 ibmcloud ks workers を実行してください。

例

クラスター内のボリューム接続の詳細を取得します。

ibmcloud ks storage attachment get \
  --cluster CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --attachment ATTACHMENT

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--worker WORKER, -w WORKER

ワーカー ID を指定します。 利用可能なワーカーの一覧を表示するには、 ibmcloud ks workers を実行してください。

例

クラスター内のワーカーのすべてのストレージ・ボリューム接続をリストします。

ibmcloud ks storage attachment ls \
  --cluster CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --output json

コマンド・オプション

--attachment ATTACHMENT

ボリューム接続 ID を指定します。 使用可能な接続をリストするには、ibmcloud ks storage attachment ls を実行します。

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--worker WORKER, -w WORKER

ワーカー ID を指定します。 利用可能なワーカーの一覧を表示するには、 ibmcloud ks workers を実行してください。

例

ワーカー・ノードからボリューム接続を削除します。

ibmcloud ks storage attachment rm \
  --cluster CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --attachment ATTACHMENT

コマンド・オプション

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--volume VOLUME

ボリューム ID を指定します。 使用可能なボリュームをリストするには、ibmcloud ks storage volume ls を実行します。

例

ボリュームの詳細を取得します。

ibmcloud ks storage volume get --volume VOLUME --output json -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--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 ID をリストするには、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 とプライベート 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>' の「Target」フィールドを確認してください。

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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

「Secure By Default」VPC クラスターの送信トラフィック保護を無効にします。

ibmcloud ks vpc outbound-traffic-protection disable --cluster CLUSTER_NAME_OR_ID -f -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

「Secure By Default」VPC クラスターに対して、送信トラフィックの保護を有効にします。

ibmcloud ks vpc outbound-traffic-protection enable --cluster CLUSTER_NAME_OR_ID -f -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--worker WORKER, -w WORKER

ワーカー ID を指定します。 利用可能なワーカーの一覧を表示するには、 ibmcloud ks workers を実行してください。

例

ワーカー・ノードの詳細を表示します。

ibmcloud ks worker get --cluster CLUSTER_NAME_OR_ID --worker WORKER_ID --output json

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--hard

ワーカー・ノードの電源を切って、強制的にワーカー・ノードをハード再起動します。 このオプションは、ワーカー・ノードが応答しない場合、またはワーカー・ノードで Docker ハングが生じた場合に使用します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--skip-master-health

操作を開始する前に行うマスターの正常性の検査をスキップします。

--worker WORKER, -w WORKER

1 個以上のワーカー ID を指定します。

例

ワーカー・ノードを再起動します。

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

1 個以上のワーカー ID を指定します。

例

1つ以上のワーカーノードで、データを削除し、イメージを再作成して、最新のパッチが適用された Kubernetes を再インストールしてください。

ibmcloud ks worker reload --skip-master-health IP_ADDRESS -f --worker WORKER_ID

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--update

ワーカー・ノードをマスターの同じメジャーおよびマイナー・バージョンと最新のパッチに更新します。 また、ワーカープールのオペレーティングシステムが更新された場合は、オペレーティングシステムも更新します。

--worker WORKER, -w WORKER

ワーカー ID を指定します。 利用可能なワーカーの一覧を表示するには、 ibmcloud ks workers を実行してください。

例

ワーカー・ノードを削除して、同じワーカー・プールの新規ワーカー・ノードに置換します。

ibmcloud ks worker replace \
  --cluster CLUSTER_NAME_OR_ID \
  --worker WORKER_ID \
  --update UPDATE

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--worker WORKER, -w WORKER

1 個以上のワーカー ID を指定します。

例

クラスターからワーカー・ノードを削除します。

ibmcloud ks worker rm --cluster CLUSTER_NAME_OR_ID -f --worker WORKER_ID

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--worker WORKER, -w WORKER

1 個以上のワーカー ID を指定します。

例

クラシック・クラスター内の 1 個以上のワーカー・ノードを新しい Kubernetes バージョンに更新します。

ibmcloud ks worker update --cluster CLUSTER_NAME_OR_ID -f --worker WORKER_ID

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--disable-disk-encrypt

ワーカー・ノードでの暗号化を無効にします。

--entitlement ENTITLEMENT

このフラグを「 ocp_entitled 」に設定するのは、このクラスターを、「 OpenShift 」の権限を持つ「 Cloud Pak 」などのライセンスとともに使用する場合に限ります。

--flavor FLAVOR

ワーカー・ノードのフレーバー。 利用可能なフレーバーを確認するには、 ibmcloud ks flavor ls --zone <zone name> （ IBM Cloud アカウントの場合）または ibmcloud ks flavor ls （ IBM Cloud Dedicated アカウントの場合）を実行してください。

--hardware HARDWARE

ワーカー・ノードのハードウェア分離のレベル。 使用可能な物理リソースを自分専用にする場合は dedicated を使用し、他の IBM のお客様と物理リソースを共有することを許可する場合は shared を使用します。 IBM Cloud パブリック・アカウントの場合には、デフォルト値は「shared」です。 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

クラスター名またはクラスター ID を指定します。

--entitlement ENTITLEMENT

このフラグを「 ocp_entitled 」に設定するのは、このクラスターを、「 OpenShift 」の権限を持つ「 Cloud Pak 」などのライセンスとともに使用する場合に限ります。

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

クラスター名またはクラスター ID を指定します。

--entitlement ENTITLEMENT

このフラグを「 ocp_entitled 」に設定するのは、このクラスターを、「 OpenShift 」の権限を持つ「 Cloud Pak 」などのライセンスとともに使用する場合に限ります。

--flavor FLAVOR

ワーカー・ノードのフレーバー。 利用可能なフレーバーを確認するには、 ibmcloud ks flavor ls --zone <zone name> （ 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 の ID。これはクラスターが含まれる VPC に一致しなければなりません。 クラスターの VPC ID をリストするには、ibmcloud ks cluster get -c <cluster_name_or_ID> を実行します。 このフラグを指定しなかった場合、ワーカー・プールは、クラスターの既存のワーカー・プールの VPC ID をデフォルトで使用します。

例

VPC 世代 1 クラスターにワーカー・プールを追加します。

ibmcloud ks worker-pool create vpc-classic \
  --name NAME \
  --cluster CLUSTER_NAME_OR_ID \
  --flavor FLAVOR

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

--crk CRK

ローカル・ディスクの暗号化に使用する、KMS インスタンス内のルート・キーの ID。 利用可能なルートキーの一覧を表示するには、 ibmcloud ks kms crk ls --instance-id <kms_instance> を実行してください。

--disable-disk-encrypt

ワーカー・ノードでの暗号化を無効にします。

--entitlement ENTITLEMENT

このフラグを「 ocp_entitled 」に設定するのは、このクラスターを、「 OpenShift 」の権限を持つ「 Cloud Pak 」などのライセンスとともに使用する場合に限ります。

--flavor FLAVOR

ワーカー・ノードのフレーバー。 利用可能なフレーバーを確認するには、 ibmcloud ks flavor ls --zone <zone name> （ IBM Cloud アカウントの場合）または ibmcloud ks flavor ls （ IBM Cloud Dedicated アカウントの場合）を実行してください。

--kms-account-id ID

ローカル・ディスクまたは秘密暗号化に使用する KMS インスタンスが含まれているアカウントの ID。

--kms-instance INSTANCE

ローカル・ディスクの暗号化に使用する KMS インスタンスの ID。 使用可能な KMS インスタンスを確認するには、ibmcloud ks kms instance ls を実行します。

--label LABEL, -l LABEL

ワーカー・プール内のすべてのワーカーにラベルを設定します。

--name NAME

ワーカー・プールの名前を入力します。

--operating-system SYSTEM

オペレーティング・システムの名前を指定します。

--output OUTPUT

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--secondary-storage STORAGE

フレーバーの 2 次ストレージ・オプション。 あるフレーバーで利用可能なセカンダリストレージのオプションを確認するには、 ibmcloud ks flavor get --provider vpc-gen2 --zone <zone name> を実行してください。

--security-group GROUP

オプション。 ワーカー・プール内のすべてのワーカーに適用するセキュリティー・グループ ID を最大 5 つ指定します。

--size-per-zone SIZE

このワーカー・プールのゾーンあたりの必要なワーカー数を指定します。

--vpc-id ID

ワーカー・ノードを作成する対象の VPC の ID。これはクラスターが含まれる VPC に一致しなければなりません。 クラスターの VPC ID をリストするには、ibmcloud ks cluster get -c <cluster_name_or_ID> を実行します。 このフラグを指定しなかった場合、ワーカー・プールは、クラスターの既存のワーカー・プールの VPC ID をデフォルトで使用します。

例

VPC 世代 2 クラスターにワーカー・プールを追加します。

ibmcloud ks worker-pool create vpc-gen2 \
  --name NAME \
  --cluster CLUSTER_NAME_OR_ID \
  --flavor FLAVOR

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

クラスター名またはクラスター ID を指定します。

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

クラスター名またはクラスター ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--worker-pool POOL, -p POOL

ワーカー・プールを指定します。