REST Resource: projects.locations.attachedClusters

Ressource: AttachedCluster

Ein Anthos-Cluster, der auf der Infrastruktur des Kunden ausgeführt wird.

JSON-Darstellung
{
  "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)
  }
}
Felder
name

string

Der Name dieser Ressource.

Clusternamen haben das Format projects/<project-number>/locations/<region>/attachedClusters/<cluster-id>.

Weitere Informationen zu Google Cloud-Ressourcennamen finden Sie unter Ressourcennamen.

description

string

Optional. Eine für Menschen lesbare Beschreibung dieses Clusters. Darf nicht länger als 255 UTF-8-codierte Byte sein.

oidcConfig

object (AttachedOidcConfig)

Erforderlich. OpenID Connect-Konfiguration (OIDC) für den Cluster.

platformVersion

string

Erforderlich. Die Plattformversion für den Cluster (z.B. 1.19.0-gke.1000).

Sie können alle unterstützten Versionen für eine bestimmte Google Cloud-Region auflisten durch Aufrufen von locations.getAttachedServerConfig.

distribution

string

Erforderlich. Die Kubernetes-Distribution des zugrunde liegenden angehängten Clusters.

Unterstützte Werte: ["eks", "aks", "generic"].

clusterRegion

string

Nur Ausgabe. Die Region, in der dieser Cluster ausgeführt wird.

Bei EKS-Clustern ist dies eine AWS-Region. Bei AKS-Clustern ist dies eine Azure-Region.

fleet

object (Fleet)

Erforderlich. Flottenkonfiguration.

state

enum (State)

Nur Ausgabe. Der aktuelle Status des Clusters.

uid

string

Nur Ausgabe. Eine global eindeutige Kennung für den Cluster.

reconciling

boolean

Nur Ausgabe. Wenn diese Option festgelegt ist, laufen aktuell Änderungen am Cluster.

createTime

string (Timestamp format)

Nur Ausgabe. Die Zeit, zu der dieser Cluster registriert wurde.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Nur Ausgabe. Die Zeit, zu der dieser Cluster zuletzt aktualisiert wurde.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

etag

string

Ermöglicht Clients durch optimistische Nebenläufigkeitserkennung, konsistente Read-Modify-Write-Vorgänge auszuführen.

Kann bei Aktualisierungs- und Löschanfragen gesendet werden, um sicherzustellen, dass der Client vor dem Fortfahren einen aktuellen Wert hat.

kubernetesVersion

string

Nur Ausgabe. Die Kubernetes-Version des Clusters.

annotations

map (key: string, value: string)

Optional. Annotationen zum Cluster.

Für dieses Feld gelten die gleichen Einschränkungen wie für Kubernetes-Annotationen. Die Gesamtgröße aller Schlüssel und Werte zusammen ist auf 256 KB begrenzt. Der Schlüssel kann zwei Segmente haben: Präfix (optional) und Name (erforderlich), getrennt durch einen Schrägstrich (/). Das Präfix muss eine DNS-Subdomain sein. Der Name darf maximal 63 Zeichen lang sein und muss mit alphanumerischen Zeichen beginnen und enden. Dazwischen müssen Bindestriche (-), Unterstriche (_), Punkte (.) und alphanumerische Zeichen liegen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

workloadIdentityConfig

object (WorkloadIdentityConfig)

Nur Ausgabe. Workload Identity-Einstellungen.

loggingConfig

object (LoggingConfig)

Optional. Logging-Konfiguration für diesen Cluster.

errors[]

object (AttachedClusterError)

Nur Ausgabe. Eine Reihe von Fehlern, die im Cluster gefunden wurden.

authorization

object (AttachedClustersAuthorization)

Optional. Konfiguration, die sich auf die RBAC-Einstellungen des Clusters bezieht.

monitoringConfig

object (MonitoringConfig)

Optional. Monitoring-Konfiguration für diesen Cluster.

proxyConfig

object (AttachedProxyConfig)

Optional. Proxykonfiguration für ausgehenden HTTP(S)-Traffic.

binaryAuthorization

object (BinaryAuthorization)

Optional. Konfiguration der Binärautorisierung für diesen Cluster.

securityPostureConfig

object (SecurityPostureConfig)

Optional. Konfiguration des Sicherheitsstatus für diesen Cluster.

tags

map (key: string, value: string)

Optional. Nur Eingabe. Tag-Schlüssel und -Werte, die direkt an diese Ressource gebunden sind.

