Ficheiro de configuração do cluster de administrador 1.28

Este documento descreve os campos no ficheiro de configuração do cluster de administrador para a versão 1.28 do Google Distributed Cloud.

Gerar um modelo para o seu ficheiro de configuração

Se usou o gkeadm para criar a estação de trabalho de administrador, o gkeadm gerou um modelo para o ficheiro de configuração do cluster de administrador. Além disso, o gkeadm preencheu alguns dos campos por si.

Se não usou o gkeadm para criar a sua estação de trabalho de administrador, pode usar o gkectl para gerar um modelo para o ficheiro de configuração do cluster de administrador.

Para gerar um modelo para o ficheiro de configuração do cluster de administrador:

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

Substitua OUTPUT_FILENAME por um caminho à sua escolha para o modelo gerado. Se omitir esta flag, gkectl atribui o nome admin-cluster.yaml ao ficheiro e coloca-o no diretório atual.

Substitua VERSION pela versão completa de uma versão de patch 1.28. Por exemplo: gkectl create-config admin --gke-on-prem-version=1.28.1200-gke.83. Esta versão tem de ser igual ou inferior à versão do gkectl. Se omitir este indicador, o modelo de configuração gerado é preenchido com valores baseados na atualização 1.28 mais recente.

Modelo

Clique para ver o modelo gerado.

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: ""
  # (Optional) Storage policy to use for cluster VM storage and default StorageClass
  storagePolicyName: ""
  # 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: ""

Preencher o ficheiro de configuração

No ficheiro de configuração, introduza os valores dos campos conforme descrito nas secções seguintes.

name

Opcional
String
Predefinição: um nome aleatório que começa com o prefixo "gke-admin-"

Um nome à sua escolha para o cluster.

Exemplo:

name: "my-admin-cluster"

bundlePath

Obrigatório
Mutável
String

O caminho do ficheiro do pacote do Google Distributed Cloud.

O ficheiro do pacote completo do Google Distributed Cloud contém todos os componentes numa versão específica do Google Distributed Cloud. Quando cria uma estação de trabalho de administração, esta inclui um pacote completo em:

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

Exemplo:

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

preparedSecrets.enabled

Pré-visualização
Opcional
Imutável
Booleano
Preenchido previamente: false
Predefinição: false

Defina esta opção como true se quiser usar credenciais preparadas no cluster de administração. Caso contrário, defina-o como false.

Exemplo:

preparedSecrets:
  enabled: true

vCenter

Obrigatório
Imutável

Esta secção contém informações sobre o seu ambiente vSphere e a sua ligação ao vCenter Server.

vCenter.address

Obrigatório
Imutável
String

O endereço IP ou o nome de anfitrião do seu servidor vCenter.

Para mais informações, consulte o artigo Encontrar o endereço do servidor vCenter.

Exemplos:

vCenter:
  address: "203.0.113.100"

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

vCenter.datacenter

Obrigatório
Imutável
String

O caminho relativo de um centro de dados do vSphere.

O valor que especificar é relativo à pasta raiz denominada /.

Se o centro de dados estiver na pasta raiz, o valor é o nome do centro de dados.

Exemplo:

vCenter:
  datacenter: "my-data-center"

Caso contrário, o valor é um caminho relativo que inclui uma ou mais pastas juntamente com o nome do centro de dados.

Exemplo:

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

vCenter.cluster

Obrigatório
Imutável
String

O caminho relativo de um cluster do vSphere que representa os anfitriões ESXi onde as VMs do cluster de administrador são executadas. Este cluster do vSphere representa um subconjunto dos anfitriões ESXi físicos no seu centro de dados do vCenter.

O valor que especificar é relativo a /.../DATA_CENTER/vm/.

Se o cluster do vSphere estiver na pasta /.../DATA_CENTER/vm/, o valor é o nome do cluster do vSphere.

Exemplo:

vCenter:
  cluster: "my-vsphere-cluster"

Caso contrário, o valor é um caminho relativo que inclui uma ou mais pastas, juntamente com o nome do cluster do vSphere.

Exemplo:

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

vCenter.resourcePool

Obrigatório
Imutável
String

Um pool de recursos do vCenter para as VMs do cluster de administrador.

Se quiser usar o conjunto de recursos predefinido, defina esta opção como VSPHERE_CLUSTER/Resources.

Exemplo:

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

Se quiser usar um conjunto de recursos que já criou, defina este parâmetro como o caminho relativo do conjunto de recursos.

O valor que especificar é relativo a /.../DATA_CENTER/host/.../VSPHERE_CLUSTER/Resources/

Se o conjunto de recursos for um filho direto de /.../DATA_CENTER/host/.../VSPHERE_CLUSTER/Resources/ o valor é o nome do conjunto de recursos.

