REST Resource: projects.locations.vmwareAdminClusters

Ressource: VmwareAdminCluster

Ressource représentant un cluster d'administration VMware.

Représentation JSON
{
  "name": string,
  "description": string,
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "annotations": {
    string: string,
    ...
  },
  "state": enum (State),
  "endpoint": string,
  "reconciling": boolean,
  "localName": string,
  "bootstrapClusterMembership": string,
  "onPremVersion": string,
  "fleet": {
    object (Fleet)
  },
  "imageType": string,
  "vcenter": {
    object (VmwareAdminVCenterConfig)
  },
  "networkConfig": {
    object (VmwareAdminNetworkConfig)
  },
  "loadBalancer": {
    object (VmwareAdminLoadBalancerConfig)
  },
  "controlPlaneNode": {
    object (VmwareAdminControlPlaneNodeConfig)
  },
  "addonNode": {
    object (VmwareAdminAddonNodeConfig)
  },
  "antiAffinityGroups": {
    object (VmwareAAGConfig)
  },
  "autoRepairConfig": {
    object (VmwareAutoRepairConfig)
  },
  "status": {
    object (ResourceStatus)
  },
  "platformConfig": {
    object (VmwarePlatformConfig)
  },
  "preparedSecrets": {
    object (VmwareAdminPreparedSecretsConfig)
  },
  "authorization": {
    object (VmwareAdminAuthorizationConfig)
  },
  "validationCheck": {
    object (ValidationCheck)
  }
}
Champs
name

string

Immuable. Nom de la ressource du cluster d'administrateur VMware.

description

string

Description lisible de ce cluster d'administrateur VMware.

uid

string

Uniquement en sortie. Identifiant unique du cluster d'administration VMware.

etag

string

Cette somme de contrôle est calculée par le serveur en fonction de la valeur des autres champs. Elle peut être envoyée lors des requêtes de mise à jour et de suppression pour s'assurer que le client dispose d'une valeur à jour avant de continuer. Permet aux clients d'effectuer des opérations de lecture-modification-écriture cohérentes via un contrôle de simultanéité optimiste.

createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le cluster administrateur VMware a été créé.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés.Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le cluster d'administrateur VMware a été mis à jour pour la dernière fois.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés.Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

annotations

map (key: string, value: string)

Annotations sur le cluster d'administrateur VMware. Ce champ est soumis aux mêmes restrictions que les annotations Kubernetes. La taille totale de toutes les clés et valeurs combinées est limitée à 256 000. La clé peut comporter deux segments : un préfixe (facultatif) et un nom (obligatoire), séparés par une barre oblique (/). Le préfixe doit être un sous-domaine DNS. Le nom ne doit pas dépasser 63 caractères. Il doit commencer et se terminer par un caractère alphanumérique, et contenir des tirets (-), des traits de soulignement (_) et des points (.), avec des caractères alphanumériques entre chaque symbole.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

state

enum (State)

Uniquement en sortie. État actuel du cluster d'administrateur VMware.

endpoint

string

Uniquement en sortie. Nom DNS du serveur d'API du cluster d'administrateur VMware.

reconciling

boolean

Uniquement en sortie. Si cette option est définie, des modifications sont en cours de diffusion dans le cluster administrateur VMware.

localName

string

Uniquement en sortie. Nom de l'objet de la ressource personnalisée VMware OnPremAdminCluster. Ce champ permet de gérer les noms en conflit lors de l'enregistrement de clusters existants dans l'API. Lorsqu'il est utilisé dans le cadre de l'enregistrement de cluster, ce champ diffère de l'ID du nom de la ressource. Pour les nouveaux clusters, ce champ correspond au nom de cluster fourni par l'utilisateur et est visible dans le dernier composant du nom de la ressource. Il n'est pas modifiable.

Tous les utilisateurs doivent utiliser ce nom pour accéder à leur cluster à l'aide de gkectl ou kubectl. Ils doivent s'attendre à voir le nom local lorsqu'ils consultent les journaux du contrôleur de cluster administrateur.

bootstrapClusterMembership

string

Cluster d'amorçage auquel appartient ce cluster d'administrateur VMware.

onPremVersion

string

