Arquivo de configuração da estação de trabalho de administrador

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

Como gerar um modelo para o arquivo de configuração

Faça o download da ferramenta de linha de comando gkeadm.

Para gerar um modelo:

./gkeadm create config --config=OUTPUT_FILENAME

Substitua OUTPUT_FILENAME por um caminho que você preferir para o modelo gerado. Se você omitir essa sinalização, gkeadm nomeará o arquivo admin-ws-config.yaml e o colocará 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

Como preencher o arquivo de configuração

No arquivo de configuração, insira os valores de campo conforme descrito nas seções a seguir.

gcp

Nesta seção, você encontra informações sobre sua conta de serviço de acesso a componentes.

gcp.componentAccessServiceAccountKeyPath

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

Por exemplo:

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

vCenter

Esta seção contém informações sobre o ambiente do vSphere.

vCenter.credentials.address

String. O endereço IP ou o nome do host do servidor vCenter.

Antes de preencher o campo address, faça o download e inspecione o certificado de exibição do servidor vCenter. Digite o comando a seguir para fazer o download do certificado e salvá-lo em um arquivo chamado 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 servidor do vCenter.

Abra o arquivo de certificado para ver o nome comum e o alternativo do assunto:

openssl x509 -in vcenter.pem -text -noout

A saída mostra o nome comum (CN, na sigla em inglês) Subject. Pode ser um endereço IP ou um nome do host. Por exemplo:

Subject: ... CN = 203.0.113.100

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

A saída 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 nome comum Subject ou um dos nomes de DNS em Subject Alternative Name para usar como o valor de vcenter.credentials.address no arquivo 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 arquivo de configuração de credenciais que contém o nome de usuário e a senha da sua conta de usuário do vCenter. A conta de usuário precisa ter o papel de administrador ou privilégios equivalentes. Consulte os requisitos do vSphere.

Quando você executa gkeadm create config, ele cria um modelo para um arquivo de configuração de estação de trabalho de administrador chamado admin-ws-config.yaml. Ele também cria um modelo para um arquivo de configuração de credenciais chamado credential.yaml.

Exemplo:

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

vCenter.credentials.fileRef.entry

String. O nome do bloco de credenciais, no arquivo de configuração de credenciais, que contém o nome de usuário e a senha da conta de usuário do vCenter.

Em credential.yaml, gkeadm cria automaticamente um bloco de credenciais chamado vCenter.

Exemplo:

vCenter:
  credentials:
    fileRef:
      entry: "vCenter"

vCenter.datacenter

String. O nome do data center do vCenter. Por exemplo:

vCenter:
  datacenter: "MY-DATACENTER"

vCenter.datastore

String. O nome do armazenamento 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 vCenter em que você quer criar a estação de trabalho de administrador. Por exemplo:

vCenter:
  network: "MY-VM-NETWORK"

vCenter.folder

String. A pasta em seu data center em que suas VMs de cluster estarão localizadas. Por exemplo:

vCenter:
  folder: "MY-FOLDER"

vCenter.resourcePool

String. Se você estiver usando um pool de recursos que não seja o padrão, forneça o nome do pool de recursos do vCenter. Por exemplo:

vCenter:
  resourcePool: "MY-POOL"

Se você estiver usando o pool de recursos padrão, forneça o seguinte valor:

vCenter:
  resourcePool: "MY_CLUSTER/Resources"

Substitua MY_CLUSTER pelo nome do cluster do vCenter.

Consulte Como especificar o pool de recursos raiz para um host autônomo.

vCenter.caCertPath

String. Quando um cliente, como o Google Distributed Cloud, envia uma solicitação ao servidor vCenter, o servidor precisa provar a própria identidade ao cliente apresentando um certificado ou um pacote de certificados. Para verificar o certificado ou pacote, o Google Distributed Cloud precisa ter o certificado raiz na cadeia de confiança.

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

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

