REST Resource: projects.locations.attachedClusters

Ressource : AttachedCluster

Cluster Anthos s'exécutant sur l'infrastructure du client.

Représentation JSON
{
  "name": string,
  "description": string,
  "oidcConfig": {
    object (AttachedOidcConfig)
  },
  "platformVersion": string,
  "distribution": string,
  "clusterRegion": string,
  "fleet": {
    object (Fleet)
  },
  "state": enum (State),
  "uid": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "kubernetesVersion": string,
  "annotations": {
    string: string,
    ...
  },
  "workloadIdentityConfig": {
    object (WorkloadIdentityConfig)
  },
  "loggingConfig": {
    object (LoggingConfig)
  },
  "errors": [
    {
      object (AttachedClusterError)
    }
  ],
  "authorization": {
    object (AttachedClustersAuthorization)
  },
  "monitoringConfig": {
    object (MonitoringConfig)
  },
  "proxyConfig": {
    object (AttachedProxyConfig)
  },
  "binaryAuthorization": {
    object (BinaryAuthorization)
  },
  "securityPostureConfig": {
    object (SecurityPostureConfig)
  },
  "tags": {
    string: string,
    ...
  },
  "systemComponentsConfig": {
    object (SystemComponentsConfig)
  }
}
Champs
name

string

Nom de cette ressource.

Les noms de cluster sont au format projects/<project-number>/locations/<region>/attachedClusters/<cluster-id>.

Pour en savoir plus sur les noms de ressources Google Cloud Platform, consultez Noms de ressources.

description

string

Facultatif. Description lisible de ce cluster. Ne doit pas comporter plus de 255 octets encodés au format UTF-8.

oidcConfig

object (AttachedOidcConfig)

Obligatoire. Configuration OpenID Connect (OIDC) pour le cluster.

platformVersion

string

Obligatoire. Version de la plate-forme du cluster (par exemple, 1.19.0-gke.1000).

Vous pouvez lister toutes les versions prises en charge dans une région Google Cloud donnée en appelant locations.getAttachedServerConfig.

distribution

string

Obligatoire. La distribution Kubernetes du cluster associé sous-jacent.

Valeurs acceptées : ["eks", "aks", "generic"].

clusterRegion

string

Uniquement en sortie. Région dans laquelle ce cluster s'exécute.

Pour les clusters EKS, il s'agit d'une région AWS. Pour les clusters AKS, il s'agit d'une région Azure.

fleet

object (Fleet)

Obligatoire. Configuration du parc.

state

enum (State)

Uniquement en sortie. État actuel du cluster.

uid

string

Uniquement en sortie. Identifiant global unique du cluster.

reconciling

boolean

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

createTime

string (Timestamp format)

Uniquement en sortie. Date et heure auxquelles ce cluster a été enregistré.

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. Date et heure de la dernière mise à jour de ce cluster.

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".

etag

string

Permet aux clients d'effectuer des opérations de lecture-modification-écriture cohérentes via un contrôle de simultanéité optimiste.

Peut être envoyé lors des requêtes de mise à jour et de suppression pour s'assurer que le client dispose d'une valeur à jour avant de continuer.

kubernetesVersion

string

Uniquement en sortie. Version de Kubernetes du cluster.

annotations

map (key: string, value: string)

Facultatif. Annotations sur le cluster.

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" }.

workloadIdentityConfig

object (WorkloadIdentityConfig)

Uniquement en sortie. Paramètres Workload Identity

loggingConfig

object (LoggingConfig)

Facultatif. Configuration de la journalisation pour ce cluster.

errors[]

object (AttachedClusterError)

Uniquement en sortie. Ensemble d'erreurs détectées dans le cluster.

authorization

object (AttachedClustersAuthorization)

Facultatif. Configuration liée aux paramètres RBAC du cluster.

monitoringConfig

object (MonitoringConfig)

Facultatif. Configuration de la surveillance pour ce cluster.

proxyConfig

object (AttachedProxyConfig)

Facultatif. Configuration du proxy pour le trafic HTTP(S) sortant.

binaryAuthorization

object (BinaryAuthorization)

Facultatif. Configuration de l'autorisation binaire pour ce cluster.

securityPostureConfig

object (SecurityPostureConfig)

Facultatif. Configuration de la stratégie de sécurité pour ce cluster.

tags

map (key: string, value: string)

Facultatif. Uniquement en entrée. Clés et valeurs de tags directement liées à cette ressource.