Version d'Anthos clusters on VMware pour le cluster d'administrateur.

fleet

object (Fleet)

Uniquement en sortie. Configuration du parc pour le cluster.

imageType

string

Type d'image de l'OS pour le cluster d'administrateur VMware.

vcenter

object (VmwareAdminVCenterConfig)

Configuration VCenter du cluster d'administrateur VMware.

networkConfig

object (VmwareAdminNetworkConfig)

Configuration réseau du cluster d'administrateur VMware.

loadBalancer

object (VmwareAdminLoadBalancerConfig)

Configuration de l'équilibreur de charge du cluster d'administrateur VMware.

controlPlaneNode

object (VmwareAdminControlPlaneNodeConfig)

Configuration du nœud du plan de contrôle du cluster d'administrateur VMware.

addonNode

object (VmwareAdminAddonNodeConfig)

Configuration du nœud supplémentaire du cluster d'administrateur VMware.

antiAffinityGroups

object (VmwareAAGConfig)

Configuration du groupe d'anti-affinité du cluster d'administrateur VMware.

autoRepairConfig

object (VmwareAutoRepairConfig)

Configuration de la réparation automatique du cluster d'administrateur VMware.

status

object (ResourceStatus)

Uniquement en sortie. ResourceStatus représentant l'état détaillé du cluster.

platformConfig

object (VmwarePlatformConfig)

Configuration de la plate-forme VMware.

preparedSecrets

object (VmwareAdminPreparedSecretsConfig)

Uniquement en sortie. Configuration des secrets préparés du cluster d'administrateur VMware. Il doit toujours être activé par l'API Central, au lieu de laisser les utilisateurs le définir.

authorization

object (VmwareAdminAuthorizationConfig)

Configuration de l'autorisation du cluster d'administrateur VMware.

validationCheck

object (ValidationCheck)

Uniquement en sortie. ValidationCheck représente le résultat de la tâche de vérification préliminaire.

État

État du cycle de vie du cluster d'administrateur VMware.

Enums
STATE_UNSPECIFIED Non défini.
PROVISIONING L'état "PROVISIONING" (En cours de provisionnement) indique que le cluster est en cours de création.
RUNNING L'état "RUNNING" (En cours d'exécution) indique que le cluster a été créé et qu'il est entièrement utilisable.
RECONCILING L'état "RECONCILING" (Rapprochement) indique que le cluster est en cours de mise à jour. Il reste disponible, mais les performances peuvent être dégradées.
STOPPING L'état "STOPPING" (Arrêt) indique que le cluster est en cours de suppression.
ERROR L'état "ERROR" (Erreur) indique que le cluster est dans un état défaillant irrécupérable.
DEGRADED L'état "DEGRADED" (Dégradé) indique que le cluster nécessite une action de l'utilisateur pour restaurer toutes ses fonctionnalités.

VmwareAdminVCenterConfig

VmwareAdminVCenterConfig contient la configuration VCenter pour le cluster d'administrateur VMware.

Représentation JSON
{
  "resourcePool": string,
  "datastore": string,
  "datacenter": string,
  "cluster": string,
  "folder": string,
  "caCertData": string,
  "address": string,
  "dataDisk": string,
  "storagePolicyName": string
}
Champs
resourcePool

string

Nom du pool de ressources vCenter pour le cluster d'administrateur.

datastore

string

Nom du datastore vCenter pour le cluster d'administrateur.

datacenter

string

Nom du centre de données vCenter pour le cluster d'administrateur.

cluster

string

Nom du cluster vCenter pour le cluster d'administrateur.

folder

string

Nom du dossier vCenter du cluster d'administrateur.

caCertData

string

Contient la clé publique du certificat de l'autorité de certification vCenter pour la validation SSL.

address

string

Adresse IP de vCenter.

dataDisk

string

Nom du disque de machine virtuelle (VMDK) pour le cluster d'administrateur.

storagePolicyName

string

Nom de la règle de stockage vCenter pour le cluster d'utilisateur.

VmwareAdminNetworkConfig

VmwareAdminNetworkConfig contient la configuration réseau du cluster d'administrateur VMware.