Exemplo:

vCenter:
  resourcePool: "my-resource-pool"

Se o seu conjunto de recursos estiver aninhado noutro conjunto de recursos, defina este parâmetro para o caminho completo do seu conjunto de recursos.

Exemplo:

vCenter:
  resourcePool: "my-vsphere-cluster/Resources/parent-resource-pool/child-resource-pool"

vCenter.datastore

Obrigatório se vCenter.storagePolicyName não estiver especificado
Imutável
String

O nome de um repositório de dados do vSphere para o cluster de administrador.

O valor especificado tem de ser um nome, não um caminho. Não inclua pastas no valor.

Exemplo:

vCenter:
  datastore: "my-datastore"

Tem de especificar um valor para vCenter.datastore ou vCenter.storagePolicyName, mas não ambos. Se especificar um valor para este campo, não especifique um valor para vCenter.storagePolicyName. O campo vCenter.datastore é imutável, exceto quando o define como uma string vazia quando migra um arquivo de dados para a gestão baseada em políticas de armazenamento (SPBM).

vCenter.storagePolicyName

Obrigatório se vCenter.datastore não estiver especificado
Imutável
String

O nome de uma política de armazenamento de VMs para os nós do cluster.

O cluster de administrador tem de estar altamente disponível (HA) para funcionar com a política de armazenamento.

Para mais informações, consulte o artigo Configure uma política de armazenamento.

Tem de especificar um valor para vCenter.datastore ou vCenter.storagePolicyName, mas não ambos. Se especificar um valor para este campo, não especifique um valor para vCenter.datastore.

vCenter.caCertPath

Obrigatório
Mutável
String

O caminho do certificado da AC para o seu servidor vCenter.

Para mais informações, consulte o artigo Obter o certificado da AC do vCenter.

Para ver informações sobre como atualizar este campo para um cluster existente, consulte o artigo Atualize as referências de certificados do vCenter.

Exemplo:

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

vCenter.credentials.fileRef.path

Obrigatório
String

O caminho de um ficheiro de configuração de credenciais que contém o nome de utilizador e a palavra-passe da sua conta de utilizador do vCenter. A conta de utilizador deve ter a função de administrador ou privilégios equivalentes. Consulte os requisitos do vSphere.

Pode usar gkectl update para atualizar este campo num cluster existente.

Para ver informações sobre como atualizar as credenciais do vCenter, consulte o artigo Atualizar credenciais do cluster.

Exemplo:

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

vCenter.credentials.fileRef.entry

Obrigatório
String

O nome do bloco de credenciais no ficheiro de configuração de credenciais que contém o nome de utilizador e a palavra-passe da sua conta de utilizador do vCenter.

Pode usar gkectl update para atualizar este campo num cluster existente.

Para ver informações sobre como atualizar as credenciais do vCenter, consulte o artigo Atualizar credenciais do cluster.

Exemplo:

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

vCenter.folder

Opcional
Imutável
String
Predefinição: a pasta ao nível do centro de dados

O caminho relativo de uma pasta do vSphere que já criou. Esta pasta vai conter as VMs do cluster de administrador.

Se não especificar um valor, as VMs do cluster de administrador são colocadas em /.../DATA_CENTER/vm/.

Se especificar um valor, este é relativo a /.../DATA_CENTER/vm/.

O valor pode ser o nome de uma pasta.

Exemplo:

vCenter:
  folder: "my-folder"

Se a pasta da VM estiver aninhada noutra pasta da VM, defina este valor como o caminho completo para a pasta da VM.

Exemplo:

vCenter:
  folder: "/my-datacenter/vm/vm-folder/nested-vm-folder"

Tenha em atenção que tem de incluir o primeiro "/" no caminho completo da pasta da VM.

vCenter.dataDisk

Não indique um valor para este campo. Elimine o campo ou deixe-o comentado.

network

Obrigatório
Imutável

Esta secção contém informações sobre a rede do cluster de administrador.

network.hostConfig

Obrigatório
Imutável

Esta secção contém informações sobre os servidores NTP, os servidores DNS e os domínios de pesquisa DNS usados pelas VMs que são os nós do cluster.

network.hostConfig.dnsServers

Obrigatório se a secção network.hostConfig estiver preenchida.
Imutável
Matriz de strings.
O número máximo de elementos na matriz é três.

Os endereços dos servidores DNS para as VMs.

Exemplo:

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

network.hostConfig.ntpServers

Obrigatório se a secção network.hostConfig estiver preenchida.
Imutável
Matriz de strings

Os endereços dos servidores de tempo que as VMs devem usar.

Exemplo:

network:
  hostConfig:
    ntpServers:
    - "216.239.35.0"

network.hostConfig.searchDomainsForDNS

Opcional
Imutável
Matriz de strings

