ibmcloud ks cluster addon disable

既存のクラスターでマネージド・アドオンを無効にします。 このコマンドは、無効にするマネージド・アドオンに応じて、以下のいずれかのサブコマンドと組み合わせて使用する必要があります。

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

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

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

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

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

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

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

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

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

ibmcloud ks cluster addon enable

既存のクラスターでマネージド・アドオンを有効にします。 このコマンドは、有効にするマネージド・アドオンに応じて、以下のいずれかのサブコマンドと組み合わせて使用する必要があります。

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

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

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

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

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

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

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

ibmcloud ks cluster addon get

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

--addon ADDON

(必須) addon の名前。 インストール済みのアドオンをリストするには、ibmcloud ks cluster addon ls を実行します。

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks cluster addon ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内で有効になっているすべてのマネージド・アドオンをリストします。

ibmcloud ks cluster addon ls --cluster CLUSTER

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

ibmcloud ks cluster addon options

仮想プライベート・クラウド クラシック・インフラストラクチャー

アドオンを有効にする前に、そのインストール・オプションを表示します。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

--addon ADDON

(必須) addon の名前。 使用可能なアドオンをリストするには、ibmcloud ks cluster addon versions を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

--version VERSION

オプション: オプションを表示する対象のアドオン・バージョンを指定します。 バージョンが指定されない場合は、デフォルト・バージョンのオプションが表示されます。 使用可能なアドオン・バージョンをリストするには、ibmcloud ks cluster addon versions を実行します。

ibmcloud ks cluster addon update

仮想プライベート・クラウド クラシック・インフラストラクチャー

インストール済みのアドオンを更新します。

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

最小限必要な許可

なし

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

--version VERSION

オプション: アドオンの更新先バージョンを指定します。 バージョンが指定されない場合、アドオンはデフォルトのバージョンに更新されます。 使用可能なアドオン・バージョンをリストするには、ibmcloud ks cluster addon versions を実行します。

ibmcloud ks cluster addon versions

仮想プライベート・クラウド クラシック・インフラストラクチャー

IBM Cloud Kubernetes Service のマネージド・アドオンのサポートされているバージョンのリストを表示します。

ibmcloud ks cluster addon versions [--addon ADD-ON_NAME] [--output json] [-q]

最小限必要な許可

なし

コマンド・オプション：

--addon ADD-ON_NAME

オプション: バージョンをフィルタリングする対象のアドオン名 (istio など) を指定します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks cluster addon versions --addon istio

ibmcloud ks cluster ca create

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター用の新規認証局 (CA) を作成します。 CA が作成され、クラスター内のコンポーネントに対して新規 CA 証明書が発行されると、クラスターの API サーバーが自動的にリフレッシュされます。

このコマンドを実行した後、ibmcloud ks cluster ca rotate コマンドを実行する前に、クラスターでの CA 証明書のローテーションのステップに従い、古い CA によって署名された証明書を使用するすべてのツールで新規証明書が使用されるように更新し、ワーカー・ノードを更新してください。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks cluster ca create --cluster my_cluster

ibmcloud ks cluster ca get

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks cluster ca get --cluster my_cluster

ibmcloud ks cluster ca rotate

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの認証局 (CA) 証明書をローテーションします。 ローテーションにより、クラスターの前の CA によって署名された証明書を無効にし、クラスターの新規 CA によって署名された証明書をワーカー・ノードに発行します。

このコマンドを実行する前に、クラスターでの CA 証明書のローテーションのステップに従い、古い CA 証明書を使用するすべてのツールで新規証明書が使用されるように更新し、ワーカー・ノードを更新してください。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks cluster ca rotate --cluster my_cluster

ibmcloud ks cluster ca status

仮想プライベート・クラウド クラシック・インフラストラクチャー

ibmcloud ks cluster ca rotate を実行した後、クラスターの認証局 (CA) 証明書のローテーション状況を表示します。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-q

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

ibmcloud ks cluster ca status --cluster my_cluster

ibmcloud ks cluster config

仮想プライベート・クラウド クラシック・インフラストラクチャー

IBM Cloud にログインした後に、クラスターに接続して kubeconfig コマンドを実行するための Kubernetes 構成データと証明書を kubectl ファイルとしてローカル・マシンにダウンロードします。

kubeconfig ファイルは、~/.kube/config 内の既存の kubeconfig ファイル (Windows の場合は <user_profile>/.kube/config)、またはコマンド・ライン・セッションで KUBECONFIG 環境変数によって設定された最後のファイルにマージされます。 ibmcloud ks cluster config を実行すると、すぐに自分のクラスタと対話することができ、 Kubernetes コンテキスト内の他のクラスタにコンテキストをすばやく変更できる。

ibmcloud ks cluster config --cluster CLUSTER [--admin] [--endpoint ENDPOINT_TYPE] [--network] [--skip-rbac] [-q] [-o]

最小限必要な許可

IBM Cloud Kubernetes Serviceのクラスターに対する ビューアー または リーダー IBM Cloud の IAM サービス・アクセス役割。 さらに、プラットフォーム・アクセス役割またはサービス・アクセス役割のいずれかしか持っていない場合は、追加の制約が適用されます。

• プラットフォームです：プラットフォームアクセスロールのみを持っている場合、このコマンドを実行できますが、クラスタで Kubernetes アクションを実行するには サービスアクセスロールが 必要です。
• サービス ： service 、このコマンドを実行できます。 ただし、クラスター管理者は、 ibmcloud ks cluster ls コマンドを実行するか、 IBM Cloud Kubernetes Service コンソールを使用して、クラスターの詳細を収集する必要があります。 クラスター名と ID を受け取った後、CLI から Kubernetes ダッシュボードを起動し、Kubernetes を操作できます。

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--admin

オプション：このオプションを使用するには、管理者プラットフォームのロールが必要です。 スーパーユーザー役割の TLS 証明書と許可ファイルをダウンロードします。 ファイルは <user_home_directory>/.bluemix/plugins/kubernetes-service/clusters/<cluster_name>-admin にダウンロードされる。 証明書は失効させたり、ローテーションさせたりすることができる。 詳細については、クラスタ内のCA証明書のローテーション を参照してください。

--endpoint ENDPOINT_TYPE

オプション: クラスターへの接続に使用するエンドポイントのタイプを指定します。 このオプションを指定しないと、クラスタのデフォルトのサービス・エンドポイントが使用されます。

• private: クラスターでプライベート・クラウド・サービス・エンドポイントを有効にした場合、クラスター・コンテキストでプライベート・クラウド・サービス・エンドポイントを使用するために、private に設定します。 この設定時には、IBM Cloud プライベート・ネットワークの中で操作するか、VPC VPN 接続を介して (クラシック・インフラストラクチャーの場合はクラシック VPN 接続または IBM Cloud Direct Link を介して) プライベート・ネットワークに接続しておく必要があります。

• vpe: VPC クラスターの場合、クラスター・コンテキストに仮想プライベート・エンドポイント・ゲートウェイを使用するには、 vpe に設定します。 VPC VPN 接続 を使用して、クラスターがデプロイされているのと同じ VPC に接続する必要があることに注意してください。

--network

オプション: クラスター内で calicoctl コマンドを実行するために必要な Calico 構成ファイル、TLS 証明書、および許可ファイルをダウンロードします。

--skip-rbac

IBM Cloud IAM サービス・アクセス役割に基づくユーザー Kubernetes RBAC 役割をクラスター構成に追加する処理を省略します。 独自の Kubernetes RBAC 役割を管理する場合にのみ、このオプションを組み込んでください。 IBM Cloud IAM サービス・アクセス役割を使用してすべての RBAC ユーザーを管理する場合は、このオプションを組み込まないでください。

-q

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

-o

オプション: コマンド出力をYAML、JSON、または .zip フォーマット。

ibmcloud ks cluster config --cluster my_cluster

ibmcloud ks cluster create classic

クラシック・インフラストラクチャー

クラシック・インフラストラクチャーのワーカー・ノードのクラスターを作成します。

ibmcloud ks cluster create classic [--hardware HARDWARE] --zone ZONE --flavor FLAVOR --name NAME  [--operating-system SYSTEM] [--version MAJOR.MINOR.PATCH] [--no-subnet] [--sm-group GROUP] [--sm-instance INSTANCE] [--private-vlan PRIVATE_VLAN] [--public-vlan PUBLIC_VLAN] [--private-only] [--private-service-endpoint] [--public-service-endpoint] [--workers WORKER] [--disable-disk-encrypt] [--pod-subnet SUBNET] [--service-subnet SUBNET] [--skip-advance-permissions-check] [-q]

VPC クラスターを作成する場合は、代わりに ibmcloud ks cluster create vpc-gen2 コマンドを使用してください。

最小限必要な許可

IBM Cloud Kubernetes Service に対するアカウント・レベルの管理者のプラットフォーム・アクセス役割

IBM Cloud Container Registry に対するアカウント・レベルの管理者のプラットフォーム・アクセス役割

IBM Cloud インフラストラクチャーに対するスーパーユーザーの役割

コマンド・オプション：

--hardware HARDWARE

ワーカー・ノードのハードウェア分離のレベル。 使用可能な物理リソースを自分専用にする場合は dedicated を使用し、他の IBM のお客様と物理リソースを共有することを許可する場合は shared を使用します。 デフォルトはsharedです。 ベアメタル・フレーバーの場合、dedicated を指定します。

--zone ZONE

クラスターを作成するゾーン。 この値は、標準クラスターの場合には必須です。

使用可能なクラシック・ゾーンまたは VPC ゾーンを確認してください。 国外のゾーンを選択する場合は、その国にデータを物理的に保管する前に法的な許可を得なければならないことがあります。

--flavor FLAVOR

ワーカー・ノードのフレーバー (つまり、マシン・タイプ) を選択します。 ワーカー・ノードは、共有または専用ハードウェア上に仮想マシンとしてデプロイすることも、ベア・メタル上に物理マシンとしてデプロイすることもできます。 使用可能な物理フレーバーと仮想フレーバーは、クラスターをデプロイするゾーンによって異なります。 詳しくは、ibmcloud ks flavors (machine-types) コマンドについての説明を参照してください。

--name NAME

必須: クラスターの名前。 名前は先頭が文字でなければならず、文字、数字、ピリオド (.)、およびハイフン (-) を使用できます。35 文字以内でなければなりません。 リージョンをまたいで固有の名前を使用します。 Ingress サブドメインの完全修飾ドメイン・ネームは、クラスター名と、クラスターがデプロイされるリージョンで形成されます。 Ingress サブドメインをリージョン内で固有にするために、クラスター名が切り捨てられ、Ingress ドメイン・ネームにランダムな値が付加されることがあります。

--operating-system UBUNTU_20_64|UBUNTU_24_64

オプション。 クラスター内のワーカー・ノードのオペレーティング・システム。 クラスタのバージョン別に利用可能なオペレーティングシステムの一覧については 、 Kubernetes のバージョン情報 をご覧ください。 オプションが指定されていない場合、クラスター・バージョンに対応するデフォルトのオペレーティング・システムが使用されます。

--version MAJOR.MINOR.PATCH

オプション: クラスター・マスター・ノードの Kubernetes のバージョン。 バージョンを指定しなかった場合、クラスターは、サポートされるデフォルトの Kubernetes バージョンを使用して作成されます。 使用可能なバージョンを確認するには、ibmcloud ks versions を実行します。

--no-subnet

デフォルトでは、パブリックとプライベートのポータブル・サブネットが、クラスターに関連付けられた VLAN 上に作成されます。 クラスタでサブネットを作成しないようにするには、 --no-subnet オプションを含めます。 後でサブネットを作成したり、クラスターに追加したりすることができます。

--sm-group GROUP

秘密が永続化される Secrets Manager インスタンスの秘密グループ ID。 シークレット・グループ ID を取得するには、 Secrets Manager CLI リファレンス を参照してください。

--sm-instance INSTANCE

Secrets Manager インスタンスの CRN。 インスタンスの CRN を取得するには、 ibmcloud ks ingress instance ls --cluster CLUSTER を実行します。

--private-vlan PRIVATE_VLAN

この標準クラスタがこのゾーンで最初に作成する標準クラスタの場合は、このオプションを含めないでください。 プライベート VLAN は、クラスターが作成されるときに作成されます。 前に標準クラスターをこのゾーンに作成している場合、または前にプライベート VLAN を IBM Cloud インフラストラクチャーに作成している場合は、そのプライベート VLAN を指定する必要があります。 必ず、プライベート VLAN ルーターの先頭は bcr (バックエンド・ルーター)、パブリック VLAN ルーターの先頭は fcr (フロントエンド・ルーター) になります。 クラスターを作成し、パブリック VLAN とプライベート VLAN を指定するときには、それらの接頭部の後の番号と文字の組み合わせが一致する必要があります。

特定のゾーンのプライベート VLAN が既に存在するかを確認したり、既存のプライベート VLAN の名前を確認したりするには、ibmcloud ks vlan ls --zone ZONE を実行します。

--public-vlan PUBLIC_VLAN

この標準クラスタがこのゾーンで最初に作成する標準クラスタの場合は、このオプションを使用しないでください。 パブリック VLAN は、クラスターが作成されるときに作成されます。 前に標準クラスターをこのゾーンに作成している場合、または前にパブリック VLAN を IBM Cloud インフラストラクチャーに作成している場合は、そのパブリック VLAN を指定します。 ワーカー・ノードをプライベート VLAN にのみ接続する場合は、このオプションを指定しないでください。 必ず、プライベート VLAN ルーターの先頭は bcr (バックエンド・ルーター)、パブリック VLAN ルーターの先頭は fcr (フロントエンド・ルーター) になります。 クラスターを作成し、パブリック VLAN とプライベート VLAN を指定するときには、それらの接頭部の後の番号と文字の組み合わせが一致する必要があります。

特定のゾーンのパブリック VLAN が既に存在するかを確認したり、既存のパブリック VLAN の名前を確認したりするには、ibmcloud ks vlan ls --zone ZONE を実行します。

--private-only

このオプションは、パブリック VLAN が作成されるのを防止するために使用します。 --private-vlan オプションを指定し、 --public-vlan オプションを含めない場合にのみ必要です。 プライベート VLAN のみを使用してワーカー・ノードをセットアップする場合は、プライベート・クラウド・サービス・エンドポイントを有効にするか、ゲートウェイ・アプライアンスを構成する必要があります。 詳しくは、 ワーカーとマスターおよびユーザーとマスターの間の通信を参照してください。

--private-service-endpoint

VRF とサービス・エンドポイントを有効にしたアカウントの標準クラスター: プライベート・クラウド・サービス・エンドポイントを有効にして、Kubernetes マスターとワーカー・ノードがプライベート VLAN で通信できるようにします。 さらに、 --public-service-endpoint オプションを使用してパブリック・クラウド・サービスのエンドポイントを有効にし、インターネット経由でクラスタにアクセスすることもできます。 プライベート・クラウド・サービス・エンドポイントのみを有効にする場合は、Kubernetes マスターと通信するためにプライベート VLAN に接続している必要があります。 プライベート・クラウド・サービス・エンドポイントを有効にした後で、無効にすることはできません。 クラスターを作成後、ibmcloud ks cluster get --cluster <cluster_name_or_ID> を実行してエンドポイントを取得できます。

--public-service-endpoint

パブリック・クラウド・サービス・エンドポイントを有効にして、Kubernetes マスターにパブリック・ネットワークを介してアクセスできるようにします (例えば、コマンド・ラインから kubectl コマンドを実行するため)。 パブリック専用クラスターは、VRF が有効になっていないアカウントでのみ作成できます。 VRFとサービス・エンドポイントが有効なアカウントで、 --private-service-endpoint オプションも含まれている場合、マスター・ワーカー・ノードの通信はプライベート・ネットワークとパブリック・ネットワークを介して行われます。 後で、プライベート専用クラスターにする場合は、パブリック・クラウド・サービス・エンドポイントを無効にすることができます。 クラスターを作成後、 ibmcloud ks cluster get --cluster <cluster_name_or_ID> を実行してエンドポイントを取得できます。

--workers WORKERS

オプション ：クラスタに含めるワーカーノードの数を指定します。 デフォルト値は 1 です。 ゾーンごとにワーカー・ノードが 1 つのみのクラスターを作成すると、Ingress で問題が発生する可能性があります。 高可用性を確保するために、ゾーンごとに少なくとも 2 つのワーカーを持つクラスターを作成します。 ワーカー・ノードごとに、固有のワーカー・ノード ID とドメイン名が割り当てられます。クラスターが作成された後にこれらを手動で変更してはいけません。 ID またはドメイン名を変更すると、Kubernetes マスターがクラスターを管理できなくなります。

--disable-disk-encrypt

ワーカー・ノードには、デフォルトで AES 256 ビット・ディスク暗号化の機能があります。詳しくはこちらを参照してください。 暗号化を無効にするには、このオプションを組み込みます。

--pod-subnet SUBNET

ワーカーノードにデプロイされるすべてのポッドには、デフォルトで 172.17.0.0/18 の範囲のプライベート IP アドレスが割り当てられます。 IBM Cloud® Direct Link または VPN サービスを介してクラスターをオンプレミスのネットワークに接続する場合は、カスタムのサブネット CIDR を指定してポッドのプライベート IP アドレスを提供することで、サブネットの競合を回避できます。

サブネットのサイズを選択する際には、作成するクラスターのサイズと今後追加するワーカー・ノードの数を考慮してください。 少なくとも、クラスター内の最大 4 台のワーカー・ノードに十分なポッド IP を提供できる /23 の CIDR のサブネットにする必要があります。 これより大きなクラスターの場合は、8 台のワーカー・ノードに十分なポッド IP アドレスを提供できる /22、16 台のワーカー・ノードに十分なポッド IP アドレスを提供できる /21 というように増やしていきます。

サブネットは、以下のいずれかの範囲内を選ばなければなりません。

• 172.17.0.0 - 172.17.255.255

• 172.21.0.0 - 172.31.255.255

• 192.168.0.0 - 192.168.255.255

• 198.18.0.0 - 198.19.255.255

ポッドとサービスのサブネットは重複することができません。 サービス・サブネットは、デフォルトでは 172.21.0.0/16 の範囲にあります。

--service-subnet *SUBNET

クラスターにデプロイされるすべてのサービスは、デフォルトでは 172.21.0.0/16 の範囲のプライベート IP アドレスを割り当てられます。 IBM Cloud Direct Link または VPN サービスを介してクラスターをオンプレミスのネットワークに接続する場合は、カスタムのサブネット CIDR を指定してサービスのプライベート IP アドレスを提供することで、サブネットの競合を回避できます。

サブネットは、CIDR 形式で `/24` 以上のサイズを指定する必要があります。/24 の場合は、クラスター内で最大 255 個のサービスに対応できます。 サブネットは、以下のいずれかの範囲内を選ばなければなりません。

• 172.17.0.0 - 172.17.255.255

• 172.21.0.0 - 172.31.255.255

• 192.168.0.0 - 192.168.255.255

• 198.18.0.0 - 198.19.255.255

ポッドとサービスのサブネットは重複することができません。 ポッドのサブネットは、デフォルトでは 172.30.0.0/16 の範囲にあります。

--skip-advance-permissions-check

オプション: クラスターの作成前のインフラストラクチャーの権限検査をスキップします。 正しいインフラストラクチャー許可がない場合、クラスターの作成は部分的にしか成功しない可能性があることに注意してください。例えば、マスター・プロビジョニングの場合でも、ワーカー・ノードをプロビジョンできません。 スキップしないとブロックされるような処理を進めたい場合に、権限検査をスキップすることができます。例えば、複数のインフラストラクチャー・アカウントを使用していて、後から必要に応じてマスターとは別にインフラストラクチャー・リソースを操作できるような場合です。

-q

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

ibmcloud ks cluster create classic --zone dal10 --private-vlan my_private_VLAN_ID --flavor b3c.4x16 --name my_cluster --hardware shared --workers 2 --operating-system UBUNTU_20_64

ibmcloud ks cluster create classic --zone dal10 --public-vlan my_public_VLAN_ID --private-vlan my_private_VLAN_ID --flavor b3c.4x16 --name my_cluster --hardware shared --workers 2 --operating-system UBUNTU_20_64

ibmcloud ks cluster create vpc-gen2

Virtual Private Cloud

ワーカー・ノードを持つ仮想プライベート・クラウド (VPC) クラスターを世代 2 インフラストラクチャーに作成します。 IBM Cloud アカウントにログインするときに、VPC クラスターを作成する IBM Cloud リージョンおよびリソース・グループをターゲットにします。 サポートされるリージョンについては、別のリージョンでの VPC の作成を参照してください。 このクラスターのリソース・グループは、VPC リソース・グループとは別にすることができます。

許可リストに登録されているアカウントでは、インスタンス・ストレージを使用する VPC 第 2 世代クラスター・フレーバーを使用できます。 許可リストに追加するには、サポートを利用して Case をオープン してください。

ibmcloud ks cluster create vpc-gen2 --name NAME --zone ZONE --vpc-id VPC_ID --subnet-id VPC_SUBNET_ID --flavor WORKER_FLAVOR [--cluster-security-group GROUP_ID] [--operating-system SYSTEM] [--version VERSION] [--workers NUMBER_WORKERS_PER_ZONE] [--dedicated-host-pool POOL] [--disable-outbound-traffic-protection] [--disable-public-service-endpoint] [--pod-subnet SUBNET] [--service-subnet SUBNET] [--kms-account-id ID] [--kms-instance KMS_INSTANCE_ID] [--crk ROOT_KEY_ID][--skip-advance-permissions-check] [--sm-group GROUP] [--sm-instance INSTANCE] [-q] [--secondary-storage STORAGE]

最小限必要な許可

VPC インフラストラクチャーに対する管理者のプラットフォーム・アクセス役割。

アカウント・レベルでの IBM Cloud Kubernetes Service の 管理者 プラットフォーム・アクセス役割。

IBM Cloud Kubernetes Serviceに対する ライター または マネージャー のサービス・アクセス役割。

アカウント・レベルでの IBM Cloud Container Registry に対する 管理者 のプラットフォーム・アクセス役割。

コマンド・オプション：

--name NAME

必須: クラスターの名前。 名前は先頭が文字でなければならず、文字、数字、ピリオド (.)、およびハイフン (-) を使用できます。35 文字以内でなければなりません。 リージョンをまたいで固有の名前を使用します。 Ingress サブドメインの完全修飾ドメイン・ネームは、クラスター名と、クラスターがデプロイされるリージョンで形成されます。 Ingress サブドメインをリージョン内で固有にするために、クラスター名が切り捨てられ、Ingress ドメイン・ネームにランダムな値が付加されることがあります。

--zone ZONE

必須: 最初のクラスター・ワーカー・プールをデプロイするゾーンを選択します。 マルチゾーン大都市でクラスターを作成する場合は、後からワーカー・プールにゾーンを追加できます。 使用可能な VPC ゾーンをリストするには、ibmcloud ks zone ls --provider vpc-gen2 を実行します。

国外のゾーンを選択する場合は、その国にデータを物理的に保管する前に法的な許可を得なければならないことがあります。

--vpc-id VPC_ID

必須: クラスターとワーカー・ノードを作成する VPC の ID。 使用可能な ID をリストするには、ibmcloud ks vpcs を実行します。

--subnet-id VPC_SUBNET_ID

必須: クラスターを割り当てる VPC サブネット。 使用可能な VPC サブネットをリストするには、ibmcloud ks subnets --provider vpc-gen2 を実行します。

--version VERSION

クラスター・マスター・ノードの Kubernetes のバージョン。 使用可能なバージョンを確認するには、ibmcloud ks versions を実行します。

--flavor FLAVOR

ワーカー・ノードのフレーバーを選択します。 ワーカー・ノードは、共有または専用のハードウェア上に仮想マシンとしてデプロイできます。 ゾーンで使用可能なフレーバーを確認するには、ibmcloud ks flavors --zone <vpc_zone> --provider vpc-gen2 を実行します。

--cluster-security-group GROUP_ID

オプション。 クラスター上のすべてのワーカーに適用する追加のセキュリティー・グループ ID を指定します。 追加する個々のセキュリティー・グループごとに、個別の --cluster-security-group オプションを指定する必要があります。 IBM 作成の kube-clusterID を適用するには、--cluster-security-group cluster を使用します。 値を指定しない場合は、kube-clusterID とデフォルトの VPC セキュリティー・グループのみが適用されます。 デフォルトのセキュリティー・グループを含め、最大 5 つのセキュリティー・グループをワーカーに適用できます。 VPC セキュリティー・グループは、他のセキュリティー・グループが指定されていない場合にのみ適用されることに注意してください。 詳しくは、作成時に VPC セキュリティー・グループをクラスターおよびワーカー・プールに追加するを参照してください。 クラスターに適用したセキュリティー・グループは、クラスターの作成後に変更することはできません。 クラスタに適用されるセキュリティグループのルールは変更できますが、クラスタレベルでセキュリティグループを追加または削除することはできません。 クラスターの作成時に誤ったセキュリティー・グループを適用した場合は、クラスターを削除して新しいクラスターを作成する必要があります。 詳細については、 作成時にクラスタとワーカー・プールにVPCセキュリティ・グループを追加するを 参照してください。

--operating-system UBUNTU_20_64|UBUNTU_24_64

オプション。 クラスター内のワーカー・ノードのオペレーティング・システム。 クラスタのバージョン別に利用可能なオペレーティングシステムの一覧については 、 Kubernetes のバージョン情報 をご覧ください。 オプションが指定されていない場合、クラスター・バージョンに対応するデフォルトのオペレーティング・システムが使用されます。