Représentation JSON
{
  "serviceAddressCidrBlocks": [
    string
  ],
  "podAddressCidrBlocks": [
    string
  ],
  "vcenterNetwork": string,
  "hostConfig": {
    object (VmwareHostConfig)
  },
  "haControlPlaneConfig": {
    object (VmwareAdminHAControlPlaneConfig)
  },

  // Union field ip_configuration can be only one of the following:
  "staticIpConfig": {
    object (VmwareStaticIpConfig)
  },
  "dhcpIpConfig": {
    object (VmwareDhcpIpConfig)
  }
  // End of list of possible types for union field ip_configuration.
}
Champs
serviceAddressCidrBlocks[]

string

Obligatoire. Une adresse IPv4 RFC1918 de ces plages est attribuée à chaque service du cluster. Une seule plage est acceptée. Ce champ ne peut plus être modifié une fois l'espace créé.

podAddressCidrBlocks[]

string

Obligatoire. Une adresse IPv4 RFC1918 de ces plages est attribuée à chaque pod du cluster. Une seule plage est acceptée. Ce champ ne peut plus être modifié une fois l'espace créé.

vcenterNetwork

string

vcenterNetwork spécifie le nom du réseau vCenter.

hostConfig

object (VmwareHostConfig)

Représente les paramètres réseau courants, quelle que soit l'adresse IP de l'hôte.

haControlPlaneConfig

object (VmwareAdminHAControlPlaneConfig)

Configuration du plan de contrôle du cluster d'administrateur haute disponibilité.

Champ d'union ip_configuration. Type de configuration IP utilisé par le cluster d'administration VMware. ip_configuration ne peut être qu'un des éléments suivants :
staticIpConfig

object (VmwareStaticIpConfig)

Paramètres de configuration pour une adresse IP statique.

dhcpIpConfig

object (VmwareDhcpIpConfig)

Paramètres de configuration pour une configuration IP DHCP.

VmwareAdminHAControlPlaneConfig

Spécifie la configuration du plan de contrôle d'administration HA.

Représentation JSON
{
  "controlPlaneIpBlock": {
    object (VmwareIpBlock)
  }
}
Champs
controlPlaneIpBlock

object (VmwareIpBlock)

Adresses IP statiques pour les nœuds du plan de contrôle de l'administrateur.

VmwareAdminLoadBalancerConfig

VmwareAdminLoadBalancerConfig contient la configuration de l'équilibreur de charge pour le cluster d'administrateur VMware.

Représentation JSON
{
  "vipConfig": {
    object (VmwareAdminVipConfig)
  },

  // Union field load_balancer_configuration can be only one of the following:
  "f5Config": {
    object (VmwareAdminF5BigIpConfig)
  },
  "manualLbConfig": {
    object (VmwareAdminManualLbConfig)
  },
  "metalLbConfig": {
    object (VmwareAdminMetalLbConfig)
  },
  "seesawConfig": {
    object (VmwareAdminSeesawConfig)
  }
  // End of list of possible types for union field load_balancer_configuration.
}
Champs
vipConfig

object (VmwareAdminVipConfig)

Adresses IP virtuelles utilisées par l'équilibreur de charge.

Champ d'union load_balancer_configuration. Configuration de l'équilibreur de charge à utiliser dans le cluster d'administration VMware. load_balancer_configuration ne peut être qu'un des éléments suivants :
f5Config

object (VmwareAdminF5BigIpConfig)

Configuration pour les équilibreurs de charge de type F5 Big IP.

manualLbConfig

object (VmwareAdminManualLbConfig)

Équilibreurs de charge configurés manuellement

metalLbConfig

object (VmwareAdminMetalLbConfig)

Équilibreurs de charge MetalLB.

seesawConfig

object (VmwareAdminSeesawConfig)

Uniquement en sortie. Configuration pour les équilibreurs de charge de type Seesaw.

VmwareAdminVipConfig

VmwareAdminVipConfig pour les configurations d'équilibreur de charge VMware.

Représentation JSON
{
  "controlPlaneVip": string,
  "addonsVip": string
}
Champs
controlPlaneVip

string

L'adresse IP virtuelle que vous avez précédemment réservée pour l'API Kubernetes du cluster d'administrateur.