Domínios de pesquisa de DNS para as VMs usarem. Estes domínios são usados como parte de uma lista de pesquisa de domínios.

Exemplo:

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

network.ipMode.type

Obrigatório
Imutável
String
Pré-preenchido: "dhcp"
Predefinição: "dhcp"

Se quiser que os nós do cluster obtenham o respetivo endereço IP a partir de um servidor DHCP, defina esta opção como "dhcp". Se quiser que os nós do cluster tenham endereços IP estáticos escolhidos a partir de uma lista que fornecer, defina esta opção como "static".

Exemplo:

network:
  ipMode:
    type: "static"

network.ipMode.ipBlockFilePath

Obrigatório se network.ipMode.type = static
Imutável
String

O caminho do ficheiro de bloqueio de IP para o seu cluster.

Exemplo:

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

network.serviceCIDR

Obrigatório
Imutável
String
Intervalo mais pequeno possível: /24
Intervalo mais largo possível: /12
Pré-preenchido: "10.96.232.0/24"
Predefinição: "10.96.232.0/24"

Um intervalo de endereços IP, no formato CIDR, a ser usado para os serviços no seu cluster.

Exemplo:

network:
  serviceCIDR: "10.96.232.0/24"

network.podCIDR

Obrigatório
Imutável
String
Intervalo mais pequeno possível: /18
Intervalo mais amplo possível: /8
Pré-preenchido: "192.168.0.0/16"
Predefinição: "192.168.0.0/16"

Um intervalo de endereços IP, no formato CIDR, a usar para os pods no seu cluster.

Exemplo:

network:
  podCIDR: "192.168.0.0/16"

O intervalo de serviço não pode sobrepor-se ao intervalo de agrupamento.

Os intervalos de serviços e de pods não podem sobrepor-se a nenhum endereço fora do cluster ao qual quer aceder a partir do interior do cluster.

Por exemplo, suponhamos que o seu intervalo de serviços é 10.96.232.0/24 e o seu intervalo de pods é 192.168.0.0/16. Todo o tráfego enviado de um pod para um endereço num desses intervalos é tratado como no cluster e não chega a nenhum destino fora do cluster.

Em particular, os intervalos de serviços e pods não podem sobrepor-se a:

• Endereços IP de nós em qualquer cluster

• Endereços IP usados por máquinas do balanceador de carga

• VIPs usados por nós do plano de controlo e balanceadores de carga

• Endereço IP dos servidores vCenter, servidores DNS e servidores NTP

Recomendamos que os intervalos de serviços e pods estejam no espaço de endereços RFC 1918.

Segue-se um motivo para a recomendação de usar endereços RFC 1918. Suponhamos que o intervalo do seu pod ou serviço contém endereços IP externos. Qualquer tráfego enviado de um pod para um desses endereços externos é tratado como tráfego no cluster e não chega ao destino externo.

network.vCenter.networkName

Obrigatório
Imutável
String

O nome da rede vSphere para os nós do cluster.

Exemplo:

network:
  vCenter:
    networkName: "my-network"

Se o nome contiver um carater especial, tem de usar uma sequência de escape para o mesmo.

Carateres especiais	Sequência de escape
Barra (/)	%2f
Barra invertida (\)	%5c
Sinal de percentagem (%)	%25

Se o nome da rede não for exclusivo no seu centro de dados, pode especificar um caminho completo.

Exemplo:

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

network.controlPlaneIPBlock

Obrigatória

network.controlPlaneIPBlock.netmask

Obrigatório
Imutável
String

A máscara de rede da rede que tem os nós do plano de controlo.

Exemplo:

network:
  controlPlaneIPBlock:
    netmask: "255.255.255.0"

network.controlPlaneIPBlock.gateway

Obrigatório
Imutável
String

O endereço IP do gateway predefinido para os nós do plano de controlo.

Exemplo:

network:
  controlPlaneIPBlock:
    gateway: "172.16.22.1"

network.controlPlaneIPBlock.ips

Obrigatório
Imutável
Matriz de três objetos, cada um dos quais tem um endereço IP e um nome de anfitrião opcional.

Estes são os endereços IP que vão ser atribuídos aos nós do plano de controlo.

Exemplo:

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

Esta secção contém informações sobre o equilibrador de carga do cluster de administrador.

loadBalancer.vips.controlPlaneVIP

Obrigatório
Imutável
String

O endereço IP que escolheu configurar no equilibrador de carga para o servidor da API Kubernetes do cluster de administrador.

Exemplo:

loadBalancer:
  vips:
    controlplaneVIP: "203.0.113.3"

loadBalancer.kind

Obrigatório
Imutável
String
Pré-preenchido: "MetalLB"

String. Defina esta opção como "ManualLB", "F5BigIP" ou "MetalLB"

