Archivo de configuración de estación de trabajo de administrador

En esta página se describen los campos del archivo de configuración de la estación de trabajo de administrador de Google Distributed Cloud.

Generar una plantilla para el archivo de configuración

Descarga la herramienta de línea de comandos gkeadm.

Para generar una plantilla, siga estos pasos:

./gkeadm create config --config=OUTPUT_FILENAME

Sustituye OUTPUT_FILENAME por la ruta que quieras para la plantilla generada. Si omites esta marca, gkeadm asigna el nombre admin-ws-config.yaml al archivo y lo coloca en el directorio actual.

Plantilla

Haz clic para ver la plantilla generada.

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

Rellenar el archivo de configuración

En el archivo de configuración, introduce los valores de los campos tal como se describe en las secciones siguientes.

gcp

Esta sección contiene información sobre tu cuenta de servicio de acceso a componentes.

gcp.componentAccessServiceAccountKeyPath

Cadena. Ruta del archivo de clave JSON de tu cuenta de servicio de acceso a componentes. Para obtener información sobre cómo crear un archivo de clave JSON, consulta el artículo sobre la cuenta de servicio de acceso a componentes.

Por ejemplo:

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

vCenter

En esta sección se incluye información sobre tu entorno de vSphere.

vCenter.credentials.address

Cadena. La dirección IP o el nombre de host de tu servidor de vCenter.

Antes de rellenar el campo address, descarga e inspecciona el certificado de servicio de tu servidor vCenter. Introduce el siguiente comando para descargar el certificado y guardarlo en un archivo llamado vcenter.pem.

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

Sustituye VCENTER_IP por la dirección IP de tu servidor vCenter.

Abre el archivo del certificado para ver el nombre común del asunto y el nombre alternativo del asunto:

openssl x509 -in vcenter.pem -text -noout

El resultado muestra el nombre común (CN) de Subject. Puede ser una dirección IP o un nombre de host. Por ejemplo:

Subject: ... CN = 203.0.113.100

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

El resultado también puede incluir uno o varios nombres de DNS en Subject Alternative Name:

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

Elige el Subjectnombre comúnSubject Alternative Name o uno de los nombres de DNS que aparecen en Subject Subject Alternative Namepara usarlo como valor de vcenter.credentials.address en tu archivo de configuración. Por ejemplo:

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

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

vCenter.credentials.fileRef.path

Cadena. Ruta de un archivo de configuración de credenciales que contiene el nombre de usuario y la contraseña de tu cuenta de usuario de vCenter. La cuenta de usuario debe tener el rol de administrador o privilegios equivalentes. Consulta los requisitos de vSphere.

Cuando ejecutas gkeadm create config, se crea una plantilla para un archivo de configuración de estación de trabajo de administrador llamado admin-ws-config.yaml. También crea una plantilla para un archivo de configuración de credenciales llamado credential.yaml.

Ejemplo:

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

vCenter.credentials.fileRef.entry

Cadena. El nombre del bloque de credenciales en tu archivo de configuración de credenciales, que contiene el nombre de usuario y la contraseña de tu cuenta de usuario de vCenter.

En credential.yaml, gkeadm crea automáticamente un bloque de credenciales llamado vCenter.

Ejemplo:

vCenter:
  credentials:
    fileRef:
      entry: "vCenter"

vCenter.datacenter

Cadena. El nombre de tu centro de datos de vCenter. Por ejemplo:

vCenter:
  datacenter: "MY-DATACENTER"

vCenter.datastore

Cadena. El nombre de tu almacén de datos de vCenter. Por ejemplo:

vCenter:
  datastore: "MY-DATASTORE"

vCenter.cluster

Cadena. El nombre de tu clúster de vCenter. Por ejemplo:

vCenter:
  cluster: "MY-CLUSTER"

vCenter.network

Cadena. El nombre de la red de vCenter en la que quieres crear tu estación de trabajo de administrador. Por ejemplo:

vCenter:
  network: "MY-VM-NETWORK"

vCenter.folder

Cadena. La carpeta de tu centro de datos en la que se ubicarán las VMs de tu clúster. Por ejemplo:

vCenter:
  folder: "MY-FOLDER"

vCenter.resourcePool

Cadena. Si utilizas un pool de recursos que no es el predeterminado, indica el nombre de tu pool de recursos de vCenter. Por ejemplo:

vCenter:
  resourcePool: "MY-POOL"

Si usas el grupo de recursos predeterminado, proporciona el siguiente valor:

vCenter:
  resourcePool: "MY_CLUSTER/Resources"

Sustituye MY_CLUSTER por el nombre de tu clúster de vCenter.

Consulta Especificar el grupo de recursos raíz de un host independiente.

vCenter.caCertPath

Cadena. Cuando un cliente, como Google Distributed Cloud, envía una solicitud a tu servidor vCenter, el servidor debe demostrar su identidad al cliente presentando un certificado o un paquete de certificados. Para verificar el certificado o el paquete, Google Distributed Cloud debe tener el certificado raíz en la cadena de confianza.

Define vCenter.caCertPath como la ruta del certificado raíz. Por ejemplo:

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

Tu instalación de VMware tiene una autoridad de certificación (CA) que emite un certificado a tu servidor vCenter. El certificado raíz de la cadena de confianza es un certificado con firma automática creado por VMware.

