Ficheiro de configuração da estação de trabalho do administrador

Esta página descreve os campos no ficheiro de configuração da estação de trabalho do administrador para o Google Distributed Cloud.

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

Transfira a ferramenta de linha de comandos gkeadm.

Para gerar um modelo:

./gkeadm create config --config=OUTPUT_FILENAME

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

Modelo

Clique para ver o modelo gerado.

gcp:
  # Path of the component access service account's JSON key file
  componentAccessServiceAccountKeyPath: ""
# Specify which vCenter resources to use
vCenter:
  # The credentials and address GKE On-Prem should use to connect to vCenter
  credentials:
    address: ""
    # reference to vCenter credentials file
    fileRef:
      # read credentials from this file
      path: credential.yaml
      # entry in the credential file
      entry: vCenter
  datacenter: ""
  datastore: ""
  cluster: ""
  network: ""
  # vSphere vm folder to deploy vms into. defaults to datacenter top level folder
  folder: ""
  resourcePool: ""
  # Provide the path to vCenter CA certificate pub key for SSL verification
  caCertPath: ""
# The URL of the proxy for the jump host
proxyUrl: ""
adminWorkstation:
  name: gke-admin-ws-230809-173521
  cpus: 4
  memoryMB: 8192
  # The boot disk size of the admin workstation in GB. It is recommended to use a
  # disk with at least 100 GB to host images decompressed from the bundle.
  diskGB: 100
  # Name for the persistent disk to be mounted to the home directory (ending in .vmdk).
  # Any directory in the supplied path must be created before deployment.
  dataDiskName: gke-on-prem-admin-workstation-data-disk/gke-admin-ws-230809-173521-data-disk.vmdk
  # The size of the data disk in MB.
  dataDiskMB: 512
  network:
    # The IP allocation mode: 'dhcp' or 'static'
    ipAllocationMode: ""
    # # The host config in static IP mode. Do not include if using DHCP
    # hostConfig:
    #   # The IPv4 static IP address for the admin workstation
    #   ip: ""
    #   # The IP address of the default gateway of the subnet in which the admin workstation
    #   # is to be created
    #   gateway: ""
    #   # The subnet mask of the network where you want to create your admin workstation
    #   # (e.g. 255.255.255.0)
    #   netmask: ""
    #   # The list of DNS nameservers to be used by the admin workstation
    #   dns:
    #   - ""
  # The URL of the proxy for the admin workstation
  proxyUrl: ""
  ntpServer: ntp.ubuntu.com

Preencher o ficheiro de configuração

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

gcp

Esta secção contém informações sobre a sua conta de serviço de acesso a componentes.

gcp.componentAccessServiceAccountKeyPath

String. O caminho do ficheiro de chave JSON para a sua conta de serviço de acesso a componentes. Para ver informações sobre como criar um ficheiro de chave JSON, consulte o artigo sobre a conta de serviço de acesso a componentes.

Por exemplo:

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

vCenter

Esta secção contém informações sobre o seu ambiente vSphere.

vCenter.credentials.address

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

Antes de preencher o campo address, transfira e inspecione o certificado de publicação do seu servidor vCenter. Introduza o seguinte comando para transferir o certificado e guardá-lo num ficheiro com o nome vcenter.pem.

true | openssl s_client -connect VCENTER_IP:443 -showcerts 2>/dev/null | sed -ne '/-BEGIN/,/-END/p' > vcenter.pem

Substitua VCENTER_IP pelo endereço IP do seu vCenter Server.

Abra o ficheiro do certificado para ver o nome comum do requerente e o nome alternativo do requerente:

openssl x509 -in vcenter.pem -text -noout

O resultado mostra o Subject nome comum (CN). Pode ser um endereço IP ou um nome de anfitrião. Por exemplo:

Subject: ... CN = 203.0.113.100

Subject: ... CN = my-host.my-domain.example

O resultado também pode incluir um ou mais nomes de DNS em Subject Alternative Name:

X509v3 Subject Alternative Name:
    DNS:vcenter.my-domain.example

Escolha o SubjectNome comum ou um dos nomes de DNS em Subject Alternative Name para usar como valor de vcenter.credentials.address no seu ficheiro de configuração. Por exemplo:

vCenter:
  credentials:
    address: "203.0.113.1"
    ...

vCenter:
  credentials:
    address: "my-host.my-domain.example"
    ...

vCenter.credentials.fileRef.path

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.

Quando executa gkeadm create config, cria um modelo para um ficheiro de configuração da estação de trabalho de administrador denominado admin-ws-config.yaml. Também cria um modelo para um ficheiro de configuração de credenciais denominado credential.yaml.

Exemplo:

vCenter:
  credentials:
    fileRef:
      path: "credential.yaml"

vCenter.credentials.fileRef.entry

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.

No credential.yaml, o gkeadm cria automaticamente um bloco de credenciais denominado vCenter.

Exemplo:

vCenter:
  credentials:
    fileRef:
      entry: "vCenter"

vCenter.datacenter

String. O nome do seu centro de dados do vCenter. Por exemplo:

vCenter:
  datacenter: "MY-DATACENTER"

vCenter.datastore

String. O nome do seu banco de dados do vCenter. Por exemplo:

vCenter:
  datastore: "MY-DATASTORE"

vCenter.cluster

String. O nome do seu cluster do vCenter. Por exemplo:

vCenter:
  cluster: "MY-CLUSTER"

vCenter.network

String. O nome da rede do vCenter onde quer criar a sua estação de trabalho de administrador. Por exemplo:

vCenter:
  network: "MY-VM-NETWORK"

vCenter.folder

String. A pasta no seu centro de dados onde as VMs do cluster vão estar localizadas. Por exemplo:

vCenter:
  folder: "MY-FOLDER"

vCenter.resourcePool

String. Se estiver a usar um conjunto de recursos não predefinido, indique o nome do seu conjunto de recursos do vCenter. Por exemplo:

vCenter:
  resourcePool: "MY-POOL"

Se estiver a usar o conjunto de recursos predefinido, indique o seguinte valor:

vCenter:
  resourcePool: "MY_CLUSTER/Resources"

Substitua MY_CLUSTER pelo nome do cluster do vCenter.

Consulte o artigo Especificar o conjunto de recursos raiz para um anfitrião autónomo.

vCenter.caCertPath

String. Quando um cliente, como o Google Distributed Cloud, envia um pedido ao seu servidor vCenter, o servidor tem de provar a sua identidade ao cliente apresentando um certificado ou um pacote de certificados. Para validar o certificado ou o pacote, o Google Distributed Cloud tem de ter o certificado de raiz na cadeia de confiança.

Defina vCenter.caCertPath para o caminho do certificado de raiz. Por exemplo:

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

A sua instalação do VMware tem uma autoridade de certificação (AC) que emite um certificado para o seu servidor vCenter. O certificado de raiz na cadeia de confiança é um certificado autoassinado criado pela VMware.

Se não quiser usar a AC da VMWare, que é a predefinição, pode configurar o VMware para usar uma autoridade de certificação diferente.

Se o seu servidor vCenter usar um certificado emitido pela AC da VMware predefinida, transfira o certificado da seguinte forma:

curl -k "https://SERVER_ADDRESS/certs/download.zip" > download.zip

Substitua SERVER_ADDRESS pela morada do seu servidor vCenter.

Instale o comando unzip e descomprima o ficheiro de certificado:

sudo apt-get install unzip
unzip download.zip

Se o comando de descompressão não funcionar da primeira vez, introduza o comando novamente.

Encontre o ficheiro de certificado em certs/lin.

proxyUrl

String: se a máquina que está a usar para executar gkeadm usar um servidor proxy para aceder à Internet, defina este campo para o URL do servidor proxy. Inclua o número da porta, mesmo que seja o mesmo que a porta predefinida do esquema. Por exemplo:

proxyUrl: "https://my-proxy.example.local:80"

adminWorkstation

Esta secção contém informações sobre a sua estação de trabalho de administração.

adminWorkstation.name

String. Um nome para a sua estação de trabalho de administrador. Este campo é preenchido com um valor gerado. Pode manter o valor gerado ou indicar outro nome à sua escolha. Por exemplo:

adminWorkstation
  name: "gke-admin-ws-200617-113711"

adminWorkstation.cpus

Número inteiro. O número de CPUs virtuais para a sua estação de trabalho de administrador. Por exemplo:

adminWorkstation:
  cpus: 4

adminWorkstation.memoryMB

Número inteiro. O número de megabytes de memória para a sua estação de trabalho de administração. Por exemplo:

adminworkstation:
  memoryMB: 8192

adminWorkstation.diskGB

Número inteiro. O tamanho, em gigabytes, do disco de arranque da estação de trabalho do administrador. Recomendamos, pelo menos, 100 GB e, na versão 1.28 e posterior, são necessários 100 GB. Por exemplo:

adminWorkstation:
  diskGB: 100

adminWorkstation.dataDiskName

String. Um nome para o disco persistente a ser montado no diretório base. Este campo é preenchido com um valor gerado. Pode manter o valor gerado ou indicar um nome à sua escolha. Tem de terminar com .vmdk. Qualquer diretório no caminho fornecido tem de ser criado antes da implementação. Se não for definido nenhum valor para este campo, a predefinição é:

gke-on-prem-admin-workstation-data-disk/ADMIN_WORKSTATION_NAME-data-disk.vmdk

Por exemplo:

adminWorkstation:
  dataDiskName: "gke-on-prem-admin-workstation-data-disk/gke-admin-ws-200617-113711-data-disk.vmdk"

adminWorkstation.dataDiskMB

Número inteiro. O tamanho em megabytes do disco de dados. Se não for definido nenhum valor para este campo, o valor predefinido é 512. Por exemplo:

adminWorkstation:
  dataDiskMB: 512

adminWorkstation.network.ipAllocationMode

String. Se quiser que a estação de trabalho do administrador obtenha o respetivo endereço IP a partir de um servidor DHCP, defina esta opção como "dhcp". Se quiser que a sua estação de trabalho de administração tenha um endereço IP estático à sua escolha, defina esta opção como "static". Por exemplo:

adminWorkstation:
  network:
    ipAllocationMode: "static"

adminWorkstation.network.hostconfig

Se definir ipAllocationMode como "static", preencha os campos nesta secção.

Se definir ipAllocationMode como "dhcp", remova esta secção ou deixe-a comentada.

adminWorkstation.network.hostConfig.ip

String. Um endereço IP à sua escolha para a estação de trabalho do administrador. Por exemplo:

adminWorkstation:
  network:
    hostconfig:
      ip: "172.16.5.1"

Nota: se o seu sistema usar um tempo de execução do Docker, tenha em atenção que a rede predefinida do daemon do Docker é 172.17.0.0/16. Certifique-se de que o endereço IP que selecionar para adminWorkstation.network.hostConfig.ip não está nessa rede.

adminWorkstation.network.hostConfig.gateway

String. O endereço IP da gateway predefinida para a rede que contém a sua estação de trabalho de administrador. Por exemplo:

adminWorkstation:
  network:
    hostconfig:
      gateway: "172.16.6.254"

adminWorkstation.network.hostConfig.netmask

String. A máscara de rede da rede que contém a sua estação de trabalho de administração. Por exemplo:

adminWorkstation:
  network:
    hostConfig:
      netmask: "255.255.248.0"

adminWorkstation.network.hostConfig.dns

Matriz de strings. Uma matriz de endereços IP para servidores DNS que a estação de trabalho do administrador pode usar. Por exemplo:

adminWorkstation:
  network:
    hostconfig:
      dns:
      - "172.16.255.1"
      - "172.16.255.2"

adminWorkstation.proxyUrl

String. Se a sua rede estiver protegida por um servidor proxy e quiser que a estação de trabalho do administrador e o cluster do administrador usem o mesmo servidor proxy, defina adminworkstation.proxyURL para o URL do servidor proxy. Inclua o número da porta, mesmo que seja o mesmo que a porta predefinida do esquema. Por exemplo:

adminworkstation:
  proxyUrl: "http://aw-proxy.example:80"

adminWorkstation.ntpServer

String. O nome do anfitrião ou o endereço IP do servidor do Network Time Protocol que a estação de trabalho do administrador deve usar. Por exemplo:

adminWorkstation:
  ntpServer: "216.239.35.0"

Se deixar este campo vazio, o Google Distributed Cloud usa "ntp.ubuntu.com".

Exemplo de um ficheiro de configuração concluído

Segue-se um exemplo de um ficheiro de configuração da estação de trabalho de administrador concluído:

gcp:
  componentAccessServiceAccountKeyPath: "my-key-folder/component-access-key.json"
vCenter:
  credentials:
    address: "203.0.113.1"
    username: "administrator.vsphere.local"
    password: "#STyZ2T#Ko2o"
  datacenter: "MY-DATACENTER"
  datastore: "MY-DATASTORE"
  cluster: "MY-CLUSTER"
  network: "MY-VM-NETWORK"
  resourcePool: "MY-POOL"
  caCertPath: "/usr/local/google/home/me/certs/the-root.cert"
proxyUrl: ""
adminWorkstation:
  name: "my-admin-workstation"
  cpus: 4
  memoryMB: 8192
  diskGB: 50
  dataDiskName: "gke-on-prem-admin-workstation-data-disk/gke-admin-ws-200617-113711-data-disk.vmdk"
  dataDiskMB: 512
  network:
    ipAllocationMode: "static"
    hostConfig:
      ip: "172.16.5.1"
      gateway: "172.16.6.254"
      netmask: "255.255.248.0"
      dns:
      - "172.16.255.1"
      - "172.16.255.2
  proxyUrl: ""
  ntpServer: "216.239.35.0"