Para ativar funcionalidades novas e avançadas, recomendamos que use "ManualLB" se tiver um balanceador de carga de terceiros (como o F5 BIG-IP ou o Citrix) ou "MetalLB" para a nossa solução integrada.

Exemplo:

loadBalancer:
  kind: "MetalLB"

loadBalancer.manualLB

Se definir loadbalancer.kind como "ManualLB", preencha esta secção. Caso contrário, remova esta secção.
Imutável

loadBalancer.manualLB.ingressHTTPNodePort

Remova este campo do ficheiro de configuração. Não é usado num cluster de administração.

loadBalancer.manualLB.ingressHTTPSNodePort

Remova este campo do ficheiro de configuração. Não é usado num cluster de administração.

loadBalancer.manualLB.konnectivityServerNodePort

Remova este campo do ficheiro de configuração. Não é usado num cluster de administração.

loadBalancer.f5BigIP

Se definir loadbalancer.kind como "f5BigIP", preencha esta secção. Caso contrário, remova esta secção.

Para ativar funcionalidades novas e avançadas, recomendamos que configure o equilíbrio de carga manual para o seu equilibrador de carga F5 BIG-IP. Para ativar o equilíbrio de carga manual, defina loadbalancer.kind como"ManualLB" e preencha a secção loadBalancer.manualLB. Para mais informações, consulte o artigo Ativar o modo de equilíbrio de carga manual.

Se tiver um equilibrador de carga F5 BIG-IP existente e o cluster usar esta configuração, após a atualização para a versão 1.29 ou superior, recomendamos que migre para o modo manual.

loadBalancer.f5BigIP.address

Obrigatório se loadBalancer.kind = "f5BigIp"
Imutável
String

O endereço do seu equilibrador de carga F5 BIG-IP. Por exemplo:

loadBalancer:
  f5BigIP:
    address: "203.0.113.2"

loadBalancer.f5BigIP.credentials.fileRef.path

Obrigatório se loadBalancer.kind = "f5BigIp"
Mutável
String

O caminho de um ficheiro de configuração de credenciais que contém o nome de utilizador e a palavra-passe de uma conta que o Google Distributed Cloud pode usar para se ligar ao seu equilibrador de carga F5 BIG-IP.

A conta de utilizador tem de ter uma função de utilizador com autorizações suficientes para configurar e gerir o equilibrador de carga. A função de administrador ou a função de administrador de recursos é suficiente.

Pode usar gkectl update para atualizar este campo num cluster existente.

Para ver informações sobre como atualizar as suas credenciais do F5 BIG-IP, consulte o artigo Atualizar credenciais do cluster.

Exemplo:

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

loadBalancer.f5BigIP.credentialsfileRef.entry

Obrigatório se loadBalancer.kind = "f5BigIp"
Mutável
String

O nome do bloco de credenciais no ficheiro de configuração de credenciais que contém o nome de utilizador e a palavra-passe da sua conta F5 BIG-IP.

Pode usar gkectl update para atualizar este campo num cluster existente.

Para ver informações sobre como atualizar as suas credenciais do F5 BIG-IP, consulte o artigo Atualizar credenciais do cluster.

Exemplo:

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

loadBalancer.f5BigIP.partition

Obrigatório se loadBalancer.kind = "f5BigIp"
Imutável
String

O nome de uma partição BIG-IP que criou para o cluster de administrador.

Exemplo:

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

loadBalancer.f5BigIP.snatPoolName

Opcional
Relevante se loadBalancer.kind = "f5BigIp"
Imutável
String

Se estiver a usar SNAT, o nome do seu conjunto de SNAT. Se não estiver a usar o SNAT, remova este campo.

Exemplo:

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

loadBalancer.seesaw

Não use esta secção. O equilibrador de carga do Seesaw não é suportado para novos clusters de administrador na versão 1.28 e superior. Em alternativa, recomendamos que configure o balanceador de carga do MetalLB para novos clusters de administrador. Para mais informações sobre a configuração do MetalLB, consulte o artigo Equilíbrio de carga integrado com o MetalLB.

Continuamos a suportar o Seesaw para clusters atualizados da versão 1.16 para a 1.28. Por exemplo, suponha que tem um cluster de administrador não HA 1.16 que usa o Seesaw. Depois de atualizar o cluster para a versão 1.28, pode continuar a usar o plano de controlo não HA e o equilibrador de carga do Seesaw. Para obter informações sobre o equilibrador de carga do Seesaw, consulte a documentação 1.16:

• Ficheiro de configuração do cluster de administrador
• Balanceador de carga Seesaw

antiAffinityGroups.enabled

Opcional
Mutável
Booleano
Pré-preenchido: verdadeiro