La clé de tag doit être spécifiée au format <tag namespace>/<tag key name>,, où l'espace de noms du tag correspond à l'ID de l'organisation ou au nom du projet dans lequel la clé de tag est définie. Le nom court d'une clé ou d'une valeur de tag ne peut pas comporter plus de 256 caractères. L'ensemble de caractères autorisés pour le nom abrégé inclut les caractères Unicode encodés au format UTF-8, à l'exception des guillemets simples ('), des guillemets doubles ("), des barres obliques inverses (\) et des barres obliques (/).

Pour en savoir plus sur les tags Google Cloud Platform, consultez Tags.

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

systemComponentsConfig

object (SystemComponentsConfig)

Facultatif. Configurations Kubernetes pour les composants installés automatiquement sur le cluster.

AttachedOidcConfig

Informations de découverte OIDC du cluster cible.

Les jetons de compte de service Kubernetes (KSA) sont des jetons JWT signés par le serveur d'API du cluster. Ce champ indique comment les services Google Cloud Platform valident les jetons KSA pour permettre aux charges de travail système (telles que les agents GKE Connect et de télémétrie) de s'authentifier auprès de Google Cloud Platform.

Les clusters avec des URL d'émetteur publiques et privées sont acceptés. Les clusters avec des émetteurs publics n'ont besoin de spécifier que le champ issuerUrl, tandis que les clusters avec des émetteurs privés doivent fournir à la fois issuerUrl et oidc_jwks.

Représentation JSON
{
  "issuerUrl": string,
  "jwks": string
}
Champs
issuerUrl

string

URI d'émetteur de jetons Web JSON (JWT). issuer doit commencer par https://.

jwks

string (bytes format)

Facultatif. Clés de validation OIDC au format JWKS (RFC 7517). Il contient une liste de clés de validation OIDC pouvant être utilisées pour valider les jetons JWT OIDC.

Ce champ est obligatoire pour les clusters qui ne disposent pas d'un point de terminaison de découverte accessible au public. Lorsqu'elle est fournie, elle est directement utilisée pour valider le jeton JWT OIDC affirmé par le fournisseur d'identité.

Chaîne encodée en base64.

État

État du cycle de vie du cluster.

Énumérations
STATE_UNSPECIFIED Non défini.
PROVISIONING L'état "PROVISIONING" (En cours de provisionnement) indique que le cluster est en cours d'enregistrement.
RUNNING L'état "RUNNING" (En cours d'exécution) indique que le cluster a été enregistré et qu'il est entièrement utilisable.
RECONCILING L'état "RECONCILING" (Rapprochement) indique que des opérations sont en cours sur le cluster, comme la mise à niveau de composants logiciels.
STOPPING L'état "STOPPING" (Arrêt) indique que le cluster est en cours de désenregistrement.
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.

AttachedClusterError

AttachedClusterError décrit les erreurs détectées sur les clusters associés.

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

string

Description de l'erreur compréhensible par l'utilisateur.

AttachedClustersAuthorization

Configuration liée aux paramètres RBAC du cluster.

Représentation JSON
{
  "adminUsers": [
    {
      object (AttachedClusterUser)
    }
  ],
  "adminGroups": [
    {
      object (AttachedClusterGroup)
    }
  ]
}
Champs
adminUsers[]

object (AttachedClusterUser)

Facultatif. Utilisateurs pouvant effectuer des opérations en tant qu'administrateurs de cluster. Un objet ClusterRoleBinding géré sera créé pour accorder le ClusterRole cluster-admin aux utilisateurs. Vous pouvez fournir jusqu'à dix utilisateurs administrateurs.

Pour en savoir plus sur le contrôle des accès basé sur les rôles, consultez la page https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles.

adminGroups[]

object (AttachedClusterGroup)

Facultatif. Groupes d'utilisateurs pouvant effectuer des opérations en tant qu'administrateurs de cluster. Un ClusterRoleBinding géré sera créé pour accorder le ClusterRole cluster-admin aux groupes. Vous pouvez fournir jusqu'à dix groupes d'administrateurs.

Pour en savoir plus sur le contrôle des accès basé sur les rôles, consultez la page https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles.

AttachedClusterUser

Identités d'un sujet de type utilisateur pour les clusters associés.

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

string

Obligatoire. Nom de l'utilisateur, par exemple my-gcp-id@gmail.com.

AttachedClusterGroup

Identités d'un sujet de type groupe pour les clusters associés.

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

string

Obligatoire. Nom du groupe, par exemple my-group@domain.com.

AttachedProxyConfig

Détails d'une configuration de proxy.