Si no quieres usar la AC de VMWare, que es la predeterminada, puedes configurar VMware para usar otra autoridad de certificación.

Si tu servidor vCenter usa un certificado emitido por la AC predeterminada de VMware, descarga el certificado de la siguiente manera:

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

Sustituye SERVER_ADDRESS por la dirección de tu servidor de vCenter.

Instala el comando unzip y descomprime el archivo de certificado:

sudo apt-get install unzip
unzip download.zip

Si el comando de descompresión no funciona la primera vez, vuelve a introducirlo.

Busca el archivo de certificado en certs/lin.

proxyUrl

Cadena: si el ordenador que usas para ejecutar gkeadm utiliza un servidor proxy para acceder a Internet, asigna a este campo la URL del servidor proxy. Incluye el número de puerto aunque sea el mismo que el puerto predeterminado del esquema. Por ejemplo:

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

adminWorkstation

Esta sección contiene información sobre tu estación de trabajo de administrador.

adminWorkstation.name

Cadena. Un nombre para tu estación de trabajo de administrador. Este campo se rellena con un valor generado. Puedes conservar el valor generado o proporcionar otro nombre que elijas. Por ejemplo:

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

adminWorkstation.cpus

Número entero. Número de CPUs virtuales de tu estación de trabajo de administrador. Por ejemplo:

adminWorkstation:
  cpus: 4

adminWorkstation.memoryMB

Número entero. Cantidad de megabytes de memoria de tu estación de trabajo de administrador. Por ejemplo:

adminworkstation:
  memoryMB: 8192

adminWorkstation.diskGB

Número entero. Tamaño, en gigabytes, del disco de arranque de la estación de trabajo de administrador. Recomendamos que sea de al menos 100 GB. En la versión 1.28 y posteriores, es obligatorio que sea de 100 GB. Por ejemplo:

adminWorkstation:
  diskGB: 100

adminWorkstation.dataDiskName

Cadena. Nombre del disco persistente que se va a montar en el directorio principal. Este campo se rellena con un valor generado. Puedes conservar el valor generado o proporcionar el nombre que quieras. Debe terminar con .vmdk. Cualquier directorio de la ruta proporcionada debe crearse antes de la implementación. Si no se define ningún valor en este campo, se usará el siguiente valor predeterminado:

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

Por ejemplo:

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

adminWorkstation.dataDiskMB

Número entero. Tamaño del disco de datos en megabytes. Si no se define ningún valor para este campo, se utiliza 512 de forma predeterminada. Por ejemplo:

adminWorkstation:
  dataDiskMB: 512

adminWorkstation.network.ipAllocationMode

Cadena. Si quieres que tu estación de trabajo de administrador obtenga su dirección IP de un servidor DHCP, define este valor como "dhcp". Si quieres que tu estación de trabajo de administrador tenga una dirección IP estática de tu elección, selecciona "static". Por ejemplo:

adminWorkstation:
  network:
    ipAllocationMode: "static"

adminWorkstation.network.hostconfig

Si defines ipAllocationMode como "static", rellena los campos de esta sección.

Si asignas el valor "dhcp" a ipAllocationMode, elimina esta sección o déjala comentada.

adminWorkstation.network.hostConfig.ip

Cadena. Una dirección IP de tu elección para tu estación de trabajo de administrador. Por ejemplo:

adminWorkstation:
  network:
    hostconfig:
      ip: "172.16.5.1"

Nota: Si tu sistema usa un tiempo de ejecución de Docker, ten en cuenta que la red predeterminada del daemon de Docker es 172.17.0.0/16. Asegúrate de que la dirección IP que selecciones para adminWorkstation.network.hostConfig.ip no esté en esa red.

adminWorkstation.network.hostConfig.gateway

Cadena. La dirección IP de la pasarela predeterminada de la red que contiene tu estación de trabajo de administrador. Por ejemplo:

adminWorkstation:
  network:
    hostconfig:
      gateway: "172.16.6.254"

adminWorkstation.network.hostConfig.netmask

Cadena. La máscara de subred de la red que contiene tu estación de trabajo de administrador. Por ejemplo:

adminWorkstation:
  network:
    hostConfig:
      netmask: "255.255.248.0"

adminWorkstation.network.hostConfig.dns

Matriz de cadenas. Una matriz de direcciones IP de servidores DNS que puede usar tu estación de trabajo de administrador. Por ejemplo:

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

adminWorkstation.proxyUrl

Cadena. Si tu red está detrás de un servidor proxy y quieres que tanto tu estación de trabajo de administrador como tu clúster de administrador usen el mismo servidor proxy, asigna a adminworkstation.proxyURL la URL del servidor proxy. Incluya el número de puerto aunque sea el mismo que el puerto predeterminado del esquema. Por ejemplo:

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

adminWorkstation.ntpServer

Cadena. El nombre de host o la dirección IP del servidor del protocolo de tiempo de red que debe usar tu estación de trabajo de administrador. Por ejemplo:

adminWorkstation:
  ntpServer: "216.239.35.0"

Si lo dejas vacío, Google Distributed Cloud usará "ntp.ubuntu.com".

Ejemplo de archivo de configuración completo

Este es un ejemplo de un archivo de configuración de estación de trabajo de administrador completo:

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"