Defina esta opção como true para ativar a criação de regras de DRS. Caso contrário, defina este valor como false.

Exemplo:

antiAffinityGroups:
  enabled: true

Se este campo for true, o Google Distributed Cloud cria regras de antiafinidade do VMware Distributed Resource Scheduler (DRS) para os nós do cluster de administrador, o que faz com que sejam distribuídos por, pelo menos, três anfitriões ESXi físicos no seu centro de dados.

Esta funcionalidade requer que o seu ambiente vSphere cumpra as seguintes condições:

• O VMware DRS está ativado. O VMware DRS requer a edição vSphere Enterprise Plus.

• A sua conta de utilizador do vSphere tem o privilégio Host.Inventory.Modify cluster.

• Estão disponíveis, pelo menos, quatro anfitriões ESXi.

Embora a regra exija que os nós do cluster estejam distribuídos por três anfitriões ESXi, recomendamos vivamente que tenha, pelo menos, quatro anfitriões ESXi disponíveis. Isto protege-o contra a perda do plano de controlo do cluster de administrador. Por exemplo, suponhamos que tem apenas três anfitriões ESXi e o nó do plano de controlo do cluster de administrador está num anfitrião ESXi com falhas. A regra DRS impede que o nó do plano de controlo seja colocado num dos dois anfitriões ESXi restantes.

Lembre-se de que, se tiver uma licença vSphere Standard, não pode ativar o VMware DRS.

Se não tiver o DRS ativado ou não tiver, pelo menos, quatro anfitriões onde seja possível agendar VMs do vSphere, defina antiAffinityGroups.enabled como false.

adminMaster

Imutável

Definições de configuração para os nós do plano de controlo no cluster de administrador.

adminMaster.cpus

Pré-visualização
Opcional
Imutável
Número inteiro
Pré-preenchido: 4
Predefinição: 4

O número de vCPUs para cada nó do plano de controlo no cluster de administrador.

Exemplo:

adminMaster:
  cpus: 4

adminMaster.memoryMB

Pré-visualização
Opcional
Imutável
Número inteiro
Pré-preenchido: 16384
Predefinição: 16384

O número de mebibytes de memória para cada nó do plano de controlo no cluster de administração.

Exemplo:

adminMaster:
  memoryMB: 16384

adminMaster.replicas

Obrigatório para novos clusters
Imutável
Número inteiro
Valores possíveis: 3

O número de nós do plano de controlo no cluster de administrador. Quando criar um novo cluster de administrador, defina este campo como 3 para criar um cluster de administrador de alta disponibilidade (HA).

Exemplo:

adminMaster:
  replicas: 3

proxy

Se a sua rede estiver protegida por um servidor proxy, preencha esta secção. Caso contrário, remova esta secção ou deixe-a comentada. O servidor proxy que especificar aqui é usado pelos clusters de utilizadores que este cluster de administrador gere.
Imutável

proxy.url

Obrigatório se a secção proxy estiver preenchida.
Imutável
String

O endereço HTTP do seu servidor proxy. Inclua o número da porta, mesmo que seja o mesmo que a porta predefinida do esquema.

Exemplo:

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

O servidor proxy que especificar aqui é usado pelos seus clusters do Google Distributed Cloud. Além disso, a estação de trabalho do administrador é configurada automaticamente para usar este mesmo servidor proxy, a menos que defina a variável de ambiente HTTPS_PROXY na estação de trabalho do administrador.

Se especificar proxy.url, também tem de especificar proxy.noProxy.

Depois de definir a configuração do proxy para o cluster de administrador, não é possível modificá-la nem eliminá-la, a menos que o cluster seja reconstruído.

proxy.noProxy

Opcional
Imutável
String

Uma lista separada por vírgulas de endereços IP, intervalos de endereços IP, nomes de anfitriões e nomes de domínios que não devem passar pelo servidor proxy. Quando o Google Distributed Cloud envia um pedido para um destes endereços, anfitriões ou domínios, o pedido é enviado diretamente.

Exemplo:

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

privateRegistry

Um registo de contentores privado é um registo onde o acesso a imagens de contentores está restrito a utilizadores autenticados. Preencha esta secção se os seus clusters de utilizadores precisarem de aceder a imagens de cargas de trabalho. Quando configura a secção privateRegistry, todos os clusters de utilizadores geridos por este cluster de administrador vão extrair imagens de cargas de trabalho do registo privado que configurar aqui.

Se configurar a secção privateRegistry, quando executar gkectl prepare antes da criação ou atualização do cluster, gkectl envia as imagens do sistema Google Distributed Cloud para o registo privado. Durante a criação ou a atualização do cluster, as imagens do sistema são extraídas do registo privado. Se não configurar a secção privateRegistry, as imagens do sistema são extraídas de gcr.io/gke-on-prem-release através da conta de serviço de acesso aos componentes.