--preview PREVIEW

オプション: 1 つ以上のクラスター・レベルのプレビュー機能 ( fips など) を指定します。

--dedicated-host-pool POOL

オプション: ワーカーの実行先となる専用ホスト・プールの ID。

--workers NUMBER_WORKERS_PER_ZONE

オプション: クラスターに含めるワーカー・ノードの数を指定します。 デフォルト値は 1 です。

--disable-outbound-traffic-protection

クラスター・ワーカーからのパブリック・アウトバウンド・アクセスを許可するには、このオプションを含めます。 デフォルトでは、パブリック・アウトバウンド・アクセスは、 OpenShift バージョン 4.15 以降および Kubernetes バージョン 1.30 以降でブロックされます。

--disable-public-service-endpoint

ワーカー・ノードおよび許可されたクラスタ・ユーザーがプライベート・クラウド・サービスのエンドポイントのみを介してマスターと通信するようにするには、このオプションを指定してパブリック・クラウド・サービスのエンドポイントなしでクラスタを作成します。

--pod-subnet SUBNET

VPC で作成した最初のクラスターでは、デフォルトのポッド・サブネットは 172.17.0.0/18 です。 第 2 世代 VPC で作成した 2 番目のクラスターでは、デフォルトのポッド・サブネットは 172.17.64.0/18 です。 それ以降の各クラスターでは、ポッド・サブネット範囲は、次に使用可能な重複しない /18 サブネットになります。 IBM Cloud® Direct Link または VPN サービスを介してクラスターをオンプレミスのネットワークに接続する場合は、カスタムのサブネット CIDR を指定してポッドのプライベート IP アドレスを提供することで、サブネットの競合を回避できます。

サブネットのサイズを選択する際には、作成するクラスターのサイズと今後追加するワーカー・ノードの数を考慮してください。 少なくとも、クラスター内の最大 4 台のワーカー・ノードに十分なポッド IP を提供できる /23 の CIDR のサブネットにする必要があります。 これより大きなクラスターの場合は、8 台のワーカー・ノードに十分なポッド IP アドレスを提供できる /22、16 台のワーカー・ノードに十分なポッド IP アドレスを提供できる /21 というように増やしていきます。

: ワーカーノードにデプロイされるすべてのポッドには、デフォルトで 172.17.0.0/18 の範囲のプライベート IP アドレスが割り当てられます。 IBM Cloud® Direct Link または VPN サービスを介してクラスターをオンプレミスのネットワークに接続する場合は、カスタムのサブネット CIDR を指定してポッドのプライベート IP アドレスを提供することで、サブネットの競合を回避できます。

VPC クラスターの場合は、サブネット・サイズを --pod-subnet オプションに含めることによって指定できます。 例: --pod-subnet 0.0.0.0/X ここで、 X は必要なポッド・サブネット・サイズです。 その後、ポッド・サブネットが自動的に選択されます。 ポッド・サブネットを自動的に割り振る場合、割り振りは 172.17.0.0 から開始され、最大サブネットは 13 に制限され、最小サブネット・サイズは 23 に制限されます。 詳しくは、 VPC サブネットの構成 を参照してください。 サブネットは、以下のいずれかの範囲内を選ばなければなりません。

• 172.17.0.0 - 172.17.255.255

• 172.21.0.0 - 172.31.255.255

• 192.168.0.0 - 192.168.255.255

• 198.18.0.0 - 198.19.255.255

ポッドとサービスのサブネットは重複することができません。 ワーカー・ノードにカスタム範囲のサブネットを使用する場合は、ワーカー・ノード・サブネットがクラスターのポッド・サブネットとオーバーラップしないようにしてください。

--service-subnet SUBNET

クラスターにデプロイされるすべてのサービスは、デフォルトでは 172.21.0.0/16 の範囲のプライベート IP アドレスを割り当てられます。 IBM Cloud Direct Link または VPN サービスを介してクラスターをオンプレミスのネットワークに接続する場合は、カスタムのサブネット CIDR を指定してサービスのプライベート IP アドレスを提供することで、サブネットの競合を回避できます。 サブネットは、CIDR 形式で /24 以上のサイズを指定する必要があります。/24 の場合は、クラスター内で最大 255 個のサービスに対応できます。 サブネットは、以下のいずれかの範囲内を選ばなければなりません。

• 172.17.0.0 - 172.17.255.255
• 172.21.0.0 - 172.31.255.255
• 192.168.0.0 - 192.168.255.255
• 198.18.0.0 - 198.19.255.255

ポッドとサービスのサブネットは重複することができません。

--skip-advance-permissions-check

オプション: クラスターの作成前のインフラストラクチャーの権限検査をスキップします。 正しいインフラストラクチャー許可がない場合、クラスターの作成は部分的にしか成功しない可能性があることに注意してください。例えば、マスター・プロビジョニングの場合でも、ワーカー・ノードをプロビジョンできません。 スキップしないとブロックされるような処理を進めたい場合に、権限検査をスキップすることができます。例えば、複数のインフラストラクチャー・アカウントを使用していて、後から必要に応じてマスターとは別にインフラストラクチャー・リソースを操作できるような場合です。

--kms-account-id ID

オプション：ローカルディスクまたは秘密の暗号化に使用するKMSインスタンスを含むアカウントのID。

--kms-instance KMS_INSTANCE_ID

オプション: default ワーカー・プール内のワーカー・ノードのローカル・ディスクを暗号化するために使用する鍵管理サービス (KMS) インスタンスの ID を含めます。 使用可能な KMS インスタンスを確認するには、ibmcloud ks kms instance ls を実行します。 このオプションを指定する場合は、--crk オプションも指定する必要があります。 KMS 暗号化を使用するには、その前に KMS インスタンスを作成し、必要なサービス許可を IAM でセットアップしておく必要があります。 クラスターのワーカー・ノードの暗号化の管理を参照してください。

--crk ROOT_KEY

オプション: default ワーカー・プール内のワーカー・ノードのローカル・ディスクを暗号化するために使用するルート鍵の ID を KMS インスタンスに含めます。 使用可能なルート鍵を確認するには、ibmcloud ks kms crk ls --instance-id を実行します。 このオプションを指定する場合は、--kms-instance オプションも指定する必要があります。 KMS 暗号化を使用するには、その前に KMS インスタンスを作成し、必要なサービス許可を IAM でセットアップしておく必要があります。 クラスターのワーカー・ノードの暗号化の管理を参照してください。

--sm-group GROUP

秘密が永続化される Secrets Manager インスタンスの秘密グループ ID。 シークレット・グループ ID を取得するには、 Secrets Manager CLI リファレンス を参照してください。

--sm-instance INSTANCE

Secrets Manager インスタンスの CRN。 インスタンスの CRN を見つけるには、 ibmcloud ks ingress instance ls --cluster CLUSTER を実行します。

--secondary-storage STORAGE

オプション: フレーバーのストレージ・オプション。 例えば、900gb.5iops-tier です。 2 次ディスクを追加すると、そのディスクがコンテナー・ランタイムに使用され、1 次ディスクがオペレーティング・システムに使用されます。 フレーバーのストレージ・オプションを表示するには、 **ibmcloud ks flavor get --flavor FLAVOR --zone ZONE --provider vpc-gen2 コマンドを実行します。

-q

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

ibmcloud ks cluster create vpc-gen2 --name mycluster --version 1.32 --zone us-south-1 --vpc-id a0123456-78b9-0c1d-23d4-567890123ef4 --subnet-id 1ab23c45-6789-0123-456d-789ef01gh234 --flavor bx2.4x16 --workers 3

ibmcloud ks cluster get

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの詳細を表示します。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--show-resources

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

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks cluster get --cluster my_cluster --show-resources

ibmcloud ks cluster image-security disable

仮想プライベート・クラウド クラシック・インフラストラクチャー

イメージ・セキュリティー制約を無効にします。 この機能を無効にすると、基礎となる ClusterImagePolicy CRD が削除されます。これにより、作成したすべてのデフォルト・イメージ・ポリシーとすべてのカスタム・イメージ・ポリシーが削除されます。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-q

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

ibmcloud ks cluster image-security disable --cluster my_cluster

ibmcloud ks cluster image-security enable

仮想プライベート・クラウド クラシック・インフラストラクチャー

Portieris Kubernetes アドミッション・コントローラーとそれに関連するデフォルトのイメージ・ポリシーをクラスターにインストールすることによって、イメージ・セキュリティー制約を有効にします。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks cluster image-security enable --cluster my_cluster

ibmcloud ks cluster ls

仮想プライベート・クラウド クラシック・インフラストラクチャー Satellite

IBM Cloud アカウント内のクラスターをすべてリストします。

すべてのロケーションのクラスターが返されます。 特定の場所でクラスタをフィルタするには、 --location オプションを指定します。 例えば、大都市 dal のクラスターをフィルタリングする場合、その大都市内の複数ゾーン・クラスターおよびその大都市内のデータ・センター (ゾーン) の単一ゾーン・クラスターが返されます。 dal10 データ・センター (ゾーン) のクラスターをフィルタリングすると、そのゾーンにワーカー・ノードがある複数ゾーン・クラスターとそのゾーンにある単一ゾーン・クラスターが返されます。 1 つのロケーションか、ロケーションのコンマ区切りのリストを渡すことができます。

ibmcloud ks cluster ls [--provider (classic | vpc-gen2)] [--location LOCATION] [--output json] [-q]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

--provider (classic | vpc-gen2)

オプション: インフラストラクチャー・プロバイダー・タイプに基づいて出力をフィルタリングします。

-l, --location LOCATION

特定のロケーションで出力をフィルタリングします。 サポート対象のロケーションを確認するには、ibmcloud ks locations を実行します。 複数の場所を指定するには、 -l dal -l seo のように、場所ごとに1つのオプションを使用します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。 注： --provider オプションを付けない場合は、クラシック・クラスタのみが返されます。

-q

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

ibmcloud ks cluster ls -l ams03 -l wdc -l ap

ibmcloud ks cluster master audit-webhook

API サーバー監査ログをリモート・サーバーに転送する Web フック・バックエンドを変更します。

これらのコマンドの別名 apiserver-config-get|set|unset audit-webhook は推奨されません。

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

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

ibmcloud ks cluster master audit-webhook set --cluster CLUSTER [--remote-server SERVER_URL_OR_IP] [--ca-cert CA_CERT_PATH] [--client-cert CLIENT_CERT_PATH] [--client-key CLIENT_KEY_PATH] [--policy POLICY] [-q]

ibmcloud ks cluster master audit-webhook set --cluster my_cluster --remote-server https://audit.example.com/audit --ca-cert /mnt/etc/kubernetes/apiserver audit/ca.pem --client-cert /mnt/etc/kubernetes/apiserver audit/cert.pem --client-key /mnt/etc/kubernetes/apiserver audit/key.pem

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

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

--output OUTPUT

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

-q

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

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

-f

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

-q

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

--type TYPE

OpenShift Web コンソールおよび OAuth サーバーのアクセス・タイプを指定します。 受け入れられる値: vpe-gateway、 legacy

ibmcloud ks cluster master pod-security get

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスタの Kubernetes API サーバーのポッドセキュリティ入場設定を表示します。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks cluster master pod-security policy disable

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの Kubernetes API サーバーのポッド・セキュリティー・ポリシーを無効にします。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-q

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

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

ibmcloud ks cluster master pod-security policy enable

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの Kubernetes API サーバーのポッド・セキュリティー・ポリシーを有効にします。 ポッド・セキュリティー・ポリシーは、バージョン 1.25 以降を実行するクラスターでは使用できないことに注意してください。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks cluster master pod-security policy get

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスタの Kubernetes API サーバーのポッドセキュリティポリシー構成を表示します。 ポッド・セキュリティー・ポリシーは、バージョン 1.25 以降を実行するクラスターでは使用できないことに注意してください。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks cluster master pod-security set

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの Kubernetes API サーバーの ポッド・セキュリティー・アドミッション を設定して有効にします。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks cluster master pod-security unset

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの Kubernetes API サーバーの ポッド・セキュリティー・アドミッション 構成を削除します。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks cluster master private-service-endpoint allowlist

プライベート・サービスのエンドポイント許可リストはサポートされなくなりました。 できるだけ早く、許可リストからコンテキストベースの制限に移行する。 詳細については、プライベート・サービス・エンドポイントの許可リストからコンテキスト・ベースの制限（CBR）への移行 を参照してください。

プライベート・クラウド・サービス・エンドポイント許可リストを管理して、許可ユーザーがその許可リストで指定されているサブネットからのみプライベート・クラウド・サービス・エンドポイントにアクセスできるようにします。

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

ibmcloud ks cluster master private-service-endpoint allowlist add --cluster mycluster --subnet 1.1.1.1/16

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

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

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

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

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

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

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

ibmcloud ks cluster master private-service-endpoint allowlist rm --cluster mycluster
 --subnet 1.1.1.1/16

ibmcloud ks cluster master private-service-endpoint disable

クラシック・インフラストラクチャー

プライベート・クラウド・サービス・エンドポイントを無効にすると、クラスター・マスターへのプライベート・アクセシビリティーが解除されます。

重要: プライベート・エンドポイントを無効にする前に、まず以下の手順を実行して、パブリック・クラウド・サービス・エンドポイントを有効にする必要があります。

1. ibmcloud ks cluster master public-service-endpoint enable --cluster <cluster_name> を実行して、パブリック・クラウド・サービス・エンドポイントを有効にします。
2. CLI に表示されたプロンプトに従って、Kubernetes マスター API サーバーをリフレッシュします。
3. クラスター内のすべてのワーカー・ノードを再ロードして、パブリック・エンドポイント構成を取得します。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

-y

オプション: ユーザー・プロンプトを出さずにクラスター・マスターをリフレッシュし、ワーカー・ノードを再ロードします。

ibmcloud ks cluster master private-service-endpoint disable --cluster my_cluster

ibmcloud ks cluster master private-service-endpoint enable

クラシック・インフラストラクチャー

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

このコマンドを実行するには、以下のようにします。

1. ご使用の IBM Cloud インフラストラクチャー・アカウントで VRF を有効にします。 VRF が既に有効になっているかどうかを確認するには、ibmcloud account show コマンドを使用します。
2. IBM Cloud アカウントでサービス・エンドポイントを使用できるようにします。
3. ibmcloud ks cluster master private-service-endpoint enable --cluster <cluster_name> を実行します。
4. CLI に表示されたプロンプトに従って、Kubernetes マスター API サーバーをリフレッシュします。
5. クラスター内のすべてのワーカー・ノードを再ロードして、プライベート・エンドポイント構成を適用させます。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-q

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

-y

オプション: ユーザー・プロンプトを出さずにクラスター・マスターをリフレッシュし、ワーカー・ノードを再ロードします。

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

ibmcloud ks cluster master public-service-endpoint disable

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターのパブリック・クラウド・サービス・エンドポイントを無効にします。

重要: パブリック・エンドポイントを無効にする前に、まず以下のステップを実行して、プライベート・クラウド・サービス・エンドポイントを有効にする必要があります。

1. ibmcloud ks cluster master private-service-endpoint enable --cluster <cluster_name> を実行して、プライベート・クラウド・サービス・エンドポイントを有効にします。
2. CLI に表示されたプロンプトに従って、Kubernetes マスター API サーバーをリフレッシュします。
3. クラスター内のすべてのワーカー・ノードを再ロードして、プライベート・エンドポイント構成を適用させます。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-y

オプション: ユーザー・プロンプトを出さずにクラスター・マスターをリフレッシュし、ワーカー・ノードを再ロードします。

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

ibmcloud ks cluster master public-service-endpoint enable

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

このコマンドを実行した後、CLI に表示されたプロンプトに従って、このサービス・エンドポイントを使用するために API サーバーをリフレッシュする必要があります。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-q

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

-y

オプション: ユーザー・プロンプトを出さずにクラスター・マスターをリフレッシュします。

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

ibmcloud ks cluster master refresh

仮想プライベート・クラウド クラシック・インフラストラクチャー

ibmcloud ks cluster master コマンドを使用して要求された、Kubernetes マスターの構成変更を適用します。 高可用性 Kubernetes マスター・コンポーネントは、ローリング・リスタートで再始動されます。 ご使用のワーカー・ノード、アプリ、リソースは変更されず、引き続き実行されます。

このコマンドの別名 apiserver-refresh および cluster-refresh は推奨されません。

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

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-q

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

ibmcloud ks cluster master update

仮想プライベート・クラウド クラシック・インフラストラクチャー Satellite

Kubernetes マスターおよび API サーバーを更新します。 更新中は、クラスターにアクセスすることも変更することもできません。 デプロイされたワーカーノード、アプリ、リソースは変更されず、実行され続ける。

今後のデプロイメント用に、YAML ファイルを変更する必要がある場合があります。 詳しくは、このリリース・ノートを確認してください。

このコマンドの別名 cluster-update は推奨されません。

ibmcloud ks cluster master update --cluster CLUSTER [--version MAJOR.MINOR.PATCH] [--force-update] [-f] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--version MAJOR.MINOR.PATCH

オプション: クラスターの Kubernetes のバージョン。 バージョンを指定しない場合、Kubernetes マスターはデフォルトの API バージョンに更新されます。 使用可能なバージョンを確認するには、ibmcloud ks versions を実行します。

--force-update

オプション: ワーカー・ノード・バージョンからの変更が 2 つのマイナー・バージョンより大規模である場合でも、更新を試行します。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks cluster master update --cluster my_cluster

ibmcloud ks cluster pull-secret apply

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの IBM Cloud IAM サービス ID を作成し、IBM Cloud Container Registry でリーダー・サービス・アクセス役割を割り当てるサービス ID のポリシーを作成してから、サービス ID の API キーを作成します。 作成すると、API キーが Kubernetes イメージ・プル・シークレットに格納されるので、default Kubernetes 名前空間のコンテナーのために、IBM Cloud Container Registry 名前空間からイメージをプルできるようになります。 このプロセスは、クラスターを作成するときに自動的に実行されます。 クラスター作成プロセス中にエラーが発生するか、または既存のクラスターがある場合は、このコマンドを使用してプロセスを再び適用することができます。

IAM API キーを使って IBM Cloud Container Registry にアクセスすることで、サービス ID に対して IAM ポリシーをカスタマイズし、ネームスペースや特定のイメージへのアクセスを制限することができます。 例えば、特定のレジストリーのリージョンまたは名前空間のみからイメージをプルするために、クラスターのイメージ・プル・シークレット内のサービス ID ポリシーを変更することができます。 IAM ポリシーをカスタマイズするには、その前に IBM Cloud に対して IBM Cloud Container Registry IAM ポリシーを有効にする必要があります。 詳しくは、 IBM Cloud Container Registry からのイメージのプルをクラスターに許可する方法を参照してください。

このコマンドを実行すると、IAM 資格情報とイメージ・プル・シークレットの作成が開始されます。これが完了するまで、しばらく時間がかかる場合があります。 イメージ・プル・シークレットが作成されるまでは、IBM Cloud Container Registry icr.io ドメインからイメージをプルするコンテナーをデプロイできません。 イメージ・プル・シークレットを確認するには、kubectl get secrets | grep icr-io を実行します。 リージョン・レジストリーへのアクセスの制限などの目的で、既存のサービス ID に IAM ポリシーを追加していた場合は、このコマンドによって、イメージ・プル・シークレットのサービス ID、IAM ポリシー、および API キーが再設定されます。

ibmcloud ks cluster pull-secret apply --cluster CLUSTER

最小限必要な許可:

• IBM Cloud Kubernetes Service でのクラスターに対するオペレーターまたは管理者のプラットフォーム・アクセス役割
• すべてのリージョンおよびリソース・グループにおける IBM Cloud Container Registry に対する管理者プラットフォーム・アクセス役割。 ポリシーのスコープを特定のリージョンまたはリソース・グループに設定することはできません。

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

ibmcloud ks cluster rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターを削除します。 すべてのワーカー・ノード、アプリ、コンテナーが完全に削除されます。 このアクションは元に戻すことができません。

ibmcloud ks cluster rm --cluster CLUSTER [--force-delete-storage] [--skip-advance-permissions-check] [-f] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--force-delete-storage

オプション: クラスターと、そのクラスターが使用する永続ストレージを削除します。 注意このオプションを含めると、クラスタまたは関連するストレージ・インスタンスに保存されているデータは復元できなくなります。

--skip-advance-permissions-check

オプション: クラスターの削除前のインフラストラクチャーの権限検査をスキップします。 ただし、適切なインフラストラクチャー権限がないと、クラスターの削除が部分的にしか成功しない可能性があります。例えば、IBM 管理のマスターは削除できても、ワーカー・ノードをインフラストラクチャー・アカウントから削除できない可能性があります。 スキップしないとブロックされるような処理を進めたい場合に、権限検査をスキップすることができます。例えば、複数のインフラストラクチャー・アカウントを使用していて、後から必要に応じてマスターとは別にインフラストラクチャー・リソースを操作できるような場合です。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks cluster rm --cluster my_cluster

ibmcloud ks cluster service bind

仮想プライベート・クラウド クラシック・インフラストラクチャー

IBM Cloud サービスをクラスターに追加するために、そのサービス・インスタンスを Kubernetes 名前空間にバインドします。 このコマンドは、IBM Cloud サービスのサービス資格情報を作成し、これらの資格情報をクラスター内の Kubernetes シークレットに保管します。

IBM Cloud カタログにある IBM Cloud サービスを表示するには、ibmcloud service offerings を実行します。 注: サービス・キーをサポートする IBM Cloud サービスだけを追加できます。 サービス・バインディングおよびクラスターに追加できるサービスについて詳しくは、IBM Cloud サービス・バインディングを使用したサービスの追加を参照してください。

