Tanzu Kubernetes Grid サービス v1alpha1 API を使用する Tanzu Kubernetes クラスタの構成パラメータ

Tanzu Kubernetes Grid サービス宣言型 API は、Tanzu Kubernetes クラスタを構成するためのパラメータをいくつか公開しています。クラスタをプロビジョニングおよびカスタマイズするには、すべてのパラメータのリストと説明、および使用に関するガイドラインを参照してください。

Tanzu Kubernetes クラスタをプロビジョニングするための注釈付き YAML

注釈付き YAML には、 Tanzu Kubernetes クラスタをプロビジョニングする際に使用可能なすべてのパラメータと、各フィールドの概要コメントが示されています。

注：クラスタをプロビジョニングする場合は、注釈付き YAML は検証されません。このガイダンスの例については、 Tanzu Kubernetes Grid サービス v1alpha1 API を使用した Tanzu Kubernetes クラスタのプロビジョニングの例を参照してください。

apiVersion: run.tanzu.vmware.com/v1alpha1
kind: TanzuKubernetesCluster
metadata:
  name: <tanzu kubernetes cluster name>
  namespace: <vsphere namespace where the cluster will be provisioned>
spec:
  distribution:
    version: <tanzu kubernetes release version string: full, point, short>      
  topology:                               
    controlPlane:
      count: <integer either 1 or 3>
      class: <vm class bound to the target vsphere namespace>
      storageClass: <vsphere storage policy bound to the target vsphere namespace>
      volumes: #optional setting for high-churn control plane component (such as etcd)
        - name: <user-defined string>
          mountPath: </dir/path>
          capacity:
            storage: <size in GiB> 
    workers:                              
      count: <integer from 0 to 150>
      class: <vm class bound to the target vsphere namespace>
      storageClass: <vsphere storage policy bound to the target vsphere namespace>
      volumes: #optional setting for high-churn worker node component (such as containerd)
        - name: <user-defined string>
          mountPath: </dir/path>
          capacity:
            storage: <size in GiB>              
  settings: #all spec.settings are optional
    storage: #optional storage settings
      classes: [<array of kubernetes storage classes for dynamic pvc provisioning>]
      defaultClass: <default kubernetes storage class>
    network: #optional network settings
      cni: #override default cni set in the tkgservicesonfiguration spec
        name: <antrea or calico>
      pods: #custom pod network
        cidrBlocks: [<array of pod cidr blocks>]
      services: #custom service network
        cidrBlocks: [<array of service cidr blocks>]
      serviceDomain: <custom service domain>
      proxy: #proxy server for outbound connections
        httpProxy: http://<IP:PORT> 
        httpsProxy: http://<IP:PORT>
        noProxy: [<array of CIDRs to not proxy>]
      trust: #trust fields for custom public certs for tls
        additionalTrustedCAs:
          - name: <first-cert-name>
            data: <base64-encoded string of PEM encoded public cert 1>
          - name: <second-cert-name>
            data: <base64-encoded string of PEM encoded public cert 2>

Tanzu Kubernetes クラスタをプロビジョニングするためのパラメータ

次の表に、Tanzu Kubernetes クラスタのプロビジョニングに使用できるすべてのパラメータおよび使用できる値のリストと説明を示します。例については、Tanzu Kubernetes Grid サービス v1alpha1 API の構成の例を参照してください。

