管理クラスタの構成ファイル

このページでは、GKE on VMware の管理クラスタ構成ファイルのフィールドについて説明します。

構成ファイルのテンプレートの生成

gkeadm を使用して管理ワークステーションを作成した場合、gkeadm により管理クラスタの構成ファイル用のテンプレートが生成されます。また、gkeadm によって一部のフィールドに入力されます。

管理ワークステーションの作成に gkeadm を使用していない場合、gkectl を使用して管理クラスタの構成ファイルのテンプレートを生成できます。

管理クラスタの構成ファイルのテンプレートを生成するには:

gkectl create-config admin --config=OUTPUT_FILENAME --gke-on-prem-version=VERSION

OUTPUT_FILENAME は、生成されたテンプレートの任意のパスに置き換えます。このフラグを省略すると、gkectl はファイルに admin-cluster.yaml という名前を付け、現在のディレクトリに配置します。

VERSION を必要なバージョン番号に置き換えます。バージョン番号は、gkectl 以降のバージョンにする必要があります。例: gkectl create-config admin --gke-on-prem-version=1.6.2-gke.0このフラグを省略すると、生成された構成テンプレートには、最新のクラスタバージョンに基づく値が入力されます。

テンプレート

クリックすると、生成されたテンプレートが表示されます。

apiVersion: v1
kind: AdminCluster
# (Optional) A unique name for this admin cluster. This will default to a random name
# prefixed with 'gke-admin-'
name: ""
# (Required) Absolute path to a GKE bundle on disk
bundlePath: ""
# # (Optional/Preview) Specify the prepared secret configuration which can be added
# # or edited only during cluster creation
# preparedSecrets:
#   # enable prepared credentials for the admin cluster; it is immutable
#   enabled: false
# (Required) vCenter configuration
vCenter:
  address: ""
  datacenter: ""
  cluster: ""
  # Resource pool to use. Specify [VSPHERE_CLUSTER_NAME]/Resources to use the default
  # resource pool
  resourcePool: ""
  datastore: ""
  # Provide the path to vCenter CA certificate pub key for SSL verification
  caCertPath: ""
  # The credentials to connect to vCenter
  credentials:
    # reference to external credentials file
    fileRef:
      # read credentials from this file
      path: ""
      # entry in the credential file
      entry: ""
  # (Optional) vSphere folder where cluster VMs will be located. Defaults to the
  # datacenter wide folder if unspecified.
  folder: ""
  # # (Only used in 1.16 and older versions for non-HA admin cluster) Provide the name
  # # for the persistent disk to be used by the deployment (ending in .vmdk). Any directory
  # # in the supplied path must be created before deployment. Required for non-HA admin
  # # cluster. Invalid for HA admin cluster as the path is generated automatically under
  # # the root directory "anthos" in the specified datastore.
  # dataDisk: ""
# (Required) Network configuration
network:
  # (Required when using "static" ipMode.type; or "Seesaw" loadBalancer.kind; or using
  # amdin cluster HA mode) This section overrides ipMode.ipBlockFilePath values when
  # ipMode.type=static. It's also used for seesaw nodes
  hostConfig:
    # List of DNS servers
    dnsServers:
    - ""
    # List of NTP servers
    ntpServers:
    - ""
    # # List of DNS search domains
    # searchDomainsForDNS:
    # - ""
  ipMode:
    # (Required) Define what IP mode to use ("dhcp" or "static")
    type: dhcp
    # # (Required when using "static" mode) The absolute or relative path to the yaml file
    # # to use for static IP allocation. Hostconfig part will be overwritten by network.hostconfig
    # # if specified
    # ipBlockFilePath: ""
  # (Required) The Kubernetes service CIDR range for the cluster. Must not overlap
  # with the pod CIDR range
  serviceCIDR: 10.96.232.0/24
  # (Required) The Kubernetes pod CIDR range for the cluster. Must not overlap with
  # the service CIDR range
  podCIDR: 192.168.0.0/16
  vCenter:
    # vSphere network name
    networkName: ""
  # (Required for HA admin cluster) Specify the IPs to use for control plane machines
  # for HA admin cluster.
  controlPlaneIPBlock:
    netmask: ""
    gateway: ""
    ips:
    - ip: ""
      hostname: ""
    - ip: ""
      hostname: ""
    - ip: ""
      hostname: ""