ibmcloud ks cluster service bind --cluster CLUSTER --namespace KUBERNETES_NAMESPACE [--key SERVICE_INSTANCE_KEY] [--role IAM_SERVICE_ROLE] --service SERVICE_INSTANCE [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-n, --namespace KUBERNETES_NAMESPACE

必須: サービス資格情報の Kubernetes シークレットを作成する Kubernetes 名前空間の名前。

--key SERVICE_INSTANCE_KEY

オプション: 既存のサービス・キーの名前または GUID。 service-binding コマンドを使用すると、サービス・インスタンスの新規サービス資格情報が自動的に作成され、IAM 対応サービスに対する IAM ライター・サービス・アクセス・ロールが割り当てられます。 以前に作成した既存のサービス・キーを使用する場合は、このオプションを使用します。 サービス・キーを定義する場合、サービス・キーは特定の IAM サービス・アクセス・ロールで既に作成されているため、--role オプションを同時に設定することはできません。

--role IAM_SERVICE_ROLE

サービス・キーに付与する IBM Cloud IAM 役割。 この値はオプションで、IAM 対応サービスにのみ使用できます。 このオプションを設定しない場合は、サービス資格情報が自動的に作成され、IAM ライター・サービス・アクセス・ロールが割り当てられます。 --key オプションを指定して既存のサービス・キーを使用する場合は、このオプションを含めないでください。 サービスで使用可能な役割をリストするには、 ibmcloud iam roles --service <service_name> を実行します。 この service_name は、ibmcloud catalog search を実行して取得できるカタログ内のサービスの名前です。

--service SERVICE_INSTANCE

必須: バインドする IBM Cloud サービス・インスタンスの名前。 名前を見つけるには、 ibmcloud resource service-instances を実行する。

-q

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

ibmcloud ks cluster service bind --cluster my_cluster --namespace my_namespace --service my_service_instance

ibmcloud ks cluster service ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内の 1 つまたはすべての Kubernetes 名前空間にバインドされたサービスをリストします。 指定されたオプションがない場合、デフォルトの名前空間のサービスが表示されます。

ibmcloud ks cluster service ls --cluster CLUSTER [--namespace KUBERNETES_NAMESPACE] [--all-namespaces] [--output json] [-q]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-n, --namespace KUBERNETES_NAMESPACE

オプション: クラスター内の特定の名前空間にバインドされたサービスを含めます。

--all-namespaces

オプション: クラスター内のすべての名前空間にバインドされたサービスを含めます。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks cluster service ls --cluster my_cluster --namespace my_namespace

ibmcloud ks cluster service unbind

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

IBM Cloud サービスを削除すると、サービス資格情報がクラスターから削除されます。 そのサービスをまだ使用しているポッドがある場合、サービス資格情報を検出できなくなるためそのポッドは失敗します。

ibmcloud ks cluster service unbind --cluster CLUSTER --namespace KUBERNETES_NAMESPACE --service SERVICE_INSTANCE [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-n, --namespace KUBERNETES_NAMESPACE

必須: Kubernetes 名前空間の名前。

--service SERVICE_INSTANCE

必須: 削除する IBM Cloud サービス・インスタンスの名前。 サービス・インスタンスの確認するには、ibmcloud ks cluster service ls --cluster <cluster_name_or_ID> を実行します。

-q

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

ibmcloud ks cluster service unbind --cluster my_cluster --namespace my_namespace --service 8567221

ibmcloud ks cluster subnet add

クラシック・インフラストラクチャー

自動的にプロビジョンされるサブネットを使用する代わりに、IBM Cloud インフラストラクチャー・アカウント内の既存のポータブル・パブリック・クラシック・サブネットまたはポータブル・プライベート・クラシック・サブネットをクラスターで使用できるようにするか、削除したクラスターのサブネットを再利用します。

クラスターでサブネットを使用できるようにすると、このサブネットの IP アドレスは、クラスターのネットワーキングの目的で使用されるようになります。 IP アドレスの競合を回避するため、1 つのサブネットは必ず 1 つのクラスターでのみ使用してください。 あるサブネットを複数のクラスターで使用したり、同時に他の目的で IBM Cloud Kubernetes Serviceの外部で使用したりしないでください。 複数のクラスター間で同じサブネットを使用する場合は、デフォルトの Ingress TLS 証明書が無効になることがあります。 非 VRF アカウントの同じ VLAN 上の別々のサブネットにあるワーカー同士で通信できるようにするには、同じ VLAN 上のサブネット間のルーティングを有効にする必要があります。

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

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--subnet-id SUBNET

必須: サブネットの ID。

-q

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

ibmcloud ks cluster subnet add --cluster my_cluster --subnet-id 1643389

ibmcloud ks cluster subnet create

クラシック・インフラストラクチャー

パブリック VLAN またはプライベート VLAN 上の IBM Cloud インフラストラクチャー・アカウントでポータブル・クラシック・サブネットを作成し、クラスターで使用できるようにします。

ポータブル・パブリック IP アドレスは、月単位で課金されます。 クラスターをプロビジョンした後にポータブル・パブリック IP アドレスを削除した場合、短時間しか使用していなくても月額料金を支払う必要があります。 クラスターでサブネットを使用できるようにすると、このサブネットの IP アドレスは、クラスターのネットワーキングの目的で使用されるようになります。 IP アドレスの競合を回避するため、1 つのサブネットは必ず 1 つのクラスターでのみ使用してください。 あるサブネットを複数のクラスターで使用したり、同時に他の目的で IBM Cloud Kubernetes Serviceの外部で使用したりしないでください。 複数のクラスター間で同じサブネットを使用する場合は、デフォルトの Ingress TLS 証明書が無効になることがあります。 クラシック・クラスターで、1 つのクラスターに複数の VLAN がある場合、同じ VLAN 上に複数のサブネットがある場合、または複数ゾーン・クラシック・クラスターである場合は、IBM Cloud インフラストラクチャー・アカウントの仮想ルーター機能 (VRF) を有効にして、ワーカー・ノードがプライベート・ネットワーク上で相互に通信できるようにする必要があります。 VRF を有効にするには、VRF の有効化を参照してください。 VRF が既に有効になっているかどうかを確認するには、ibmcloud account show コマンドを使用します。 VRF を有効にできない、または有効にしない場合は、VLAN スパンニングを有効にします。 このアクションを実行するには、 [ネットワーク] > [ネットワークVLANスパニングインフラストラクチャの管理] 権限が必要です。 VLANスパニングがすでに有効になっているかどうかを確認するには、 ibmcloud ks vlan spanning get --region <region> コマンドを 使用します。

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

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。 クラスターをリストするには、ibmcloud ks cluster ls コマンドを使用します。

--size SIZE

ポータブル・サブネットに作成する IP アドレスの数。 受け入れられる値は 8、16、32、64 です。 サブネットのポータブル IP アドレスを追加する場合、3 つの IP アドレスはクラスター内ネットワークの確立のために使用されます。 これら 3 つの IP アドレスを Ingress アプリケーション・ロード・バランサー (ALB) に使用したり、これらを使用してネットワーク・ロード・バランサー (NLB) サービスを作成したりすることはできません。 例えば、8 個のポータブル・パブリック IP アドレスを要求する場合は、そのうちの 5 個を、アプリをパブリックに公開するために使用できます。

--vlan VLAN_ID

サブネットを作成するパブリック VLAN またはプライベート VLAN の ID。 既存のワーカー・ノードが接続されているパブリック VLAN またはプライベート VLAN を選択する必要があります。 ワーカー・ノードが接続されているパブリック VLAN またはプライベート VLAN を確認するには、ibmcloud ks cluster get --cluster <cluster> --show-resources を実行し、出力でサブネット VLAN (Subnet VLANs) セクションを探します。 サブネットは、VLAN が存在するゾーンにプロビジョンされます。

-q

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

ibmcloud ks cluster subnet create --cluster my_cluster --size 8 --vlan 1764905

ibmcloud ks cluster subnet detach

クラシック・インフラストラクチャー

IBM Cloud インフラストラクチャー・アカウント内のパブリックまたはプライベートのポータブル・クラシック・サブネットをクラスターから切り離します。 このサブネットは、その後も IBM Cloud インフラストラクチャー・アカウント内に、使用可能な状態で残ります。 注: サブネットに属する IP アドレスにデプロイされたサービスは、そのサブネットが削除された後もアクティブのままになります。

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

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。 クラスターをリストするには、ibmcloud ks cluster ls コマンドを使用します。

--vlan VLAN_ID

切り離すパブリック・サブネットまたはプライベート・サブネットの ID。 サブネット ID を見つけるには、まず ibmcloud ks cluster get --cluster <cluster> --show-resources を実行して、出力の Subnet VLANs セクションでサブネット CIDR を探します。 次に、サブネット CIDR を使用して ibmcloud ks subnets --provider classic を実行し、サブネットの ID を探します。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks cluster subnet detach --cluster my_cluster --subnet-id 1602829

非推奨: ibmcloud ks cluster user-subnet add

クラシック・インフラストラクチャー

IBM Cloud Kubernetes Service のクラスターに独自のプライベート・サブネットを追加します。 このプライベート・サブネットは、IBM Cloud インフラストラクチャーから提供されたプライベート・サブネットではありません。 このため、そのサブネットに対してインバウンドおよびアウトバウンドのネットワーク・トラフィックのルーティングをすべて構成する必要があります。

コマンドは推奨されません。 既存の IBM Cloud インフラストラクチャー・サブネットをクラスターに追加するには、ibmcloud ks cluster subnet add を実行します。

クラスターでサブネットを使用できるようにすると、このサブネットの IP アドレスは、クラスターのネットワーキングの目的で使用されるようになります。 IP アドレスの競合を回避するため、1 つのサブネットは必ず 1 つのクラスターでのみ使用してください。 あるサブネットを複数のクラスターで使用したり、同時に他の目的で IBM Cloud Kubernetes Serviceの外部で使用したりしないでください。 複数のクラスター間で同じサブネットを使用する場合は、デフォルトの Ingress TLS 証明書が無効になることがあります。 クラシック・クラスターで、1 つのクラスターに複数の VLAN がある場合、同じ VLAN 上に複数のサブネットがある場合、または複数ゾーン・クラシック・クラスターである場合は、IBM Cloud インフラストラクチャー・アカウントの仮想ルーター機能 (VRF) を有効にして、ワーカー・ノードがプライベート・ネットワーク上で相互に通信できるようにする必要があります。 VRF を有効にするには、VRF の有効化を参照してください。 VRF が既に有効になっているかどうかを確認するには、ibmcloud account show コマンドを使用します。 VRF を有効にできない、または有効にしない場合は、VLAN スパンニングを有効にします。 このアクションを実行するには、 [ネットワーク] > [ネットワークVLANスパニングインフラストラクチャの管理] 権限が必要です。 VLANスパニングがすでに有効になっているかどうかを確認するには、 ibmcloud ks vlan spanning get --region <region> コマンドを 使用します。

ibmcloud ks cluster user-subnet add --cluster CLUSTER --subnet-cidr SUBNET_CIDR --private-vlan PRIVATE_VLAN

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--subnet-cidr SUBNET_CIDR

サブネットのクラスレス・ドメイン間ルーティング (CIDR)。 この値は必須です。IBM Cloud インフラストラクチャーによって使用されるどのサブネットとも競合しない値にする必要があります。 サポートされる接頭部の範囲は、/30 (1 個の IP アドレス) から /24 (253 個の IP アドレス) です。 CIDR の接頭部の長さを設定した後でその長さを変更することが必要になった場合は、まず新しい CIDR を追加し、その後古い CIDR を削除します。

--private-vlan PRIVATE_VLAN

必須: プライベート VLAN の ID。 ID は、ワーカー・ノードが 1 つ以上存在するクラスターのプライベート VLAN のものでなければなりません。 クラスター内のプライベート VLAN を表示するには、ibmcloud ks cluster get --cluster <cluster_name_or_ID> --show-resources を実行します。 出力の Subnet VLANs セクションで、Public 値が false の VLAN を見つけます。

ibmcloud ks cluster user-subnet add --cluster my_cluster --subnet-cidr 169.xx.xxx.xxx/29 --private-vlan 1502175

非推奨: ibmcloud ks cluster user-subnet rm

クラシック・インフラストラクチャー

指定されたクラスターから独自のプライベート・サブネットを削除します。 独自のプライベート・サブネットに属する IP アドレスでデプロイされたサービスは、そのサブネットが削除された後にもすべてアクティブのままになります。

コマンドは推奨されません。 IBM Cloud インフラストラクチャー・サブネットをクラスターから削除するには、代わりに ibmcloud ks cluster subnet detach を実行します。

ibmcloud ks cluster user-subnet rm --cluster CLUSTER --subnet-cidr SUBNET_CIDR --private-vlan PRIVATE_VLAN

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--subnet-cidr SUBNET_CIDR

サブネットのクラスレス・ドメイン間ルーティング (CIDR)。 この値は必須です。ibmcloud ks cluster user-subnet add コマンドで設定された CIDR と一致する値にする必要があります。

--private-vlan PRIVATE_VLAN

プライベート VLAN の ID。 この値は必須です。ibmcloud ks cluster user-subnet add コマンドで設定された VLAN ID と一致する値にする必要があります。

ibmcloud ks cluster user-subnet rm --cluster my_cluster --subnet-cidr 169.xx.xxx.xxx/29 --private-vlan 1502175

ベータ: ibmcloud ks dedicated flavors

Virtual Private Cloud

専用ホスト・フレーバーを表示します。

ibmcloud ks dedicated flavors --zone ZONE --provider PROVIDER

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタのオペレータ・ プラットフォーム・アクセス・ロール。

コマンド・オプション：

--zone ZONE

専用ホスト・フレーバーを検索するためのゾーン。

--provider PROVIDER

専用ホスト・フレーバーの検索に使用するプロバイダー。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

例:

ibmcloud ks dedicated flavors --zone us-south-1 --provider myprovider1

ベータ: ibmcloud ks dedicated host create

Virtual Private Cloud

専用ホストを作成します。

ibmcloud ks dedicated host create --flavor FLAVOR --pool POOL --zone ZONE [--output OUTPUT] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタのオペレータ・ プラットフォーム・アクセス・ロール。

コマンド・オプション：

-- flavor FLAVOR

専用ホストのフレーバー。

-- pool POOL

専用ホストを追加する専用ホスト・プールの名前。

--zone ZONE

専用ホストを作成するゾーン。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

例:

ibmcloud ks dedicated host create --flavor b3c.4x16 --pool mypool --zone wdc

ベータ: ibmcloud ks dedicated host get

Virtual Private Cloud

専用ホストの詳細を取得します。

ibmcloud ks dedicated host get --host HOST --pool POOL [--output OUTPUT] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタのビューアプラットフォームアクセスロール。

コマンド・オプション：

--host HOST

専用ホストの ID。

--pool POOL

専用ホストが配置されている専用ホスト・プールの ID。 専用ホスト・プールをリストするには、ibmcloud ks dedicated pool ls を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

例:

ibmcloud ks dedicated host get --host myhost  --pool mypool

ベータ: ibmcloud ks dedicated host ls

Virtual Private Cloud

専用ホスト・プール内のすべての専用ホストをリストします。

ibmcloud ks dedicated host ls --pool POOL [--output OUTPUT] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタのビューアプラットフォームアクセスロール。

コマンド・オプション：

--pool POOL

専用ホスト・プールの ID。 専用ホスト・プールをリストするには、ibmcloud ks dedicated pool ls を実行します。

-q

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

例:

ibmcloud ks dedicated host ls --pool mypool

ベータ: ibmcloud ks dedicated host placement disable

Virtual Private Cloud

専用ホストの配置を無効にします。

ibmcloud ks dedicated host placement disable --host HOST --pool POOL

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタの管理者プラットフォームアクセスロール。

コマンド・オプション：

--host HOST

配置を無効にする対象の専用ホストの ID。

--pool POOL

専用ホストが配置されている専用ホスト・プールの ID。 専用ホスト・プールをリストするには、ibmcloud ks dedicated pool ls を実行します。

--q

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

例:

ibmcloud ks dedicated host placement disable --host myhost --pool mypool

ベータ: ibmcloud ks dedicated host placement enable

Virtual Private Cloud

専用ホストの配置を有効にします。

ibmcloud ks dedicated host placement enable --host HOST --pool POOL

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタの管理者プラットフォームアクセスロール。

コマンド・オプション：

--host HOST

配置を有効にする専用ホストのID。

--pool POOL

専用ホストが配置されている専用ホスト・プールの ID。 専用ホスト・プールをリストするには、ibmcloud ks dedicated pool ls を実行します。

--q

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

例:

ibmcloud ks dedicated host placement enable --host myhost --pool mypool

ベータ: ibmcloud ks dedicated host rm

Virtual Private Cloud

専用ホストを削除します。 このアクションは元に戻すことができません。

ibmcloud ks dedicated host rm --host HOST --pool POOL [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタの管理者プラットフォームアクセスロール。

コマンド・オプション：

--pool POOL

削除する専用ホストが含まれている専用ホスト・プールの ID。 専用ホスト・プールをリストするには、ibmcloud ks dedicated pool ls を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

--q

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

例:

ibmcloud ks dedicated host rm --host myhost --pool mypool

ベータ: ibmcloud ks dedicated pool create

Virtual Private Cloud

専用ホスト・プールを作成します。

ibmcloud ks dedicated pool create --flavor-class CLASS --metro METRO --name NAME [--output OUTPUT]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタの管理者プラットフォームアクセスロール。

コマンド・オプション：

--flavor-class CLASS

専用ホスト・プールのフレーバー・クラス。 使用可能なオプションを確認するには、ibmcloud ks flavors を実行します。

--metro METRO

専用ホスト・プールを作成する大都市 (dal や wdc など)。

--name NAME

専用ホスト・プールの名前。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

例:

ibmcloud ks dedicated pool --flavor-class mb4c.20x64 --metro dal --name mypool

ベータ: ibmcloud ks dedicated pool get

Virtual Private Cloud

専用ホスト・プールの詳細を取得します。

ibmcloud ks dedicated pool get --pool POOL [--output OUTPUT] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタのビューアプラットフォームアクセスロール。

コマンド・オプション：

--pool POOL

専用ホスト・プールの ID。 専用ホスト・プールをリストするには、ibmcloud ks dedicated pool ls を実行します。

--output OUTPUT

-q

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

例:

ibmcloud ks dedicated pool get --pool mypool

ベータ: ibmcloud ks dedicated pool ls

Virtual Private Cloud

すべての専用ホストプールをリストする。

ibmcloud ks dedicated pool ls [--output OUTPUT] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタのビューアプラットフォームアクセスロール。

コマンド・オプション：

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

--q

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

例:

ibmcloud ks dedicated pool ls

ベータ: ibmcloud ks dedicated pool rm

Virtual Private Cloud

専用ホスト・プールを削除します。 このアクションは元に戻すことができません。

ibmcloud ks dedicated pool rm --pool POOL [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタの管理者プラットフォームアクセスロール。

コマンド・オプション：

--pool POOL

削除する専用ホストプールのID。 専用ホスト・プールをリストするには、ibmcloud ks dedicated pool ls を実行します。

--q

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

例:

ibmcloud ks dedicated pool rm --pool mypool

非推奨: ibmcloud ks worker add

仮想プライベート・クラウド クラシック・インフラストラクチャー

スタンドアロン・ワーカー・ノードをクラスターに追加します。

コマンドは推奨されません。 ibmcloud ks worker-pool create classic または ibmcloud ks worker-pool create vpc-gen2 を実行してワーカー・プールを作成するか、ibmcloud ks worker-pool resize を実行して既存のワーカー・プールにワーカーを追加します。

ibmcloud ks worker add --cluster CLUSTER [--hardware HARDWARE] --flavor FLAVOR --workers NUMBER --private-vlan PRIVATE_VLAN --public-vlan PUBLIC_VLAN [--disable-disk-encrypt] [--operating-system SYSTEM] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--hardware HARDWARE

オプション: ワーカー・ノードのハードウェア分離のレベル。 使用可能な物理リソースを自分専用にする場合は dedicated を使用し、他の IBM のお客様と物理リソースを共有することを許可する場合は shared を使用します。 デフォルトはsharedです。 ベアメタル・フレーバーの場合、dedicated を指定します。

--flavor FLAVOR

ワーカー・ノードのマシン・タイプ、つまりフレーバーを選択します。 ワーカー・ノードは、共有または専用ハードウェア上に仮想マシンとしてデプロイすることも、ベア・メタル上に物理マシンとしてデプロイすることもできます。 使用可能な物理マシンと仮想マシンのタイプは、クラスターをデプロイするゾーンによって異なります。 詳しくは、ibmcloud ks flavors (machine-types) コマンドについての説明を参照してください。

--workers NUMBER

クラスター内に作成するワーカー・ノードの数を表す整数。

--private-vlan PRIVATE_VLAN

必須: クラスターの作成時に指定されたプライベート VLAN。 必ず、プライベート VLAN ルーターの先頭は bcr (バックエンド・ルーター)、パブリック VLAN ルーターの先頭は fcr (フロントエンド・ルーター) になります。 クラスターを作成し、パブリック VLAN とプライベート VLAN を指定するときには、それらの接頭部の後の番号と文字の組み合わせが一致する必要があります。

--public-vlan PUBLIC_VLAN

オプション: クラスターの作成時に指定されたパブリック VLAN。 ワーカー・ノードがプライベート VLAN だけに存在するようにするには、パブリック VLAN ID を指定しないでください。 必ず、プライベート VLAN ルーターの先頭は bcr (バックエンド・ルーター)、パブリック VLAN ルーターの先頭は fcr (フロントエンド・ルーター) になります。 クラスターを作成し、パブリック VLAN とプライベート VLAN を指定するときには、それらの接頭部の後の番号と文字の組み合わせが一致する必要があります。 プライベート VLAN のみを使用してワーカー・ノードをセットアップする場合は、プライベート・クラウド・サービス・エンドポイントを有効にするか、ゲートウェイ・アプライアンスを構成することによって、ワーカー・ノードとクラスター・マスターが通信できるようにする必要があります。

--disable-disk-encrypt

ワーカー・ノードには、デフォルトで AES 256 ビット・ディスク暗号化の機能があります。詳しくはこちらを参照してください。 暗号化を無効にするには、このオプションを組み込みます。

--operating-system UBUNTU_20_64|UBUNTU_24_64

オプション。 クラスター内のワーカー・ノードのオペレーティング・システム。 クラスタのバージョン別に利用可能なオペレーティングシステムの一覧については 、 Kubernetes のバージョン情報 をご覧ください。 オプションが指定されていない場合、クラスター・バージョンに対応するデフォルトのオペレーティング・システムが使用されます。

-q

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

ibmcloud ks worker add --cluster my_cluster --workers 3 --public-vlan my_public_VLAN_ID --private-vlan my_private_VLAN_ID --flavor b3c.4x16 --hardware shared

ibmcloud ks worker get

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

ibmcloud ks worker get --cluster CLUSTER_NAME_OR_ID --worker WORKER_NODE_ID [--output json] [-q]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER_NAME_OR_ID

オプション: ワーカー・ノードのクラスターの名前または ID。

--worker WORKER_NODE_ID

必須: ワーカー・ノードの名前。 クラスター内のワーカー・ノードの ID を表示するには、ibmcloud ks worker ls --cluster CLUSTER を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks worker get --cluster my_cluster --worker kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1

ibmcloud ks worker ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内のすべてのワーカー・ノードをリストします。

ibmcloud ks worker ls --cluster CLUSTER [--worker-pool POOL] [--show-pools] [--show-deleted] [--output json] [-q]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: 使用可能なワーカー・ノードのクラスターの名前または ID。

-p, --worker-pool POOL

オプション: ワーカー・プールに属するワーカー・ノードのみを表示します。 使用可能なワーカー・プールをリストするには、ibmcloud ks worker-pool ls --cluster <cluster_name_or_ID> を実行します。

--show-pools

オプション: 各ワーカー・ノードが属するワーカー・プールをリストします。

--show-deleted

オプション: クラスターから削除されたワーカー・ノードを、削除理由も含めて表示します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks worker ls --cluster my_cluster

ibmcloud ks worker reboot

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内のワーカー・ノードをリブートします。

リブート中は、ワーカー・ノードの状態は変わりません。 例えば、クラシック IBM Cloud インフラストラクチャーのワーカー・ノードの状況が Powered Off のときに、ワーカー・ノードをオンにする必要がある場合、リブートを使用できます。 リブートすると、一時ディレクトリーが消去されますが、ファイル・システム全体が消去されたり、ディスクが再フォーマットされたりすることはありません。 リブート操作の後も、ワーカー・ノードの IP アドレスは同じままです。

ワーカー・ノードをリブートすると、ワーカー・ノードのデータが破損する可能性があります。 このコマンドは、リブートがワーカー・ノードのリカバリーに役立つことが明らかな場合に、注意して使用してください。 そうでない場合は、代わりにワーカー・ノードを再ロードしてください。

ワーカー・ノードをリブートする前に、ワーカー・ノード上のポッドのスケジュールを変更できるだけの十分なキャパシティーが他のワーカー・ノードにあることを確認してください。 ポッドのスケジュールを変更すると、アプリのダウン時間やワーカー・ノード上のデータ破損を回避するのに役立ちます。

1. クラスター内のすべてのワーカー・ノードをリストして、削除するワーカー・ノードの名前をメモします。

   kubectl get nodes
   

   このコマンドで返される名前は、ワーカー・ノードに割り当てられたプライベート IP アドレスです。 ibmcloud ks worker ls --cluster <cluster_name_or_ID> コマンドを実行して、同じプライベート IP アドレスを持つワーカー・ノードを探すと、ワーカー・ノードに関する詳細情報を参照できます。

2. ポッドをワーカー・ノードから強制的に削除し、クラスター内の残りのワーカー・ノードにスケジュールを変更します。 また、このワーカー・ノードは閉鎖されます。つまり、これ以降のポッドのスケジューリングに使用できないものとしてマークされます。 <worker_name> は、先ほど取得したワーカー・ノードのプライベート IP アドレスに置き換えてください。

   kubectl drain <worker_name>
   

   この処理には数分かかる場合があります。

3. ワーカー・ノードをリブートします。 ibmcloud ks worker ls --cluster <cluster_name_or_ID> コマンドから返されるワーカー ID を使用します。

   ibmcloud ks worker reboot --cluster <cluster_name_or_ID> --worker <worker_name_or_ID>
   

4. リブートを確実に完了させるために、約 5 分間待機してから、ワーカー・ノードをポッドのスケジューリングに使用できるようにします。 リブート中は、ワーカー・ノードの状態は変わりません。 ワーカー・ノードのリブートは、通常数秒で完了します。

5. ワーカー・ノードをポッドのスケジューリングに使用できるようにします。 ** コマンドから返されるワーカー・ノードの**名前kubectl get nodesを使用します。

   kubectl uncordon <worker_name>
   

ibmcloud ks worker reboot [--hard] --cluster CLUSTER --worker WORKER_ID [--skip-master-healthcheck] [-f] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--hard

オプション: ワーカー・ノードの電源を遮断することでワーカー・ノードのハード再始動を強制するには、このオプションを使用します。 このオプションは、ワーカー・ノードが応答しない場合、またはワーカー・ノードのコンテナー・ランタイムが応答しない場合に使用します。

-w, --worker WORKER

ワーカー・ノード ID を指定します。 複数のワーカーノードをリロードするには、 -w worker1_id -w worker2_id のように複数のオプションを使用します。

--skip-master-healthcheck

マスターのヘルス・チェックをスキップしてから、ワーカー・ノードを再ロードまたはリブートします。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks worker reboot --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

ibmcloud ks worker reload

クラシック・インフラストラクチャー

Classic ワーカーノードの設定を再読み込みします。 VPCクラスタのワーカー・ノードをリロードするには、代わりに ibmcloud ks worker replace 命令。

再ロードは、ワーカー・ノードでパフォーマンスの低下などの問題が発生した場合や、ワーカー・ノードが正常でない状態に陥った場合に役立ちます。 再ロード中に、ワーカー・ノード・マシンが最新のイメージで更新されるので、ワーカー・ノードの外部に保管していないデータは削除されます。 再ロード操作の後も、ワーカー・ノードのパブリック IP アドレスとプライベート IP アドレスは同じままです。

ワーカー・ノードを再ロードすると、パッチ・バージョンの更新がワーカー・ノードに適用されますが、メジャー更新やマイナー更新は適用されません。 あるパッチバージョンから次のバージョンへの変更点を見るには、 バージョン変更履歴の ドキュメントをご覧ください。

ワーカー・ノードを再ロードする前に、ワーカー・ノード上のポッドのスケジュールを変更できるだけの十分なキャパシティーが他のワーカー・ノードにあることを確認してください。 ポッドのスケジュールを変更すると、アプリのダウン時間やワーカー・ノード上のデータ破損を回避するのに役立ちます。

1. クラスター内のすべてのワーカー・ノードをリストして、再ロードするワーカー・ノードの名前をメモします。

   kubectl get nodes
   

   このコマンドで返される名前は、ワーカー・ノードに割り当てられたプライベート IP アドレスです。 ibmcloud ks worker ls --cluster <cluster_name_or_ID> コマンドを実行して、同じプライベート IP アドレスを持つワーカー・ノードを探すと、ワーカー・ノードに関する詳細情報を参照できます。

2. ワーカー・ノードを再ロードします。 再ロード・プロセスの一部として、ワーカー・ノードで実行されているポッドが排出され、クラスター内の他のワーカー・ノードにスケジュール変更されます。 また、このワーカー・ノードは閉鎖されます。つまり、これ以降のポッドのスケジューリングに使用できないものとしてマークされます。 ibmcloud ks worker ls --cluster <cluster_name_or_ID> コマンドから返されたワーカー・ノード ID を使用します。

   ibmcloud ks worker reload --cluster <cluster_name_or_ID> --worker <worker_name_or_ID>
   

3. 再ロードが完了するまで待ちます。 ワーカー・ノードが「正常」状態になると、そのワーカー・ノードは再びポッドのスケジューリングに使用可能になります。

ibmcloud ks worker reload --cluster CLUSTER --worker WORKER_ID [--skip-master-healthcheck] [-f] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-w, --worker WORKER

ワーカー・ノード ID を指定します。 複数のワーカーノードをリロードするには、 -w worker1_id -w worker2_id のように複数のオプションを使用します。

--skip-master-healthcheck

マスターのヘルス・チェックをスキップしてから、ワーカー・ノードを再ロードまたはリブートします。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks worker reload --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

ibmcloud ks worker replace

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

後継のワーカー・ノードは古いワーカー・ノードと同じゾーンに作成され、フレーバーも同じですが、新しいパブリック IP アドレスまたはプライベート IP アドレスを割り当てられることがあります。 一般には、ワーカー・ノードの状態に問題が生じたりして再ロードや更新ができなくなった場合にワーカー・ノードを置換します。

このコマンドを使用して、ワーカーノードの Kubernetes バージョンを Kubernetes マスターのメジャーバージョンとマイナーバージョンに一致するように更新することもできます。この場合、 --update オプションを指定します。 --update オプションを含めない場合、パッチバージョンのアップデートはワーカーノードに適用されますが、メジャーアップデートやマイナーアップデートは適用されません。 メジャーバージョン、マイナーバージョン、パッチバージョンから次のバージョンへの変更点を確認するには、 バージョン変更ログ 文書をご覧ください。 ワーカー・ノードは、マスター・バージョンよりも 2 バージョン古いものまでにしかできないことに注意してください (n-2)。

ワーカー・ノードを置換する場合は、以下の考慮事項に留意してください。

Satellite ワーカー・ノードを更新するには、ワーカー・ノードとして Satellite 対応サービスに割り当てられているホストの更新 を参照してください。

• 複数のワーカー・ノードは同時に置換される: 複数のワーカー・ノードを同時に置換すると、それらは 1 つずつではなく、同時に削除され、置換されます。 ワーカー・ノードを置換する前に、ワークロードのスケジュールを変更するための十分な容量がクラスター内にあることを確認してください。
• ノード・レベルのカスタマイズは保持されない: 個々のワーカー・ノードのレベルで適用したカスタム・ラベルまたはテイントは、後継のワーカー・ノードには適用されません。 代わりに、ワーカー・プール・レベルでラベルまたはテイントを適用して、後継のワーカー・ノードでこれらの属性が取得されるようにします。
• 自動再バランス: ワーカー・プールで自動再バランスが有効になっていない場合、後継のワーカー・ノードは作成されません。

始める前に、ご使用のクラスターにその他のワーカー・ノードが十分にあることを確認して、ポッドのスケジュールを変更し、ポッドの実行を続行できるようにしてください。

1. クラスター内のすべてのワーカー・ノードをリストして、置換するワーカー・ノードの名前をメモします。

   kubectl get nodes
   

   このコマンドで返される名前は、ワーカー・ノードに割り当てられたプライベート IP アドレスです。 ibmcloud ks worker ls --cluster <cluster_name_or_ID> コマンドを実行して、同じプライベート IP アドレスを持つワーカー・ノードを探すと、ワーカー・ノードに関する詳細情報を参照できます。

2. ワーカー・ノードを置換します。 置換プロセスの一部として、ワーカー・ノードで実行されているポッドが排出され、クラスター内の他のワーカー・ノードにスケジュール変更されます。 また、このワーカー・ノードは閉鎖されます。つまり、これ以降のポッドのスケジューリングに使用できないものとしてマークされます。 ibmcloud ks worker ls --cluster <cluster_name_or_ID> コマンドから返されたワーカー・ノード ID を使用します。

   ibmcloud ks worker replace --cluster <cluster_name_or_ID> --worker <worker_node_ID>
   

3. ワーカー・ノードが置換されたことを確認します。

   ibmcloud ks worker ls --cluster <cluster_name_or_ID>
   

ibmcloud ks worker replace --cluster CLUSTER_NAME_OR_ID --worker WORKER_ID [--update] [-f] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタのオペレータ・ プラットフォーム・アクセス・ロール。

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--worker WORKER

必須: ワーカー・ノードの名前または ID。

--update

ワーカーノードをマスターと最新パッチと同じメジャー、マイナーバージョンに更新するには、このオプションを含めます。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks worker replace --cluster my_cluster --worker kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1

ibmcloud ks worker rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

1 つ以上のワーカー・ノードをクラスターから削除します。 ワーカー・ノードを削除すると、クラスターがアンバランスになります。また、ワーカー・ノードを置き換えると、後継のワーカー・ノードは作成されなくなります。 ワーカー・ノードを削除した後に ibmcloud ks worker-pool rebalance コマンドを実行して、ワーカー・プールのバランスを自動的に再調整できます。

ibmcloud ks worker rm --cluster CLUSTER --worker WORKER [-f] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-w, --worker WORKER

ワーカー・ノード ID を指定します。 複数のワーカーノードをリロードするには、 -w worker1_id -w worker2_id のように複数のオプションを使用します。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks worker rm --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

ibmcloud ks worker update

クラシック・インフラストラクチャー

ワーカー・ノードを更新して最新のセキュリティー更新とパッチをオペレーティング・システムに適用し、Kubernetes のバージョンを Kubernetes マスターのバージョンと一致するように更新します。 ibmcloud ks cluster master update コマンドを使用して、マスターの Kubernetes バージョンを更新できます。 ワーカー・ノードは、マスター・バージョンよりも 2 バージョン古いものまでにしかできないことに注意してください (n-2)。更新操作の後も、ワーカー・ノードの IP アドレスは同じままです。

VPCクラスタのワーカー・ノードを更新するには、代わりに ibmcloud ks worker replace 命令。

ibmcloud ks worker update を実行すると、アプリとサービスにダウン時間が発生する可能性があります。 更新中は、すべてのポッドが他のワーカー・ノードにスケジュール変更され、ワーカー・ノードが再イメージ化されるので、ポッドの外部に保管していないデータは削除されます。 ダウン時間を回避するには、選択したワーカー・ノードの更新中に、ワークロードを処理するために十分なワーカー・ノード数を確保するようにしてください。

Satellite ワーカー・ノードを更新するには、ワーカー・ノードとして Satellite 対応サービスに割り当てられているホストの更新 を参照してください。

更新の前に、デプロイメント用に YAML ファイルを変更する必要がある場合があります。 詳しくは、このリリース・ノートを確認してください。

ibmcloud ks worker update --cluster CLUSTER --worker WORKER_ID [-f] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: 使用可能なワーカー・ノードをリストする対象のクラスターの名前または ID。

-w, --worker WORKER

ワーカー・ノード ID を指定します。 複数のワーカーノードをリロードするには、 -w worker1_id -w worker2_id のように複数のオプションを使用します。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks worker update --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

ibmcloud ks worker-pool create classic

クラシック・インフラストラクチャー

クラスター内にワーカー・プールを作成できます。 デフォルトでは、ワーカー・プールの追加時にゾーンは割り当てられません。 各ゾーンに必要なワーカー数と、ワーカーのフレーバーを指定します。 デフォルトの Kubernetes バージョンがワーカー・プールに付与されます。 ワーカーの作成を終了するには、プールに 1 つまたは複数のゾーンを追加します。

VPCクラスタにワーカープールを作成するには、 ibmcloud ks worker-pool create vpc-gen2 コマンドを 使用します。

ibmcloud ks worker-pool create classic --name POOL_NAME --cluster CLUSTER --flavor FLAVOR --size-per-zone WORKERS_PER_ZONE --hardware ISOLATION [--disable-disk-encrypt] [--label KEY1=VALUE1] [--operating-system SYSTEM]  [-q] [--output json]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

--name POOL_NAME

ワーカー・プールに指定する名前。

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--flavor FLAVOR

マシン・タイプ、またはフレーバーを選択します。 ワーカー・ノードは、共有または専用ハードウェア上に仮想マシンとしてデプロイすることも、ベア・メタル上に物理マシンとしてデプロイすることもできます。 使用可能な物理マシンと仮想マシンのタイプは、クラスターをデプロイするゾーンによって異なります。 詳しくは、ibmcloud ks flavors (machine-types) コマンドについての説明を参照してください。

--size-per-zone WORKERS_PER_ZONE

各ゾーンに作成するワーカーの数。

--hardware ISOLATION

必須: ワーカー・ノードのハードウェア分離のレベル。 使用可能な物理リソースを自分専用にする場合には dedicated を使用し、他の IBM の顧客と物理リソースを共有することを許可する場合には shared を使用してください。 デフォルトはsharedです。 ベアメタル・フレーバーの場合、dedicated を指定します。

--disable-disk-encrypt

ディスクが暗号化されないことを指定します。 デフォルト値は falseです。

-l, --label KEY1=VALUE1

オプション: ワーカー・プールの各ワーカー・ノードにキー値ラベルを適用します。 複数のラベルを指定するには、 -l key1=value1 -l key2=value2 のように複数のオプションを使用する。

--operating-system UBUNTU_20_64|UBUNTU_24_64

オプション。 クラスター内のワーカー・ノードのオペレーティング・システム。 クラスタのバージョン別に利用可能なオペレーティングシステムの一覧については 、 Kubernetes のバージョン情報 をご覧ください。 オプションが指定されていない場合、クラスター・バージョンに対応するデフォルトのオペレーティング・システムが使用されます。

-q

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

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

ibmcloud ks worker-pool create classic --name my_pool --cluster my_cluster --flavor b3c.4x16 --size-per-zone 6

ibmcloud ks worker-pool create vpc-gen2

Virtual Private Cloud

VPC クラスターにワーカー・プールを追加します。 ワーカー・プールにゾーンを追加するまで、ワーカー・ノードは作成されません。

ibmcloud ks worker-pool create vpc-gen2 --name <worker_pool_name> --cluster <cluster_name_or_ID> --flavor <flavor> --size-per-zone <number_of_workers_per_zone> [--operating-system SYSTEM][--dedicated-host-pool POOL][--vpc-id <VPC ID>] [--label KEY1=VALUE1] [--kms-account-id ID] [--kms-instance KMS_INSTANCE_ID] [--crk ROOT_KEY_ID] [--operating-system SYSTEM] [-q] [--secondary-storage STORAGE] [--security-group GROUP ...] [--output json]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタのオペレータ・ プラットフォーム・アクセス・ロール。

コマンド・オプション：

--name NAME

必須: ワーカー・プールの名前を設定します。

-c, --cluster CLUSTER

必須: クラスターの名前または ID を指定します。 VPC クラスターをリストするには、ibmcloud ks cluster ls --provider vpc-gen2 を実行します。

--size-per-zone NUMBER_WORKERS_PER_ZONE

このワーカー・プールで作成する 1 ゾーンあたりのワーカー・ノード数を指定します。 ワーカー・プールにゾーンを追加するまで、ワーカー・ノードは作成されません。

--operating-system UBUNTU_20_64|UBUNTU_24_64

オプション。 クラスター内のワーカー・ノードのオペレーティング・システム。 クラスタのバージョン別に利用可能なオペレーティングシステムの一覧については 、 Kubernetes のバージョン情報 をご覧ください。 オプションが指定されていない場合、クラスター・バージョンに対応するデフォルトのオペレーティング・システムが使用されます。

--flavor FLAVOR

ワーカー・ノードのフレーバーを選択します。 ワーカー・ノードは、共有または専用のハードウェア上に仮想マシンとしてデプロイできます。 VPC ゾーンで使用可能なフレーバーを表示するには、ibmcloud ks flavors --zone <vpc_zone> --provider vpc-gen2 を実行します。

--dedicated-host-pool POOL

オプション。 ワーカーを実行する専用ホストプールのID。

--vpc-id VPC_ID

オプション: ワーカー・プールのワーカー・ノードを作成する VPC の ID を指定します。 この値は、クラスターが存在する VPC の ID と一致する必要があります。 クラスターの VPC ID をリストするには、ibmcloud ks cluster get -c <cluster_name_or_ID> を実行します。 このオプションが指定されない場合、ワーカープールのデフォルトは、クラスタ内の既存のワーカープールのVPC IDになります。

-l, --label KEY1=VALUE1

オプション: ワーカー・プールの各ワーカー・ノードにキー値ラベルを適用します。 複数のラベルを指定するには、 -l key1=value1 -l key2=value2 のように複数のオプションを使用する。

--kms-account-id ID

オプション：ローカルディスクまたは秘密の暗号化に使用するKMSインスタンスを含むアカウントのID。

--kms-instance KMS_INSTANCE_ID

オプション: default ワーカー・プール内のワーカー・ノードのローカル・ディスクを暗号化するために使用する鍵管理サービス (KMS) インスタンスの ID を含めます。 使用可能な KMS インスタンスを確認するには、ibmcloud ks kms instance ls を実行します。 このオプションを指定する場合は、--crk オプションも指定する必要があります。 作成手順などについて詳しくは、 クラスターのワーカー・ノードの暗号化の管理を参照してください。

--crk ROOT_KEY

オプション: このワーカー・プール内のワーカー・ノードのローカル・ディスクを暗号化するために使用するルート鍵の ID を KMS インスタンスに含めます。 使用可能なルート鍵を確認するには、ibmcloud ks kms crk ls --instance-id を実行します。 このオプションを含める場合は、--kms-instance オプションも含める必要があります。 KMS 暗号化を使用するには、その前に KMS インスタンスを作成し、必要なサービス許可を IAM でセットアップしておく必要があります。 クラスターのワーカー・ノードの暗号化の管理を参照してください。

-q

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

--secondary-storage STORAGE

オプション: フレーバーのストレージ・オプション。 例えば、900gb.5iops-tier です。 2 次ディスクを追加すると、そのディスクがコンテナー・ランタイムに使用され、1 次ディスクがオペレーティング・システムに使用されます。 フレーバーのストレージ・オプションを表示するには、 **ibmcloud ks flavor get --flavor FLAVOR --zone ZONE --provider vpc-gen2 コマンドを実行します。

--security-group GROUP

オプション。 クラスター上のすべてのワーカーに適用する 1 つ以上のセキュリティー・グループ ID を指定します。 OpenShift バージョン 4.15 および Kubernetes バージョン 1.30 以降の場合、これらのセキュリティー・グループは、 IBM管理 kube-clusterID セキュリティー・グループに加えて適用されます。 それより前のクラスター・バージョンの場合は、 --cluster-security-group cluster オプションを指定して kube-clusterID セキュリティー・グループを適用します。 値を指定しない場合は、 kube-clusterID を含むセキュリティー・グループのデフォルト・セットが適用されます。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

ibmcloud ks worker-pool create vpc-gen2 --name my_pool --cluster my_cluster --flavor bx2.4x16 --size-per-zone 3

ibmcloud ks worker-pool get

仮想プライベート・クラウド クラシック・インフラストラクチャー

ワーカー・プールの詳細を表示します。

ibmcloud ks worker-pool get --worker-pool WORKER_POOL --cluster CLUSTER [--output json] [-q]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-p, --worker-pool WORKER_POOL

必須: 詳細を表示するワーカー・ノード・プールの名前。 使用可能なワーカー・プールをリストするには、ibmcloud ks worker-pool ls --cluster <cluster_name_or_ID> を実行します。

-c, --cluster CLUSTER

必須: ワーカー・プールが存在するクラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks worker-pool get --worker-pool pool1 --cluster my_cluster

ibmcloud ks worker-pool label rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

ワーカー・プール内のすべてのワーカー・ノードからすべてのカスタム Kubernetes ラベルを削除します。

個々のテイントを作業プールから削除することはできません。 代わりに kubectl taint node <worker_privateIP> key:effect- コマンドを使って、個々のワーカーノードからテイントを削除します。

ibmcloud ks worker-pool label rm --cluster CLUSTER --worker-pool POOL [-f] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: ワーカー・プールが存在するクラスターの名前または ID。

-p, --worker-pool WORKER_POOL

必須: 詳細を表示するワーカー・ノード・プールの名前。 使用可能なワーカー・プールをリストするには、ibmcloud ks worker-pool ls --cluster <cluster_name_or_ID> を実行します。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks worker-pool label rm --worker-pool pool1 --cluster my_cluster

ibmcloud ks worker-pool label set

仮想プライベート・クラウド クラシック・インフラストラクチャー

ワーカー・プール内のすべてのワーカー・ノードのカスタム Kubernetes ラベルを key=value という形式で設定します。 ワーカー・プールの既存のカスタム・ラベルを保持するには、該当するラベルをこのコマンドに含める必要があります。

ibmcloud ks worker-pool label set --cluster CLUSTER --label LABEL [--label LABEL ...] --worker-pool POOL [-f] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: ワーカー・プールが存在するクラスターの名前または ID。

--label LABEL

必須: ワーカー・プール内のすべてのワーカー・ノードに対して設定する key=value という形式のカスタム・ラベル。 複数のラベルを使用する場合は、このオプションを繰り返す。 ワーカープールに既存のカスタムラベルを残すには、このオプションにそれらのラベルを含めます。 ibmcloud ks worker-pool get -c <cluster_name_or_ID> --worker-pool <pool> を実行することによって、ワーカー・プールにあるワーカー・ノードの既存のカスタム・ラベルをリストすることができます。

-p, --worker-pool WORKER_POOL

必須: 詳細を表示するワーカー・ノード・プールの名前。 使用可能なワーカー・プールをリストするには、ibmcloud ks worker-pool ls --cluster <cluster_name_or_ID> を実行します。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks worker-pool label set --worker-pool pool1 --cluster my_cluster --label app=dev

ibmcloud ks worker-pool ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内のすべてのワーカー・プールをリストします。

ibmcloud ks worker-pool ls --cluster CLUSTER [--output json] [-q]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER_NAME_OR_ID

必須: ワーカー・プールをリストするクラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks worker-pool ls --cluster my_cluster

ibmcloud ks worker-pool operating-system set

オペレーティングシステムを設定する。 オペレーティングシステムを設定したら、ibmcloud ks worker update または ibmcloud ks worker replace のどちらかを実行してワーカーをアップデートする必要があります。

ibmcloud ks worker-pool operating-system set --cluster CLUSTER --operating-system SYSTEM --worker-pool POOL [-q]

ibmcloud ks worker-pool rebalance

仮想プライベート・クラウド クラシック・インフラストラクチャー

ワーカー・ノードの削除後に、クラスターのワーカー・プールのバランスを再調整します。 このコマンドを実行すると、新しいワーカーが 1 つ以上ワーカー・プールに追加され、ワーカー・プールのゾーンごとのノード数が指定された数と同じになります。

ibmcloud ks worker-pool rebalance --cluster CLUSTER --worker-pool WORKER_POOL [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-p, --worker-pool WORKER_POOL

必須: バランスを再調整するワーカー・プール。

-q

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

ibmcloud ks worker-pool rebalance --cluster my_cluster --worker-pool my_pool

ibmcloud ks worker-pool resize

仮想プライベート・クラウド クラシック・インフラストラクチャー

ワーカー・プールをサイズ変更して、クラスターの各ゾーンにあるワーカー・ノードの数を増減します。

ibmcloud ks worker-pool resize --cluster CLUSTER --worker-pool WORKER_POOL --size-per-zone WORKERS_PER_ZONE [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: ワーカー・プールをサイズ変更するクラスターの名前または ID。

--worker-pool WORKER_POOL

必須: 更新するワーカー・ノード・プールの名前。

--size-per-zone WORKERS_PER_ZONE

各ゾーンに必要なワーカーの数。

-q

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

ibmcloud ks worker-pool resize --cluster my_cluster --worker-pool my_pool --size-per-zone 3

ibmcloud ks worker-pool rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターからワーカー・プールを削除します。 プール内のすべてのワーカー・ノードが削除されます。 削除を行うと、ポッドがスケジュール変更されます。 ダウン時間を避けるため、ワークロードを実行するために十分なワーカーがあることを確認してください。

ibmcloud ks worker-pool rm --worker-pool WORKER_POOL --cluster CLUSTER [-q] [-f]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-p, --worker-pool WORKER_POOL

必須: 削除するワーカー・ノード・プールの名前。

-c, --cluster CLUSTER

必須: ワーカー・プールを削除するクラスターの名前または ID。

-q

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

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

ibmcloud ks worker-pool rm --cluster my_cluster --worker-pool pool1

ibmcloud ks worker-pool taint

ワーカー・プール内のすべてのワーカー・ノードについて、Kubernetes テイントを設定または削除します。 テイントをセットアップした後、容認が一致しないポッドをワーカー・プールで実行することはできません。 テイントを使用して、ワーカー・プールを特定のタイプのワークロード (ネットワーキング・エッジ・ノードやクラスター自動スケーリング機能など) 専用にすることができます。 テインツとトレランスがどのように機能するかについては、 Kubernetes のドキュメントを参照してください。

ibmcloud ks worker-pool taint set --worker-pool WORKER_POOL --cluster CLUSTER --taint KEY=VALUE:EFFECT [--taint KEY=VALUE2:EFFECT] [-f]

ibmcloud ks worker-pool taint set --cluster my_cluster --worker-pool pool1 --taint env=prod:NoSchedule

ibmcloud ks worker-pool taint rm --worker-pool WORKER_POOL --cluster CLUSTER [-f]

ibmcloud ks worker-pool taint rm --cluster my_cluster --worker-pool pool1

ibmcloud ks worker-pool zones

仮想プライベート・クラウド クラシック・インフラストラクチャー

ワーカー・プールに接続されているゾーンを表示します。

ibmcloud ks worker-pool zones --worker-pool WORKER_POOL --cluster CLUSTER [-q] [-f]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: ワーカー・プールが存在するクラスターの名前または ID。

-p, --worker-pool WORKER_POOL

必須: ゾーンを表示するワーカー・ノード・プールの名前。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks worker-pool zones --cluster my_cluster --worker-pool pool1

ibmcloud ks zone add classic

クラシック・インフラストラクチャー

クラシック・クラスターまたはワーカー・プールを作成した後、ゾーンを追加できます。 ゾーンを追加すると、ワーカー・プールに対して指定した「ゾーンあたりのワーカー数」を満たすように新しいゾーンにワーカー・ノードが追加されます。 クラスターが複数ゾーンの大都市にある場合にのみ、複数のゾーンを追加できます。

VPCクラスタ内のワーカープールにゾーンを追加するには、 ibmcloud ks zone add vpc-gen2 コマンドを 使用します。

ibmcloud ks zone add classic --zone ZONE --cluster CLUSTER --worker-pool WORKER_POOL [--private-vlan PRIVATE_VLAN] [--public-vlan PUBLIC_VLAN] [--private-only] [--output json] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

--zone ZONE

必須: 追加するゾーン。 ゾーンはクラスターのリージョン内の複数ゾーン対応ゾーンでなければなりません。

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-p, --worker-pool WORKER_POOL

ゾーンの追加先のワーカー・プールの名前。 複数のワーカープールを指定するには、 -p pool1 -p pool2 のように複数のオプションを使用する。

--private-vlan PRIVATE_VLAN

プライベート VLAN の ID。 この値は条件付きです。 ゾーンにプライベート VLAN がある場合、この値は、クラスターのワーカー・ノードが 1 つ以上存在するプライベート VLAN ID と一致していなければなりません。 使用可能な VLAN を確認するには、ibmcloud ks cluster get --cluster <cluster> --show-resources を実行します。 指定した VLAN に新しいワーカー・ノードが追加されますが、既存のワーカー・ノードの VLAN は変更されません。 そのゾーンにプライベート VLAN もパブリック VLAN もない場合は、このオプションを指定しないでください。 ゾーンをワーカー・プールに初めて追加するときに、プライベート VLAN とパブリック VLAN が自動的に作成されます。 クラシック・クラスターで、1 つのクラスターに複数の VLAN がある場合、同じ VLAN 上に複数のサブネットがある場合、または複数ゾーン・クラシック・クラスターである場合は、IBM Cloud インフラストラクチャー・アカウントの 仮想ルーター機能 (VRF) を有効にして、ワーカー・ノードがプライベート・ネットワーク上で相互に通信できるようにする必要があります。 VRF を有効にするには、VRF の有効化を参照してください。 VRF が既に有効になっているかどうかを確認するには、ibmcloud account show コマンドを使用します。 VRF を有効にできない、または有効にしない場合は、VLAN スパンニングを有効にします。 このアクションを実行するには、 [ネットワーク] > [ネットワークVLANスパニングインフラストラクチャの管理] 権限が必要です。 VLAN スパンニングが既に有効になっているかどうかを確認するには、ibmcloud ks vlan spanning get --region <region> コマンド を使用します。

--public-vlan PUBLIC_VLAN

パブリック VLAN の ID。 クラスターの作成後にノード上のワークロードをパブリックに公開する場合は、この値が必要です。 この値は、このゾーンでクラスターのワーカー・ノードが 1 つ以上存在するパブリック VLAN ID と一致していなければなりません。 使用可能な VLAN を確認するには、ibmcloud ks cluster get --cluster <cluster> --show-resources を実行します。 指定した VLAN に新しいワーカー・ノードが追加されますが、既存のワーカー・ノードの VLAN は変更されません。 そのゾーンにプライベート VLAN もパブリック VLAN もない場合は、このオプションを指定しないでください。 ゾーンをワーカー・プールに初めて追加するときに、プライベート VLAN とパブリック VLAN が自動的に作成されます。 クラシック・クラスターで、1 つのクラスターに複数の VLAN がある場合、同じ VLAN 上に複数のサブネットがある場合、または複数ゾーン・クラシック・クラスターである場合は、IBM Cloud インフラストラクチャー・アカウントの仮想ルーター機能 (VRF) を有効にして、ワーカー・ノードがプライベート・ネットワーク上で相互に通信できるようにする必要があります。 VRF を有効にするには、VRF の有効化を参照してください。 VRF が既に有効になっているかどうかを確認するには、ibmcloud account show コマンドを使用します。 VRF を有効にできない、または有効にしない場合は、VLAN スパンニングを有効にします。 このアクションを実行するには、 [ネットワーク] > [ネットワークVLANスパニングインフラストラクチャの管理] 権限が必要です。 VLAN スパンニングが既に有効になっているかどうかを確認するには、ibmcloud ks vlan spanning get --region <region> コマンド を使用します。

--private-only

このオプションは、パブリック VLAN が作成されるのを防止するために使用します。 --private-vlan オプションを指定し、 --public-vlan オプションを含めない場合にのみ必要です。 プライベート VLAN のみを使用してワーカー・ノードをセットアップする場合は、プライベート・クラウド・サービス・エンドポイントを有効にするか、ゲートウェイ・アプライアンスを構成する必要があります。 詳しくは、 プライベート・クラスターおよびワーカー・ノードのセットアップの計画を参照してください。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks zone add classic --zone dal10 --cluster my_cluster -p pool1 -w pool2 --private-vlan 2294021

ibmcloud ks zone add vpc-gen2

Virtual Private Cloud

第 2 世代の VPC クラスターまたはワーカー・プールを作成したら、ゾーンを追加できます。 ゾーンを追加すると、ワーカー・プールに対して指定した「ゾーンあたりのワーカー数」を満たすように新しいゾーンにワーカー・ノードが追加されます。 クラスターが複数ゾーンの大都市にある場合にのみ、複数のゾーンを追加できます。

ibmcloud ks zone add vpc-gen2 --zone ZONE --subnet-id VPC_SUBNET_ID --cluster CLUSTER --worker-pool WORKER_POOL [--output json] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

--zone ZONE

必須: 追加するゾーン。 クラスターのリージョン内の VPC ゾーンでなければなりません。 使用可能な VPC ゾーンを表示するには、ibmcloud ks zone ls --provider vpc-gen2 を実行します。

--subnet-id SUBNET_ID

必須: 追加するサブネットの ID。 この VPC サブネットは、指定するzone内になければなりません。 使用可能な VPC サブネットを確認するには、ibmcloud ks subnets --provider vpc-gen2 --vpc-id <vpc> --zone <vpc_zone>を実行します。 クラスターのワーカー・ノードおよびロード・バランサー・サービスの IP アドレスは VPC サブネットから取得されるので、256 個などの十分な数の IP アドレスが含まれる VPC サブネットを使用してください。

-c, --cluster CLUSTER

必須: クラスターの名前または ID。 VPC クラスターをリストするには、ibmcloud ks cluster ls --provider vpc-gen2 を実行します。

-p, --worker-pool WORKER_POOL

ゾーンの追加先のワーカー・プールの名前。 複数のワーカープールを指定するには、 -p pool1 -p pool2 のように複数のオプションを使用する。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks zone add vpc-gen2 --zone us-south-3 --cluster my_cluster -p pool1 -w pool2

ibmcloud ks zone ls

仮想プライベート・クラウド クラシック・インフラストラクチャー Satellite

クラスターを作成するために使用できるゾーンのリストを表示します。

このコマンドの別名 locations は推奨されません。

ibmcloud ks zone ls --provider (classic | satellite | vpc-gen2) [--location LOCATION] [--region-only] [--output json] [-q]

最小許可: なし

コマンド・オプション：

--provider (classic | satellite | vpc-gen2)

ゾーンをリストするインフラストラクチャー・プロバイダー・タイプ。 このオプションは必須です。

-l, --location LOCATION

特定のロケーションで出力をフィルタリングします。 サポート対象のロケーションを確認するには、ibmcloud ks locations を実行します。 複数の場所を指定するには、 -l dal -l seo のように、場所ごとに1つのオプションを使用します。

--region-only

オプション: ログインしているリージョン内の複数ゾーンのみリストします。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

例:

ibmcloud ks zone ls -l ap

ibmcloud ks zone network-set

クラシック・インフラストラクチャー

複数ゾーン・クラシック・クラスターのみ: これまで使用していたものとは別のパブリック VLAN またはプライベート VLAN をゾーンで使用するように、ワーカー・プールのネットワーク・メタデータを設定します。 プール内に既に作成済みのワーカー・ノードは、これまでと同じパブリック VLAN またはプライベート VLAN を使用し続けますが、プール内の新しいワーカー・ノードは新しいネットワーク・データを使用します。

ibmcloud ks zone network-set --zone ZONE --cluster CLUSTER  --private-vlan PRIVATE_VLAN --worker-pool WORKER_POOL [--public-vlan PUBLIC_VLAN] [--private-only] [-f] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

--zone ZONE

必須: 追加するゾーン。 ゾーンはクラスターのリージョン内の複数ゾーン対応ゾーンでなければなりません。

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-p, --worker-pool WORKER_POOL

ゾーンの追加先のワーカー・プールの名前。 複数のワーカープールを指定するには、 -p pool1 -p pool2 のように複数のオプションを使用する。

--private-vlan PRIVATE_VLAN

プライベート VLAN の ID。 この値は、使用するプライベート VLAN が他のワーカー・ノードで使用していたものと同じか異なるかに関係なく必須です。 指定した VLAN に新しいワーカー・ノードが追加されますが、既存のワーカー・ノードの VLAN は変更されません。 プライベート VLAN とパブリック VLAN は互換性がある必要があり、これは、Router ID 接頭部で判別できます。

--public-vlan PUBLIC_VLAN

パブリック VLAN の ID。 この値は、ゾーンのパブリック VLAN を変更する場合にのみ、必須です。 パブリック VLAN を変更するには、常に互換性のあるプライベート VLAN を指定する必要があります。 指定した VLAN に新しいワーカー・ノードが追加されますが、既存のワーカー・ノードの VLAN は変更されません。 プライベート VLAN とパブリック VLAN は互換性がある必要があり、これは、Router ID 接頭部で判別できます。

--private-only

オプション: パブリック VLAN を設定解除して、このゾーン内のワーカーがプライベート VLAN のみに接続されるようにします。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

使用法:

1. クラスター内で使用可能な VLAN を確認します。

   ibmcloud ks cluster get --cluster <cluster_name_or_ID> --show-resources
   

   出力例

   Subnet VLANs
   VLAN ID   Subnet CIDR         Public   User-managed
   229xxxx   169.xx.xxx.xxx/29   true     false
   229xxxx   10.xxx.xx.x/29      false    false
   

2. 使用するパブリック VLAN ID とプライベート VLAN ID に互換性があることを確認します。 対応している VLAN は、Router のポッド ID が同じです。 必ず、プライベート VLAN ルーターの先頭は bcr (バックエンド・ルーター)、パブリック VLAN ルーターの先頭は fcr (フロントエンド・ルーター) になります。 クラスターを作成し、パブリック VLAN とプライベート VLAN を指定するときには、それらの接頭部の後の番号と文字の組み合わせが一致する必要があります。

   ibmcloud ks vlan ls --zone <zone>
   

   この出力例では、Router のポッド ID は 01a と 01a であり、一致しています。 どちらかのポッド ID が 01a で、もう一方が 02a であれば、これらのパブリック VLAN ID とプライベート VLAN ID をワーカー・プールに設定することはできません。

   ID        Name   Number   Type      Router         Supports Virtual Workers
   229xxxx          1234     private   bcr01a.dal12   true
   229xxxx          5678     public    fcr01a.dal12   true
   

3. 使用可能な VLAN がない場合は、新規 VLAN をオーダーできます。

ibmcloud ks zone network-set --zone dal10 -c my_cluster -p pool1 -p pool2 --private-vlan 2294021

ibmcloud ks zone rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

複数ゾーン・クラスターのみ: クラスター内の 1 つ以上のワーカー・プールからゾーンを削除します。 ワーカー・プールからそのゾーンのワーカー・ノードがすべて削除されます。

必ず、ゾーンを削除する前に、クラスター内の他のゾーンに、ポッドがスケジュールを変更できるだけの十分な数のワーカー・ノードが存在することを確認してください。 ポッドのスケジュールを変更すると、アプリのダウン時間やワーカー・ノードのデータ破損を回避できます。

ibmcloud ks zone rm --cluster CLUSTER --zone ZONE --worker-pool WORKER_POOL [-f] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--zone ZONE

必須: 削除するゾーン。

-p, --worker-pool WORKER_POOL

ゾーンを削除するワーカー・プールの名前。 複数のワーカープールを指定するには、 -p pool1 -p pool2 のように複数のオプションを使用する。 クラスタ内のすべてのワーカープールからゾーンを削除するには、このオプションを含めないでください。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks zone rm --zone dal10 --cluster my_cluster

ibmcloud ks ingress alb autoscale get

仮想プライベート・クラウド クラシック・インフラストラクチャー

Ingress ALB 自動スケーリング構成の詳細と状況を取得します。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

--alb ALB

必須: 自動スケーリングをオンに構成する ALB の名前または ID。

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-q

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

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

ibmcloud ks ingress alb autoscale get --alb myalb123 --cluster mycluster

ibmcloud ks ingress alb autoscale set

仮想プライベート・クラウド クラシック・インフラストラクチャー

現在の負荷に基づいて Ingress ALB ポッドの数を自動的に増減するように自動スケーリングを構成します。 CPU 使用率に基づいてポッドをスケーリングすることも、指定したカスタム・メトリックを使用することもできます。 CPU 使用率に基づいて自動スケーリングを構成する場合は、平均 CPU 使用率と、任意の時点でデプロイされるポッドの最大数および最小数を指定します。 自動スケーリングのカスタム・メトリックを指定することを選択した場合は、カスタム・メトリック・ファイルへのパスを渡します。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

--alb ALB

必須: 自動スケーリングをオンに構成する ALB の名前または ID。

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--max-replicas REPLICAS

任意の時点でデプロイされるレプリカの最大数。 ---cpu-average-utilization オプションを含める場合、この値は必須です。

--min-replicas REPLICAS

任意の時点でデプロイするレプリカの最小数。 ---cpu-average-utilization オプションを含める場合、この値は必須です。

--cpu-average-utilization PERCENTAGE

レプリカの数を動的に計算するために使用される平均使用率しきい値。

--custom-metrics-file

カスタム・メトリック・ファイルへのパス。

-q

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

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

ibmcloud ks ingress alb autoscale set --alb myalb123 --cluster mycluster --max-replicas 5 --min-replicas 2 --cpu-average-utilization 5

ibmcloud ks ingress alb autoscale unset

仮想プライベート・クラウド クラシック・インフラストラクチャー

自動スケーリング構成を削除して、Ingress ALB から自動スケーリングを削除します。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

--alb ALB

必須: 自動スケーリングをオンに構成する ALB の名前または ID。

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress alb autoscale unset --alb myalb123 --cluster mycluster

ibmcloud ks ingress alb autoupdate disable

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

デフォルトでは、Ingress アプリケーション・ロード・バランサー (ALB) に対する自動更新は有効になっています。 新しいイメージ・バージョンが使用可能になると、ALB ポッドが自動的に更新されます。 代わりに手動でアドオンを更新したい場合に、このコマンドを使用して自動更新を無効にすることができます。 その後に、ibmcloud ks ingress alb update コマンドを実行して ALB ポッドを更新できます。

お客様がクラスターの Kubernetes のメジャー・バージョンまたはマイナー・バージョンを更新した場合、IBM は Ingress デプロイメントに対して必要な変更を自動的に行いますが、Ingress ALB アドオンのイメージ・バージョンは変更しません。 お客様が、最新の Kubernetes バージョンと Ingress ALB アドオン・イメージの互換性を確認する必要があります。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-q

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

ibmcloud ks ingress alb autoupdate disable --cluster mycluster

ibmcloud ks ingress alb autoupdate enable

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

Ingress ALB アドオンの自動更新を無効にした場合に、再び自動更新を有効にすることができます。 次のイメージ・バージョンが使用可能になるたびに、ALB は自動的に最新ビルドに更新されます。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-q

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

ibmcloud ks ingress alb autoupdate get

仮想プライベート・クラウド クラシック・インフラストラクチャー

Ingress ALB アドオンの自動更新が有効になっているかどうか、および ALB が最新のイメージ・バージョンに更新されているかどうかを検査します。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress alb create classic

クラシック・インフラストラクチャー

クラシック・クラスター内にパブリック ALB またはプライベート ALB を作成します。 作成した ALB はデフォルトで有効になります。

ibmcloud ks ingress alb create classic --cluster CLUSTER --type (PUBLIC|PRIVATE) --vlan VLAN_ID --zone ZONE [--ip IP] [--version IMAGE_VERSION] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

クラスターの名前または ID。

--type (PUBLIC|PRIVATE)

ALB のタイプ: public または private。 このタイプは vlan と一致する必要があります。

--vlan VLAN_ID

ALB を作成する VLAN の ID 。 この VLAN は、ALB の type と一致しなければならず、作成する ALB と同じ zone 内になければなりません。

--zone ZONE

ALB を作成するゾーン。

--ip IP

オプション: ALB に割り当てる IP アドレス。 この IP は、指定した vlan のものでなければならず、作成する ALB と同じ zone 内になければなりません。 この IP アドレスは、クラスター内の別のロード・バランサーまたは ALB によって使用されていてはなりません。 現在使用中の IP アドレスを表示するには、kubectl get svc --all-namespaces を実行します。

--version IMAGE_VERSION

オプション: ALB を実行するイメージのバージョン。 使用可能なバージョンをリストするには、ibmcloud ks ingress alb versions を実行します。 デフォルト以外のバージョンを指定するには、最初に ibmcloud ks ingress alb autoupdate disable コマンドを実行して、自動更新を無効にする必要があります。 このオプションを省略すると、ALBは Kubernetes Ingressイメージタイプのデフォルトバージョンを実行する。

-q

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

ibmcloud ks ingress alb create classic --cluster mycluster --type public --vlan 2234945 --zone dal10 --ip 1.1.1.1 --version 1.1.2_2507_iks

ibmcloud ks ingress alb create vpc-gen2

Virtual Private Cloud

VPC クラスター内にパブリック ALB またはプライベート ALB を作成します。 作成した ALB はデフォルトで有効になります。

ibmcloud ks ingress alb create vpc-gen2 --cluster CLUSTER --type PUBLIC|PRIVATE --zone ZONE [--version IMAGE_VERSION] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

クラスターの名前または ID。 VPC クラスターを表示するには、ibmcloud ks cluster ls --provider vpc-gen2 を実行します。

--type PUBLIC|PRIVATE

ALB のタイプ: public または private。

--zone ZONE

ALB をデプロイする VPC ゾーン。

--version IMAGE_VERSION

オプション: ALB を実行するイメージのバージョン。 使用可能なバージョンをリストするには、ibmcloud ks ingress alb versions を実行します。 デフォルト以外のバージョンを指定するには、最初に ibmcloud ks ingress alb autoupdate disable コマンドを実行して、自動更新を無効にする必要があります。 このオプションを省略すると、ALBは Kubernetes Ingressイメージタイプのデフォルトバージョンを実行する。

-q

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

ibmcloud ks ingress alb create vpc-gen2 --cluster mycluster --type public --zone us-south-1 --version 1.1.2_2507_iks

ibmcloud ks ingress alb disable

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内の ALB を無効にします。 ALB およびそのポッドは引き続き存在しますが、アプリへのトラフィックのルーティングは停止します。

このコマンドの以前の別名 ibmcloud ks ingress alb configure は非推奨です。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

--alb ALB_ID

必須: ALB の ID。 クラスターの ALB の ID を表示するには、ibmcloud ks ingress alb ls --cluster CLUSTER を実行します。

-c, --cluster CLUSTER

クラスターの名前または ID。

-q

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

ibmcloud ks ingress alb disable --alb public-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster

ibmcloud ks ingress alb enable classic

クラシック・インフラストラクチャー

クラシック・クラスター内の ALB を有効にします。

このコマンドの以前の別名 ibmcloud ks ingress alb configure classic は非推奨です。

このコマンドを使用して、以下の操作を行うことができます。

• デフォルトのプライベート ALB を有効にします。 クラスターを作成すると、ワーカーおよび使用可能なプライベート・サブネットを持つ各ゾーンにデフォルトのプライベート ALB が作成されますが、デフォルトのプライベート ALB は有効になりません。 一方、デフォルトのパブリック ALB はすべて自動的に有効になります。また、ibmcloud ks ingress alb create classic コマンドを使用してユーザーが作成したパブリック ALB またはプライベート ALB もデフォルトで有効になります。
• 以前に無効にした ALB を有効にします。

ibmcloud ks ingress alb enable classic --alb ALB_ID --cluster CLUSTER [--ip IP_ADDRESS] [--version IMAGE_VERSION] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

--alb ALB_ID

必須: ALB の ID。 クラスターの ALB の ID を表示するには、ibmcloud ks ingress alb ls --cluster CLUSTER を実行します。

-c, --cluster CLUSTER

クラスターの名前または ID。

--ip IP_ADDRESS

オプション: ALB が作成されたゾーン内の VLAN 上にある IP アドレスを指定します。 ALB は、このパブリック IP アドレスまたはプライベート IP アドレスで有効になり、このアドレスを使用します。 この IP アドレスは、クラスター内の別のロード・バランサーまたは ALB によって使用されていてはなりません。 IP アドレスが指定されていない場合、クラスターの作成時に自動的にプロビジョンされたポータブル・パブリック・サブネットかポータブル・プライベート・サブネットのパブリック IP アドレスかプライベート IP アドレスを使用して ALB はデプロイされ、以前有効だった ALB を再度有効にする場合は、以前 ALB に割り当てられていたパブリック IP アドレスかプライベート IP アドレスを使用して ALB はデプロイされます。

--version IMAGE_VERSION

オプション: ALB を実行するイメージのバージョン。 使用可能なバージョンをリストするには、ibmcloud ks ingress alb versions を実行します。 デフォルト以外のバージョンを指定するには、最初に ibmcloud ks ingress alb autoupdate disable コマンドを実行して、自動更新を無効にする必要があります。 このオプションを省略すると、ALB は以前に実行したのと同じイメージのデフォルトバージョンを実行します。 Kubernetes Ingress イメージまたは IBM Cloud Kubernetes Service Ingress イメージのいずれかです。

-q

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

ibmcloud ks ingress alb enable classic --alb private-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster --ip 169.XX.XXX.XX --version 1.1.2_2507_iks

ibmcloud ks ingress alb enable vpc-gen2

Virtual Private Cloud

VPC クラスター内の ALB を有効にします。

このコマンドの以前の別名 ibmcloud ks ingress alb configure vpc-gen2 は非推奨です。

このコマンドを使用して、以下の操作を行うことができます。

• デフォルトのプライベート ALB を有効にします。 クラスターを作成すると、ワーカー・ノードを持つ各ゾーンにデフォルトのプライベート ALB が作成されますが、デフォルトのプライベート ALB は有効になりません。 一方、デフォルトのパブリック ALB はすべて自動的に有効になります。また、ibmcloud ks ingress alb create vpc-gen2 コマンドを使用してユーザーが作成したパブリック ALB またはプライベート ALB もデフォルトで有効になります。
• 以前に無効にした ALB を有効にします。

ibmcloud ks ingress alb enable vpc-gen2 --alb ALB_ID --cluster CLUSTER [--version IMAGE_VERSION] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

--alb ALB_ID

必須: ALB の ID。 クラスターの ALB の ID を表示するには、ibmcloud ks ingress alb ls --cluster CLUSTER を実行します。

-c, --cluster CLUSTER

クラスターの名前または ID。

--version IMAGE_VERSION

オプション: ALB を実行するイメージのバージョン。 使用可能なバージョンをリストするには、ibmcloud ks ingress alb versions を実行します。 デフォルト以外のバージョンを指定するには、最初に ibmcloud ks ingress alb autoupdate disable コマンドを実行して、自動更新を無効にする必要があります。 このオプションを省略すると、ALB は以前に実行したのと同じイメージのデフォルトバージョンを実行します。 Kubernetes Ingress イメージまたは IBM Cloud Kubernetes Service Ingress イメージのいずれかです。

-q

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

ibmcloud ks ingress alb enable vpc-gen2 --alb private-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster --version 1.1.2_2507_iks

ibmcloud ks ingress alb get

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内の Ingress ALB の詳細を表示します。

ibmcloud ks ingress alb get --alb ALB_ID --cluster CLUSTER [--output json] [-q]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

--alb ALB_ID

必須: ALB の ID。 クラスターの ALB の ID を表示するには、ibmcloud ks ingress alb ls --cluster CLUSTER を実行します。

-c, --cluster CLUSTER

クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress alb get --alb public-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster

ibmcloud ks ingress alb health-checker disable

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内の Ingress ALB のヘルス・チェッカーを無効にします。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

クラスターの名前または ID。

-q

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

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

ibmcloud ks ingress alb health-checker enable

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内の Ingress ALB に対してヘルス・チェッカーを有効にします。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

クラスターの名前または ID。

-q

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

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

ibmcloud ks ingress alb health-checker get

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内の Ingress ALB のヘルス・チェッカーの詳細を表示します。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks ingress alb ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内のすべての Ingress ALB ID をリストし、ALB ポッドの更新が使用可能かどうかを表示します。

ALB ID が返されない場合、クラスターには移植可能なサブネットはありません。 サブネットを作成したり、クラスターに追加したりすることができます。 その後、ALB は自動的に作成されます。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

*-c, --cluster *CLUSTER

必須: 使用可能な ALB をリストするクラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress alb ls --cluster my_cluster

ibmcloud ks ingress alb update

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内の個々の Ingress ALB またはすべての Ingress ALB のポッドを、最新のバージョンまたは特定のバージョンに強制的に更新します。

Ingress ALB アドオンの自動更新が無効になっている場合にアドオンを更新するには、一回限りの ALB ポッド更新を強制実行します。 ALB ポッドが最近更新されたが、ALB のカスタム構成が最新ビルドの影響を受けているという場合も、このコマンドを使用して ALB ポッドを以前のサポートされているバージョンにロールバックすることができます。 このコマンドを使用して ALB イメージを別のバージョンに更新できますが、ALB をあるタイプのイメージから別のタイプのイメージに変更することはできません。 一回限りの更新を強制実行しても、自動更新は無効のままですが、ibmcloud ks ingress alb autoupdate enable コマンドを使用して、自動更新を再度有効にすることができます。

ibmcloud ks ingress alb update --cluster CLUSTER [--alb ALB1_ID --alb ALB2_ID ...] [--version IMAGE_VERSION] [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: ALB を更新するクラスターの名前または ID。

--alb CLUSTER

オプション: 更新する個々の ALB の ID 。 ALB ID をリストするには、ibmcloud ks ingress alb ls -c <cluster> を実行します。 複数のALBを更新するには、 --alb ALB1_ID --alb ALB2_ID のように複数のオプションを使用する。 このオプションを省略すると、クラスタ内のすべてのALBが更新されます。

--version IMAGE_VERSION

オプション: ALB を更新する対象となるイメージのバージョン。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

• クラスター内のすべての ALB ポッドを更新するには、以下のようにします。

  ibmcloud ks ingress alb update -c mycluster --version 1.1.2_2507_iks
  

• 1 つ以上の特定の ALB を対象に ALB ポッドを更新するには、以下のようにします。

  ibmcloud ks ingress alb update -c mycluster --version 1.1.2_2507_iks --alb public-crdf253b6025d64944ab99ed63bb4567b6-alb1
  

ibmcloud ks ingress alb versions

仮想プライベート・クラウド クラシック・インフラストラクチャー

使用可能な Ingress ALB のバージョンを表示します。

ibmcloud ks ingress alb versions [--output json] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service に対するビューアー・プラットフォーム・アクセス役割

コマンド・オプション：

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress domain create

クラスターの Ingress ドメインを作成します。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須：ドメインを作成するクラスタの名前またはID。

--crn CRN

IBM Cloud Internet Services ドメインの場合は必須です。 IBM Cloud Internet Services インスタンス用の CRN。

--is-default

オプション。 関連するドメインをクラスタのデフォルト・ドメインとして設定するには、このオプションを含めます。

--domain DOMAIN

Ingress ドメイン。 既存のドメインを指定することも、新しいドメインを作成することもできる。 ドメインの指定に関するプロバイダー固有の情報については、 独自の Ingress ドメインの作成 を参照してください。

--hostname HOSTNAME

オプション。 VPC クラスターの場合。 ドメインに登録するホスト名。

--ip IP

オプション。 ドメイン用に登録する IP アドレス。

--output OUTPUT

オプション: コマンド出力を JSON フォーマットで出力します。

--domain-provider PROVIDER

オプション。 外部 DNS プロバイダー・タイプ。 利用可能なオプションは cis-ext です。 プロバイダーが指定されていない場合 IBMの内部プロバイダーでドメインが作成されます。

--secret-namespace NAMESPACE

オプション。 TLS シークレットが作成される名前空間。 名前空間が指定されていない場合、秘密は default 名前空間に作成される。

--domain-zone ZONE

オプション。 ご使用の IBM Cloud Internet Services インスタンスのドメイン ID。 これはGUID値である。

ibmcloud ks ingress domain create --cluster my-cluster --domain exampledomain

ibmcloud ks ingress domain default replace

クラスターのデフォルト Ingress ドメインを変更します。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスタのオペレータ・ プラットフォーム・アクセス・ロール。

コマンド・オプション：

-c, --cluster CLUSTER

必須：ドメインが適用されるクラスタの名前またはID。

--domain DOMAIN

必須。 クラスター用の新しいデフォルト・ドメインとして指定するドメイン。 既存のドメインを指定する必要があります。

-q

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

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

ibmcloud ks ingress domain get

Ingress ドメインの詳細を表示します。

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

最小限必要な許可

IBM Cloud Kubernetes Service に対するビューアー・プラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須：ドメインが適用されるクラスタの名前またはID。

--domain DOMAIN

必須。 詳細を表示する対象となるドメイン。

--output OUTPUT

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks ingress domain ls

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

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

最小限必要な許可

IBM Cloud Kubernetes Service に対するビューアー・プラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output OUTPUT

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks ingress domain rm

クラスターから Ingress ドメインを削除します。

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

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須：ドメインが適用されるクラスタの名前またはID。

--domain DOMAIN

必須。 クラスターから除去したいドメイン。 デフォルト・ドメインを指定することはできません。 クラスターのデフォルトとして現在設定されているドメインを削除する場合は、まず デフォルトを別のドメインに置き換える 必要があります。

-f

-q

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

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

ibmcloud ks ingress domain secret regenerate

Ingress ドメインの証明書を再生成します。 このコマンドを実行して、DNS プロバイダーに新規トークンを生成し、それをクラスターに適用します。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須：ドメインが適用されるクラスタの名前またはID。

--domain DOMAIN

必須。 再生成する対象のドメイン。

--output OUTPUT

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress domain secret regenerate --cluster mycluster --domain exampledomain [--output OUTPUT] [-q]

ibmcloud ks ingress domain secret rm

Ingress ドメインのシークレットを削除し、今後証明書が更新されないようにする。

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

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須：ドメインが適用されるクラスタの名前またはID。

--domain DOMAIN

必須。 シークレットを削除する対象のドメイン。

-f

--output OUTPUT

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks ingress domain update

クラスターの Ingress ドメインを更新して、ドメインに関連付けられているホスト名または IP アドレスを変更します。 このコマンドは、指定された IP アドレスまたはホスト名を持つクラスター内のすべてのリソースを更新し、アプリ URL を変更します。

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

IP アドレスまたはホスト名を追加する場合は、現在ドメインに登録されている IP またはホスト名をすべて含める必要があることに注意してください。 ドメインは指定されたとおりの値で更新されるため、現行の IP アドレスまたはホスト名が含まれていない場合は上書きされます。 例えば、 52.137.182.166 が現在ドメインに登録されており、 52.137.182.270 を追加する場合は、コマンドに --ip 52.137.182.166 --ip 52.137.182.270 を指定する必要があります。

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須：ドメインが適用されるクラスタの名前またはID。

--domain DOMAIN

必須。 更新しようとしているドメイン。

--hostname HOSTNAME

VPC クラスターの場合。 ドメインに登録するホスト名。

--ip IP

ドメイン用に登録する IP アドレス。 渡された IP アドレスは、現在ドメインに関連付けられている IP アドレスを完全に置き換えます。 現在の IP アドレスを保持する場合は、それらを含める必要があります。 値なしでこのフラグを指定すると、ドメインから現在の IP アドレスが登録抹消されます。

-q

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

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

ibmcloud ks ingress instance default set

仮想プライベート・クラウド クラシック・インフラストラクチャー

登録済みの IBM Cloud Secrets Manager インスタンスをデフォルトに設定します。 既存のデフォルト・インスタンスが存在する場合は、デフォルトから設定解除されます。

新しいデフォルトの Secrets Manager インスタンスを設定する場合、IBM Cloud によって管理されていない既存のシークレットは、新しいデフォルト・インスタンスの CRN と一致するように証明書 CRN を手動で更新する必要があります。 CRN を更新するには、ibmcloud ks ingress secret update コマンドを使用します。 CRN を更新しない場合、これらのシークレットは、次にスケジュールされている証明書の更新時に更新されません。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--c, --cluster CLUSTER

必須。 クラスターの名前または ID。

--crn

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

--name NAME

必須。 Secret Manager インスタンスの名前。

-q

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

--secret-group GROUP

シークレットが保持される IBM Cloud Secret Manager インスタンスのシークレット・グループ ID。 シークレット・グループ ID を取得するには、 Secrets Manager CLI リファレンス を参照してください。

例:

ibmcloud ks ingress instance default set --cluster --cluster a111aaa11a1aaaaaaa1 --crn crn:v1:staging:public:secrets-manager:eu-gb:a/1a11a1a111aa11aa111aa1a1111aa1a1:1aaa1a1a-aaaa-11aa-1a11-a11aaa1a11a1:secret:a1a11a11-111a-11a1-aa11-11aaa1a11a11 --name my-secret-manager --namespace default --secret-group 90e059dd-d04e-a32b-010f-4d303b9050b8

ibmcloud ks ingress instance default unset

仮想プライベート・クラウド クラシック・インフラストラクチャー

デフォルト・インスタンスとしての Secrets Manager インスタンスを削除します。

デフォルト・インスタンスが設定されていない場合、シークレットはクラスターに直接書き込まれるだけで、Secrets Manager インスタンスには書き込まれません。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--c, --cluster CLUSTER

必須。 クラスターの名前または ID。

--crn

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

--name NAME

必須。 Secret Manager インスタンスの名前。

-q

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

例:

ibmcloud ks ingress instance default unset --cluster --cluster a111aaa11a1aaaaaaa1 --crn crn:v1:staging:public:secrets-manager:eu-gb:a/1a11a1a111aa11aa111aa1a1111aa1a1:1aaa1a1a-aaaa-11aa-1a11-a11aaa1a11a1:secret:a1a11a11-111a-11a1-aa11-11aaa1a11a11 --name my-secret-manager --namespace default

ibmcloud ks ingress instance get

仮想プライベート・クラウド クラシック・インフラストラクチャー

Secrets Manager インスタンスの詳細を表示します。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

--c, --cluster CLUSTER

必須。 クラスターの名前または ID。

--name NAME

必須。 Secret Manager インスタンスの名前。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

例:

ibmcloud ks ingress instance get --cluster my-cluster --name my-secrets-manager

ibmcloud ks ingress instance ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターに登録されているすべての Secrets Manager インスタンスをリストします。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

--c, --cluster CLUSTER

必須。 クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

--show-deleted

オプション。 クラスターから登録解除されたインスタンスを含めるには、このオプションを追加します。

例:

ibmcloud ks ingress instance ls --cluster my-cluster --show-deleted

ibmcloud ks ingress instance register

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--c, --cluster CLUSTER

必須。 クラスターの名前または ID。

--crn

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

--is-default

オプション。 登録済みインスタンスを、すべての Ingress サブドメイン証明書が保管されるデフォルトの Secrets Manager インスタンスとして設定する場合にも、このオプションを含めます。 別のインスタンスが既にデフォルトとして設定されている場合、そのインスタンスは削除されます。 証明書またはシークレットを新しいデフォルト・インスタンスにアップロードするには、それらを手動で更新する必要があることに注意してください。 それ以外の場合は、シークレットの次回のスケジュール更新時にアップロードされます。

-q

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

--secret-group GROUP

シークレットが保持される IBM Cloud Secret Manager インスタンスのシークレット・グループ ID。 シークレット・グループ ID を取得するには、 Secrets Manager CLI リファレンス を参照してください。

例:

ibmcloud ks ingress instance register --cluster my-cluster --crn crn:v1:staging:public:secrets-manager:eu-gb:a/1a11a1a111aa11aa111aa1a1111aa1a1:1aaa1a1a-aaaa-11aa-1a11-a11aaa1a11a1:secret:a1a11a11-111a-11a1-aa11-11aaa1a11a11 --secret-group 90e059dd-d04e-a32b-010f-4d303b9050b8

ibmcloud ks ingress instance unregister

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターから Secrets Manager インスタンスを削除します。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--c, --cluster CLUSTER

必須。 クラスターの名前または ID。

--name

必須。 削除する Secrets Manager インスタンスの名前。

-q

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

例:

ibmcloud ks ingress instance unregister --cluster my-cluster --name my-secrets-manager-instance

ibmcloud ks ingress lb get

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

例えば、以前に ibmcloud ks ingress lb proxy-protocol enable などのコマンドを実行した場合は、以下のコマンドを使用して構成変更を表示できます。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks ingress lb get --cluster mycluster

ibmcloud ks ingress lb proxy-protocol disable

Virtual Private Cloud

クラスター内のすべての Ingress ALB の前にあるロード・バランサーの NGINX PROXY プロトコルを無効にして、クライアント接続情報が要求ヘッダーで ALB に渡されないようにします。

このコマンドを実行すると、既存のロード・バランサーが削除されて再作成されるので、サービスの中断が発生する可能性があります。 ロード・バランサーの再作成中には、それぞれのサブネットで 2 つの未使用の IP アドレスを使用できる必要があります。

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

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks ingress lb proxy-protocol disable --cluster mycluster

ibmcloud ks ingress lb proxy-protocol enable

Virtual Private Cloud

クラスタ内のIngress ALBを公開するすべてのロードバランサで NGINX PROXYプロトコルを有効にして、クライアント接続情報がリクエストヘッダでALBに渡されるようにします。

PROXY プロトコルを使用すると、ロード・バランサーはクライアント要求のヘッダーに含まれているクライアント接続情報を ALB に渡せるようになります。 このクライアント情報には、クライアントの IP アドレス、プロキシー・サーバーの IP アドレス、両方のポート番号などが含まれます。

このコマンドを実行すると、既存のロード・バランサーが削除されて再作成されるので、サービスの中断が発生する可能性があります。 ロード・バランサーの再作成中には、それぞれのサブネットで 2 つの未使用の IP アドレスを使用できる必要があります。

ibmcloud ks ingress lb proxy-protocol enable --cluster CLUSTER [--cidr CIDR ...] [--header-timeout TIMEOUT] [-f] [-q]

最小限必要な許可

クラスタのオペレータ・ プラットフォーム・アクセス・ロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--cidr CIDR

オプション: ALB が PROXY プロトコル・ヘッダー内の情報を処理するロード・バランサーの CIDR。 PROXY ヘッダーが組み込まれている要求が他の IP 範囲のロード・バランサーから発信された場合は、ヘッダー内の情報は ALB によって処理されません。 このオプションがサポートされるのは、コミュニティー Kubernetes Ingress イメージを実行する ALB の場合に限られます。 デフォルト: 0.0.0.0/0

--header-timeout TIMEOUT

オプション: クライアント接続情報が組み込まれている PROXY プロトコル・ヘッダーをロード・バランサーが受信する場合のタイムアウト値 (秒単位)。 このオプションがサポートされるのは、コミュニティー Kubernetes Ingress イメージを実行する ALB の場合に限られます。 デフォルト: 5

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

-q

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

ibmcloud ks ingress lb proxy-protocol enable --cluster mycluster --cidr 1.1.1.1/16

ibmcloud ks ingress secret create

仮想プライベート・クラウド クラシック・インフラストラクチャー

IBM Cloud® Secrets Manager に保管された証明書用にクラスター内に Ingress シークレットを作成します。 このコマンドを使用して、TLS シークレットまたは非 TLS シークレットを作成できます。

このコマンドの以前の別名 ibmcloud ks ingress alb cert deploy は非推奨です。 CLI バージョン 1.0.157 以降では、ibmcloud ks ingress alb cert カテゴリーは推奨されなくなり、これらのコマンドは ibmcloud ks ingress secret サブカテゴリーにリストされるようになりました。 詳しくは、 CLI 変更ログ を参照してください。

ibmcloud ks ingress secret create コマンドを使用するには、デフォルトの Secrets Manager インスタンスがクラスターに登録されている必要があります。 Secrets Manager インスタンスがなく、代わりにシークレットがクラスターに直接書き込まれる場合は、必要な CRN 値がシークレットにないため、 kubectl コマンドを使用してシークレットを管理する必要があります。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--cert-crn CERTIFICATE_CRN

必須: 証明書 CRN。

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--name SECRET_NAME

必須: シークレットの名前を指定します。 IBM提供の Ingress シークレット (ibmcloud ks cluster get --cluster <cluster_name_or_ID> | grep Ingress を実行して見つけることができる) と同じ名前のシークレットを作成しないでください。

--field CRN

非 TLS シークレットの場合は必須です。 シークレットにフィールドを追加する。 一度に複数のフィールドを指定できます。 詳しくは、 TLS 以外のシークレット・フィールドの管理 を参照してください。 このオプションはTLSシークレットには対応していない。

• シークレット・タイプのデフォルト・フィールド名を使用してシークレットをプルするには、デフォルト・フィールド・オプション --field <crn> を使用します。 このオプションは、すべての非 TLS シークレット・タイプに使用できます。
• フィールド名を指定するには、名前付きフィールド・オプション --field name=<crn> を使用します。 このオプションは、任意の資格情報タイプおよび IAM 資格情報シークレット・タイプに使用できます。
• IBM Cloud Secrets Manager シークレットを接頭部として使用するには、接頭部フィールド・オプション --field prefix=<crn> を使用します。 このオプションは、IAM 資格情報、ユーザー名とパスワード、およびキー値のシークレット・タイプに使用できます。

--namespace NAMESPACE

オプション: Ingress リソースがデプロイされる名前空間を指定します。 ALB が Kubernetes Ingress イメージを実行している場合、ALB では Ingress リソースと同じ名前空間にあるシークレットのみが識別されるため、この値は必須です。 ALB が IBM Cloud Kubernetes Service Ingress イメージを実行し、名前空間が指定されないと、証明書シークレットは ibm-cert-store という名前空間に作成されます。 それから、このシークレットへの参照が default 名前空間に作成されます。これには、どの名前空間内の、どの Ingress リソースでもアクセスできます。 ALB は、要求の処理中に、この参照に従って ibm-cert-store 名前空間から証明書シークレットを取得して使用します。

--persist

オプション: クラスター内のシークレット・データを永続化します。 シークレットが後で CLI または Red Hat OpenShift Web コンソールで削除された場合、シークレットは自動的にクラスター内に再作成されます。 シークレットを完全に削除するには、/ingress/v2/secret/deleteSecret API を使用する必要があります。

--type

オプション。 シークレットのタイプ。 証明書 CRN の場合は tls から、非証明書 CRN の場合は opaque から選択します。 tls には、1 つしか CRN を指定できません。 opaque には、複数の CRN を指定できます。 シークレット・タイプが指定されていない場合は、デフォルトで tls が適用されます。

-q

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

ibmcloud ks ingress secret create --cert-crn crn:v1:staging:public:cloudcerts:us-south:a/06580c923e40314421d3b6cb40c01c68:0db4351b-0ee1-479d-af37-56a4da9ef30f:certificate:4bc35b7e0badb304e60aef00947ae7ff --cluster my_cluster --type tls --name my_alb_secret --namespace demo_ns

ibmcloud ks ingress secret field add

仮想プライベート・クラウド クラシック・インフラストラクチャー

不透明なシークレットに非 TLS CRN フィールドを追加する。 フィールド・タイプを指定するには、3 つの方法があります。 選択するものは、シークレットのタイプと、TLS 以外のシークレットでフィールドに名前を付ける方法によって異なります。 詳しくは、 TLS 以外のシークレット・フィールドの管理 を参照してください。

ibmcloud ks ingress secret field add --cluster CLUSTER --name SECRET_NAME --field CRN --namespace NAMESPACE [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--c, --cluster CLUSTER

必須。 クラスターの名前または ID。

--name NAME

必須。 フィールドを追加するシークレットの名前。

--field CRN

必須。 フィールドに追加する秘密のCRN。 一度に複数のフィールドを指定できます。 詳しくは、 TLS 以外のシークレット・フィールドの管理 を参照してください。

• シークレット・タイプのデフォルト・フィールド名を使用してシークレットをプルするには、デフォルト・フィールド・オプション --field <crn> を使用します。 このオプションは、すべての非 TLS シークレット・タイプに使用できます。
• フィールド名を指定するには、名前付きフィールド・オプション --field name=<crn> を使用します。 このオプションは、任意の資格情報タイプおよび IAM 資格情報シークレット・タイプに使用できます。
• IBM Cloud Secrets Manager シークレットを接頭部として使用するには、接頭部フィールド・オプション --field prefix=<crn> を使用します。 このオプションは、IAM 資格情報、ユーザー名とパスワード、およびキー値のシークレット・タイプに使用できます。

--namespace NAMESPACE

必須。 シークレットのデプロイ先の名前空間。

-q

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

デフォルト・フィールド、名前付きフィールド、および接頭部付きフィールドを IAM 資格情報のセットに追加する例:

ibmcloud ks ingress secret field add --cluster example-cluster --name example-iam-secret --namespace default  --field crn:v1:bluemix:public:secrets-manager:us-south:a/1aa111aa1a11111aaa1a1111aa1aa111:111a1111-11a1 --field unique_iam_name=crn:v1:bluemix:public:secrets-manager:us-south:a/1aa111aa1a11111aaa1a1111aa1aa111:111a1111-11a1 --field prefix=crn:v1:bluemix:public:secrets-manager:us-south:a/1aa111aa1a11111aaa1a1111aa1aa111:111a1111-11a1

ibmcloud ks ingress secret field ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

Ingress シークレットの CRN フィールドを表示します。 このコマンドは、Opaque シークレットにのみ適用されます。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--c, --cluster CLUSTER

必須。 クラスターの名前または ID。

--name NAME

必須。 フィールドを追加するシークレットの名前。

--namespace NAMESPACE

必須。 シークレットのデプロイ先の名前空間。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress secret field ls --cluster a11a11a11a111a1a111a --name my-secret --namespace default

ibmcloud ks ingress secret field rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--c, --cluster CLUSTER

必須。 クラスターの名前または ID。

--name NAME

必須。 フィールドを削除するシークレットの名前。

--namespace NAMESPACE

必須。 シークレットのデプロイ先の名前空間。

--field-name NAME

削除するフィールドの名前。 フィールドのリストを表示するには、ibmcloud ks ingress secret field ls を実行します。

ibmcloud ks ingress secret field rm --cluster a11a11a11a111a1a111a --name my-secret --namespace default --field-name test-field-name

ibmcloud ks ingress secret get

仮想プライベート・クラウド クラシック・インフラストラクチャー

IBM Cloud® Secrets Managerに保管されているシークレットを含む、クラスター内の Ingress シークレットに関する情報を表示します。

このコマンドの以前の別名 ibmcloud ks ingress alb cert get は非推奨です。 CLI バージョン 1.0.157 以降では、ibmcloud ks ingress alb cert カテゴリーは推奨されなくなり、これらのコマンドは ibmcloud ks ingress secret サブカテゴリーにリストされるようになりました。 詳しくは、 CLI 変更ログ を参照してください。

ibmcloud ks ingress secret get --cluster CLUSTER --name SECRET_NAME --namespace NAMESPACE [--output json] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--name SECRET_NAME

必須: シークレットの名前。

--namespace NAMESPACE

必須: シークレットがデプロイされている名前空間。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress secret get --cluster my_cluster --name my_alb_secret --namespace demo_ns

ibmcloud ks ingress secret ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

IBM Cloud® Secrets Managerに保管されているシークレットを含め、クラスター内の Ingress シークレットをリストします。

このコマンドの以前の別名 ibmcloud ks ingress alb cert ls は非推奨です。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--show-deleted

オプション: クラスターから削除されたシークレットを表示します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress secret ls --cluster my_cluster

ibmcloud ks ingress secret rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターから Ingress シークレットを削除します。 Secrets Manager の証明書用にシークレットを作成した場合は、クラスター内のシークレットのみが削除され、証明書は Secrets Manager インスタンス内に残ります。

このコマンドの以前の別名 ibmcloud ks ingress alb cert rm は非推奨です。 CLI バージョン 1.0.157 以降では、ibmcloud ks ingress alb cert カテゴリーは推奨されなくなり、これらのコマンドは ibmcloud ks ingress secret サブカテゴリーにリストされるようになりました。 詳しくは、 CLI 変更ログ を参照してください。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--name SECRET_NAME

必須: シークレットの名前。

--namespace NAMESPACE

必須: シークレットがデプロイされている名前空間。

-q

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

ibmcloud ks ingress secret rm --cluster my_cluster --name my_alb_secret --namespace demo_ns

ibmcloud ks ingress secret update

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター用に作成されたデフォルトの Secrets Manager インスタンスでホストされていない証明書の Ingress シークレットを更新します。

クラスタ内のデフォルトの Secrets Manager インスタンスで証明書に加えた変更は、クラスタ内のシークレットに自動的に反映されます。 クラスタ Secrets Manager インスタンスでホストされていない証明書に変更を加える場合は、このコマンドを使用してクラスタのシークレットを更新し、証明書の変更をピックアップする必要があります。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--name SECRET_NAME

必須: シークレットの名前。 使用可能なシークレットを表示するには、ibmcloud ks ingress secret ls を実行します。

--namespace NAMESPACE

必須: シークレットがデプロイされている名前空間。 シークレット名前空間を表示するには、ibmcloud ks ingress secret get --cluster cluster_name_or_ID <--name secret_name> --namespace <namespace> を実行します。

--cert-crn CERTIFICATE_CRN

オプション: 証明書 CRN。 シークレット CRN を表示するには、ibmcloud ks ingress secret get --cluster <cluster_name_or_ID> --name secret_name> --namespace <namespace> を実行します。 このオプションには、クラスター内のデフォルトの Secrets Manager インスタンスが必要です。

-q

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

ibmcloud ks ingress secret update --cluster my_cluster --name my_alb_secret --namespace demo_ns

ibmcloud ks ingress status-report disable

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress status-report disable --cluster mycluster

ibmcloud ks ingress status-report enable

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress status-report enable --cluster mycluster

ibmcloud ks ingress status-report get

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress status-report get --cluster mycluster

ibmcloud ks ingress status-report ignored-errors add

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの Ingress 状況で無視される警告を追加します。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-code, --code CODE

必須：無視する警告のコード。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks ingress status-report ignored-errors ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの Ingress 状況で現在無視されている警告をリストします。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

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

ibmcloud ks ingress status-report ignored-errors rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの Ingress 状況で現在無視されている警告を削除します。 削除されると、これらの警告は無視されなくなります。

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

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-code, --code CODE

必須: 無視されるリストから削除される警告のコード。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks ingress status-report ignored-errors rm --cluster mycluster

ibmcloud ks logging autoupdate disable

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

特定のクラスター内の Fluentd ポッドの自動更新を無効にします。 お客様がクラスターの Kubernetes のメジャー・バージョンまたはマイナー・バージョンを更新した場合、IBM は Fluentd 構成マップに対して必要な変更を自動的に行いますが、ロギング用 Fluentd アドオンのイメージ・バージョンは変更しません。 お客様が、最新の Kubernetes バージョンとアドオン・イメージの互換性を確認する必要があります。

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

コマンド・オプション：

-c, --cluster CLUSTER

必須: Fluentd アドオンの自動更新を無効にするクラスターの名前または ID。

-q

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

ibmcloud ks logging autoupdate enable

仮想プライベート・クラウド クラシック・インフラストラクチャー

特定のクラスター内の Fluentd ポッドの自動更新を有効にします。 新しいイメージ・バージョンが使用可能になると、Fluentd ポッドが自動的に更新されます。

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

コマンド・オプション：

-c, --cluster CLUSTER

必須: Fluentd アドオンの自動更新を有効にするクラスターの名前または ID。

-q

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

ibmcloud ks logging autoupdate get

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

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

コマンド・オプション：

-c, --cluster CLUSTER

必須: Fluentd アドオンの自動更新が有効になっているかどうかを検査するクラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks logging config create

仮想プライベート・クラウド クラシック・インフラストラクチャー

ロギング構成を作成します。 このコマンドを使用して、コンテナー、アプリケーション、ワーカー・ノード、Kubernetes クラスター、Ingress アプリケーション・ロード・バランサーのログを外部 syslog サーバーに転送できます。

ibmcloud ks logging config create --cluster CLUSTER --logsource LOG_SOURCE --type syslog [--namespace KUBERNETES_NAMESPACE] [--hostname LOG_SERVER_HOSTNAME_OR_IP] [--port LOG_SERVER_PORT] [--app-containers CONTAINERS] [--app-paths PATHS_TO_LOGS] [--syslog-protocol PROTOCOL] [--skip-validation] [--force-update] [--output json] [-q]

最小限必要な許可

クラスタのエディタ・ プラットフォーム・アクセス・ロール

コマンド・オプション：

-c, --cluster CLUSTER

クラスターの名前または ID。

--logsource LOG_SOURCE

ログ転送を有効にする対象のログ・ソース。 このオプションは、設定に適用するログ・ソースのカンマ区切りリストをサポートする。 指定可能な値は、container、application、worker、kubernetes、storage、および ingress です。 ログ・ソースを指定しないと、container および ingress を対象に構成が作成されます。

--type syslog

ログを外部サーバーに転送するには、syslog と入力します。

-n, --namespace KUBERNETES_NAMESPACE

ログの転送元になる Kubernetes 名前空間。 ログ転送は、Kubernetes 名前空間 ibm-system と kube-system ではサポートされていません。 この値はコンテナー・ログ・ソースについてのみ有効で、オプションです。 名前空間を指定しないと、クラスター内のすべての名前空間でこの構成が使用されます。

--hostname LOG_SERVER_HOSTNAME

ログ・コレクター・サーバーのホスト名または IP アドレス。

--port LOG_SERVER_PORT

オプション: ログ・コレクター・サーバーのポート。 ポートを指定しないと、標準ポート 514 が syslog に使用され、標準ポート 9091 が ibm に使用されます。

-p, --app-path

アプリがロギングするコンテナー上のパス。 ソース・タイプが application のログを転送するには、パスを指定する必要があります。 /var/log/*.log のようなワイルドカードは使用できるが、 /var/log/**/test.log のような再帰グ ロブは使用できない。 複数のパスを指定するには、 -p /var/log/myApp1/* -p /var/log/myApp2/* のように複数のオプションを使用する。 この値はログ・ソース application の場合に必須です。

--syslog-protocol

ロギング・タイプが syslog である場合に使用される転送層プロトコル。 サポートされる値は、tcp、tls、およびデフォルトの udp です。 udp プロトコルを使用して rsyslog サーバーに転送する場合、1 KB を超えるログは切り捨てられます。

-C, --app-container

アプリのログを転送するには、アプリが含まれているコンテナーの名前を指定します。 複数のコンテナを指定するには、 -C /var/log/myApp1/* -C /var/log/myApp2/* のように複数のオプションを使用する。 コンテナーを指定しない場合は、指定したパスが入っているすべてのコンテナーのログが転送されます。 このオプションは、ログ・ソース application の場合にのみ有効です。

--skip-validation

オプション: 組織名とスペース名が指定されている場合にそれらの検証をスキップします。 検証をスキップすると処理時間は短縮されますが、ロギング構成が無効な場合、ログは正しく転送されません。

--force-update

Fluentd ポッドを強制的に最新バージョンに更新します。 ロギング構成を変更するには、Fluentd が最新バージョンでなければなりません。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

例:

デフォルト・ポート 514 で syslog ログ・ソースから転送されるログ・タイプ container の例:

ibmcloud ks logging config create my_cluster --logsource container --namespace my_namespace  --hostname 169.xx.xxx.xxx --type syslog

デフォルトではないポートで syslog ソースからログを転送するログ・タイプ ingress の例:

ibmcloud ks logging config create --cluster my_cluster --logsource container --hostname 169.xx.xxx.xxx --port 5514 --type syslog

ibmcloud ks logging config get

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターのログ転送構成をすべて表示するか、またはログ・ソースを基準にロギング構成をフィルタリングします。

ibmcloud ks logging config get --cluster CLUSTER [--logsource LOG_SOURCE] [--output json] [-q]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--logsource LOG_SOURCE

オプション: フィルター操作で取得するログ・ソースの種類。 クラスター内のこのログ・ソースのロギング構成のみが返されます。 指定可能な値は、container、storage、application、worker、kubernetes、および ingress です。

--show-covering-filters

以前のフィルターをサポート対象外にするロギング・フィルターを表示します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks logging config get --cluster my_cluster --logsource worker

ibmcloud ks logging config rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターの 1 つのログ転送構成またはすべてのロギング構成を削除します。 ログ構成を削除すると、リモート syslog サーバーへのログの転送が停止します。

ibmcloud ks logging config rm --cluster CLUSTER (--namespace NAMESPACE --id LOG_CONFIG_ID] [--all] [--force-update] [-q]

最小限必要な許可

クラスタのエディタ・ プラットフォーム・アクセス・ロール

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

-n, --namespace NAMESPACE

ログ転送構成を削除する名前空間。 同じネームスペースに複数のコンフィグがある場合は、代わりに --id <logging_configuration_ID>。

--id LOG_CONFIG_ID

単一のロギング構成を削除する場合は、ロギング構成 ID。

--all

クラスタ内のすべてのロギング設定を削除するオプション。

--force-update

Fluentd ポッドを強制的に最新バージョンに更新します。 ロギング構成を変更するには、Fluentd が最新バージョンでなければなりません。

-q

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

ibmcloud ks logging config rm --cluster my_cluster --id f4bc77c0-ee7d-422d-aabf-a4e6b977264e

ibmcloud ks logging config update

仮想プライベート・クラウド クラシック・インフラストラクチャー

ログ転送構成の詳細を更新します。

ibmcloud ks logging config update --cluster CLUSTER --id LOG_CONFIG_ID --type LOG_TYPE  [--namespace NAMESPACE] [--hostname LOG_SERVER_HOSTNAME_OR_IP] [--port LOG_SERVER_PORT] [--app-paths PATH] [--app-containers PATH] [--output json] [--skipValidation] [--force-update] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--id LOG_CONFIG_ID

必須: 更新するロギング構成 ID。

--type LOG_TYPE

必須: 使用するログ転送プロトコル。 現在、syslog と ibm がサポートされています。

-n, --namespace NAMESPACE

ログの転送元になる Kubernetes 名前空間。 ログ転送は、Kubernetes 名前空間 ibm-system と kube-system ではサポートされていません。 この値は、container ログ・ソースについてのみ有効です。 名前空間を指定しないと、クラスター内のすべての名前空間でこの構成が使用されます。

--hostname LOG_SERVER_HOSTNAME

ログ・コレクター・サーバーのホスト名または IP アドレス。

--port LOG_SERVER_PORT

ログ・コレクター・サーバーのポート。 この値は、ロギング・タイプが syslog の場合にオプションです。 ポートを指定しないと、標準ポート 514 が syslog に使用され、9091 が ibm に使用されます。

-p, --app-path

アプリがロギングするコンテナー上のパス。 ソース・タイプが application のログを転送するには、パスを指定する必要があります。 /var/log/*.log のようなワイルドカードは使用できるが、 /var/log/**/test.log のような再帰グ ロブは使用できない。 複数のパスを指定するには、 -p /var/log/myApp1/* -p /var/log/myApp2/* のように複数のオプションを使用する。 この値はログ・ソース application の場合に必須です。

-C, --app-container

アプリのログを転送するには、アプリが含まれているコンテナーの名前を指定します。 複数のコンテナを指定するには、 -C /var/log/myApp1/* -C /var/log/myApp2/* のように複数のオプションを使用する。 コンテナーを指定しない場合は、指定したパスが入っているすべてのコンテナーのログが転送されます。 このオプションは、ログ・ソース application の場合にのみ有効です。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

--skipValidation

オプション: 組織名とスペース名が指定されている場合にそれらの検証をスキップします。 検証をスキップすると処理時間は短縮されますが、ロギング構成が無効な場合、ログは正しく転送されません。

--force-update

Fluentd ポッドを強制的に最新バージョンに更新します。 ロギング構成を変更するには、Fluentd が最新バージョンでなければなりません。

-q

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

ログ・タイプ ibm の例

ibmcloud ks logging config update --cluster my_cluster --id f4bc77c0-ee7d-422d-aabf-a4e6b977264e --type ibm

ログ・タイプ syslog の例

ibmcloud ks logging config update --cluster my_cluster --id f4bc77c0-ee7d-422d-aabf-a4e6b977264e --hostname localhost --port 5514 --type syslog

ibmcloud ks logging filter create

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

ibmcloud ks logging filter create --cluster CLUSTER --type LOG_TYPE [--logging-config CONFIG] [--namespace KUBERNETES_NAMESPACE] [--container CONTAINER_NAME] [--level LOGGING_LEVEL] [--message MESSAGE] [--regex-message MESSAGE] [--force-update] [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: ロギング・フィルターを作成するクラスターの名前または ID。

--type LOG_TYPE

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

-lc, --logging-config CONFIG

オプション: ロギング構成の ID。 指定しない場合、フィルターに渡されたすべてのクラスター・ロギング構成にフィルターが適用されます。 コマンドで --show-matching-configs オプションを使用すると、フィルターに一致するログ設定を表示できます。 複数のIDを指定するには、 -lc id1 -lc id2 のように複数のオプションを使用する。

-n, --namespace KUBERNETES_NAMESPACE

オプション: ログをフィルタリングする Kubernetes 名前空間。

--container CONTAINER_NAME

オプション: ログをフィルターで除外するコンテナーの名前。 このオプションは、ログタイプ container を使用している場合にのみ適用されます。

--level LOGGING_LEVEL

オプション: 指定したレベル以下のログをフィルターで除外します。 指定できる値は、規定の順に fatal、error、warn/warning、info、debug、trace です。 例えば、info レベルのログをフィルタリングした場合、debug と trace もフィルタリングされます。 注釈 このオプションは、ログ・メッセージが JSON 形式で、レベル・フィールドを含む場合にのみ使 用できます。 出力例 {"log": "hello", "level": "info"}

--message MESSAGE

オプション: 指定したメッセージが含まれているログをフィルターで除外します。 例: メッセージ「Hello」、「!」、および「Hello, World!」は、ログ「Hello, World!」に適用されます。

--regex-message MESSAGE

オプション: ログ内のどこかの場所に正規表現で記述された指定メッセージが含まれるログをすべてフィルターで除外します。 例: パターン「hello [0-9]」は「hello 1」、「hello 2」、および「hello 9」に適用されます。

--force-update

Fluentd ポッドを強制的に最新バージョンに更新します。 ロギング構成を変更するには、Fluentd が最新バージョンでなければなりません。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

例:

この例のフィルターでは、デフォルト名前空間内の test-container という名前のコンテナーから転送された、ログ・メッセージに「GET request」が含まれている、debug レベル以下のすべてのログが除外されます。

ibmcloud ks logging filter create --cluster example-cluster --type container --namespace default --container test-container --level debug --message "GET request"

この例では、特定のクラスターから info レベル以下で転送されるすべてのログがフィルターで除外されます。 出力は JSON として返されます。

ibmcloud ks logging filter create --cluster example-cluster --type all --level info --output json

ibmcloud ks logging filter get

仮想プライベート・クラウド クラシック・インフラストラクチャー

ロギング・フィルター構成を表示します。

ibmcloud ks logging filter get --cluster CLUSTER [--id FILTER_ID] [--show-matching-configs] [--show-covering-filters] [--output json] [-q]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: フィルターを表示するクラスターの名前または ID。

--id FILTER_ID

表示するログ・フィルターの ID。

--show-matching-configs

オプション: 表示している構成と一致するロギング構成を表示します。

--show-covering-filters

オプション: 以前のフィルターをサポート対象外にするロギング・フィルターを表示します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks logging filter get --cluster mycluster --id 885732 --show-matching-configs

ibmcloud ks logging filter rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

ibmcloud ks logging filter rm --cluster CLUSTER [--id FILTER_ID] [--all] [--force-update] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

フィルターを削除するクラスターの名前または ID。

--id FILTER_ID

削除するログ・フィルターの ID。

--all

オプション: すべてのログ転送フィルターを削除します。

--force-update

Fluentd ポッドを強制的に最新バージョンに更新します。 ロギング構成を変更するには、Fluentd が最新バージョンでなければなりません。

-q

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

ibmcloud ks logging filter rm --cluster mycluster --id 885732

ibmcloud ks logging filter update

仮想プライベート・クラウド クラシック・インフラストラクチャー

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

ibmcloud ks logging filter update --cluster CLUSTER --id FILTER_ID --type LOG_TYPE [--logging-config CONFIG] [--namespace KUBERNETES_NAMESPACE] [--container CONTAINER_NAME] [--level LOGGING_LEVEL] [--message MESSAGE] [--regex-message MESSAGE] [--force-update] [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: ロギング・フィルターを更新するクラスターの名前または ID。

--id FILTER_ID

更新するログ・フィルターの ID。

--type LOG_TYPE

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

-lc, --logging-config CONFIG

オプション: ロギング構成の ID。 指定しない場合、フィルターに渡されたすべてのクラスター・ロギング構成にフィルターが適用されます。 コマンドで --show-matching-configs オプションを使用すると、フィルターに一致するログ設定を表示できます。 複数のIDを指定するには、 -lc id1 -lc id2 のように複数のオプションを使用する。

-n, --namespace KUBERNETES_NAMESPACE

オプション: ログをフィルタリングする Kubernetes 名前空間。

--container CONTAINER_NAME

オプション: ログをフィルターで除外するコンテナーの名前。 このオプションは、ログタイプ container を使用している場合にのみ適用されます。

--level LOGGING_LEVEL

オプション: 指定したレベル以下のログをフィルターで除外します。 指定できる値は、規定の順に fatal、error、warn/warning、info、debug、trace です。 例えば、info レベルのログをフィルタリングした場合、debug と trace もフィルタリングされます。 注釈 このオプションは、ログ・メッセージが JSON 形式で、レベル・フィールドを含む場合にのみ使 用できます。 出力例 {"log": "hello", "level": "info"}

--message MESSAGE

オプション: 指定したメッセージが含まれているログをフィルターで除外します。 例: メッセージ「Hello」、「!」、および「Hello, World!」は、ログ「Hello, World!」に適用されます。

--regex-message MESSAGE

オプション: ログ内のどこかの場所に正規表現で記述された指定メッセージが含まれるログをすべてフィルターで除外します。 例: パターン「hello [0-9]」は「hello 1」、「hello 2」、および「hello 9」に適用されます。

--force-update

Fluentd ポッドを強制的に最新バージョンに更新します。 ロギング構成を変更するには、Fluentd が最新バージョンでなければなりません。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

例:

この例のフィルターでは、デフォルト名前空間内の test-container という名前のコンテナーから転送された、ログ・メッセージに「GET request」が含まれている、debug レベル以下のすべてのログが除外されます。

ibmcloud ks logging filter update --cluster example-cluster --id 885274 --type container --namespace default --container test-container --level debug --message "GET request"

この例では、特定のクラスターから info レベル以下で転送されるすべてのログがフィルターで除外されます。 出力は JSON として返されます。

ibmcloud ks logging filter update --cluster example-cluster --id 274885 --type all --level info --output json

ibmcloud ks logging refresh

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターのロギング構成をリフレッシュします。 このアクションは、クラスター内のスペース・レベルに転送を行うすべてのロギング構成のロギング・トークンをリフレッシュします。

このコマンドの別名 logging config refresh は推奨されません。

ibmcloud ks logging refresh --cluster CLUSTER [--force-update] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--force-update

Fluentd ポッドを強制的に最新バージョンに更新します。 ロギング構成を変更するには、Fluentd が最新バージョンでなければなりません。

-q

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

ibmcloud ks logging refresh --cluster my_cluster

ibmcloud ks nlb-dns add

クラシック・インフラストラクチャー

ibmcloud ks nlb-dns create コマンドで作成した既存のサブドメインに、1 つ以上のネットワーク・ロード・バランサー (NLB) の IP アドレスを追加します。

例えば、複数ゾーン・クラシック・クラスターでは、アプリを公開する各ゾーンに NLB を作成する場合があります。 それらの NLB の IP は、ibmcloud ks nlb-dns create classic を実行して 1 つのサブドメインに登録します。 その後、別のゾーンをクラスターに追加し、そのゾーン用に別の NLB を追加します。 このコマンドを使用すれば、その新規 NLB の IP をこの既存のサブドメインに追加できます。 ユーザーがアプリのサブドメインにアクセスすると、クライアントがこれらの IP のいずれかにランダムにアクセスし、要求が NLB に送信されます。

ibmcloud ks nlb-dns add --cluster CLUSTER --ip NLB_IP [--ip NLB2_IP2 --ip NLB3_IP ...] --nlb-host SUBDOMAIN [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--ip NLB_IP

サブドメインに追加する NLB IP アドレス。 NLB IP を表示するには、kubectl get svc を実行します。 複数のIPアドレスを指定するには、複数の --ip。

--nlb-host SUBDOMAIN

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

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns add --cluster mycluster --ip 1.1.1.1 --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns create classic

クラシック・インフラストラクチャー

ネットワーク・ロード・バランサー (NLB) IP を登録する DNS サブドメインを作成することによって、アプリをパブリックに公開します。

ibmcloud ks nlb-dns create classic --cluster CLUSTER --ip NLB_IP [--ip NLB2_IP --ip NLB3_IP ...] [--secret-namespace NAMESPACE] [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--ip IP

登録するネットワーク・ロード・バランサー IP アドレス。 NLB の IP アドレスを表示するには、kubectl get svc を実行します。 複数のIPアドレスを指定するには、複数の --ip。

--secret-namespace NAMESPACE

NLB 用の SSL 証明書情報を保持する Kubernetes シークレットを作成する Kubernetes 名前空間。 名前空間を指定しない場合、シークレットは自動的に default 名前空間で作成されます。

--type public

サブドメイン・タイプ。 現在は、public のみがサポートされています。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns create classic --cluster mycluster --ip 1.1.1.1

ibmcloud ks nlb-dns create vpc-gen2

Virtual Private Cloud

VPC ネットワーク・ロード・バランサーまたは VPC アプリケーション・ロード・バランサーの DNS レコードを作成します。

VPC ネットワーク・ロード・バランサーを作成するときは、クラスター内の各ゾーンの外部 IP アドレスがロード・バランサーに割り当てられます。 VPC アプリケーション・ロード・バランサーを作成するときは、ホスト名がロード・バランサーに割り当てられます。 TLS ターミネーションを使用するアプリ・サブドメインが必要な場合は、ibmcloud ks nlb-dns create vpc-gen2 コマンドを使用して、IP アドレスまたはホスト名に対して DNS レコードを作成します。IBM Cloud は、サブドメインのワイルドカード SSL 証明書の生成と保守を自動的に行います。 パブリックとプライベートの両方の VPC ロード・バランサーのサブドメインを作成できます。

ibmcloud ks nlb-dns create vpc-gen2 --cluster CLUSTER (--lb-host VPC_ALB_HOSTNAME | --ip VPC_NLB_IP) [--secret-namespace NAMESPACE] [--type (public|private)] [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--lb-host VPC_ALB_HOSTNAME | --ip VPC_NLB_IP

VPC アプリケーション・ロード・バランサーの場合は、ロード・バランサーのホスト名。 ロード・バランサーのホスト名を調べるには、kubectl get svc -o wide を実行します。 VPC ネットワーク・ロード・バランサーの場合は、外部 IP アドレス。 複数のIPアドレスを指定するには、複数の --ip。 ロード・バランサーの IP アドレスを調べるには、kubectl get svc -o wide を実行します。

--secret-namespace NAMESPACE

NLB 用の SSL 証明書情報を保持する Kubernetes シークレットを作成する Kubernetes 名前空間。 名前空間を指定しない場合、シークレットは自動的に default 名前空間で作成されます。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns create vpc-gen2 --cluster mycluster --lb-host 1234abcd-us-south.lb.appdomain.cloud --type public

ibmcloud ks nlb-dns get

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスター内の登録済み NLB ホスト名の詳細を表示します。

ibmcloud ks nlb-dns get --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output OUTPUT] [-q]

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--nlb-subdomain SUBDOMAIN

ネットワーク・ロード・バランサー (NLB) IP アドレスが登録されている DNS サブドメイン。 NLB をリストするには、ibmcloud ks nlb-dns ls --cluster mycluster を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns get --cluster mycluster --nlb-subdomain subDomain1

ibmcloud ks nlb-dns ls

クラシック・クラスターでは、DNS サブドメインに登録されているネットワーク・ロード・バランサー (NLB) の IP アドレスをリストします。 VPC クラスターでは、DNS サブドメインに登録されている VPC ロード・バランサーのホスト名をリストします。

ibmcloud ks nlb-dns ls --cluster CLUSTER [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns ls --cluster mycluster

ibmcloud ks nlb-dns monitor configure

クラシック・インフラストラクチャー

クラスター内の既存の NLB サブドメインに対するヘルス・チェック・モニターを構成し、オプションとして有効にします。 サブドメインに対するモニターを有効にすると、モニターによって各ゾーンの NLB IP のヘルス・チェックが行われ、それらのヘルス・チェックに基づいて DNS 参照の結果が最新の状態に保たれます。

このコマンドを使用すると、ヘルス・チェック・モニターを作成して有効にしたり、既存のヘルス・チェック・モニターの設定を更新したりできます。 新しいモニターを作成するには、 --enable オプションと、設定したいすべての設定のオプションを含めます。

既存のモニターを更新するには、既存の設定を含め、希望する設定のすべてのオプションを含める必要があります。

ibmcloud ks nlb-dns monitor configure --cluster CLUSTER --nlb-host SUBDOMAIN [--enable] [--description DESCRIPTION] [--type TYPE] [--method METHOD] [--path PATH] [--timeout TIMEOUT] [--retries RETRIES] [--interval INTERVAL] [--port PORT] [--header HEADER] [--expected-body BODY STRING] [--expected-codes HTTP CODES] [--follows-redirects TRUE] [--allows-insecure TRUE] [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

サブドメインが登録されているクラスターの名前または ID。

--nlb-host SUBDOMAIN

ヘルス・チェック・モニターの構成対象のサブドメイン。 サブドメインをリストするには、ibmcloud ks nlb-dns ls --cluster CLUSTER を実行します。

--enable

サブドメインの新しいヘルスチェックモニタを有効にするには、このオプションを含めます。

--description DESCRIPTION

ヘルス・モニターの説明。

--type TYPE

ヘルス・チェックに使用するプロトコル: HTTP、HTTPS、または TCP。 デフォルト: HTTP

--method METHOD

ヘルス・チェックに使用するメソッド。 type HTTP および HTTPS のデフォルト: GET。 type TCP のデフォルト: connection_established。

--path PATH

type が HTTPS の場合: ヘルス・チェックの対象となるエンドポイント・パス。 デフォルト: /

--timeout TIMEOUT

IP が到達不能と見なされるまでのタイムアウト (秒)。 ヘルス・チェックは、IP への到達を再度試行する前に、interval パラメーターで指定された秒数待機します。 この値は 1 から 15 までの範囲内の整数でなければなりません。 デフォルト：5

--retries RETRIES

タイムアウトが発生したときに、到達不能 IP が正常でないと見なされるまでに再試行する回数。 再試行は即時に実行されます。 この値は 1 から 5 までの範囲内の整数でなければなりません。 デフォルト: 2

--interval INTERVAL

各ヘルス・チェックの間隔 (秒)。 間隔を短くすると、フェイルオーバーの時間が改善される場合がありますが、IP の負荷が増える場合があります。 この値は 10 から 3600 までの範囲内の整数でなければならず、(RETRIES + 1) * TIMEOUT より大きくなければなりません。 デフォルト：60

--port PORT

ヘルス・チェックのために接続するポート番号。 type が TCP の場合、このパラメーターは必須です。 type が HTTP または HTTPS の場合、80 (HTTP の場合) または 443 (HTTPS の場合) 以外のポートを使用する場合にのみポートを定義します。 TCP のデフォルト: 0。 HTTP のデフォルト: 80。 HTTPS のデフォルト: 443。

--header HEADER

type が HTTP または HTTPS である場合: 正常性検査で送信する HTTP 要求ヘッダー (ホスト・ヘッダーなど)。 User-Agent ヘッダーはオーバーライドできません。 このオプションは、タイプ「 HTTP 」または「 HTTPS 」に対してのみ有効である。 リクエストに複数のヘッダーを追加するには、このオプションを複数回 指定する。 このオプションは以下のフォーマットで値を受け付ける： --header Header-Name=value. モニターを更新する際に、既存のヘッダーは指定したヘッダーに置き換えられます。 既存のヘッダーをすべて削除するには、オプションに空の値 --header "" を指定します。

--expected-body BODY STRING

type が HTTP または HTTPS の場合: ヘルス・チェックが応答本体で検索する大/小文字を区別しないサブストリング。 このストリングが検出されない場合、IP が正常でないと見なされます。

--expected-codes HTTP CODES

type が HTTP または HTTPS の場合: ヘルス・チェックが応答内で検索する HTTP コード。 HTTP コードが検出されない場合、IP が正常でないと見なされます。 デフォルト: 2xx

--allows-insecure TRUE

type が HTTP または HTTPS の場合: 証明書を検証しない場合は true に設定します。

--follows-redirects TRUE

type が HTTP または HTTPS の場合: IP によって返されたすべてのリダイレクトに従う場合は、true に設定します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns monitor configure --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud --enable --description "Login page monitor" --type HTTPS --method GET --path / --timeout 5 --retries 2 --interval 60  --expected-body "healthy" --expected-codes 2xx --follows-redirects true

ibmcloud ks nlb-dns monitor disable

クラシック・インフラストラクチャー

クラスター内のサブドメインに対する既存のヘルス・チェック・モニターを無効にします。

ibmcloud ks nlb-dns monitor disable --cluster CLUSTER --nlb-host SUBDOMAIN [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--nlb-host SUBDOMAIN

モニターによるヘルス・チェック対象のサブドメイン。 サブドメインをリストするには、ibmcloud ks nlb-dns ls --cluster CLUSTER を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns monitor disable --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns monitor enable

クラシック・インフラストラクチャー

構成した既存のヘルス・チェック・モニターを有効にします。

ヘルス・チェック・モニターを初めて作成するとき、それを構成して有効化するために、ibmcloud ks nlb-dns monitor configure コマンドを使用する必要があります。 ibmcloud ks nlb-dns monitor enable コマンドは、構成済みだがまだ有効にしていないモニターを有効にする場合や、前に無効にしたモニターを再度有効にする場合にのみ使用してください。

ibmcloud ks nlb-dns monitor enable --cluster CLUSTER --nlb-host SUBDOMAIN [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--nlb-host SUBDOMAIN

モニターによるヘルス・チェック対象のサブドメイン。 サブドメインをリストするには、ibmcloud ks nlb-dns ls --cluster CLUSTER を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns monitor enable --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns monitor get

クラシック・インフラストラクチャー

既存のヘルス・チェック・モニターの設定を表示します。

ibmcloud ks nlb-dns monitor get --cluster CLUSTER --nlb-host SUBDOMAIN [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--nlb-host SUBDOMAIN

モニターによるヘルス・チェック対象のサブドメイン。 サブドメインをリストするには、ibmcloud ks nlb-dns ls --cluster CLUSTER を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns monitor get --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns monitor ls

クラシック・インフラストラクチャー

クラスター内の NLB サブドメインごとのヘルス・チェック・モニターの設定をリストします。

ibmcloud ks nlb-dns monitor ls --cluster CLUSTER [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns monitor ls --cluster mycluster

ibmcloud ks nlb-dns replace

Virtual Private Cloud

DNS サブドメインに登録されているロード・バランサーのホスト名を置き換えます。 例えば、アプリ用に新しい VPC ロード・バランサーを作成したが、ユーザーがアプリにアクセスするために使用できる新しい DNS サブドメインを作成したくない場合は、古いロード・バランサーのホスト名を新しいロード・バランサーのホスト名で置き換えます。

ibmcloud ks nlb-dns replace --cluster CLUSTER --lb-host NEW_LB_HOSTNAME --nlb-subdomain SUBDOMAIN [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--lb-host NEW_LB_HOSTNAME

サブドメインの更新後の新しい VPC ロード・バランサーのホスト名。 VPC ロード・バランサーのホスト名を調べるには、kubectl get svc -o wide を実行します。

nlb-subdomain SUBDOMAIN

ロード・バランサーのホスト名を置き換える DNS サブドメイン。 既存のサブドメインを表示するには、ibmcloud ks nlb-dns ls --cluster <cluster> を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns replace --cluster mycluster --lb-host 1234abcd-us-south.lb.appdomain.cloud nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns rm classic

クラシック・インフラストラクチャー

サブドメインからネットワーク・ロード・バランサー (NLB) の IP アドレスを削除します。 サブドメインからすべての IP を削除してもサブドメインは引き続き存在しますが、そのサブドメインに関連付けられている IP はなくなります。 注: 削除する IP アドレスごとに、以下のコマンドを実行する必要があります。

ibmcloud ks nlb-dns rm classic --cluster CLUSTER --ip IP --nlb-host SUBDOMAIN [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--ip IP

削除する NLB IP。 各サブドメインに登録されている IP を表示するには、 ibmcloud ks nlb-dns ls --cluster <cluster> を実行します。

--nlb-host SUBDOMAIN

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

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns rm classic --cluster mycluster --ip 1.1.1.1 --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns rm vpc-gen2

Virtual Private Cloud

ロード・バランサーのホスト名 (VPC アプリケーション・ロード・バランサーの場合) または IP アドレス (VPC ネットワーク・ロード・バランサーの場合) をそのロード・バランサーの DNS レコードから削除します。

ホスト名または IP アドレスを削除しても、その DNS サブドメインはまだ存在します。ただし、そのサブドメインにロード・バランサーは登録されていません。

ibmcloud ks nlb-dns rm vpc-gen2 --cluster CLUSTER --nlb-subdomain SUBDOMAIN [ --ip IP] [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--nlb-subdomain SUBDOMAIN

VPC ロード・バランサーのホスト名から関連付けを解除するサブドメイン。 既存のサブドメインを表示するには、ibmcloud ks nlb-dns ls --cluster <cluster> を実行します。

--ip IP

VPC ネットワーク・ロード・バランサーの場合は、削除する IP アドレス。 各サブドメインに登録されている IP を表示するには、 ibmcloud ks nlb-dns ls --cluster <cluster> を実行します。 削除する IP アドレスごとにこのコマンドを繰り返す必要があるということに注意してください。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns rm vpc-gen2 --cluster mycluster --nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

試験版: ibmcloud ks nlb-dns secret regenerate

仮想プライベート・クラウド クラシック・インフラストラクチャー

NLB サブドメインの証明書とシークレットを再生成します。 シークレットの再生成は中断を伴わない処理です。シークレットの再生成中もトラフィックの転送が続けられます。

シークレットの再生成中に Let’s Encrypt の証明書作成が失敗した場合は、10 分間待機した後、再生成が自動的に再試行されます。 シークレットの再生成が完了するまでにさらに 5 分かかるため、プロセス全体で合計 15 分かかることになります。

Let 's Encrypt レート制限を回避するには、1 日に 5 回を超えてシークレットを再生成しないでください。

ibmcloud ks nlb-dns secret regenerate --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--nlb-subdomain SUBDOMAIN

シークレットを再生成するサブドメイン。 サブドメインをリストするには、ibmcloud ks nlb-dns ls --cluster CLUSTER を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns secret regenerate --cluster mycluster --nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

試験版: ibmcloud ks nlb-dns secret rm

仮想プライベート・クラウド クラシック・インフラストラクチャー

NLB サブドメインのシークレットを削除し、これ以降、証明書が更新されないようにします。

サブドメインを使用しなくなった場合やシークレットの所有者が組織を離れる場合には、NLB サブドメインのシークレットを削除できます。

ibmcloud ks nlb-dns secret rm --cluster CLUSTER --nlb-subdomain SUBDOMAIN [-f] [--output json] [-q]

最小限必要な許可

クラスタのエディタプラットフォームアクセスロールを IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--nlb-subdomain SUBDOMAIN

シークレットを削除するサブドメイン。 サブドメインをリストするには、ibmcloud ks nlb-dns ls --cluster CLUSTER を実行します。

-f

オプション: ユーザー・プロンプトなしで強制的にコマンドを実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks nlb-dns secret rm --cluster mycluster --nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

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

--disable-outbound-traffic-protection

クラスター・ワーカーからのパブリック・アウトバウンド・アクセスを許可するには、このオプションを含めます。 デフォルトでは、パブリック・アウトバウンド・アクセスはブロックされる。

-f

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

-q

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

webhook-create コマンドの例

ibmcloud ks webhook-create --cluster my_cluster --level Normal --type slack --url http://github.com/mywebhook

ibmcloud ks api-key info

仮想プライベート・クラウド クラシック・インフラストラクチャー

リージョン内のインフラストラクチャーやリソース・グループなどの特定の要求を認証するために IBM Cloud で使用される IBM Cloud Kubernetes Service Identity and Access Management (IAM) API キーの所有者の名前と E メール・アドレスを表示します。

リソース・グループおよびリージョンに対して別の API キーを作成するには、ibmcloud ks api-key reset コマンドを使用します。

ibmcloud ks credential set コマンドを使用して IBM Cloud インフラストラクチャー資格情報を手動で設定した場合、このコマンドで返される API キーは、インフラストラクチャー許可には使用されません。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

-c, --cluster CLUSTER

必須: クラスターの名前または ID。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks api-key info --cluster my_cluster

ibmcloud ks api-key reset

仮想プライベート・クラウド クラシック・インフラストラクチャー

現在のリソース・グループおよびリージョンのすべてのクラスターに対する要求を認証するためにユーザーの許可として機能する IBM Cloud IAM API キーを作成します。

Block Storage for VPC またはクラスター自動スケーリング機能のアドオンをクラスターで使用する場合は、API キーをリセットした後にアドオン・コントローラー・ポッドを再作成する必要があります。 詳しくは、 Block Storage for VPC API キーのリセット後に PVC の作成が失敗する および API キーのリセット後に自動スケーリングが失敗する を参照してください。

このコマンドを使用する前に、このコマンドを実行するユーザーに必要な IBM Cloud Kubernetes Service 権限と IBM Cloud インフラストラクチャー権限があることを確認してください。 API キーを設定するリソース・グループと地域をターゲットに指定します。 API キーがリセットされると、そのリージョンおよびリソース・グループに使用されていた以前の API キー (存在する場合) は廃止されます。 その後、API キーのリストから古い API キーを削除できます。 APIキーをリセット する 前に、既存のAPIキーを使用する他のサービスがあるかどうかを確認してください。 Secrets Manager.

ibmcloud ks api-key reset --region REGION [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--region REGION

IBM Cloud Kubernetes Service 内のリージョンを指定します (jp-osa、jp-tok、au-syd、eu-de、eu-gb、us-east、または us-south)。

-q

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

ibmcloud ks api-key reset --region us-south

ibmcloud ks credential get

クラシック・インフラストラクチャー

複数の異なる資格情報を使用して IBM Cloud インフラストラクチャー・ポートフォリオにアクセスするように IBM Cloud アカウントをセットアップした場合に、現在ターゲットになっているリージョンとリソース・グループのインフラストラクチャー・ユーザー名を取得します。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

--region REGION

IBM Cloud Kubernetes Service 内のリージョンを指定します (jp-osa、jp-tok、au-syd、eu-de、eu-gb、us-east、または us-south)。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks credential get --region us-south

ibmcloud ks credential set classic

クラシック・インフラストラクチャー

IBM Cloud アカウントを介して IBM Cloud インフラストラクチャー・ポートフォリオにアクセスできるようにするために、リソース・グループとリージョンの資格情報を設定します。

IBM Cloud 従量制課金アカウントがあれば、IBM Cloud インフラストラクチャー・ポートフォリオにデフォルトでアクセスできます。 ただし、インフラストラクチャーを注文するために、別の既存 IBM Cloud インフラストラクチャー・アカウントを使用する場合があります。 このコマンドを使用すると、そのようなインフラストラクチャー・アカウントを IBM Cloud アカウントにリンクできます。

特定のリージョンとリソース・グループに対して IBM Cloud インフラストラクチャーの資格情報が手動で設定されている場合、そのリージョンのそのリソース・グループ内のすべてのクラスターにおいて、それらの資格情報を使用してインフラストラクチャーを注文します。 リソース・グループおよびリージョンに IBM CloudIAM API キーが存在している場合でも、インフラストラクチャー権限を判別するためにこれらの資格情報が使用されます。 資格情報が保管されているユーザーにインフラストラクチャーを注文するために必要な権限がない場合、クラスターを作成したりワーカー・ノードを再ロードしたりするインフラストラクチャー関連のアクションは失敗する可能性があります。

同じ IBM Cloud Kubernetes Service リソース・グループおよびリージョンに対して複数の資格情報を設定することはできません。

このコマンドを使用する前に、使用する資格情報を所有するユーザーに、必要な IBM Cloud Kubernetes Service 権限と IBM Cloud インフラストラクチャー権限があることを確認してください。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--infrastructure-username USERNAME

必須: IBM Cloud インフラストラクチャー・アカウントの API ユーザー名。 インフラストラクチャー API ユーザー名は、IBMid と同じではありません。 インフラストラクチャーの API ユーザー名を表示するには、クラシック・インフラストラクチャー API キーの管理を参照してください。

--infrastructure-api-key API_KEY

必須: IBM Cloud インフラストラクチャー・アカウントの API キー。 インフラストラクチャー API キーを表示または生成するには、クラシック・インフラストラクチャー API キーの管理を参照してください。

--region REGION

IBM Cloud Kubernetes Service 内のリージョンを指定します (jp-osa、jp-tok、au-syd、eu-de、eu-gb、us-east、または us-south)。

-q

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

ibmcloud ks credential set classic --infrastructure-api-key <api_key> --infrastructure-username dbmanager --region us-south

ibmcloud ks credential unset

クラシック・インフラストラクチャー

リソース・グループとリージョンの資格情報を削除することにより、IBM Cloud アカウントを介した IBM Cloud インフラストラクチャー・ポートフォリオへのアクセスができないようにします。

資格情報を削除すると、IBM CloudIAM API キーが、IBM Cloud インフラストラクチャーのリソースの注文に使用されます。

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

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--region REGION

IBM Cloud Kubernetes Service 内のリージョンを指定します (jp-osa、jp-tok、au-syd、eu-de、eu-gb、us-east、または us-south)。

-q

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

ibmcloud ks credential unset --region us-south

ibmcloud ks infra-permissions get

クラシック・インフラストラクチャー

ターゲットのリソース・グループとリージョンの IBM Cloud インフラストラクチャー・ポートフォリオにアクセスできるようにする資格情報に、suggested または required インフラストラクチャー許可が含まれていないかどうかを確認します。

リージョンとリソース・グループのインフラストラクチャー資格情報に許可がない場合、このコマンドの出力は、required 許可と suggested 許可のリストを返します。

• Required: これらの許可は、ワーカー・ノードなどのインフラストラクチャー・リソースを正常に注文および管理するために必要です。 インフラストラクチャー資格情報にこれらの許可のいずれかがない場合、worker reload などの一般的なアクションは、リージョンおよびリソース・グループ内のすべてのクラスターで失敗する可能性があります。
• Suggested: これらの許可はインフラストラクチャー許可に含めるのに役立ち、特定のユース・ケースで必要になる場合があります。 例えば、パブリック・ネットワーキングが必要な場合は、Add Compute with Public Network Port インフラストラクチャー許可が必要になるため、この許可が提案されます。 ただし、ユース・ケースがプライベート VLAN 上のみのクラスターの場合、許可は不要であるため、required とは見なされません。

許可別の一般的なユース・ケースのリストについては、インフラストラクチャー役割を参照してください。

コンソールや インフラストラクチャの役割 テーブルにはないインフラストラクチャの権限がある場合はどうすればよいですか？

Support Case 許可は、コンソールのインフラストラクチャー許可とは異なる部分で管理されています。 インフラストラクチャー許可のカスタマイズ を参照してください。

どのインフラストラクチャ権限を割り当てればよいですか？

会社の許可に関するポリシーが厳密な場合は、クラスターのユース・ケースに対する suggested 許可を制限する必要がある場合があります。 そうでない場合は、リージョンおよびリソース・グループのインフラストラクチャー資格情報に、すべての required 許可と suggested 許可が含まれていることを確認してください。

ほとんどのユース・ケースでは、適切なインフラストラクチャー許可を持つリージョンおよびリソース・グループの API キーをセットアップします。 現在のアカウントとは異なる別のインフラストラクチャー・アカウントを使用する必要がある場合は、手動資格情報をセットアップします。

ユーザーが実行できるアクションを制御するには？

インフラストラクチャー資格情報をセットアップした後、ユーザーが実行できるアクションに IBM Cloud IAM プラットフォーム・アクセス役割を割り当てることによって、これらのアクションを制御できます。

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

最小限必要な許可

クラスタの Viewer プラットフォームアクセスロール IBM Cloud Kubernetes Service

コマンド・オプション：

--region REGION

必須: IBM Cloud Kubernetes Service 内のリージョンを指定します (jp-osa、jp-tok、au-syd、eu-de、eu-gb、us-east、または us-south)。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks infra-permissions get --region us-south

Missing Virtual Worker Permissions

Add Server                    suggested
Cancel Server                 suggested
View Virtual Server Details   required

Missing Physical Worker Permissions

No changes are suggested or required.

Missing Network Permissions

No changes are suggested or required.

Missing Storage Permissions

Add Storage       required
Manage Storage    required

ibmcloud ks kms crk ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

鍵管理サービス・インスタンスで使用できるカスタマー・ルート鍵 (CRK) を表示します。 ルート鍵とは、クラスターのシークレットの暗号化に使用するローカル・データ暗号鍵 (DEK) をラップ/アンラップするための鍵です。 詳しくは、鍵管理サービス (KMS) プロバイダーについてを参照してください。

新しい鍵を使用するためにローテーションを行う場合でも、KMS インスタンスにあるルート鍵は削除しないでください。 クラスターが使用するルート・キーを削除すると、そのクラスターは使用できなくなり、そのクラスターのデータはすべて失われ、そのクラスターはリカバリーできなくなります。

ibmcloud ks kms crk ls --instance-id KMS_INSTANCE_ID [--output json] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service の ビューアー のプラットフォーム・アクセス役割

コマンド・オプション：

--instance-id KMS_INSTANCE_ID

ルート鍵を表示する鍵管理サービス・インスタンスの ID。 使用可能な KMS インスタンスを確認するには、ibmcloud ks kms instance ls を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks kms crk ls --instance-id 1aa1a111-1111-1111-a111-a1aaaa1a1a1a

ibmcloud ks kms enable

仮想プライベート・クラウド クラシック・インフラストラクチャー

クラスターで鍵管理サービス (KMS) プロバイダーを有効にして、Kubernetes シークレットを暗号化します。 既存の鍵の暗号化でクラスターの鍵を交替させるには、新規ルート鍵 ID を使用してこのコマンドを再実行します。

新しい鍵を使用するためにローテーションを行う場合でも、KMS インスタンスにあるルート鍵は削除しないでください。 クラスターが使用するルート・キーを削除すると、そのクラスターは使用できなくなり、そのクラスターのデータはすべて失われ、そのクラスターはリカバリーできなくなります。 ルート鍵をローテーションする場合は、同じクラスターに対して以前のルート鍵を再使用できません。

ibmcloud ks kms enable --cluster CLUSTER_NAME_OR_ID --instance-id KMS_INSTANCE_ID --crk ROOT_KEY_ID [--kms-account-id ID] [--public-endpoint] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service のクラスターに対する管理者のプラットフォーム・アクセス役割

コマンド・オプション：

--container, -c CLUSTER_NAME_OR_ID

クラスターの名前または ID。

--instance-id KMS_INSTANCE_ID

クラスターでシークレットの暗号化に使用する KMS インスタンスの ID。 使用可能な KMS インスタンスを確認するには、ibmcloud ks kms instance ls を実行します。

--crk ROOT_KEY_ID

クラスターのローカルに保管されるデータ暗号鍵 (DEK) をラップするために使用する、KMS インスタンスにあるカスタマー・ルート鍵 (CRK) の ID。 使用可能なルート鍵を確認するには、ibmcloud ks kms crk ls --instance-id <kms_instance_id> を実行します。

--kms-account-id ID

オプション：ローカルディスクまたは秘密の暗号化に使用するKMSインスタンスを含むアカウントのID。

--public-endpoint

オプション: KMS のパブリックのクラウド・サービス・エンドポイントを使用する場合は、このオプションを指定します。 このオプションを含めない場合、プライベート・クラウド・サービスのエンドポイントがデフォルトで使用されます。

-q

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

ibmcloud ks kms enable -c mycluster --instance-id a11aa11a-bbb2-3333-d444-e5e555e5ee5 --crk 1a111a1a-bb22-3c3c-4d44-55e555e55e55

ibmcloud ks kms instance ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

IBM Cloud、クラスターで有効化することを選択できる、利用可能な 鍵管理サービス（KMS）インスタンスの 一覧を表示します。

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

最小限必要な許可

IBM Cloud Kubernetes Service の ビューアー のプラットフォーム・アクセス役割

コマンド・オプション：

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

例:

ibmcloud ks kms instance ls

ibmcloud ks quota ls

仮想プライベート・クラウド クラシック・インフラストラクチャー

IBM Cloud アカウント内のクラスター関連リソースのすべての割り当て量と制限をリストします。

ibmcloud ks quota ls [--provider PROVIDER] [--output json]

最小限必要な許可

IBM Cloud Kubernetes Service に対するビューアー・プラットフォーム・アクセス役割

コマンド・オプション：

--provider (classic | vpc-gen2)

割り当て量と制限をリストするインフラストラクチャー・プロバイダー・タイプ。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

例:

ibmcloud ks quota ls

ibmcloud ks vlan ls

クラシック・インフラストラクチャー

あるゾーンにおいて、クラシック IBM Cloud インフラストラクチャー・アカウントで使用可能なパブリック VLAN とプライベート VLAN をリストします。 使用可能な VLAN をリストするには、有料アカウントが必要です。

ibmcloud ks vlan ls --zone ZONE [--all] [--output json] [-q]

最小限必要な許可:

• ゾーン内のクラスター接続先 VLAN を表示する場合: IBM Cloud Kubernetes Service 内のクラスターに対するビューアーのプラットフォーム・アクセス役割
• ゾーン内の使用可能な VLAN をすべてリストする場合: IBM Cloud Kubernetes Service 内のリージョンに対するビューアーのプラットフォーム・アクセス役割

コマンド・オプション：

--zone ZONE

必須: プライベート VLAN とパブリック VLAN をリストする対象のゾーンを入力します。 使用可能なゾーンを表示するには、ibmcloud ks zone ls を実行します。

--all

使用可能なすべての VLAN をリストします。 デフォルトでは、VLAN はフィルタリングされて、有効な VLAN のみが表示されます。 VLAN が有効であるためには、ローカル・ディスク・ストレージを持つワーカーをホストできるインフラストラクチャーに VLAN が関連付けられている必要があります。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks vlan ls --zone dal10

ibmcloud ks vlan spanning get

クラシック・インフラストラクチャー

IBM Cloud インフラストラクチャー・アカウントの VLAN スパンニングの状況を表示します。 VLAN スパンニングは、アカウント上のすべてのデバイスが、割り当てられている VLAN に関係なく、プライベート・ネットワークを介して相互に通信できるようにします。

VLAN スパンニング・オプションは、VRF 対応アカウントで作成されるクラスターでは無効になっています。 VRF が有効であれば、自動的にアカウント内のすべての VLAN がプライベート・ネットワーク経由で相互に通信できることになります。 VRF が有効になっているかどうかを確認するには、ibmcloud account show コマンドを使用します。 詳しくは、クラスター・ネットワークのセットアップの計画: ワーカー間の通信を参照してください。

ibmcloud ks vlan spanning get --region REGION [--output json] [-q]

最小限必要な許可

IBM Cloud Kubernetes Service に対するビューアー・プラットフォーム・アクセス役割

コマンド・オプション：

--region REGION

IBM Cloud Kubernetes Service 内のリージョンを指定します (jp-osa、jp-tok、au-syd、eu-de、eu-gb、us-east、または us-south)。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks vlan spanning get --region us-south

コマンド・オプション

--output OUTPUT

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

VPC インフラストラクチャーのプロバイダー・タイプ。 サポートされる値は、vpc-classic および vpc-gen2 です。 デフォルトでは、すべてのプロバイダー・タイプの VPC が返されます。

-q

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

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

-f

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

-q

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

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

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

-f

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

-q

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

flavor get コマンド

仮想プライベート・クラウド クラシック・インフラストラクチャー

ゾーンおよびプロバイダーのフレーバーの情報を取得します。

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

最小限必要な許可

なし

コマンド・オプション：

--flavor FLAVOR

情報を取得する対象のフレーバー。 フレーバーによって、各ワーカー・ノードで使用可能な仮想 CPU、メモリー、およびディスク・スペースの容量が決定されます。

--provider PROVIDER

フレーバー情報を取得する対象のインフラストラクチャー・プロバイダー。 利用可能なオプションは classic、 vpc-classic 、 vpc-gen2。

--zone ZONE

フレーバー情報を取得する対象のゾーン。 クラシック・クラスターに使用可能なゾーンを表示するには、ibmcloud ks zone ls を実行します。 第 2 世代コンピュートの場合、VPC クラスターで使用できるゾーンを表示するには、ibmcloud ks zone ls --provider vpc-gen2 を実行します。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks flavor get --zone us-south-1 --provider vpc-gen2 --flavor bx2d.48x192.900gb

flavor ls コマンド

仮想プライベート・クラウド クラシック・インフラストラクチャー

ゾーンで使用可能なフレーバーをリストします。

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

最小限必要な許可

なし

コマンド・オプション：

--zone ZONE

フレーバー情報を取得する対象のゾーン。 クラシック・クラスターに使用可能なゾーンを表示するには、ibmcloud ks zone ls を実行します。 第 2 世代コンピュートの場合、VPC クラスターで使用できるゾーンを表示するには、ibmcloud ks zone ls --provider vpc-gen2 を実行します。

--provider PROVIDER

オプション: フレーバー情報を取得する対象のインフラストラクチャー・プロバイダー。 利用可能なオプションは classic、 vpc-classic 、 vpc-gen2。

--show-os

オプション：サポート対象のオペレーティングシステムを列挙する。

--show-storage

オプション: SDS ワーカー・ノード・フレーバーで使用できる追加のロー・ディスクを表示します。 詳しくは、ソフトウェア定義ストレージ (SDS) マシンを参照してください。 各都市部の表では、SDSのフレーバーはベアメタルのタブにあり、.ssd で終わっている。

--output json

オプション: コマンド出力を JSON フォーマットで出力します。

-q

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

ibmcloud ks flavor ls --zone us-south-1 --provider vpc-gen2 --show-os --show-storage