REST Resource: projects.locations.bareMetalAdminClusters

Ressource : BareMetalAdminCluster

Ressource représentant un cluster d'administrateur Bare Metal.

Représentation JSON 
{
  "name": string,
  "description": string,
  "uid": string,
  "bareMetalVersion": string,
  "state": enum (State),
  "endpoint": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "localName": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "networkConfig": {
    object (BareMetalAdminNetworkConfig)
  },
  "controlPlane": {
    object (BareMetalAdminControlPlaneConfig)
  },
  "loadBalancer": {
    object (BareMetalAdminLoadBalancerConfig)
  },
  "storage": {
    object (BareMetalAdminStorageConfig)
  },
  "fleet": {
    object (Fleet)
  },
  "clusterOperations": {
    object (BareMetalAdminClusterOperationsConfig)
  },
  "status": {
    object (ResourceStatus)
  },
  "maintenanceConfig": {
    object (BareMetalAdminMaintenanceConfig)
  },
  "maintenanceStatus": {
    object (BareMetalAdminMaintenanceStatus)
  },
  "validationCheck": {
    object (ValidationCheck)
  },
  "nodeConfig": {
    object (BareMetalAdminWorkloadNodeConfig)
  },
  "proxy": {
    object (BareMetalAdminProxyConfig)
  },
  "securityConfig": {
    object (BareMetalAdminSecurityConfig)
  },
  "nodeAccessConfig": {
    object (BareMetalAdminNodeAccessConfig)
  },
  "osEnvironmentConfig": {
    object (BareMetalAdminOsEnvironmentConfig)
  },
  "binaryAuthorization": {
    object (BinaryAuthorization)
  }
}
Champs
name

string

Immuable. Nom de ressource du cluster d'administrateur Bare Metal.
description

string

Description lisible de ce cluster d'administrateur Bare Metal.
uid

string

Uniquement en sortie. Identifiant unique du cluster d'administration bare metal.
bareMetalVersion

string

Version des clusters Anthos sur Bare Metal pour le cluster d'administrateur Bare Metal.
state

enum (State)

Uniquement en sortie. État actuel du cluster d'administration Bare Metal.
endpoint

string

Uniquement en sortie. Nom de l'adresse IP du serveur d'API du cluster d'administrateur Bare Metal.
reconciling

boolean

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

string (Timestamp format)

Uniquement en sortie. Date et heure auxquelles ce cluster d'administrateur bare metal a été créé.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé 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 de la dernière mise à jour de ce cluster d'administrateur bare metal.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé 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".
deleteTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle ce cluster d'administrateur Bare Metal a été supprimé. Si la ressource n'est pas supprimée, ce champ doit être vide.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé 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".
localName

string

Uniquement en sortie. Nom d'objet de la ressource personnalisée du cluster Bare Metal. Ce champ permet de gérer les noms conflictuels lors de l'enregistrement de clusters existants auprès de l'API. Lorsqu'il est utilisé dans l'enregistrement d'un cluster, ce champ diffère de l'ID figurant dans le 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 ressource. Il n'est pas modifiable.

Tous les utilisateurs doivent utiliser ce nom pour accéder à leur cluster à l'aide de gkectl ou kubectl, et s'attendre à voir le nom local lorsqu'ils consultent les journaux du contrôleur de cluster d'administrateur.
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.
annotations

map (key: string, value: string)

Annotations sur le cluster d'administrateur Bare Metal. 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" }.
networkConfig

object (BareMetalAdminNetworkConfig)

Configuration réseau.
controlPlane

object (BareMetalAdminControlPlaneConfig)

Configuration du plan de contrôle.
loadBalancer

object (BareMetalAdminLoadBalancerConfig)

Configuration de l'équilibreur de charge.
storage

object (BareMetalAdminStorageConfig)

Configuration du stockage.
fleet

object (Fleet)

Uniquement en sortie. Configuration du parc pour le cluster.
clusterOperations

object (BareMetalAdminClusterOperationsConfig)

Configuration des opérations de cluster.
status

object (ResourceStatus)

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

object (BareMetalAdminMaintenanceConfig)

Configuration de la maintenance.
maintenanceStatus

object (BareMetalAdminMaintenanceStatus)

Uniquement en sortie. MaintenanceStatus représentant l'état de la maintenance.
validationCheck