# (Required) Load balancer configuration
loadBalancer:
  # (Required) The VIPs to use for load balancing
  vips:
    # Used to connect to the Kubernetes API
    controlPlaneVIP: ""
  # (Required) Which load balancer to use "F5BigIP" "Seesaw" "ManualLB" or "MetalLB".
  # Uncomment the corresponding field below to provide the detailed spec
  kind: MetalLB
  # # (Required when using "ManualLB" kind) Specify pre-defined nodeports
  # manualLB:
  #   # NodePort for ingress service's http (only needed for user cluster)
  #   ingressHTTPNodePort: 0
  #   # NodePort for ingress service's https (only needed for user cluster)
  #   ingressHTTPSNodePort: 0
  #   # NodePort for konnectivity server service (only needed for controlplane v1 user
  #   # cluster)
  #   konnectivityServerNodePort: 0
  #   # NodePort for control plane service (not needed for HA admin cluster or controlplane
  #   # V2 user cluster)
  #   controlPlaneNodePort: 30968
  # # (Required when using "F5BigIP" kind) Specify the already-existing partition and
  # # credentials
  # f5BigIP:
  #   address: ""
  #   credentials:
  #     # reference to external credentials file
  #     fileRef:
  #       # read credentials from this file
  #       path: ""
  #       # entry in the credential file
  #       entry: ""
  #   partition: ""
  #   # # (Optional) Specify a pool name if using SNAT
  #   # snatPoolName: ""
  # # (Only used in 1.16 and older versions for using "Seesaw" kind) Specify the Seesaw
  # # configs
  # seesaw:
  #   # (Required) The absolute or relative path to the yaml file to use for IP allocation
  #   # for LB VMs. Must contain one or two IPs. Hostconfig part will be overwritten by
  #   # network.hostconfig if specified.
  #   ipBlockFilePath: ""
  #   # (Required) The Virtual Router IDentifier of VRRP for the Seesaw group. Must be
  #   # between 1-255 and unique in a VLAN.
  #   vrid: 0
  #   # (Required) The IP announced by the master of Seesaw group
  #   masterIP: ""
  #   # (Required) The number CPUs per machine
  #   cpus: 2
  #   # (Required) Memory size in MB per machine
  #   memoryMB: 3072
  #   # (Optional) Network that the LB interface of Seesaw runs in (default: cluster network)
  #   vCenter:
  #     # vSphere network name
  #     networkName: ""
  #   # (Optional) Run two LB VMs to achieve high availability (default: false)
  #   enableHA: false
  #   # (Optional) Avoid using VRRP MAC and rely on gratuitous ARP to do failover. In
  #   # this mode MAC learning is not needed but the gateway must refresh arp table based
  #   # on gratuitous ARP. It's recommended to turn this on to avoid MAC learning configuration.
  #   # In vsphere 7+ it must be true to enable HA. It is supported in GKE on-prem version
  #   # 1.7+. (default: false)
  #   disableVRRPMAC: true
# Spread admin addon nodes and user masters across different physical hosts (requires
# at least three hosts)
antiAffinityGroups:
  # Set to false to disable DRS rule creation
  enabled: true
# (Optional) Specify the admin master node configuration which can be added or edited
# only during cluster creation (default: 4 CPUs; 16384 MB memory; 3 replicas)
adminMaster:
  cpus: 4
  memoryMB: 16384
  # How many machines of this type to deploy
  replicas: 3
# # (Only used in 1.16 and older versions) Specify the addon node configuration which
# # can be added or edited only during cluster creation
# addonNode:
#   # Enable auto resize for addon node
#   autoResize:
#     # Whether to enable auto resize for master. Defaults to false.
#     enabled: false
# (Optional) Specify the proxy configuration
proxy:
  # The URL of the proxy
  url: ""
  # The domains and IP addresses excluded from proxying
  noProxy: ""
# # (Optional) Use a private registry to host GKE images
# privateRegistry:
#   # Do not include the scheme with your registry address
#   address: ""
#   credentials:
#     # reference to external credentials file
#     fileRef:
#       # read credentials from this file
#       path: ""
#       # entry in the credential file
#       entry: ""
#   # The absolute or relative path to the CA certificate for this registry
#   caCertPath: ""
# (Required): The absolute or relative path to the GCP service account key for pulling
# GKE images
componentAccessServiceAccountKeyPath: ""
# (Required) Specify which GCP project to register your GKE OnPrem cluster to
gkeConnect:
  projectID: ""
  # # (Optional) The location of the GKE Hub and Connect service where the cluster is
  # # registered to. It can be any GCP region or "global". Default to "global" when unspecified.
  # location: us-central1
  # The absolute or relative path to the key file for a GCP service account used to
  # register the cluster
  registerServiceAccountKeyPath: ""
# # (Optional) Specify if you wish to explicitly enable/disable the cloud hosted gkeonprem
# # API to enable/disable cluster lifecycle management from gcloud UI and Terraform.
# gkeOnPremAPI:
#   enabled: false
# (Required) Specify which GCP project to connect your logs and metrics to
stackdriver:
  # The project ID for logs and metrics. It should be the same with gkeconnect.projectID.
  projectID: ""
  # A GCP region where you would like to store logs and metrics for this cluster.
  clusterLocation: us-central1
  enableVPC: false
  # The absolute or relative path to the key file for a GCP service account used to
  # send logs and metrics from the cluster
  serviceAccountKeyPath: ""
  # (Optional) Disable vsphere resource metrics collection from vcenter.  False by
  # default
  disableVsphereResourceMetrics: false
# (Optional) Configure kubernetes apiserver audit logging
cloudAuditLogging:
  # The project ID for logs and metrics. It should be the same with gkeconnect.projectID.
  projectID: ""
  # A GCP region where you would like to store audit logs for this cluster.
  clusterLocation: us-central1
  # The absolute or relative path to the key file for a GCP service account used to
  # send audit logs from the cluster
  serviceAccountKeyPath: ""
# # (Optional/Preview) Configure backups for admin cluster. Backups will be stored under
# # /anthos-backups/.
# clusterBackup:
#   # # datastore where admin cluster backups are desired
#   # datastore: ""
# Enable auto repair for the cluster
autoRepair:
  # Whether to enable auto repair feature. Set false to disable.
  enabled: true
# # Encrypt Kubernetes secrets at rest
# secretsEncryption:
#   # Secrets Encryption Mode. Possible values are: GeneratedKey
#   mode: GeneratedKey
#   # GeneratedKey Secrets Encryption config
#   generatedKey:
#     # # key version
#     # keyVersion: 1
#     # # disable secrets encryption
#     # disabled: false
# (Optional) Specify the type of OS image; available options can be set to "ubuntu_containerd"
# "cos" "ubuntu_cgv2" or "cos_cgv2". Default is "ubuntu_containerd".
osImageType: ""

構成ファイルの入力