addonsVip

string

Adresse IP virtuelle pour configurer l'équilibreur de charge pour les modules complémentaires.

VmwareAdminF5BigIpConfig

VmwareAdminF5BigIpConfig représente les paramètres de configuration d'un équilibreur de charge F5 BIG-IP.

Représentation JSON
{
  "address": string,
  "partition": string,
  "snatPool": string
}
Champs
address

string

Adresse IP de l'équilibreur de charge.

partition

string

Partition préexistante à utiliser par l'équilibreur de charge. Cette partition est généralement créée pour le cluster d'administration (par exemple, "my-f5-admin-partition").

snatPool

string

Nom du pool. Uniquement nécessaire si vous utilisez la traduction d'adresse réseau source.

VmwareAdminManualLbConfig

Représentation JSON
{
  "ingressHttpNodePort": integer,
  "ingressHttpsNodePort": integer,
  "controlPlaneNodePort": integer,
  "konnectivityServerNodePort": integer,
  "addonsNodePort": integer
}
Champs
ingressHttpNodePort

integer

NodePort pour le protocole HTTP du service d'entrée. Le service d'entrée du cluster d'administrateur est mis en œuvre en tant que service de type NodePort (par exemple, 32527).

ingressHttpsNodePort

integer

NodePort pour le protocole HTTPS du service d'entrée. Le service d'entrée du cluster d'administrateur est mis en œuvre en tant que service de type NodePort (par exemple, 30139).

controlPlaneNodePort

integer

NodePort pour le service de plan de contrôle. Le serveur d'API Kubernetes du cluster d'administrateur est mis en œuvre en tant que service de type NodePort (par exemple, 30968).

konnectivityServerNodePort

integer

NodePort pour le service de serveur de connectivité exécuté en tant que sidecar dans chaque pod kube-apiserver (par exemple, 30564).

addonsNodePort

integer

NodePort pour le serveur de modules complémentaires dans le cluster d'administrateur.

VmwareAdminMetalLbConfig

VmwareAdminMetalLbConfig représente les paramètres de configuration d'un équilibreur de charge MetalLB. Pour les clusters d'administrateur, aucune configuration n'est actuellement requise.

Représentation JSON
{
  "enabled": boolean
}
Champs
enabled

boolean

Indique si MetalLB est activé.

VmwareAdminSeesawConfig

VmwareSeesawConfig représente les paramètres de configuration d'un équilibreur de charge Seesaw déjà existant.

IMPORTANT: Veuillez noter que l'API Anthos On-Prem ne génère ni ne met à jour de configurations Seesaw. Elle ne peut lier qu'une configuration préexistante à un nouveau cluster d'utilisateurs.

IMPORTANT: Lorsque vous essayez de créer un cluster d'utilisateurs avec un équilibreur de charge Seesaw préexistant, vous devez suivre certaines étapes de préparation avant d'appeler la méthode d'API vmwareClusters.create. Vous devez d'abord créer l'espace de noms du cluster d'utilisateur via kubectl. L'espace de noms doit utiliser la convention d'attribution de noms suivante : -gke-onprem-mgmt ou -gke-onprem-mgmt selon que vous avez utilisé "VmwareCluster.local_name" pour lever les ambiguïtés. Pour en savoir plus, consultez la documentation sur "VmwareCluster.local_name". Une fois l'espace de noms créé, vous devez créer une ressource de secret via kubectl. Ce secret contiendra des copies de vos identifiants Seesaw. Le secret doit être appelé "user-cluster-creds" et contenir les identifiants SSH et de certificat de Seesaw. Les identifiants doivent être associés aux noms suivants: "seesaw-ssh-private-key", "seesaw-ssh-public-key", "seesaw-ssh-ca-key" et "seesaw-ssh-ca-cert".

Représentation JSON
{
  "group": string,
  "masterIp": string,
  "ipBlocks": [
    {
      object (VmwareIpBlock)
    }
  ],
  "enableHa": boolean,
  "vms": [
    string
  ],
  "stackdriverName": string
}
Champs
group

string

En général, le format suivant doit être utilisé pour le nom du groupe Seesaw: seesaw-for-[nom du cluster].

masterIp