object (ValidationCheck)

Uniquement en sortie. ValidationCheck représentant le résultat de la vérification préliminaire.
nodeConfig

object (BareMetalAdminWorkloadNodeConfig)

Configuration du nœud de charge de travail.
proxy

object (BareMetalAdminProxyConfig)

Configuration du proxy.
securityConfig

object (BareMetalAdminSecurityConfig)

Configuration liée à la sécurité.
nodeAccessConfig

object (BareMetalAdminNodeAccessConfig)

Configurations liées à l'accès aux nœuds.
osEnvironmentConfig

object (BareMetalAdminOsEnvironmentConfig)

Configurations liées à l'environnement de l'OS.
binaryAuthorization

object (BinaryAuthorization)

Configurations liées à l'autorisation binaire.

État

État du cycle de vie du cluster d'administration bare metal.

Énumérations
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 ses 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 les fonctionnalités.

BareMetalAdminNetworkConfig

BareMetalAdminNetworkConfig spécifie la configuration réseau du cluster.

Représentation JSON 
{

  // Union field cluster_cidr_configuration can be only one of the following:
  "islandModeCidr": {
    object (BareMetalAdminIslandModeCidrConfig)
  }
  // End of list of possible types for union field cluster_cidr_configuration.
}
Champs
Champ d'union cluster_cidr_configuration. Configuration CIDR à utiliser dans le cluster d'administrateur. cluster_cidr_configuration ne peut être qu'un des éléments suivants :
islandModeCidr

object (BareMetalAdminIslandModeCidrConfig)

Configuration du bloc CIDR du mode Île.

BareMetalAdminIslandModeCidrConfig

BareMetalAdminIslandModeCidrConfig spécifie la configuration du CIDR du cluster en mode île.

Représentation JSON 
{
  "serviceAddressCidrBlocks": [
    string
  ],
  "podAddressCidrBlocks": [
    string
  ]
}
Champs
serviceAddressCidrBlocks[]

string

Obligatoire. Une adresse IPv4 RFC1918 de ces plages est attribuée à chaque service du cluster. Une fois le compte créé, ce champ ne peut plus être modifié.
podAddressCidrBlocks[]

string

Obligatoire. Une adresse IPv4 RFC1918 de ces plages est attribuée à chaque pod du cluster. Une fois le compte créé, ce champ ne peut plus être modifié.

BareMetalAdminControlPlaneConfig

BareMetalAdminControlPlaneConfig spécifie la configuration du plan de contrôle.

Représentation JSON 
{
  "controlPlaneNodePoolConfig": {
    object (BareMetalAdminControlPlaneNodePoolConfig)
  },
  "apiServerArgs": [
    {
      object (BareMetalAdminApiServerArgument)
    }
  ]
}
Champs
controlPlaneNodePoolConfig

object (BareMetalAdminControlPlaneNodePoolConfig)

Obligatoire. Configure le pool de nœuds exécutant le plan de contrôle. Si spécifié, le NodePool correspondant sera créé pour le plan de contrôle du cluster. Le NodePool aura le même nom et le même espace de noms que le cluster.
apiServerArgs[]

object (BareMetalAdminApiServerArgument)

Personnalise les arguments par défaut du serveur d'API. Seul un sous-ensemble d'indicateurs personnalisés est accepté. Veuillez consulter la documentation du serveur d'API ci-dessous pour connaître le format exact : https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/.

BareMetalAdminControlPlaneNodePoolConfig

BareMetalAdminControlPlaneNodePoolConfig spécifie la configuration du pool de nœuds du plan de contrôle. Nous disposons d'une configuration de pool de nœuds spécifique au plan de contrôle afin de pouvoir prendre en charge de manière flexible les champs spécifiques au plan de contrôle à l'avenir.

Représentation JSON 
{
  "nodePoolConfig": {
    object (BareMetalNodePoolConfig)
  }
}
Champs
nodePoolConfig

object (BareMetalNodePoolConfig)

Obligatoire. Configuration générique d'un pool de nœuds exécutant le plan de contrôle.

BareMetalAdminApiServerArgument

BareMetalAdminApiServerArgument représente une paire nom->valeur d'argument. Seul un sous-ensemble d'indicateurs personnalisés est accepté. Veuillez consulter la documentation du serveur d'API ci-dessous pour connaître le format exact : https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/.