表 1. Tanzu Kubernetes クラスタをプロビジョニングするためのパラメータ
名前	値	説明
`apiVersion`	`run.tanzu.vmware.com/v1alpha1`	Tanzu Kubernetes Grid サービス API のバージョンを指定します。
`kind`	`TanzuKubernetesCluster`	作成する Kubernetes リソースのタイプを指定します。使用できる値は `TanzuKubernetesCluster` のみです（大文字と小文字を区別）。
`metadata`	クラスタメタデータのセクション	`name` や `namespace` などのクラスタメタデータが含まれています。これは標準の Kubernetes メタデータであるため、`name` の代わりに `generateName` を使用したり、ラベルや注釈を追加したりすることができます。
`name`	英数字とダッシュを使用するユーザー定義の文字列（例：`my-tkg-cluster-1`）	作成するクラスタの名前を指定します。現在のクラスタの名前付けの制約：名前の長さは 41 文字以内にする必要があります。名前は文字で始まる必要があります。名前には、文字、数字、ハイフンを含めることができます。名前は文字または数字で終わる必要があります。
`namespace`	英数字とダッシュを使用するユーザー定義の文字列（例：`my-sns-1`）	クラスタがデプロイされるスーパーバイザーネームスペースの名前を識別します。これは、スーパーバイザークラスタ内にあるスーパーバイザーネームスペースへの参照です。
`spec`	クラスタの技術仕様のセクション	ノードの `toplogy` や Kubernetes ソフトウェアの `distribution` など、クラスタのエンド状態の仕様を宣言型形式で示します。
`distribution`	Tanzu Kubernetes リリースのバージョンを指定するセクション	クラスタのディストリビューションを指定します。これは、制御プレーンとワーカーノードにインストールされている Tanzu Kubernetes クラスタソフトウェアで、Kubernetes 自体も含みます。
`version`	Kubernetes のバージョンを表す、ダッシュを含む英数字の文字列（例：`v1.20.2+vmware.1-tkg.1`、`v1.20.2`、`v1.20`）	セマンティックなバージョン表記を使用して、クラスタノードにインストールする Kubernetes ディストリビューションのソフトウェアバージョンを指定します。完全修飾バージョンを指定するか、ショートカットを使用することができます。「version: v1.20.2」は、そのパッチバージョンに一致する最新のイメージに解決され、「version: v1.20」は該当する最新のパッチバージョンに解決されます。クラスタの作成後、その説明に解決後のバージョンが「fullVersion」として表示されます。
`topology`	クラスタノードトポロジのセクション	クラスタノードの数、目的、および編成と、それぞれに割り当てられたリソースを示すフィールドを含んでいます。クラスタノードは、目的に応じて `control-plane` または `worker` のプールにグループ化されます。各プールは同種で、同じリソース割り当てを持ち、同じストレージを使用します。
`controlPlane`	制御プレーン設定のセクション	ノードの数 (`count`)、仮想マシンのタイプ (`class`)、各ノードに割り当てられるストレージリソース (`storageClass`) など、クラスタ制御プレーンのトポロジを指定します。
`count`	`1` または `3` のいずれかの整数	制御プレーンノードの数を指定します。制御プレーンには奇数個のノードが必要です。
`class`	列挙セットからの文字列形式のシステム定義要素（例：`guaranteed-small`、`best-effort-large`）	プール内の各ノードで使用される仮想ハードウェア設定を示す VirtualMachineClass の名前を指定します。これにより、ノード（CPU とメモリ）で使用できるハードウェア、およびこれらのリソースの要求と制限が制御されます。Tanzu Kubernetes クラスタの仮想マシンのクラスを参照してください。
`storageClass`	`node-storage`（例）	制御プレーンノードのルートファイルシステムを格納するディスクのストレージに使用されるストレージクラスを識別します。使用可能なストレージクラスを表示するには、名前空間で `kubectl describe ns` を実行します。名前空間で使用可能なストレージクラスは、vSphere 管理者が設定するストレージによって異なります。スーパーバイザーネームスペースに関連付けられているストレージクラスがクラスタに複製されます。つまり、ストレージクラスがこのフィールドで有効な値になるためには、スーパーバイザーネームスペースで使用できる必要があります。vSphere 名前空間の構成と管理を参照してください。
`volumes`	オプションのストレージ設定 volumes： name：`string` mountPath：`/dir/path` キャパシティ storage：GiB サイズ	制御プレーンノードの etcd のディスクとストレージのパラメータを個別に指定できます。ディスクパラメータとストレージパラメータを個別に使用するクラスタの例を参照してください。
`workers`	ワーカーノード設定のセクション	ノードの数 (`count`)、仮想マシンのタイプ (`class`)、各ノードに割り当てられるストレージリソース (`storageClass`) など、クラスタワーカーノードのトポロジを指定します。
`count`	0 ～ 150 の整数（例：`1`、`2`、`7`）	クラスタ内のワーカーノードの台数を指定します。ワーカーノード数がゼロのクラスタを作成することで、制御プレーンノードのみを持つクラスタを使用できます。ワーカーノードの数には、厳密な上限はありませんが、妥当な制限は 150 です。注： 0 台のワーカーノードを使用してプロビジョニングされたクラスタには、ロードバランササービスが割り当てられません。
`class`	列挙セットからの文字列形式のシステム定義要素（例：`guaranteed-small`、`best-effort-large`）	プール内の各ノードで使用される仮想ハードウェア設定を示す VirtualMachineClass の名前を指定します。これにより、ノード（CPU とメモリ）で使用できるハードウェア、およびこれらのリソースの要求と制限が制御されます。Tanzu Kubernetes クラスタの仮想マシンのクラスを参照してください。
`storageClass`	`node-storage`（例）	ワーカーノードのルートファイルシステムを格納するディスクのストレージに使用されるストレージクラスを識別します。使用可能なストレージクラスを一覧表示するには、名前空間で `kubectl describe ns` を実行します。名前空間で使用可能なストレージクラスは、vSphere 管理者が設定するストレージによって異なります。スーパーバイザーネームスペースに関連付けられているストレージクラスがクラスタに複製されます。つまり、有効にするためには、スーパーバイザーネームスペースでストレージクラスを使用できる必要があります。vSphere 名前空間の構成と管理を参照してください。
`volumes`	オプションのストレージ設定 volumes： name：`string` mountPath：`/dir/path` キャパシティ storage：GiB サイズ	ワーカーノードのコンテナイメージのディスクとストレージのパラメータを個別に指定できます。ディスクパラメータとストレージパラメータを個別に使用するクラスタの例を参照してください。
`settings`	クラスタ固有の設定に関するセクション（すべての `spec.settings` はオプション）	クラスタのランタイム構成情報（オプション）を識別します。これには、ノードの `network` の詳細とポッドのパーシステント `storage` が含まれます。
`storage`	ストレージを指定するセクション	コンテナワークロードのパーシステントボリューム (PV) ストレージエントリを識別します。
`classes`	1 つ以上のユーザー定義文字列の配列（例：`["gold", "silver"]`）	コンテナワークロードの名前付きパーシステントボリューム (PV) ストレージクラスを指定します。スーパーバイザーネームスペースに関連付けられているストレージクラスがクラスタに複製されます。つまり、有効な値であるためには、スーパーバイザーネームスペースでストレージクラスを使用できる必要があります。ストレージクラスとパーシステントボリュームのデフォルトクラスを使用するクラスタの例を参照してください。
`defaultClass`	`silver`（例）	クラスタ内でデフォルトとして注釈が付けられる名前付きストレージクラスを指定します。これを指定しないと、デフォルトはありません。`defaultClass` を指定するために 1 つまたは複数の `classes` を指定する必要はありません。一部のワークロードでは、Helm などのデフォルトクラスが必要な場合があります。ストレージクラスとパーシステントボリュームのデフォルトクラスを使用するクラスタの例を参照してください。
`network`	ネットワーク設定のセクションマーカー	クラスタのネットワーク関連の設定を指定します。
`cni`	CNI を指定するためのセクションマーカー	クラスタのコンテナネットワークインターフェイス (CNI) プラグインを識別します。デフォルトは Antrea です。新しいクラスタに指定する必要はありません。
`name`	文字列 `antrea` または `calico`	使用する CNI を指定します。Antrea と Calico がサポートされています。システム構成により、Antrea がデフォルトの CNI として設定されます。デフォルトの CNI は変更できます。デフォルトを使用する場合、このフィールドを指定する必要はありません。
`services`	Kubernetes サービスサブネットを指定するセクションマーカー	Kubernetes サービスのネットワーク設定を識別します。デフォルトは 10.96.0.0/12 です。
`cidrBlocks`	配列 `["198.51.100.0/12"]`（例）	Kubernetes サービスで使用する IP アドレスの範囲を指定します。デフォルトは 10.96.0.0/12 です。スーパーバイザークラスタ用に選択された設定と重複しないようにしてください。このフィールドは複数の範囲を指定できる配列ですが、現在は IP アドレス範囲を 1 つのみ使用できます。Tanzu Kubernetes Grid サービス v1alpha1 API を使用した Tanzu Kubernetes クラスタのプロビジョニングの例のネットワークの例を参照してください。
`pods`	Kubernetes ポッドのサブネットを指定するセクションマーカー	ポッドのネットワーク設定を指定します。デフォルトは 192.168.0.0/16 です。最小ブロックサイズは /24 です。
`cidrBlocks`	配列 `["192.0.2.0/16"]`（例）	Kubernetes ポッドで使用する IP アドレスの範囲を指定します。デフォルトは 192.168.0.0/16 です。スーパーバイザークラスタ用に選択された設定と重複しないようにしてください。ポッドのサブネットサイズは /24 以上にする必要があります。このフィールドは複数の範囲を指定できる配列ですが、現在は IP アドレス範囲を 1 つのみ使用できます。Tanzu Kubernetes Grid サービス v1alpha1 API を使用した Tanzu Kubernetes クラスタのプロビジョニングの例のネットワークの例を参照してください。
`serviceDomain`	`"cluster.local"`	クラスタのサービスドメインを指定します。デフォルトは `cluster.local` です。
`proxy`	クラスタの HTTP(S) プロキシ設定を指定するセクション。実装されている場合は、すべてのフィールドが必須です。	指定したプロキシ設定のフィールドに入力します。グローバルプロキシが設定され、クラスタプロキシが個別に設定されていない場合は、自動的にポピュレートされます。プロキシサーバを使用するクラスタの例を参照してください。
`httpProxy`	`http://<user>:<pwd>@<ip>:<port>`	クラスタ外の HTTP 接続の作成に使用するプロキシ URL を指定します。
`httpsProxy`	`http://<user>:<pwd>@<ip>:<port>`	クラスタ外の HTTPS 接続の作成に使用するプロキシ URL を指定します。
`noProxy`	プロキシにしない CIDR ブロックの配列（`[10.246.0.0/16,192.168.144.0/20,192.168.128.0/20]` など）。スーパーバイザークラスタのワークロードネットワークから必要な値を取得します（`Pod CIDRs`、`Ingress CIDRs`、および `Egress CIDRs`）。 `noProxy` 配列フィールドに含める値については、次の図を参照してください。	スーパーバイザークラスタ上のワークロードネットワークで使用されるサブネット（ポッド、Ingress、および Egress）をプロキシにすることはできません。 `noProxy` フィールドにスーパーバイザークラスタのサービス CIDR を含める必要はありません。Tanzu Kubernetes クラスタは、これらのサービスと連携しません。エンドポイント `localhost` と `127.0.0.1` は自動的にプロキシされません。これらを `noProxy` フィールドに追加する必要はありません。 Tanzu Kubernetes クラスタのポッド CIDR およびサービス CIDR は、自動的にプロキシされません。これらを `noProxy` フィールドに追加する必要はありません。プロキシサーバを使用するクラスタの例を参照してください。
`trust`	`trust` パラメータのセクションマーカー。	データを受け入れない。
`additionalTrustedCAs`	`name` と `data` の証明書の配列をそれぞれ受け入れます。	データを受け入れない。
`name`	文字列	TLS 証明書の名前。
`data`	文字列	PEM でエンコードされたパブリック証明書の base64 エンコード文字列。

図に示すように、スーパーバイザークラスタの [ワークロードネットワーク] から必要な noProxy 値を取得します。

[ワークロードネットワーク] ウィンドウ。[ポッド CIDR]、[Ingress CIDR]、[Egress CIDR]の値が強調表示されています。