次のセクションで説明するように、構成ファイルでフィールド値を入力します。

`name`

省略可
文字列
デフォルト: 接頭辞「gke-admin-」が付いたランダムな名前

クラスタに付ける名前。

例:

name: "my-admin-cluster"

`bundlePath`

必須
変更可
文字列

GKE on VMware バンドルファイルのパス。

GKE on VMware のフルバンドルファイルには、GKE on VMware の特定のリリースのすべてのコンポーネントが含まれています。管理ワークステーションを作成すると、フルバンドルが次の場所に追加されます。

/var/lib/gke/bundles/gke-onprem-vsphere-VERSION-full.tgz

例:

bundlePath: "/var/lib/gke/bundles/gke-onprem-vsphere-1.10.0-gke.8.full.tgz"

`preparedSecrets.enabled`

プレビュー
省略可
不変
ブール値
事前入力: false
デフォルト: false

管理クラスタで準備された認証情報を使用する場合は、これを true に設定します。それ以外の場合は、false に設定します。

例:

preparedSecrets:
  enabled: true

`vCenter`

必須
不変

このセクションには、vSphere 環境と vCenter Server への接続に関する情報を掲載しています。

`vCenter.address`

必須
不変
文字列

vCenter Server の IP アドレスまたはホスト名。

詳細については、vCenter Server アドレスの確認をご覧ください。

例:

vCenter:
  address: "203.0.113.100"

vCenter:
  address: "my-vcenter-server.my-domain.example"

`vCenter.datacenter`

必須
不変
文字列

vSphere データセンターの相対パス。

指定する値は、/ という名前のルートフォルダを基準とします。

データセンターがルートフォルダにある場合、値はデータセンターの名前です。

例:

vCenter:
  datacenter: "my-data-center"

それ以外の場合は、値は 1 つ以上のフォルダとデータセンターの名前を含む相対パスになります。

例:

vCenter:
  datacenter: "data-centers/data-center-1"

`vCenter.cluster`

必須
不変
文字列

管理クラスタ VM を実行する ESXi ホストを表す vSphere クラスタの相対パス。この vSphere クラスタは、vCenter データセンターの物理 ESXi ホストのサブセットを表します。

指定する値は、/.../DATA_CENTER/vm/ を基準とします。

vSphere クラスタが /.../DATA_CENTER/vm/ フォルダにある場合、値は vSphere クラスタの名前です。

例:

vCenter:
  cluster: "my-vsphere-cluster"

それ以外の場合、値は 1 つ以上のフォルダと vSphere クラスタの名前を含む相対パスになります。

例:

vCenter:
  cluster: "clusters/vsphere-cluster-1"

`vCenter.resourcePool`

必須
不変
文字列

管理クラスタ VM の vCenter リソースプール。

デフォルトのリソースプールを使用する場合は、これを VSPHERE_CLUSTER/Resources に設定します。

例:

vCenter:
  resourcePool: "my-vsphere-cluster/Resources"

すでに作成したリソースプールを使用する場合は、これにリソースプールの相対パスを設定します。

指定する値は /.../DATA_CENTER/host/.../VSPHERE_CLUSTER/Resources/ を基準とします。

リソースプールが /.../DATA_CENTER/host/.../VSPHERE_CLUSTER/Resources/ の直接の子である場合、値はリソースプールの名前です。

例:

vCenter:
  resourcePool: "my-resource-pool"

それ以外の場合、値は 2 つ以上のリソースプールを含む相対パスです。

例:

vCenter:
  resourcePool: "resource-pool-1/resource-pool-2"

`vCenter.datastore`

必須
不変
文字列

管理クラスタの vSphere データストアの名前。

指定する値はパスではなく名前にする必要があります。値にフォルダを含めないでください。

例:

vCenter:
  datastore: "my-datastore"

このフィールドの値を指定する場合は、vCenter.storagePolicyName の値を指定しないでください。

`vCenter.storagePolicyName`

省略可
文字列

クラスタノードの VM ストレージポリシーの名前。

ストレージポリシーを使用するには、管理クラスタが高可用性（HA）である必要があります。

詳細については、ストレージポリシーを構成するをご覧ください。

このフィールドの値を指定する場合は、vCenter.datastore の値を指定しないでください。

`vCenter.caCertPath`

必須
変更可
文字列

vCenter Server の CA 証明書のパス。

詳細については、vCenter CA 証明書の取得をご覧ください。

既存のクラスタのこのフィールドを更新する方法については、vCenter 証明書の参照を更新するをご覧ください。

例:

vCenter:
  caCertPath: "/usr/local/google/home/me/certs/vcenter-ca-cert.pem"

`vCenter.credentials.fileRef.path`

必須
文字列

vCenter ユーザーアカウントのユーザー名とパスワードを保持する認証情報構成ファイルのパス。ユーザーアカウントには管理者ロールまたは同等の権限が必要です。vSphere の要件をご覧ください。

gkectl update を使用すると、既存のクラスタのこのフィールドを更新できます。

vCenter 認証情報を更新する方法については、クラスタ認証情報の更新をご覧ください。

例:

vCenter:
  credentials:
    fileRef:
      path: "my-config-folder/admin-creds.yaml"

`vCenter.credentials.fileRef.entry`

必須
文字列

vCenter ユーザーアカウントのユーザー名とパスワードを保持する認証情報構成ファイルにある認証情報ブロックの名前。

gkectl update を使用すると、既存のクラスタのこのフィールドを更新できます。

vCenter 認証情報を更新する方法については、クラスタ認証情報の更新をご覧ください。

例:

vCenter:
  credentials:
    fileRef:
      entry: "vcenter-creds"

`vCenter.folder`

省略可
不変
文字列
デフォルト: データセンター全体のフォルダ

すでに作成した vSphere フォルダの相対パス。このフォルダは、管理クラスタ VM を保持します。

値を指定しない場合、管理クラスタ VM は /.../DATA_CENTER/vm/ に配置されます。

値を指定すると、/.../DATA_CENTER/vm/ を基準とします。

値にはフォルダの名前を指定できます。

例:

vCenter:
  folder: "my-folder"

複数のフォルダを含む相対パスを値に指定することもできます。

例:

vCenter:
  folder: "folders/folder-1"

`vCenter.dataDisk`

このフィールドには値を指定しないでください。フィールドを削除するか、コメントアウトしたままにします。

`network`

必須
不変

このセクションには、管理クラスタネットワークに関する情報が含まれます。

`network.hostConfig`

必須
不変

このセクションには、クラスタノードである VM で使用される NTP サーバー、DNS サーバー、DNS 検索ドメインに関する情報を掲載しています。

`network.hostConfig.dnsServers`

network.hostConfig セクションに値が入力されている場合は必須です。
不変
文字列の配列。
配列内の要素の最大数は 3 つです。

VM の DNS サーバーのアドレス。

例:

network:
  hostConfig:
    dnsServers:
    - "172.16.255.1"
    - "172.16.255.2"

`network.hostConfig.ntpServers`

network.hostConfig セクションに値が入力されている場合は必須です。
不変
文字列の配列

VM が使用する時刻サーバーのアドレス。

例:

network:
  hostConfig:
    ntpServers:
    - "216.239.35.0"

`network.hostConfig.searchDomainsForDNS`

省略可
不変
文字列の配列

VM が使用する DNS 検索ドメイン。これらのドメインは、ドメイン検索リストの一部として使用されます。

例:

network:
  hostConfig:
    searchDomainsForDNS:
    - "my.local.com"

`network.ipMode.type`

必須
不変
文字列
事前入力: 「dhcp」
デフォルト: 「dhcp」

クラスタノードが DHCP サーバーから IP アドレスを取得するようにするには、これを "dhcp" に設定します。クラスタノードに、指定したリストから静的 IP アドレスを選択させる場合は、これを "static" に設定します。

例:

network:
  ipMode:
    type: "static"

`network.ipMode.ipBlockFilePath`

network.ipMode.type = static の場合は必須
不変
文字列

クラスタの IP ブロックファイルのへのパス。

例:

network:
  ipMode:
    ipBlockFilePath: "/my-config-folder/admin-cluster-ipblock.yaml"

`network.serviceCIDR`

必須
不変
文字列
可能な最小範囲: /24
可能な最大範囲: /12
事前入力: 「10.96.232.0/24」
デフォルト: 「10.96.232.0/24」

クラスタ内の Service に使用される IP アドレスの範囲（CIDR 形式）。

例:

network:
  serviceCIDR: "10.96.232.0/24"

`network.podCIDR`

必須
不変
文字列
可能な最小範囲: /18
可能な最大範囲: /8
事前入力: 「192.168.0.0/16」
デフォルト: 「192.168.0.0/16」

クラスタ内の Pod に使用される IP アドレスの範囲（CIDR 形式）。

例:

network:
  podCIDR: "192.168.0.0/16"

Service の範囲が Pod の範囲と重複しないようにする必要があります。

Service と Pod の範囲は、クラスタ内から到達可能にする必要があるクラスタ外のアドレスと重複しないようにしてください。

たとえば、Service の範囲が 10.96.232.0/24、Pod の範囲が 192.168.0.0/16 であるとします。Pod からいずれかの範囲のアドレスに送信されたトラフィックは、クラスタ内として扱われ、クラスタ外の宛先に到達しません。

特に、Service と Pod の範囲が次の対象と重複しないようにする必要があります。

任意のクラスタ内に存在するノードの IP アドレス
ロードバランサマシンで使用される IP アドレス
コントロールプレーンノードとロードバランサで使用される VIP
vCenter Server、DNS サーバー、NTP サーバーの IP アドレス

Service と Pod の範囲は RFC 1918 アドレス空間にすることをおすすめします。

RFC 1918 アドレスを使用することが推奨される理由の 1 つは次のとおりです。Pod または Service の範囲に外部 IP アドレスが含まれているとします。Pod からそれらの外部アドレスのいずれかに送信されたトラフィックは、クラスタ内トラフィックとして扱われ、外部の宛先に到達しません。

`network.vCenter.networkName`

必須
不変
文字列

クラスタノードの vSphere ネットワークの名前。

例:

network:
  vCenter:
    networkName: "my-network"

名前に特殊文字が含まれる場合は、エスケープシーケンスを使用する必要があります。

