Fichier de configuration du poste de travail administrateur

Cette page décrit les champs du fichier de configuration du poste de travail administrateur pour GKE sur VMware.

Générer un modèle pour votre fichier de configuration

Télécharger l'outil de ligne de commande gkeadm :

Pour générer un modèle, procédez comme suit :

./gkeadm create config --config=OUTPUT_FILENAME

Remplacez OUTPUT_FILENAME par le chemin d'accès que vous avez choisi pour le modèle généré. Si vous omettez cette option, gkeadm nomme le fichier admin-ws-config.yaml et le place dans le répertoire actuel.

Modèle

Cliquez pour afficher le modèle généré.

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

Remplir votre fichier de configuration

Dans votre fichier de configuration, saisissez les valeurs des champs comme décrit dans les sections suivantes.

`gcp`

Cette section contient des informations sur votre compte de service d'accès au composant.

`gcp.componentAccessServiceAccountKeyPath`

Chaîne. Chemin d'accès au fichier de clé JSON de votre compte de service d'accès au composant. Pour en savoir plus sur la création d'un fichier de clé JSON, consultez la section Compte de service d'accès au composant.

Exemple :

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

`vCenter`

Cette section contient des informations sur votre environnement vSphere.

`vCenter.credentials.address`

Chaîne. Adresse IP ou nom d'hôte de votre serveur vCenter.

Avant de remplir le champ address, téléchargez et inspectez le certificat de diffusion de votre serveur vCenter. Saisissez la commande suivante pour télécharger le certificat et l'enregistrer dans un fichier nommé vcenter.pem.

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

Remplacez VCENTER_IP par l'adresse IP de votre serveur vCenter.

Ouvrez le fichier de certificat pour afficher le nom commun d'objet et le nom alternatif d'objet :

openssl x509 -in vcenter.pem -text -noout

Le résultat indique le nom commun (CN) d'objet (Subject). Il peut s'agir d'une adresse IP ou d'un nom d'hôte. Exemple :

Subject: ... CN = 203.0.113.100

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

Le résultat peut également inclure un ou plusieurs noms DNS sous Subject Alternative Name :

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

Choisissez le nom commun Subject ou l'un des noms DNS sous Subject Alternative Name pour l'utiliser comme valeur du champ vcenter.credentials.address dans votre fichier de configuration. Exemple :

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

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

`vCenter.credentials.fileRef.path`

Chaîne. Chemin d'accès d'un fichier de configuration des identifiants contenant le nom d'utilisateur et le mot de passe de votre compte utilisateur vCenter. Le compte utilisateur doit disposer du rôle d'administrateur ou de privilèges équivalents. Consultez les exigences concernant vSphere.

Lorsque vous exécutez gkeadm create config, il crée un modèle pour un fichier de configuration de poste de travail administrateur nommé admin-ws-config.yaml. Il crée également un modèle pour un fichier de configuration d'identifiants nommé credential.yaml.

Exemple :

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

`vCenter.credentials.fileRef.entry`

Chaîne. Nom du bloc d'identifiants, dans votre fichier de configuration des identifiants, qui contient le nom d'utilisateur et le mot de passe de votre compte utilisateur vCenter.

Dans credential.yaml, gkeadm crée automatiquement un bloc d'identifiants nommé vCenter.

Exemple :

vCenter:
  credentials:
    fileRef:
      entry: "vCenter"

`vCenter.datacenter`

Chaîne. Nom de votre centre de données vCenter. Exemple :

vCenter:
  datacenter: "MY-DATACENTER"

`vCenter.datastore`

Chaîne. Nom de votre magasin de données vCenter. Exemple :

vCenter:
  datastore: "MY-DATASTORE"

`vCenter.cluster`

Chaîne. Nom de votre cluster vCenter. Exemple :

vCenter:
  cluster: "MY-CLUSTER"

`vCenter.network`

Chaîne. Nom du réseau vCenter dans lequel vous souhaitez créer le poste de travail administrateur. Exemple :

vCenter:
  network: "MY-VM-NETWORK"

`vCenter.folder`

Chaîne. Dossier dans votre centre de données où seront situées les VM de cluster. Exemple :

vCenter:
  folder: "MY-FOLDER"

`vCenter.resourcePool`

Chaîne. Si vous utilisez un pool de ressources autre que celui par défaut, indiquez le nom de votre pool de ressources vCenter. Exemple :

vCenter:
  resourcePool: "MY-POOL"

Si vous utilisez le pool de ressources par défaut, indiquez la valeur suivante :

vCenter:
  resourcePool: "MY_CLUSTER/Resources"

Remplacez MY_CLUSTER par le nom de votre cluster vCenter.

Consultez la section Spécifier le pool de ressources racine pour un hôte autonome.

`vCenter.caCertPath`

Chaîne. Lorsqu'un client, tel que GKE sur VMware, envoie une requête à votre serveur vCenter, celui-ci doit prouver son identité au client en présentant un certificat ou un groupe de certificats. Pour valider le certificat ou le groupe, le certificat racine doit se trouver dans la chaîne de confiance de GKE sur VMware.

Définissez vCenter.caCertPath sur le chemin d'accès du certificat racine. Exemple :

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