É recomendável configurar a secção privateRegistry para que os clusters extraiam imagens do sistema do registo privado em vez de gcr.io/gke-on-prem-release nos seguintes casos:

• Tem de minimizar as ligações ao Google Cloud devido a preocupações de segurança ou requisitos regulamentares.
• A sua organização requer que o tráfego de saída passe por um servidor proxy e a velocidade da rede para estabelecer ligação ao Google Cloud é lenta.

Se quiser usar o Artifact Registry da Google como um registo privado, consulte o artigo Use o Artifact Registry como um registo privado para imagens de cargas de trabalho para ver os passos de configuração.

privateRegistry.address

Obrigatório para o registo privado
Imutável
String

O endereço IP ou o FQDN (nome do domínio totalmente qualificado) da máquina que executa o seu registo privado.

Exemplos:

privateRegistry:
  address: "203.0.113.10"

privateRegistry:
  address: "fqdn.example.com"

privateRegistry.credentials.fileRef.path

Obrigatório para o registo privado
Mutável
String

O caminho de um ficheiro de configuração de credenciais que contém o nome de utilizador e a palavra-passe de uma conta que o Google Distributed Cloud pode usar para aceder ao seu registo privado.

Exemplo:

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

privateRegistry.credentials.fileRef.entry

Obrigatório para o registo privado
Mutável
String

O nome do bloco de credenciais no ficheiro de configuração de credenciais que contém o nome de utilizador e a palavra-passe da sua conta de registo privado.

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

privateRegistry.caCertPath

Obrigatório para o registo privado
Mutável
String

Quando o tempo de execução do contentor extrai uma imagem do seu registo privado, o registo tem de comprovar a sua identidade apresentando um certificado. O certificado do registo é assinado por uma autoridade de certificação (CA). O tempo de execução do contentor usa o certificado da AC para validar o certificado do registo.

Defina este campo para o caminho do certificado da AC.

Exemplo:

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

componentAccessServiceAccountKeyPath

Obrigatório
Mutável
String

O caminho do ficheiro de chave JSON para a sua conta de serviço de acesso a componentes.

Exemplo:

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

gkeConnect

Obrigatório
Mutável

Quando preenche a secção gkeConnect, o cluster de administrador é automaticamente registado numa frota após a sua criação. Esta secção contém informações sobre o Google Cloud projeto e a conta de serviço necessários para registar o cluster.

Durante a criação ou a atualização do cluster, são configuradas várias políticas de RBAC no cluster de administrador. Estas políticas de RBAC são necessárias para poder criar clusters de utilizadores na consola do Google Cloud .

gkeConnect.projectID

Obrigatório
Imutável
String

O ID do seu projeto anfitrião da frota. Para novos clusters, este ID do projeto tem de ser igual ao ID definido em stackdriver.projectID e cloudAuditLogging.projectID. Se os IDs dos projetos não forem iguais, a criação do cluster falha. Este requisito não é aplicado aos clusters existentes.

Exemplo:

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

gkeConnect.location

Opcional
Imutável
String
Predefinição: global

A associação de frotas de cada cluster é gerida pelo serviço Fleet (gkehub.googleapis.com) e pelo serviço Connect (gkeconnect.googleapis.com). A localização dos serviços pode ser global ou regional. Na versão 1.28 e posteriores, pode especificar opcionalmente a Google Cloud região em que os serviços Fleet e Connect são executados. Se não for especificado, são usadas as instâncias globais dos serviços. Tenha em conta o seguinte:

• Os clusters de administrador criados antes da versão 1.28 são geridos pelos serviços globais Fleet e Connect.

• Para novos clusters, se incluir este campo, a região especificada tem de ser igual à região configurada em cloudAuditLogging.clusterLocation, stackdriver.clusterLocation e gkeOnPremAPI.location. Se as regiões não forem iguais, a criação do cluster falha.

Exemplo:

gkeConnect:
  location: "us-central1"

gkeConnect.registerServiceAccountKeyPath

Obrigatório
Mutável
String

O caminho do ficheiro de chave JSON para a sua conta de serviço connect-register.

Exemplo:

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

gkeOnPremAPI

Opcional

Na versão 1.16 e posteriores, se a API GKE On-Prem estiver ativada no seu Google Cloud projeto, todos os clusters no projeto são inscritos na API GKE On-Prem automaticamente na região configurada em stackdriver.clusterLocation.

• Se quiser inscrever todos os clusters no projeto na API GKE On-Prem, certifique-se de que executa os passos em Antes de começar para ativar e usar a API GKE On-Prem no projeto.