特殊文字	エスケープシーケンス
スラッシュ（`/`）	`%2f`
バックスラッシュ（`\`）	`%5c`
パーセント記号（`%`）	`%25`

データセンター内でネットワーク名が一意でない場合は、フルパスを指定できます。

例:

network:
  vCenter:
    networkName: "/data-centers/data-center-1/network/my-network"

`network.controlPlaneIPBlock`

必須

`network.controlPlaneIPBlock.netmask`

必須
不変
文字列

コントロールプレーンノードを持つネットワークのネットマスク。

例:

network:
  controlPlaneIPBlock:
    netmask: "255.255.255.0"

`network.controlPlaneIPBlock.gateway`

必須
不変
文字列

コントロールプレーンノードのデフォルトゲートウェイの IP アドレス。

例:

network:
  controlPlaneIPBlock:
    gateway: "172.16.22.1"

`network.controlPlaneIPBlock.ips`

必須
不変
それぞれが IP アドレスとオプションのホスト名を持つ 3 つのオブジェクトの配列。

これらは、コントロールプレーンノードに割り当てられる IP アドレスです。

例:

network:
  controlPlaneIPBlock:
    ips:
    - ip: "172.16.22.6"
      hostname: "admin-cp-vm-1"
    - ip: "172.16.22.7"
      hostname: "admin-cp-vm-2"
    - ip: "172.16.22.8"
      hostname: "admin-cp-vm-3"

`loadBalancer`

このセクションでは、管理クラスタのロードバランサに関する情報について説明します。

`loadBalancer.vips.controlPlaneVIP`

必須
不変
文字列

管理クラスタの Kubernetes API サーバー用にロードバランサで構成するために選択した IP アドレス。

例:

loadBalancer:
  vips:
    controlplaneVIP: "203.0.113.3"

`loadBalancer.kind`

必須
不変
文字列
事前入力:「MetalLB」

文字列。これを "ManualLB"、"F5BigIP"、"MetalLB" のいずれかに設定する

例:

loadBalancer:
  kind: "MetalLB"

`loadBalancer.manualLB`

loadbalancer.kind を "ManualLB" に設定した場合は、このセクションに入力します。それ以外の場合は、このセクションを削除します。
不変

`loadBalancer.manualLB.ingressHTTPNodePort`

このフィールドを構成ファイルから削除します。管理クラスタでは使用されません。

`loadBalancer.manualLB.ingressHTTPSNodePort`

このフィールドを構成ファイルから削除します。管理クラスタでは使用されません。

`loadBalancer.manualLB.konnectivityServerNodePort`

このフィールドを構成ファイルから削除します。管理クラスタでは使用されません。

`loadBalancer.f5BigIP`

loadbalancer.kind を "f5BigIP" に設定した場合は、このセクションに入力します。それ以外の場合は、このセクションを削除します。

`loadBalancer.f5BigIP.address`

loadBalancer.kind = "f5BigIp" の場合は必須
不変
文字列

F5 BIG-IP ロードバランサのアドレス。次に例を示します。

loadBalancer:
  f5BigIP:
    address: "203.0.113.2"

`loadBalancer.f5BigIP.credentials.fileRef.path`

loadBalancer.kind の場合は必須 = "f5BigIp"
変更可
文字列

GKE on VMware が F5 BIG-IP ロードバランサへの接続に使用できるアカウントの、ユーザー名とパスワードを保持する認証情報構成ファイルのパス。

ユーザーアカウントには、ロードバランサの設定と管理を行うために十分な権限を持つユーザーロールが必要です。管理者ロールまたはリソース管理者ロールのどちらかで十分です。

gkectl update を使用すると、既存のクラスタのこのフィールドを更新できます。

F5 BIG-IP 認証情報を更新する方法については、クラスタ認証情報の更新をご覧ください。

例:

loadBalancer:
  f5BigIP:
    credentials:
      fileRef:
        path: ""my-config-folder/admin-creds.yaml"

`loadBalancer.f5BigIP.credentialsfileRef.entry`

loadBalancer.kind の場合は必須 = "f5BigIp"
変更可
文字列

F5 BIG-IP アカウントのユーザー名とパスワードを保持する認証情報構成ファイルにある認証情報ブロックの名前。

gkectl update を使用すると、既存のクラスタのこのフィールドを更新できます。

F5 BIG-IP 認証情報を更新する方法については、クラスタ認証情報の更新をご覧ください。

例:

loadBalancer:
  f5BigIP:
    credentials:
      fileRef:
        entry: "f5-creds"

`loadBalancer.f5BigIP.partition`

loadBalancer.kind = "f5BigIp" の場合は必須
不変
文字列

管理クラスタ用に作成した BIG-IP パーティションの名前。

例:

loadBalancer:
  f5BigIP:
    partition: "my-f5-admin-partition"

`loadBalancer.f5BigIP.snatPoolName`

省略可
loadBalancer.kind = "f5BigIp" の場合に関連
不変
文字列

SNAT を使用している場合は、SNAT プールの名前。SNAT を使用していない場合は、このフィールドを削除します。

例:

loadBalancer:
  f5BigIP:
    snatPoolName: "my-snat-pool"

`loadBalancer.seesaw`

このセクションは使用しないでください。Seesaw ロードバランサは、バージョン 1.28 の新しい管理クラスタではサポートされていません。

1.16 から 1.28 にアップグレードされたクラスタの Seesaw は引き続きサポートされます。たとえば、Seesaw を使用する 1.16 の非 HA 管理クラスタがあるとします。クラスタを 1.28 にアップグレードした後も、非 HA コントロールプレーンと Seesaw ロードバランサは引き続き使用できます。Seesaw ロードバランサの詳細については、1.16 のドキュメントをご覧ください。

`antiAffinityGroups.enabled`

省略可
変更可
ブール値
事前入力: true

DRS ルールの作成を有効にするには、この値を true に設定します。それ以外の場合は false に設定します。

例:

antiAffinityGroups:
  enabled: true

このフィールドが true の場合、GKE on VMware は管理クラスタのノードに対して VMware Distributed Resource Scheduler（DRS）の反アフィニティルールを作成し、それらをデータセンターの少なくとも 3 つの物理 ESXi ホストに分散させます。

この機能を使用するには、vSphere 環境が次の条件を満たしている必要があります。

VMware DRS が有効になっていること。VMware DRS には、vSphere Enterprise Plus ライセンスエディションが必要です。
vSphere ユーザーアカウントに Host.Inventory.Modify cluster 権限があること。
利用可能なホストが少なくとも 4 つ存在すること。

このルールでは、クラスタノードを 3 つの ESXi ホストに分散させることが要件ですが、少なくとも 4 つの ESXi ホストを利用できるようにすることを強くおすすめします。これにより、管理クラスタのコントロールプレーンが失われなくなります。たとえば、ESXi ホストが 3 つだけで、管理クラスタのコントロールプレーンノードが障害が発生した ESXi ホストにあるとします。DRS ルールにより、残りの 2 つの ESXi ホストのいずれにもコントロールプレーンノードは配置されなくなります。

前述のとおり、vSphere スタンダードライセンスがある場合、VMware DRS を有効にすることはできません。

DRS が有効になっていない場合や、vSphere VM をスケジュール設定できるホストが 4 つ以上ない場合は、antiAffinityGroups.enabled を false に設定します。

`adminMaster`

不変

管理クラスタ内のコントロールプレーンノードの構成設定。

`adminMaster.cpus`

プレビュー
省略可
不変
整数
事前入力: 4
デフォルト: 4

管理クラスタ内の各コントロールプレーンノードの vCPU 数。

例:

adminMaster:
  cpus: 4

`adminMaster.memoryMB`

プレビュー
省略可
不変
整数
事前入力: 16384
デフォルト: 16384

管理クラスタ内の各コントロールプレーンノードのメモリ容量（メビバイト）。

例:

adminMaster:
  memoryMB: 16384

`adminMaster.replicas`

新しいクラスタの場合は必須
不変
整数
有効な値: 3

管理クラスタ内のコントロールプレーンノードの数。新しい管理クラスタを作成する場合は、このフィールドを 3 に設定して高可用性（HA）管理クラスタを作成します。

例:

adminMaster:
  replicas: 3

`proxy`

ネットワークがプロキシサーバーの背後にある場合は、このセクションに入力します。それ以外の場合は、このセクションを削除するか、コメントアウトしたままにします。ここで指定するプロキシサーバーは、この管理クラスタが管理するユーザークラスタで使用されます。
不変

`proxy.url`

proxy セクションに値が入力されている場合は必須です。
不変
文字列

プロキシサーバーの HTTP アドレス。スキームのデフォルトポートと同じ場合でも、ポート番号を含めます。

例:

proxy:
  url: "http://my-proxy.example.local:80"

ここで指定するプロキシサーバーは、GKE on VMware クラスタで使用されます。また、管理ワークステーションで HTTPS_PROXY 環境変数を設定しない限り、管理ワークステーションはこの同じプロキシサーバーを使用するように自動的に構成されます。

proxy.url を指定する場合は、proxy.noProxy も指定する必要があります。

管理クラスタのプロキシ構成を設定した後は、クラスタを再ビルドしない限り、構成の変更や削除はできません。

`proxy.noProxy`

省略可
不変
文字列

プロキシサーバーを経由しない IP アドレス、IP アドレス範囲、ホスト名、ドメイン名のカンマ区切りのリスト。GKE on VMware がこれらのアドレス、ホスト、ドメインのいずれかにリクエストを送信する場合、そのリクエストは直接送信されます。

例:

proxy:
  noProxy: "10.151.222.0/24,my-host.example.local,10.151.2.1"

`privateRegistry`

非公開の Container Registry がある場合は、このセクションに入力します。それ以外の場合は、このセクションを削除するか、コメントアウトしたままにします。

`privateRegistry.address`

非公開レジストリの場合は必須
不変
文字列

非公開レジストリを実行するマシンの IP アドレスまたは FQDN（完全修飾ドメイン名）。

例:

privateRegistry:
  address: "203.0.113.10"

privateRegistry:
  address: "fqdn.example.com"

`privateRegistry.credentials.fileRef.path`

非公開レジストリの場合は必須
変更可
文字列

GKE on VMware が非公開レジストリへのアクセスに使用できるアカウントのユーザー名とパスワードを保持する認証情報構成ファイルのパス。

例:

privateRegistry:
  credentials:
    fileRef:
      path: "my-config-folder/admin-creds.yaml"

`privateRegistry.credentials.fileRef.entry`

非公開レジストリの場合は必須
変更可
文字列

非公開レジストリのアカウントのユーザー名とパスワードを保持する認証情報構成ファイルにある認証情報ブロックの名前。

privateRegistry:
  credentials:
    fileRef:
      entry: "private-registry-creds"

`privateRegistry.caCertPath`

非公開レジストリの場合は必須
変更可
文字列

コンテナランタイムが非公開レジストリからイメージを pull する場合、レジストリは証明書を提示して自身の ID を証明する必要があります。レジストリの証明書は、認証局（CA）によって署名されます。コンテナランタイムは、CA 証明書を使用してレジストリの証明書を検証します。

このフィールドを CA 証明書のパスに設定します。

例:

privateRegistry:
  caCertPath: "my-cert-folder/registry-ca.crt"

`componentAccessServiceAccountKeyPath`

必須
変更可
文字列

コンポーネントアクセスサービスアカウントの JSON キーファイルのパス。

例:

componentAccessServiceAccountKeyPath: "my-key-folder/access-key.json"

`gkeConnect`

必須
変更可

gkeConnect セクションに入力すると、管理クラスタは作成後にフリートに自動的に登録されます。このセクションには、クラスタの登録に必要な Google Cloud プロジェクトとサービスアカウントに関する情報が含まれます。

クラスタの作成または更新時に、管理クラスタにいくつかの RBAC ポリシーが構成されます。これらの RBAC ポリシーは、Google Cloud コンソールでユーザークラスタを作成するために必要です。

`gkeConnect.projectID`

必須
不変
文字列

フリートホストプロジェクトの ID。新しいクラスタの場合、このプロジェクト ID は、stackdriver.projectID と cloudAuditLogging.projectID で設定した ID と同じである必要があります。プロジェクト ID が同じでない場合、クラスタの作成は失敗します。この要件は、既存のクラスタには適用されません。

例:

gkeConnect:
  projectID: "my-fleet-host-project"

`gkeConnect.location`

省略可
不変
文字列
デフォルト: グローバル

各クラスタのフリートメンバーシップは、Fleet サービス（gkehub.googleapis.com）と Connect サービス（gkeconnect.googleapis.com）で管理されます。サービスのロケーションは、グローバルにもリージョンにもできます。1.28 以降では、必要に応じて、Fleet と Connect サービスが実行される Google Cloud リージョンを指定できます。指定しない場合は、サービスのグローバルインスタンスが使用されます。次の点にご注意ください。

1.28 より前に作成された管理クラスタは、グローバルの Fleet と Connect サービスによって管理されます。
新しいクラスタの場合、このフィールドを指定する場合、指定するリージョンは cloudAuditLogging.clusterLocation、stackdriver.clusterLocation、gkeOnPremAPI.location　に構成されたリージョンと同じでなければなりません。リージョンが同じでない場合、クラスタの作成は失敗します。

例:

gkeConnect:
  location: "us-central1"

`gkeConnect.registerServiceAccountKeyPath`

必須
変更可
文字列

接続登録サービスアカウントの JSON 鍵ファイルのパス。

例:

gkeConnect:
  registerServiceAccountKeyPath: "my-key-folder/connect-register-key.json"

`gkeOnPremAPI`

省略可
。

1.16 以降では、Google Cloud プロジェクトで GKE On-Prem API が有効になっている場合、プロジェクト内のすべてのクラスタが、stackdriver.clusterLocation で構成されたリージョンの GKE On-Prem API に登録（自動的に）されます。

GKE On-Prem API のプロジェクトにすべてのクラスタを登録する場合は、始める前にの手順に沿って、プロジェクト内の GKE On-Prem API を有効にしてから使用します。
GKE On-Prem API にクラスタを登録しない場合は、このセクションを追加して、gkeOnPremAPI.enabled を false に設定します。プロジェクトにクラスタを登録しない場合は、プロジェクトで gkeonprem.googleapis.com（GKE On-Prem API のサービス名）を無効にします。手順については、サービスの無効化をご覧ください。

GKE On-Prem API に管理クラスタを登録すると、Google Cloud コンソール、Google Cloud CLI、Terraform といった標準的なツールを使用して、管理クラスタが管理するユーザークラスタをアップグレードできます。クラスタを登録すると、gcloud コマンドを実行してクラスタに関する情報を取得することもできます。

このセクションを追加して管理クラスタを作成または更新した後、セクションを削除してクラスタを更新すると、更新が失敗します。

`gkeOnPremAPI.enabled`

gkeOnPremAPI セクションが含まれている場合は必須です。
変更可
ブール値
デフォルト: true

デフォルトでは、プロジェクトで GKE On-Prem API が有効になっている場合、クラスタは Anthos On-Prem API に登録されます。クラスタを登録しない場合は、false に設定します。

クラスタを GKE On-Prem API に登録した後、クラスタの登録を解除する必要がある場合は、次の変更を行い、クラスタを更新します。

gkeOnPremAPI:
  enabled: false

`gkeOnPremAPI.location`

不変
文字列
デフォルト: stackdriver.clusterLocation

GKE On-Prem API が実行され、クラスタメタデータが保存される Google Cloud リージョン。サポートされているリージョンのいずれかを選択します。cloudAuditLogging.clusterLocation、gkeConnect.location、stackdriver.clusterLocation に構成されているものと同じリージョンを使用する必要があります。gkeOnPremAPI.enabled が false の場合、このフィールドを含めないでください。

`stackdriver`

デフォルトは必須
変更可

クラスタに対して Cloud Logging と Cloud Monitoring を有効にする場合は、このセクションに入力します。それ以外の場合は、このセクションを削除します。

デフォルトでは、このセクションは必須です。つまり、このセクションを含めない場合は、gkectl create admin を実行する際に --skip-validation-stackdriver フラグを含める必要があります。

このセクションは、GKE On-Prem API クライアントを使用するユーザークラスタのライフサイクルを管理する場合に管理クラスタで必要です。

`stackdriver.projectID`

Logging と Monitoring の場合は必須
不変
文字列

フリートホストプロジェクトの ID。新しいクラスタの場合、このプロジェクト ID は、gkeConnect.projectID と cloudAuditLogging.projectID で設定した ID と同じである必要があります。プロジェクト ID が同じでない場合、クラスタの作成は失敗します。この要件は、既存のクラスタには適用されません。

必要に応じて、このプロジェクトのログルーターを構成して、別のプロジェクトのログバケットにログをルーティングできます。ログルーターの構成方法については、サポートされる宛先をご覧ください。

例:

stackdriver:
  projectID: "my-fleet-host-project"

`stackdriver.clusterLocation`

Logging と Monitoring の場合は必須
不変
文字列
事前入力: 「us-central1」

ログを保存する Google Cloud リージョン。お使いのオンプレミスデータセンターの近くのリージョンを選択することをおすすめします。

新しいクラスタの場合、構成ファイルで gkeOnPremAPI セクションと cloudAuditLogging セクションを設定すれば、ここで設定するリージョンは、cloudAuditLogging.clusterLocation、gkeConnect.location、gkeOnPremAPI.location　で設定したリージョンと同じにする必要があります。リージョンが同じでない場合、クラスタの作成は失敗します。

例:

stackdriver:
  clusterLocation: "us-central1"

`stackdriver.enableVPC`

省略可
不変
ブール値
事前入力: false

クラスタのネットワークが VPC によって管理されている場合は、これを true に設定します。これにより、すべてのテレメトリーが Google の制限された IP アドレスを通過するようになります。それ以外の場合は false に設定します。

例:

stackdriver:
  enableVPC: false

`stackdriver.serviceAccountKeyPath`

Logging と Monitoring の場合は必須
変更可
文字列

ロギングモニタリングサービスアカウントの JSON 鍵ファイルのパス。

既存のクラスタでこのフィールドを更新する方法については、サービスアカウントキーのローテーションをご覧ください。

例:

stackdriver:
  serviceAccountKeyPath: "my-key-folder/log-mon-key.json"

`stackdriver.disableVsphereResourceMetrics`

省略可
変更可
Logging と Monitoring に関連
ブール値
事前入力: false
デフォルト: false

これを true に設定すると、vSphere からの指標の収集が無効になります。それ以外の場合は、false に設定します。

このセクションは、Google Cloud コンソールのユーザークラスタのライフサイクルを管理する場合に管理クラスタで必要です。

例:

stackdriver:
  disableVsphereResourceMetrics: true

`cloudAuditLogging`

クラスタの Kubernetes API サーバーの監査ログを Cloud Audit Logs と統合する場合は、このセクションに入力します。それ以外の場合は、このセクションを削除するか、コメントアウトしたままにします。
変更可

このセクションは、GKE On-Prem API クライアントを使用するユーザークラスタのライフサイクルを管理する場合に管理クラスタで必要です。

`cloudAuditLogging.projectID`

Cloud Audit Logs の場合は必須
不変
文字列

フリートホストプロジェクトの ID。新しいクラスタの場合、このプロジェクト ID は、gkeConnect.projecID と stackdriver.projectID で設定した ID と同じである必要があります。プロジェクト ID が同じでない場合、クラスタの作成は失敗します。この要件は、既存のクラスタには適用されません。

例:

cloudAuditLogging:
  projectID: "my-fleet-host-project"

`cloudAuditLogging.clusterLocation`

Cloud Audit Logs の場合は必須
不変
文字列

監査ログを保存する Google Cloud のリージョン。お使いのオンプレミスデータセンターの近くのリージョンを選択することをおすすめします。

新しいクラスタの場合、構成ファイルで gkeOnPremAPI セクションと stackdriver セクションを設定すれば、ここで設定するリージョンは、gkeConnect.location、gkeOnPremAPI.location、stackdriver.clusterLocation　で設定したリージョンと同じにする必要があります。リージョンが同じでない場合、クラスタの作成は失敗します。

例:

cloudAuditLogging:
  clusterLocation: "us-central1"

`cloudAuditLogging.serviceAccountKeyPath`

Cloud Audit Logs の場合は必須
変更可
文字列

監査ログサービスアカウントの JSON 鍵ファイルのパス。

既存のクラスタでこのフィールドを更新する方法については、サービスアカウントキーのローテーションをご覧ください。

例:

cloudAuditLogging:
  serviceAccountKeyPath: "my-key-folder/audit-log-key.json"

`clusterBackup.datastore`

プレビュー
省略可
変更可
文字列

管理クラスタのバックアップを有効にする場合は、これをクラスタのバックアップを保存する vSphere データストアに設定します。

例:

clusterBackup:
  datastore: "my-datastore"

`autoRepair.enabled`

省略可
変更可
ブール値
事前入力: true

ノードの自動修復を有効にするには、これを true に設定します。それ以外の場合は false に設定します。

このフィールドの値を更新するには、gkectl update admin を使用します。

例:

autoRepair:
  enabled: true

`secretsEncryption`

外部 KMS（鍵管理サービス）やその他の依存関係を必要とせずに Secret を暗号化する場合は、このセクションに入力します。それ以外の場合は、このセクションを削除するか、コメントアウトしたままにします。
不変

`secretsEncryption.mode`

Secret の暗号化の場合は必須
不変
文字列
有効な値: 「GeneratedKey」
事前入力: 「GeneratedKey」

Secret の暗号化モード。

secretsEncryption:
  mode: "GeneratedKey"

`secretsEncryption.generatedKey.keyVersion`

Secret の暗号化の場合は必須
変更可
整数
事前入力: 1

鍵のバージョン番号に使用するために選んだ整数。最初は 1 を使用することをおすすめします。

例:

secretsEncryption:
  generatedKey:
    keyVersion: 1

`secretsEncryption.generatedKey.disabled`

Secret の暗号化の場合は必須
変更可
ブール値
事前入力: false

Secret の暗号化を無効にするには、これを true に設定します。それ以外の場合は、false に設定します。

例:

secretsEncryption:
  generatedKey:
    disabled: false

`osImageType`

省略可
変更可
文字列
有効な値:「ubuntu_containerd」、「cos」、「ubuntu_cgv2」、「cos_cgv2」
事前入力: ""
デフォルト:「ubuntu_containerd」

管理クラスタノードで実行する OS イメージのタイプ。

ubuntu_cgv2 または cos_cgv2 を指定する場合は、クラスタを作成または更新する前に gkectl prepare --extra-os-image-types=cgroupv2 を実行する必要があります。

例:

osImageType: "cos"