Représentation JSON 
{
  "argument": string,
  "value": string
}
Champs
argument

string

Obligatoire. Nom de l'argument tel qu'il apparaît sur la ligne de commande du serveur d'API. Veillez à supprimer les tirets de début.
value

string

Obligatoire. Valeur de l'argument tel qu'il sera transmis à la ligne de commande du serveur d'API.

BareMetalAdminLoadBalancerConfig

BareMetalAdminLoadBalancerConfig spécifie la configuration de l'équilibreur de charge.

Représentation JSON 
{
  "vipConfig": {
    object (BareMetalAdminVipConfig)
  },
  "portConfig": {
    object (BareMetalAdminPortConfig)
  },

  // Union field load_balancer_configuration can be only one of the following:
  "manualLbConfig": {
    object (BareMetalAdminManualLbConfig)
  }
  // End of list of possible types for union field load_balancer_configuration.
}
Champs
vipConfig

object (BareMetalAdminVipConfig)

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

object (BareMetalAdminPortConfig)

Configure les ports sur lesquels l'équilibreur de charge écoutera.
Champ d'union load_balancer_configuration. Configuration de l'équilibreur de charge à utiliser dans le cluster d'administrateur. load_balancer_configuration ne peut être qu'un des éléments suivants :
manualLbConfig

object (BareMetalAdminManualLbConfig)

Équilibreurs de charge configurés manuellement.

BareMetalAdminVipConfig

BareMetalAdminVipConfig pour les configurations d'équilibreur de charge Bare Metal.

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

string

Adresse IP virtuelle que vous avez précédemment réservée pour l'API Kubernetes de ce cluster d'administrateur Bare Metal.

BareMetalAdminPortConfig

BareMetalAdminPortConfig est la spécification des ports de l'équilibreur de charge.

Représentation JSON 
{
  "controlPlaneLoadBalancerPort": integer
}
Champs
controlPlaneLoadBalancerPort

integer

Port sur lequel les équilibreurs de charge hébergés du plan de contrôle écouteront.

BareMetalAdminManualLbConfig

BareMetalAdminManualLbConfig représente les paramètres de configuration d'un équilibreur de charge manuel.

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

boolean

Indique si l'équilibrage de charge manuel est activé.

BareMetalAdminStorageConfig

BareMetalAdminStorageConfig spécifie la configuration du stockage du cluster.

Représentation JSON 
{
  "lvpShareConfig": {
    object (BareMetalLvpShareConfig)
  },
  "lvpNodeMountsConfig": {
    object (BareMetalLvpConfig)
  }
}
Champs
lvpShareConfig

object (BareMetalLvpShareConfig)

Obligatoire. Spécifie la configuration des PersistentVolumes locaux secondés (protégés) par des sous-répertoires dans un système de fichiers partagé. Ces sous-répertoires sont générés automatiquement lors de la création du cluster.
lvpNodeMountsConfig

object (BareMetalLvpConfig)

Obligatoire. Spécifie la configuration des PersistentVolumes locaux secondés par des disques de nœud installés. Ces disques doivent être formatés et installés par l'utilisateur, avant ou après la création du cluster.

BareMetalAdminClusterOperationsConfig

BareMetalAdminClusterOperationsConfig spécifie l'infrastructure d'observabilité du cluster d'administrateur.

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

boolean

Indique si la collecte des journaux/métriques d'application doit être activée (en plus des journaux/métriques système).

BareMetalAdminMaintenanceConfig

BareMetalAdminMaintenanceConfig spécifie les configurations permettant de placer les nœuds des CR du cluster d'administrateur Bare Metal en mode maintenance et d'en sortir.

Représentation JSON 
{
  "maintenanceAddressCidrBlocks": [
    string
  ]
}
Champs
maintenanceAddressCidrBlocks[]

string

Obligatoire. Toutes les adresses IPv4 de ces plages seront placées en mode maintenance. Les nœuds en mode maintenance seront marqués comme non programmables et drainés. Lorsque ces deux conditions sont remplies, l'annotation "baremetal.cluster.gke.io/maintenance" est définie sur la ressource de nœud.

BareMetalAdminMaintenanceStatus

BareMetalAdminMaintenanceStatus représente l'état de maintenance des nœuds du CR du cluster d'administration Bare Metal.