• Se não quiser inscrever o cluster na API GKE On-Prem, inclua esta secção e defina gkeOnPremAPI.enabled como false. Se não quiser inscrever nenhum cluster no projeto, desative gkeonprem.googleapis.com (o nome do serviço para a API GKE On-Prem) no projeto. Para ver instruções, consulte o artigo Desativar serviços.

A inscrição do cluster de administrador na API GKE On-Prem permite-lhe usar ferramentas padrão, como a consola, a CLI do Google Cloud ou o Terraform, para atualizar os clusters de utilizadores que o cluster de administrador gere. Google Cloud A inscrição do cluster também lhe permite executar comandos gcloud para obter informações sobre os seus clusters.

Depois de adicionar esta secção e criar ou atualizar o cluster de administrador, se remover posteriormente a secção e atualizar o cluster, a atualização falha.

gkeOnPremAPI.enabled

Obrigatório se a secção gkeOnPremAPI estiver incluída.
Mutável
Booleano
Predefinição: true

Por predefinição, o cluster está inscrito na API GKE On-Prem se a API GKE On-Prem estiver ativada no seu projeto. Defina como false se não quiser inscrever o cluster.

Depois de o cluster ser inscrito na API GKE On-Prem, se precisar de anular a inscrição do cluster, faça a seguinte alteração e, em seguida, atualize o cluster:

gkeOnPremAPI:
  enabled: false

gkeOnPremAPI.location

Imutável
String
Predefinição:stackdriver.clusterLocation

A Google Cloud região onde a API GKE On-Prem é executada e armazena metadados do cluster. Escolha uma das regiões suportadas. Tem de usar a mesma região configurada em cloudAuditLogging.clusterLocation, gkeConnect.location e stackdriver.clusterLocation. Se gkeOnPremAPI.enabled for false, não inclua este campo.

stackdriver

Obrigatório por predefinição
Mutável

Se quiser ativar o Cloud Logging e o Cloud Monitoring para o seu cluster, preencha esta secção. Caso contrário, remova esta secção.

Esta secção é obrigatória por predefinição. Ou seja, se não incluir esta secção, tem de incluir a flag --skip-validation-stackdriver quando executar gkectl create admin.

Esta secção é necessária no cluster de administrador se quiser gerir o ciclo de vida dos clusters de utilizadores através de clientes da API GKE On-Prem.

stackdriver.projectID

Obrigatório para o registo e a monitorização
Imutável
String

O ID do seu projeto anfitrião da frota. Para novos clusters, este ID do projeto tem de ser igual ao ID definido em gkeConnect.projectID e cloudAuditLogging.projectID. Se os IDs dos projetos não forem iguais, a criação do cluster falha. Este requisito não é aplicado aos clusters existentes.

Se necessário, pode configurar um router de registos neste projeto para encaminhar registos para contentores de registos noutro projeto. Para ver informações sobre como configurar o Log Router, consulte o artigo Destinos suportados.

Exemplo:

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

stackdriver.clusterLocation

Obrigatório para registo e monitorização
Imutável
String
Pré-preenchido: "us-central1"

A Google Cloud região onde quer encaminhar e armazenar as métricas do Cloud Monitoring. Recomendamos que escolha uma região próxima do seu centro de dados no local.

Especifica o encaminhamento de registos e a localização de armazenamento do Cloud Logging na configuração do Log Router. Para mais informações sobre o encaminhamento de registos, consulte o artigo Vista geral do encaminhamento e armazenamento.

O operador do Stackdriver (stackdriver-operator) anexa o valor deste campo a cada entrada de registo e métrica antes de serem encaminhadas para Google Cloud. Estas etiquetas anexadas podem ser úteis para filtrar os registos e as métricas no Explorador de registos e no Explorador de métricas, respetivamente.

Para novos clusters, se incluir as secções gkeOnPremAPI e cloudAuditLogging no ficheiro de configuração, a região que definir aqui tem de ser a mesma que definir em cloudAuditLogging.clusterLocation, gkeConnect.location e gkeOnPremAPI.location. Se as regiões não forem iguais, a criação do cluster falha.

Exemplo:

stackdriver:
  clusterLocation: "us-central1"

stackdriver.enableVPC

Opcional
Imutável
Booleano
Pré-preenchido: false

Se a rede do cluster for controlada por uma VPC, defina esta opção comotrue. Isto garante que toda a telemetria flui através dos endereços IP restritos da Google. Caso contrário, defina este valor como false.

Exemplo:

stackdriver:
  enableVPC: false

stackdriver.serviceAccountKeyPath

Obrigatório para o registo e a monitorização
Mutável
String

O caminho do ficheiro de chave JSON para a sua conta de serviço de registo e monitorização.

Para ver informações sobre como atualizar este campo num cluster existente, consulte o artigo Faça a rotação das chaves da conta de serviço.

Exemplo:

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

stackdriver.disableVsphereResourceMetrics