Der Tag-Schlüssel muss das Format <tag namespace>/<tag key name>, haben. Der Tag-Namespace ist die ID der Organisation oder der Name des Projekts, in dem der Tag-Schlüssel definiert ist. Der Kurzname eines Tag-Schlüssels oder -Werts darf maximal 256 Zeichen lang sein. Der zulässige Zeichensatz für den Kurznamen umfasst UTF-8-codierte Unicode-Zeichen mit Ausnahme von einfachen Anführungszeichen ('), doppelten Anführungszeichen ("), umgekehrten Schrägstrichen (\) und Schrägstrichen (/).

Weitere Informationen zu Google Cloud Platform-Tags finden Sie unter Tags.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

systemComponentsConfig

object (SystemComponentsConfig)

Optional. Kubernetes-Konfigurationen für automatisch installierte Komponenten im Cluster.

AttachedOidcConfig

OIDC-Erkennungsinformationen des Zielclusters.

KSA-Token (Kubernetes Service Account) sind JWT-Token, die vom Cluster API-Server signiert wurden. In diesem Feld wird angegeben, wie Google Cloud-Dienste KSA-Tokens validieren, damit sich Systemarbeitslasten wie GKE Connect- und Telemetrie-Agents wieder bei der Google Cloud Platform authentifizieren können.

Sowohl Cluster mit öffentlichen als auch mit privaten Aussteller-URLs werden unterstützt. Cluster mit öffentlichen Ausstellern müssen nur das issuerUrl-Feld angeben, während Cluster mit privaten Ausstellern sowohl issuerUrl als auch oidc_jwks angeben müssen.

JSON-Darstellung
{
  "issuerUrl": string,
  "jwks": string
}
Felder
issuerUrl

string

Der URI eines JWT-Ausstellers (JSON Web Token). issuer muss mit https:// beginnen.

jwks

string (bytes format)

Optional. OIDC-Bestätigungsschlüssel im JWKS-Format (RFC 7517). Sie enthält eine Liste von OIDC-Verifizierungsschlüsseln, mit denen OIDC-JWTs verifiziert werden können.

Dieses Feld ist für Cluster erforderlich, die keinen öffentlich verfügbaren Endpunkt für die Erkennung haben. Wenn Sie einen Wert angeben, wird dieser direkt verwendet, um das vom Identitätsanbieter geltend gemachte OIDC-JWT zu überprüfen.

Ein base64-codierter String.

Bundesland

Der Lebenszyklusstatus des Clusters.

Enums
STATE_UNSPECIFIED Nicht definiert.
PROVISIONING Der Status „BEREITGESTELLT“ gibt an, dass der Cluster registriert wird.
RUNNING Der Status „RUNNING“ gibt an, dass der Cluster registriert wurde und vollständig nutzbar ist.
RECONCILING Der Status „ABGLEICHEND“ gibt an, dass im Cluster aktiv etwas ausgeführt wird, z. B. ein Upgrade von Softwarekomponenten.
STOPPING Der Status „STOPPING“ gibt an, dass der Cluster abgemeldet wird.
ERROR Der Status „ERROR“ gibt an, dass sich der Cluster in einem fehlerhaften Zustand befindet, der nicht wiederhergestellt werden kann.
DEGRADED Der Status „BESCHÄDIGT“ gibt an, dass für den Cluster eine Nutzeraktion erforderlich ist, um die volle Funktionalität wiederherzustellen.

AttachedClusterError

AttachedClusterError beschreibt Fehler, die in angehängten Clustern gefunden wurden.

JSON-Darstellung
{
  "message": string
}
Felder
message

string

Eine nutzerfreundliche Beschreibung des Fehlers.

AttachedClustersAuthorization

Konfiguration, die sich auf die RBAC-Einstellungen des Clusters bezieht.

JSON-Darstellung
{
  "adminUsers": [
    {
      object (AttachedClusterUser)
    }
  ],
  "adminGroups": [
    {
      object (AttachedClusterGroup)
    }
  ]
}
Felder
adminUsers[]

object (AttachedClusterUser)

Optional. Nutzer, die Vorgänge als Clusteradministrator ausführen können Es wird eine verwaltete ClusterRoleBinding erstellt, um den Nutzern die ClusterRole cluster-admin zu gewähren. Es können bis zu zehn Administratoren angegeben werden.

Weitere Informationen zu RBAC finden Sie unter https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles.

adminGroups[]

object (AttachedClusterGroup)

Optional. Gruppen von Nutzern, die Vorgänge als Clusteradministrator ausführen können Es wird eine verwaltete ClusterRoleBinding erstellt, um den Gruppen die cluster-admin-ClusterRole zu gewähren. Es können bis zu zehn Administratorgruppen angegeben werden.

Weitere Informationen zu RBAC finden Sie unter https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles.

AttachedClusterUser

Identitäten eines Nutzersubjekts für angehängte Cluster.

JSON-Darstellung
{
  "username": string
}
Felder
username

string

Erforderlich. Der Name des Nutzers, z.B. my-gcp-id@gmail.com.

AttachedClusterGroup

Identitäten eines Subjekts vom Typ „Gruppe“ für angehängte Cluster.

JSON-Darstellung
{
  "group": string
}
Felder
group

string

Erforderlich. Der Name der Gruppe, z.B. my-group@domain.com.

AttachedProxyConfig

Details zu einer Proxykonfiguration.

JSON-Darstellung
{
  "kubernetesSecret": {
    object (KubernetesSecret)
  }
}
Felder
kubernetesSecret

object (KubernetesSecret)

Die Kubernetes-Secret-Ressource, die die HTTP(S)-Proxykonfiguration enthält. Das Secret muss eine JSON-codierte Proxykonfiguration sein, wie unter https://cloud.google.com/kubernetes-engine/multi-cloud/docs/attached/eks/how-to/use-a-proxy#configure-proxy-support für EKS-Cluster und https://cloud.google.com/kubernetes-engine/multi-cloud/docs/attached/aks/how-to/use-a-proxy#configure-proxy-support für AKS-Cluster beschrieben.

KubernetesSecret

Informationen zu einem Kubernetes-Secret

JSON-Darstellung
{
  "name": string,
  "namespace": string
}
Felder
name

string

Name des Kubernetes-Secrets.

namespace

string

Namespace, in dem das Kubernetes-Secret gespeichert ist.

SecurityPostureConfig

Mit SecurityPostureConfig werden die Flags definiert, die zum Aktivieren/Deaktivieren von Funktionen für die Security Posture API erforderlich sind.

JSON-Darstellung
{
  "vulnerabilityMode": enum (VulnerabilityMode)
}
Felder
vulnerabilityMode

enum (VulnerabilityMode)

Hier legen Sie fest, welcher Modus für das Scannen auf Sicherheitslücken verwendet werden soll.

VulnerabilityMode

Mit VulnerabilityMode wird der Aktivierungsmodus für das Scannen auf Sicherheitslücken definiert.

Enums
VULNERABILITY_MODE_UNSPECIFIED Der Standardwert ist nicht angegeben.
VULNERABILITY_DISABLED Deaktiviert das Scannen auf Sicherheitslücken auf dem Cluster.
VULNERABILITY_ENTERPRISE Wendet die Sicherheitslücke des Sicherheitsstatus auf Funktionen auf Clusterebene für Unternehmen an.

SystemComponentsConfig

In „SystemComponentsConfig“ werden die Felder für die Anpassung von Konfigurationen für automatisch installierte Komponenten definiert.

JSON-Darstellung
{
  "tolerations": [
    {
      object (Toleration)
    }
  ],
  "labels": [
    {
      object (Label)
    }
  ]
}
Felder
tolerations[]

object (Toleration)

Hiermit werden benutzerdefinierte Toleranzen für Pods festgelegt, die von automatisch installierten Komponenten erstellt wurden.

labels[]

object (Label)

Hiermit werden benutzerdefinierte Labels für Pods festgelegt, die von automatisch installierten Komponenten erstellt wurden.

Toleranz

Mit „Toleration“ werden die Felder für Toleranzen für Pods definiert, die von automatisch installierten Komponenten erstellt wurden.

JSON-Darstellung
{
  "key": string,
  "value": string,
  "keyOperator": enum (KeyOperator),
  "effect": enum (Effect)
}
Felder
key

string

„Key“ ist der Taint-Schlüssel, auf den sich die Toleranz bezieht.

value

string

„Wert“ ist der Taint-Wert, auf den sich die Toleranz bezieht.

keyOperator

enum (KeyOperator)

„KeyOperator“ gibt die Beziehung eines Schlüssels zum Wert an, z.B. „Exist“.

effect

enum (Effect)

„Effect“ gibt den zu vergleichenden Effekt der Beschädigung an, z. B. „NoSchedule“.

KeyOperator

„KeyOperator“ gibt die Beziehung eines Schlüssels zum Wert an, z.B. „Gleich“.

Enums
KEY_OPERATOR_UNSPECIFIED Der Operator ist nicht angegeben.
KEY_OPERATOR_EQUAL Der Operator entspricht „Gleich“.
KEY_OPERATOR_EXISTS Operator entspricht „Exists“ (Existiert).

Effekt

„Effect“ gibt den zu vergleichenden Effekt der Beschädigung an, z.B. „NoSchedule“.

Enums
EFFECT_UNSPECIFIED Effekt nicht angegeben.
EFFECT_NO_SCHEDULE Der Effekt wird „NoSchedule“ zugeordnet.
EFFECT_PREFER_NO_SCHEDULE Der Effekt wird „PreferNoSchedule“ zugeordnet.
EFFECT_NO_EXECUTE Der Effekt wird „NoExecute“ zugeordnet.

Label

„Label“ definiert die zusätzlichen Felder für Labels für Pods, die von automatisch installierten Komponenten erstellt wurden.

JSON-Darstellung
{
  "key": string,
  "value": string
}
Felder
key

string

Das ist der Schlüssel des Labels.

value

string

Das ist der Wert des Labels.

Methoden

create

Erstellt eine neue AttachedCluster-Ressource in einem bestimmten Google Cloud-Projekt und einer bestimmten Region.

delete

Löscht eine bestimmte AttachedCluster-Ressource.

generateAttachedClusterAgentToken

Generiert ein Zugriffstoken für einen Cluster-Agenten.

get

Beschreibt eine bestimmte AttachedCluster-Ressource.

import

Beim Importieren wird eine neue AttachedCluster-Ressource erstellt, indem eine vorhandene Ressource für die Flottenmitgliedschaft importiert wird.

list

Listet alle AttachedCluster-Ressourcen in einem bestimmten Google Cloud-Projekt und einer bestimmten Region auf.

patch

Aktualisiert eine AttachedCluster.