Représentation JSON 
{
  "machineDrainStatus": {
    object (BareMetalAdminMachineDrainStatus)
  }
}
Champs
machineDrainStatus

object (BareMetalAdminMachineDrainStatus)

Représente l'état des nœuds de machine en cours de vidange et vidangés. Il est utilisé pour afficher la progression de la mise à niveau du cluster.

BareMetalAdminMachineDrainStatus

BareMetalAdminMachineDrainStatus représente l'état des machines de nœuds Bare Metal en cours de drainage.

Représentation JSON 
{
  "drainingMachines": [
    {
      object (BareMetalAdminDrainingMachine)
    }
  ],
  "drainedMachines": [
    {
      object (BareMetalAdminDrainedMachine)
    }
  ]
}
Champs
drainingMachines[]

object (BareMetalAdminDrainingMachine)

Liste des machines de vidange.
drainedMachines[]

object (BareMetalAdminDrainedMachine)

Liste des machines vidées.

BareMetalAdminDrainingMachine

BareMetalAdminDrainingMachine représente les machines en cours de vidange.

Représentation JSON 
{
  "nodeIp": string,
  "podCount": integer
}
Champs
nodeIp

string

Adresse IP de la machine à vider.
podCount

integer

Nombre de pods à vider.

BareMetalAdminDrainedMachine

BareMetalAdminDrainedMachine représente les machines drainées.

Représentation JSON 
{
  "nodeIp": string
}
Champs
nodeIp

string

Adresse IP de la machine vidée.

BareMetalAdminWorkloadNodeConfig

BareMetalAdminWorkloadNodeConfig spécifie les configurations des nœuds de charge de travail.

Représentation JSON 
{
  "maxPodsPerNode": string
}
Champs
maxPodsPerNode

string (int64 format)

Nombre maximal de pods qu'un nœud peut exécuter. La taille de la plage CIDR attribuée au nœud sera dérivée de ce paramètre. Par défaut, 110 pods sont créés par nœud. La limite supérieure est de 250 pour les clusters d'administrateur haute disponibilité et standards. La limite inférieure est de 64 pour les clusters d'administrateur non HD et de 32 pour les clusters d'administrateur HD.

BareMetalAdminProxyConfig

BareMetalAdminProxyConfig spécifie la configuration du proxy du cluster.

Représentation JSON 
{
  "uri": string,
  "noProxy": [
    string
  ]
}
Champs
uri

string

Obligatoire. Spécifie l'adresse de votre serveur proxy. Exemples : http://domain

AVERTISSEMENT : Ne fournissez pas d'identifiants au format http://(username:password@)domain, car ils seront rejetés par le serveur.
noProxy[]

string

Liste d'adresses IP, de noms d'hôtes et de domaines qui doivent ignorer le proxy. Exemples : ["127.0.0.1", "example.com", ".corp", "localhost"].

BareMetalAdminSecurityConfig

Spécifie les paramètres de sécurité du cluster d'administrateur Bare Metal.

Représentation JSON 
{
  "authorization": {
    object (Authorization)
  }
}
Champs
authorization

object (Authorization)

Configure l'accès des utilisateurs au cluster d'administrateur.

BareMetalAdminNodeAccessConfig

Spécifie les paramètres liés à l'accès aux nœuds pour le cluster d'administrateur Bare Metal.

Représentation JSON 
{
  "loginUser": string
}
Champs
loginUser

string

Obligatoire. LoginUser est le nom d'utilisateur utilisé pour accéder aux machines de nœud. Si aucune valeur n'est définie, la valeur par défaut est "root".

BareMetalAdminOsEnvironmentConfig

Spécifie les paramètres de fonctionnement du système d'exploitation pour le provisionnement du cluster.

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

boolean

Indique si le dépôt de packages doit être ajouté lors de l'initialisation des machines Bare Metal.

Méthodes

create

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

enroll

 Enregistre un cluster d'administrateur Bare Metal existant auprès de l'API Anthos On-Prem dans un projet et un emplacement donnés.

get

 Récupère les détails d'un seul cluster d'administrateur bare metal.

list

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

patch

 Mettre à jour les paramètres d'un seul cluster d'administrateur bare metal.

queryVersionConfig

 Interroge la configuration de la version du cluster d'administrateur Bare Metal.