string

MasterIP est l'adresse IP annoncée par le maître du groupe Seesaw.

ipBlocks[]

object (VmwareIpBlock)

Blocs d'adresses IP à utiliser par l'équilibreur de charge Seesaw

enableHa

boolean

Activez deux VM d'équilibrage de charge pour obtenir un équilibreur de charge Seesaw à haute disponibilité.

vms[]

string

Noms des VM créées pour ce groupe Seesaw.

stackdriverName

string

Nom à utiliser par Stackdriver.

VmwareAdminControlPlaneNodeConfig

VmwareAdminControlPlaneNodeConfig contient la configuration du nœud de plan de contrôle pour le cluster d'administrateur VMware.

Représentation JSON
{
  "cpus": string,
  "memory": string,
  "replicas": string
}
Champs
cpus

string (int64 format)

Nombre de vCPU pour le nœud du plan de contrôle du cluster d'administrateur.

memory

string (int64 format)

Nombre de mébioctets de mémoire pour le nœud de plan de contrôle du cluster d'administrateur.

replicas

string (int64 format)

Nombre de nœuds de plan de contrôle pour ce cluster d'administrateur VMware. (par défaut: 1 réplique)

VmwareAdminAddonNodeConfig

VmwareAdminAddonNodeConfig contient les configurations de nœuds de modules complémentaires pour le cluster d'administrateur VMware.

Représentation JSON
{
  "autoResizeConfig": {
    object (VmwareAutoResizeConfig)
  }
}
Champs
autoResizeConfig

object (VmwareAutoResizeConfig)

La configuration VmwareAutoResizeConfig spécifie la configuration de redimensionnement automatique.

VmwarePlatformConfig

VmwarePlatformConfig représente la configuration de la plate-forme VMware.

Représentation JSON
{
  "requiredPlatformVersion": string,
  "platformVersion": string,
  "bundles": [
    {
      object (VmwareBundleConfig)
    }
  ],
  "status": {
    object (ResourceStatus)
  }
}
Champs
requiredPlatformVersion

string

Uniquement en entrée. Version de la plate-forme requise (par exemple, 1.13.1). Si la version actuelle de la plate-forme est antérieure à la version cible, la version cible sera appliquée. Si la version cible n'est pas installée sur la plate-forme (versions groupées), téléchargez le groupe de versions cibles.

platformVersion

string

Uniquement en sortie. Version de la plate-forme (par exemple, 1.13.2).

bundles[]

object (VmwareBundleConfig)

Uniquement en sortie. Liste des bundles installés dans le cluster d'administration.

status

object (ResourceStatus)

Uniquement en sortie. État de la ressource pour la plate-forme.

VmwareBundleConfig

VmwareBundleConfig représente la configuration du bundle.

Représentation JSON
{
  "version": string,
  "status": {
    object (ResourceStatus)
  }
}
Champs
version

string

Version du bundle.

status

object (ResourceStatus)

Uniquement en sortie. État de la ressource du groupe.

VmwareAdminPreparedSecretsConfig

VmwareAdminPreparedSecretsConfig représente la configuration des secrets préparés du cluster d'administrateur.

Représentation JSON
{
  "enabled": boolean
}
Champs
enabled

boolean

Indique si les secrets préparés sont activés.

VmwareAdminAuthorizationConfig

VmwareAdminAuthorizationConfig représente la configuration de l'autorisation de cluster d'administrateur.

Représentation JSON
{
  "viewerUsers": [
    {
      object (ClusterUser)
    }
  ]
}
Champs
viewerUsers[]

object (ClusterUser)

Pour les clusters d'administrateur VMware, le rôle cluster-viewer sera attribué aux utilisateurs sur le cluster.

Méthodes

create

Crée un cluster d'administrateur VMware dans un projet et un emplacement donnés.

enroll

Inscrit un cluster d'administrateur VMware existant à l'API Anthos On-Prem dans un projet et un emplacement donnés.

get

Récupère les informations d'un seul cluster d'administrateur VMware.

list

Répertorie les clusters d'administrateur VMware d'un projet et d'un emplacement donnés.

patch

Met à jour les paramètres d'un seul cluster administrateur VMware.