Votre installation VMware comporte une autorité de certification qui émet un certificat sur votre serveur vCenter. Le certificat racine de la chaîne de confiance est un certificat autosigné créé par VMware.

Si vous ne souhaitez pas utiliser l'autorité de certification VMWare, qui est définie par défaut, vous pouvez configurer VMware de sorte à utiliser une autre autorité de certification.

Si votre serveur vCenter utilise un certificat émis par l'autorité de certification VMware par défaut, téléchargez-le comme suit :

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

Remplacez SERVER_ADDRESS par l'adresse de votre serveur vCenter.

Installez la commande unzip et décompressez le fichier de certificat :

sudo apt-get install unzip
unzip download.zip

Si la commande de décompression ne fonctionne pas au premier essai, saisissez-la à nouveau.

Recherchez le fichier de certificat dans certs/lin.

`proxyUrl`

Chaîne : Si la machine que vous utilisez pour exécuter gkeadm utilise un serveur proxy pour accéder à Internet, définissez ce champ sur l'URL du serveur proxy. Exemple :

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

`adminWorkstation`

Cette section contient des informations sur le poste de travail administrateur.

`adminWorkstation.name`

Chaîne. Nom du poste de travail administrateur. Ce champ est renseigné avec une valeur par défaut. Vous pouvez conserver cette valeur ou indiquer un nom de votre choix. Exemple :

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

`adminWorkstation.cpus`

Entier. Nombre de processeurs virtuels pour votre poste de travail d'administrateur. Exemple :

adminWorkstation:
  cpus: 4

`adminWorkstation.memoryMB`

Entier. Nombre de mégaoctets de mémoire pour votre poste de travail d'administrateur. Exemple :

adminworkstation:
  memoryMB: 8192

`adminWorkstation.diskGB`

Entier. Taille, exprimée en gigaoctets, du disque de démarrage du poste de travail administrateur. Nous vous recommandons d'utiliser un disque d'au moins 100 Go. Exemple :

adminWorkstation:
  diskGB: 100

`adminWorkstation.dataDiskName`

Chaîne. Nom du disque persistant à installer dans le répertoire d'accueil. Ce champ est renseigné avec une valeur par défaut. Vous pouvez conserver cette valeur ou indiquer un nom de votre choix. Il doit se terminer par .vmdk. Vous devez créer les répertoires du chemin d'accès fourni avant le déploiement. Si aucune valeur n'est définie pour ce champ, la valeur par défaut est la suivante :

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

Exemple :

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

`adminWorkstation.dataDiskMB`

Entier. Taille du disque de données, exprimée en mégaoctets. Si aucune valeur n'est définie pour ce champ, la valeur par défaut est 512. Exemple :

adminWorkstation:
  dataDiskMB: 512

`adminWorkstation.network.ipAllocationMode`

Chaîne. Si vous souhaitez que votre poste de travail administrateur obtienne son adresse IP à partir d'un serveur DNS, définissez ce paramètre sur "dhcp". Si vous souhaitez que votre poste de travail administrateur dispose de l'adresse IP statique de votre choix, définissez ce paramètre sur "static". Exemple :

adminWorkstation:
  network:
    ipAllocationMode: "static"

`adminWorkstation.network.hostconfig`

Si vous définissez ipAllocationMode sur "static", renseignez les champs de cette section.

Si vous définissez ipAllocationMode sur "dhcp", supprimez cette section ou laissez-la en commentaire.

`adminWorkstation.network.hostConfig.ip`

Chaîne. Adresse IP de votre choix pour votre poste de travail d'administrateur. Exemple :

adminWorkstation:
  network:
    hostconfig:
      ip: "172.16.5.1"

`adminWorkstation.network.hostConfig.gateway`

Chaîne. Adresse IP de la passerelle par défaut pour le réseau contenant votre poste de travail d'administrateur. Exemple :

adminWorkstation:
  network:
    hostconfig:
      gateway: "172.16.6.254"

`adminWorkstation.network.hostConfig.netmask`

Chaîne. Masque de réseau pour le réseau contenant votre poste de travail d'administrateur. Exemple :

adminWorkstation:
  network:
    hostConfig:
      netmask: "255.255.248.0"

`adminWorkstation.network.hostConfig.dns`

Tableau de chaînes. Tableau d'adresses IP de serveurs DNS que votre poste de travail d'administrateur peut utiliser. Exemple :

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

`adminWorkstation.proxyUrl`

Chaîne. Si votre réseau se trouve derrière un serveur proxy et que vous souhaitez que votre poste de travail administrateur et votre GKE sur VMware utilisent le même serveur proxy, définissez adminworkstation.proxyURL sur l'URL du serveur proxy. Exemple :

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

`adminWorkstation.ntpServer`

Chaîne. Nom d'hôte ou adresse IP du serveur NTP que votre poste de travail d'administrateur doit utiliser. Exemple :

adminWorkstation:
  ntpServer: "216.239.35.0"

Si vous laissez ce champ vide, GKE sur VMware utilise "ntp.ubuntu.com".

Exemple de fichier de configuration terminé

Voici un exemple de fichier de configuration complet pour un poste de travail administrateur :

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"