A instalação do VMware tem uma autoridade de certificação (CA, na sigla em inglês) que emite um certificado para o servidor vCenter. O certificado raiz na cadeia de confiança é um certificado autoassinado criado pela VMware.

Se você não quiser usar a CA do VMWare, que é o padrão, configure o VMware para usar uma autoridade de certificação diferente.

Se o servidor vCenter usa um certificado emitido pela CA do VMware padrão, faça o download do certificado da seguinte maneira:

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

Substitua SERVER_ADDRESS pelo endereço do servidor do vCenter.

Instale o comando unzip e descompacte o arquivo de certificado:

sudo apt-get install unzip
unzip download.zip

Se o comando para descompactar não funcionar na primeira vez, digite o comando novamente.

Encontre o arquivo de certificado em certs/lin.

proxyUrl

String: se a máquina que você estiver usando para executar gkeadm usar um servidor proxy para acessar a Internet, defina esse campo como o URL do servidor proxy. Inclua o número da porta mesmo que ele seja igual à porta padrão do esquema. Por exemplo:

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

adminWorkstation

Esta seção contém informações sobre a estação de trabalho do administrador.

adminWorkstation.name

String. Um nome para a estação de trabalho do administrador. Esse campo é preenchido com um valor gerado. É possível manter o valor gerado ou fornecer um nome diferente de sua escolha. Por exemplo:

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

adminWorkstation.cpus

Número inteiro. O número de CPUs virtuais para 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 estação de trabalho do administrador. Exemplo:

adminworkstation:
  memoryMB: 8192

adminWorkstation.diskGB

Número inteiro. O tamanho, em gigabytes, do disco de inicialização da estação de trabalho do administrador. Recomendamos pelo menos 100 GB, e na versão 1.28 e mais recentes, 100 GB são obrigatórios. Exemplo:

adminWorkstation:
  diskGB: 100

adminWorkstation.dataDiskName

String. Um nome para o disco permanente a ser ativado para o diretório inicial. Esse campo é preenchido com um valor gerado. É possível manter o valor gerado ou fornecer um nome de sua escolha. Termina com .vmdk. Qualquer diretório no caminho fornecido precisa ser criado antes da implantação. Se nenhum valor for definido para esse campo, o padrão será:

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 nenhum valor for definido para esse campo, o padrão será 512. Por exemplo:

adminWorkstation:
  dataDiskMB: 512

adminWorkstation.network.ipAllocationMode

String. Se você quiser que a estação de trabalho do administrador receba o endereço IP de um servidor DHCP, defina-o como "dhcp". Se você quiser que a estação de trabalho de administrador tenha um endereço IP estático de sua escolha, defina como "static". Por exemplo:

adminWorkstation:
  network:
    ipAllocationMode: "static"

adminWorkstation.network.hostconfig

Se você definir ipAllocationMode como "static", preencha os campos nesta seção.

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

adminWorkstation.network.hostConfig.ip

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

adminWorkstation:
  network:
    hostconfig:
      ip: "172.16.5.1"

Observação: se o sistema usa um ambiente de execução do Docker, a rede padrão do daemon do Docker é 172.17.0.0/16. Verifique se o endereço IP selecionado para adminWorkstation.network.hostConfig.ip não está nessa rede.

adminWorkstation.network.hostConfig.gateway

String. O endereço IP do gateway padrão da rede que contém sua estação de trabalho do 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 sua estação de trabalho do administrador. 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 rede estiver protegida por um servidor proxy e você quiser que a estação de trabalho de administrador e o cluster do administrador usem o mesmo servidor proxy, defina adminworkstation.proxyURL como o URL desse servidor. Inclua o número da porta mesmo que ele seja igual à porta padrão do esquema. Exemplo:

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

adminWorkstation.ntpServer

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

adminWorkstation:
  ntpServer: "216.239.35.0"

Se você deixar esse campo em branco, o Google Distributed Cloud usará "ntp.ubuntu.com".

Exemplo de arquivo de configuração concluído

Veja um exemplo de um arquivo de configuração concluído da estação de trabalho do administrador:

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"