Opcional
Mutável
Relevante para registo e monitorização
Booleano
Pré-preenchido: false
Predefinição: false

Defina esta opção como true para desativar a recolha de métricas do vSphere. Caso contrário, defina-o como false.

Esta secção é necessária no cluster de administrador se quiser gerir o ciclo de vida dos clusters de utilizadores com clientes da API GKE On-Prem.

Exemplo:

stackdriver:
  disableVsphereResourceMetrics: true

cloudAuditLogging

Se quiser integrar os registos de auditoria do servidor da API Kubernetes do seu cluster com os registos de auditoria do Cloud, preencha esta secção. Caso contrário, remova esta secção ou deixe-a comentada.
Mutável

Esta secção é necessária no cluster de administrador se quiser gerir o ciclo de vida dos clusters de utilizadores com clientes da API GKE On-Prem.

cloudAuditLogging.projectID

Obrigatório para registos de auditoria do Cloud
Imutável
String

O ID do seu projeto anfitrião da frota. Para novos clusters, este ID do projeto tem de ser igual ao ID definido em gkeConnect.projecID e stackdriver.projectID. Se os IDs dos projetos não forem iguais, a criação do cluster falha. Este requisito não é aplicado aos clusters existentes.

Se necessário, pode configurar um router de registos neste projeto para encaminhar registos para contentores de registos noutro projeto. Para ver informações sobre como configurar o Log Router, consulte o artigo Destinos suportados.

Exemplo:

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

cloudAuditLogging.clusterLocation

Obrigatório para registos de auditoria do Cloud
Imutável
String

A Google Cloud região onde quer armazenar os registos de auditoria. É recomendável escolher uma região perto do seu centro de dados no local

Para novos clusters, se incluir as secções gkeOnPremAPI e stackdriver no ficheiro de configuração, a região que definir aqui tem de ser a mesma que definir em gkeConnect.location, gkeOnPremAPI.location e stackdriver.clusterLocation. Se as regiões não forem as mesmas, a criação do cluster falha.

Exemplo:

cloudAuditLogging:
  clusterLocation: "us-central1"

cloudAuditLogging.serviceAccountKeyPath

Obrigatório para os registos de auditoria do Cloud
Mutável
String

O caminho do ficheiro de chave JSON para a sua conta de serviço de registo de auditoria.

Para ver informações sobre como atualizar este campo num cluster existente, consulte o artigo Faça a rotação das chaves da conta de serviço.

Exemplo:

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

clusterBackup.datastore

Pré-visualização
Opcional
Mutável
String

Se quiser ativar a cópia de segurança do cluster de administrador, defina esta opção para o arquivo de dados do vSphere onde quer guardar as cópias de segurança do cluster.

Exemplo:

clusterBackup:
  datastore: "my-datastore"

autoRepair.enabled

Opcional
Mutável
Booleano
Pré-preenchido: verdadeiro

Defina esta opção como true para ativar a reparação automática de nós. Caso contrário, defina este valor como false.

Para atualizar o valor deste campo, use gkectl update admin.

Exemplo:

autoRepair:
  enabled: true

secretsEncryption

Se quiser encriptar segredos sem precisar de um KMS (serviço de gestão de chaves) externo ou outras dependências, preencha esta secção. Caso contrário, remova esta secção ou deixe-a comentada.
Imutável

secretsEncryption.mode

Obrigatório para a encriptação de segredos
Imutável
String
Valor possível: "GeneratedKey"
Pré-preenchido: "GeneratedKey"

O modo de encriptação secreto.

secretsEncryption:
  mode: "GeneratedKey"

secretsEncryption.generatedKey.keyVersion

Obrigatório para a encriptação de Secrets
Mutável
Número inteiro
Pré-preenchido: 1

Um número inteiro à sua escolha para usar como número da versão da chave. Recomendamos que comece com 1.

Exemplo:

secretsEncryption:
  generatedKey:
    keyVersion: 1

secretsEncryption.generatedKey.disabled

Opcional para a encriptação de segredos
Mutável
Booleano
Preenchido previamente: falso

Defina este valor como true para desativar a encriptação de segredos. Caso contrário, defina-o como false.

Exemplo:

secretsEncryption:
  generatedKey:
    disabled: false

osImageType

Opcional
Mutável
String
Valores possíveis: "ubuntu_containerd", "cos", "ubuntu_cgv2", "cos_cgv2"
Pré-preenchido: ""
Predefinição: "ubuntu_containerd"

O tipo de imagem do SO a executar nos nós do cluster de administrador.

Se especificar ubuntu_cgv2 ou cos_cgv2, tem de executar gkectl prepare --extra-os-image-types=cgroupv2 antes de criar/atualizar o cluster.

Exemplo:

osImageType: "cos"