Représentation JSON
{
  "kubernetesSecret": {
    object (KubernetesSecret)
  }
}
Champs
kubernetesSecret

object (KubernetesSecret)

Ressource Kubernetes Secret contenant la configuration du proxy HTTP(S). Le secret doit être une configuration de proxy encodée au format JSON, comme décrit sur la page https://cloud.google.com/kubernetes-engine/multi-cloud/docs/attached/eks/how-to/use-a-proxy#configure-proxy-support pour les clusters EKS et https://cloud.google.com/kubernetes-engine/multi-cloud/docs/attached/aks/how-to/use-a-proxy#configure-proxy-support pour les clusters AKS.

KubernetesSecret

Informations sur un secret Kubernetes

Représentation JSON
{
  "name": string,
  "namespace": string
}
Champs
name

string

Nom du secret Kubernetes.

namespace

string

Espace de noms dans lequel le secret Kubernetes est stocké.

SecurityPostureConfig

SecurityPostureConfig définit les options nécessaires pour activer/désactiver les fonctionnalités de l'API Security Posture.

Représentation JSON
{
  "vulnerabilityMode": enum (VulnerabilityMode)
}
Champs
vulnerabilityMode

enum (VulnerabilityMode)

Définit le mode à utiliser pour l'analyse des failles.

VulnerabilityMode

La ressource VulnerabilityMode définit le mode d'activation pour l'analyse des failles.

Enums
VULNERABILITY_MODE_UNSPECIFIED Valeur par défaut non spécifiée.
VULNERABILITY_DISABLED Désactive l'analyse des failles sur le cluster.
VULNERABILITY_ENTERPRISE Applique la faille de sécurité de la stratégie de sécurité aux fonctionnalités de niveau Enterprise du cluster.

SystemComponentsConfig

SystemComponentsConfig définit les champs permettant de personnaliser les configurations des composants installés automatiquement.

Représentation JSON
{
  "tolerations": [
    {
      object (Toleration)
    }
  ],
  "labels": [
    {
      object (Label)
    }
  ]
}
Champs
tolerations[]

object (Toleration)

Définit des tolérances personnalisées pour les pods créés par les composants installés automatiquement.

labels[]

object (Label)

Définit des libellés personnalisés pour les pods créés par les composants installés automatiquement.

Tolérance

La tolérance définit les champs de tolérance pour les pods créés par les composants installés automatiquement.

Représentation JSON
{
  "key": string,
  "value": string,
  "keyOperator": enum (KeyOperator),
  "effect": enum (Effect)
}
Champs
key

string

"Key" est la clé de rejet à laquelle s'applique la tolérance.

value

string

"Value" correspond à la valeur du taint à laquelle s'applique la tolérance.

keyOperator

enum (KeyOperator)

KeyOperator représente la relation d'une clé avec la valeur, par exemple "Exist".

effect

enum (Effect)

L'effet indique l'effet de rejet à faire correspondre (par exemple, "NoSchedule").

KeyOperator

KeyOperator représente la relation d'une clé avec la valeur, par exemple "Égal à".

Énumérations
KEY_OPERATOR_UNSPECIFIED L'opérateur n'est pas spécifié.
KEY_OPERATOR_EQUAL L'opérateur correspond à "Égal à".
KEY_OPERATOR_EXISTS L'opérateur correspond à "Existe".

Effet

"effect" indique l'effet de rejet à faire correspondre (par exemple, "NoSchedule").

Énumérations
EFFECT_UNSPECIFIED L'effet n'est pas spécifié.
EFFECT_NO_SCHEDULE L'effet correspond à "NoSchedule".
EFFECT_PREFER_NO_SCHEDULE L'effet correspond à "PreferNoSchedule".
EFFECT_NO_EXECUTE L'effet est mappé sur "NoExecute".

Libellé

Le libellé définit les champs supplémentaires pour les libellés des pods créés par les composants installés automatiquement.

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

string

Il s'agit de la clé du libellé.

value

string

Il s'agit de la valeur du libellé.

Méthodes

create

Crée une ressource AttachedCluster dans un projet et une région Google Cloud Platform donnés.

delete

Supprime une ressource AttachedCluster spécifique.

generateAttachedClusterAgentToken

Génère un jeton d'accès pour un agent de cluster.

get

Décrit une ressource AttachedCluster spécifique.

import

Imports crée une ressource AttachedCluster en important une ressource d'abonnement au parc existante.

list

Répertorie toutes les ressources AttachedCluster d'un projet et d'une région Google Cloud donnés.

patch

Met à jour un AttachedCluster.