REST Resource: projects.locations.vmwareAdminClusters

Ressource: VmwareAdminCluster

Ressource, die einen VMware-Administratorcluster darstellt.

JSON-Darstellung 
{
  "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)
  },
  "privateRegistryConfig": {
    object (VmwareAdminPrivateRegistryConfig)
  },
  "enableAdvancedCluster": boolean
}
Felder
name

string

Nicht veränderbar. Der Ressourcenname des VMware-Administratorclusters.
description

string

Eine für Menschen lesbare Beschreibung dieses VMware-Administratorclusters.
uid

string

Nur Ausgabe. Die eindeutige ID des VMware-Administratorclusters.
etag

string

Diese Prüfsumme wird vom Server anhand des Werts anderer Felder berechnet und kann bei Aktualisierungs- und Löschanfragen gesendet werden, um sicherzustellen, dass der Client vor dem Fortfahren einen aktuellen Wert hat. Ermöglicht Clients durch optimistische Nebenläufigkeitserkennung, konsistente Read-Modify-Write-Vorgänge auszuführen.
createTime

string (Timestamp format)

Nur Ausgabe. Die Zeit, zu der der VMware-Administratorcluster erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. 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 der VMware-Administratorcluster zuletzt aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
annotations

map (key: string, value: string)

Annotationen zum VMware-Administratorcluster. Für dieses Feld gelten die gleichen Einschränkungen wie für Kubernetes-Annotationen. Die Gesamtgröße aller Schlüssel und Werte 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" }.
state

enum (State)

Nur Ausgabe. Der aktuelle Status des VMware-Administratorclusters.
endpoint

string

Nur Ausgabe. Der DNS-Name des API-Servers des VMware-Administratorclusters.
reconciling

boolean

Nur Ausgabe. Wenn diese Option festgelegt ist, laufen aktuell Änderungen am VMware-Administratorcluster.
localName

string

Nur Ausgabe. Der Objektname der benutzerdefinierten VMware OnPremAdminCluster-Ressource. Dieses Feld wird verwendet, um Konflikte bei Namen zu vermeiden, wenn vorhandene Cluster in der API registriert werden. Wenn dieses Feld im Rahmen der Clusterregistrierung verwendet wird, unterscheidet es sich von der ID im Ressourcennamen. Bei neuen Clustern entspricht dieses Feld dem vom Nutzer angegebenen Clusternamen und ist in der letzten Komponente des Ressourcennamens sichtbar. Sie kann nicht geändert werden.

Alle Nutzer sollten diesen Namen verwenden, um mit gkectl oder kubectl auf ihren Cluster zuzugreifen. In den Controllerlogs des Administratorclusters wird der lokale Name angezeigt.
bootstrapClusterMembership

string

Der Bootstrap-Cluster, zu dem dieser VMware-Administratorcluster gehört.
onPremVersion

string

Die Anthos-Cluster auf VMware-Version des Administratorclusters.
fleet

object (Fleet)

Nur Ausgabe. Flottenkonfiguration für den Cluster.
imageType

string

Der Betriebssystem-Image-Typ für den VMware-Administratorcluster.
vcenter

object (VmwareAdminVCenterConfig)

Die vCenter-Konfiguration des VMware-Administratorclusters.
networkConfig

object (VmwareAdminNetworkConfig)

Die Netzwerkkonfiguration des VMware-Administratorclusters.
loadBalancer

object (VmwareAdminLoadBalancerConfig)

Die Load-Balancer-Konfiguration des VMware-Administratorclusters.
controlPlaneNode

object (VmwareAdminControlPlaneNodeConfig)

Die Konfiguration des Knotens der Steuerungsebene des VMware-Administratorclusters.
addonNode

object (VmwareAdminAddonNodeConfig)

Die Konfiguration des Add-on-Knotens des VMware-Administratorclusters.
antiAffinityGroups

object (VmwareAAGConfig)

Die Konfiguration der Anti-Affinitätsgruppe des VMware-Administratorclusters.
autoRepairConfig

object (VmwareAutoRepairConfig)

Konfiguration für die automatische Reparatur des VMware-Administratorclusters.
status

object (ResourceStatus)

Nur Ausgabe. ResourceStatus, der den detaillierten Clusterstatus darstellt.
platformConfig

object (VmwarePlatformConfig)

Die VMware-Plattformkonfiguration.
preparedSecrets

object (VmwareAdminPreparedSecretsConfig)

Nur Ausgabe. Die Konfiguration der vorbereiteten Secrets für den VMware-Administratorcluster. Sie sollte immer von der Central API aktiviert werden, anstatt dass Nutzer sie festlegen.
authorization

object (VmwareAdminAuthorizationConfig)

Die Autorisierungskonfiguration des VMware-Administratorclusters.
validationCheck

object (ValidationCheck)

Nur Ausgabe. „ValidationCheck“ stellt das Ergebnis des Preflight-Prüfjobs dar.
privateRegistryConfig

object (VmwareAdminPrivateRegistryConfig)

Konfiguration für die Registry.
enableAdvancedCluster

boolean

Erweiterten Cluster aktivieren.

Bundesland

Der Lebenszyklusstatus des VMware-Administratorclusters.

Enums
STATE_UNSPECIFIED Nicht definiert.
PROVISIONING Der Status PROVISIONING gibt an, dass der Cluster erstellt wird.
RUNNING Der Status „RUNNING“ gibt an, dass der Cluster erstellt wurde und vollständig nutzbar ist.
RECONCILING Der Status RECONCILING gibt an, dass der Cluster aktualisiert wird. Er ist weiterhin verfügbar, aber die Leistung ist möglicherweise beeinträchtigt.
STOPPING Der Status STOPPING gibt an, dass der Cluster gelöscht wird.
ERROR Der Status „ERROR“ gibt an, dass sich der Cluster in einem fehlerhaften, nicht wiederherstellbaren Zustand befindet.
DEGRADED Der Status „DEGRADED“ gibt an, dass zum Wiederherstellen der vollen Funktionalität des Clusters eine Nutzeraktion erforderlich ist.

VmwareAdminVCenterConfig

VmwareAdminVCenterConfig enthält die vCenter-Konfiguration für den VMware-Administratorcluster.

JSON-Darstellung 
{
  "resourcePool": string,
  "datastore": string,
  "datacenter": string,
  "cluster": string,
  "folder": string,
  "caCertData": string,
  "address": string,
  "dataDisk": string,
  "storagePolicyName": string
}
Felder
resourcePool

string

Der Name des vCenter-Ressourcenpools für den Administratorcluster.
datastore

string

Der Name des vCenter-Datenspeichers für den Administratorcluster.
datacenter

string

Der Name des vCenter-Rechenzentrums für den Administratorcluster.
cluster

string

Der Name des vCenter-Clusters für den Administratorcluster.
folder

string

Der Name des vCenter-Ordners für den Administratorcluster.
caCertData

string

Enthält den öffentlichen Schlüssel des vCenter-CA-Zertifikats für die SSL-Überprüfung.
address

string

Die vCenter-IP-Adresse.
dataDisk

string

Der Name des VM-Laufwerks (VMDK) für den Administratorcluster.
storagePolicyName

string

Der Name der vCenter-Speicherrichtlinie für den Nutzercluster.

VmwareAdminNetworkConfig

VmwareAdminNetworkConfig enthält die Netzwerkkonfiguration für den VMware-Administratorcluster.

JSON-Darstellung 
{
  "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.
}
Felder
serviceAddressCidrBlocks[]

string

Erforderlich. Allen Diensten im Cluster wird eine RFC1918-IPv4-Adresse aus diesen Bereichen zugewiesen. Es wird nur ein einziger Bereich unterstützt. Dieses Feld kann nach dem Erstellen nicht mehr geändert werden.
podAddressCidrBlocks[]

string

Erforderlich. Allen Pods im Cluster wird eine RFC1918-IPv4-Adresse aus diesen Bereichen zugewiesen. Es wird nur ein einziger Bereich unterstützt. Dieses Feld kann nach dem Erstellen nicht mehr geändert werden.
vcenterNetwork

string

vcenterNetwork gibt den vCenter-Netzwerknamen an.
hostConfig

object (VmwareHostConfig)

Stellt allgemeine Netzwerkeinstellungen unabhängig von der IP-Adresse des Hosts dar.
haControlPlaneConfig

object (VmwareAdminHAControlPlaneConfig)

Konfiguration für die Steuerungsebene des HA-Administratorclusters.
Union-Feld ip_configuration. Der Typ der IP-Konfiguration, die vom VMware-Administratorcluster verwendet wird. Für ip_configuration ist nur einer der folgenden Werte zulässig:
staticIpConfig

object (VmwareStaticIpConfig)

Konfigurationseinstellungen für eine statische IP-Konfiguration.
dhcpIpConfig

object (VmwareDhcpIpConfig)

Konfigurationseinstellungen für eine DHCP-IP-Konfiguration.

VmwareAdminHAControlPlaneConfig

Gibt die Konfiguration der HA-Administratorsteuerungsebene an.

JSON-Darstellung 
{
  "controlPlaneIpBlock": {
    object (VmwareIpBlock)
  }
}
Felder
controlPlaneIpBlock

object (VmwareIpBlock)

Statische IP-Adressen für die Knoten der Administratorcluster-Steuerungsebene.

VmwareAdminLoadBalancerConfig

VmwareAdminLoadBalancerConfig enthält die Load-Balancer-Konfiguration für den VMware-Administratorcluster.

JSON-Darstellung 
{
  "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.
}
Felder
vipConfig

object (VmwareAdminVipConfig)

Die vom Load-Balancer verwendeten VIPs.
Union-Feld load_balancer_configuration. Die Load-Balancer-Konfiguration, die im VMware-Administratorcluster verwendet werden soll. Für load_balancer_configuration ist nur einer der folgenden Werte zulässig:
f5Config

object (VmwareAdminF5BigIpConfig)

Konfiguration für typisierte F5 Big-IP-Load-Balancer.
manualLbConfig

object (VmwareAdminManualLbConfig)

Manuell konfigurierte Load-Balancer.
metalLbConfig

object (VmwareAdminMetalLbConfig)

MetalLB-Load-Balancer.
seesawConfig

object (VmwareAdminSeesawConfig)

Nur Ausgabe. Konfiguration für typisierte Seesaw-Load-Balancer.

VmwareAdminVipConfig

VmwareAdminVipConfig für VMware-Load-Balancer-Konfigurationen.

JSON-Darstellung 
{
  "controlPlaneVip": string,
  "addonsVip": string
}
Felder
controlPlaneVip

string

Die VIP, die Sie zuvor für die Kubernetes API des Administratorclusters reserviert haben.
addonsVip

string

Die virtuelle IP-Adresse, mit der der Load-Balancer für Add-ons konfiguriert wird.

VmwareAdminF5BigIpConfig

VmwareAdminF5BigIpConfig stellt Konfigurationsparameter für einen F5 BIG-IP-Load-Balancer dar.

JSON-Darstellung 
{
  "address": string,
  "partition": string,
  "snatPool": string
}
Felder
address

string

Die IP-Adresse des Load-Balancers.
partition

string

Die vorhandene Partition, die vom Load-Balancer verwendet werden soll. Diese Partition wird in der Regel für den Administratorcluster erstellt, z. B. „my-f5-admin-partition“.
snatPool

string

Der Poolname. Nur erforderlich, wenn SNAT verwendet wird.

VmwareAdminManualLbConfig

JSON-Darstellung 
{
  "ingressHttpNodePort": integer,
  "ingressHttpsNodePort": integer,
  "controlPlaneNodePort": integer,
  "konnectivityServerNodePort": integer,
  "addonsNodePort": integer
}
Felder
ingressHttpNodePort

integer

NodePort für den HTTP-Teil des Ingress-Dienstes. Der Ingress-Dienst im Administratorcluster ist als Dienst vom Typ NodePort implementiert (z. B. 32527).
ingressHttpsNodePort

integer

NodePort für HTTPS des Ingress-Dienstes. Der Ingress-Dienst im Administratorcluster ist als Dienst vom Typ NodePort implementiert (z. B. 30139).
controlPlaneNodePort

integer

NodePort für den Dienst der Steuerungsebene. Der Kubernetes API-Server im Administratorcluster ist als Dienst vom Typ NodePort implementiert (z. B. 30968).
konnectivityServerNodePort

integer

NodePort für den Konnectivity-Serverdienst, der als Sidecar in jedem kube-apiserver-Pod ausgeführt wird (z. B. 30564).
addonsNodePort

integer

NodePort für den Add-on-Server im Administratorcluster.

VmwareAdminMetalLbConfig

VmwareAdminMetalLbConfig stellt Konfigurationsparameter für einen MetalLB-Load-Balancer dar. Für Administratorcluster ist derzeit keine Konfiguration erforderlich.

JSON-Darstellung 
{
  "enabled": boolean
}
Felder
enabled

boolean

Gibt an, ob MetalLB aktiviert ist.

VmwareAdminSeesawConfig

VmwareSeesawConfig stellt Konfigurationsparameter für einen bereits vorhandenen Seesaw-Load-Balancer dar.

WICHTIG: Die Anthos On-Prem API generiert oder aktualisiert keine Seesaw-Konfigurationen. Sie kann nur eine vorhandene Konfiguration an einen neuen Nutzercluster binden.

WICHTIG: Wenn Sie versuchen, einen Nutzercluster mit einem vorhandenen Seesaw-Load-Balancer zu erstellen, müssen Sie einige Vorbereitungsschritte ausführen, bevor Sie die API-Methode „vmwareClusters.create“ aufrufen. Zuerst müssen Sie den Namespace des Nutzerclusters über kubectl erstellen. Der Namespace muss der folgenden Namenskonvention entsprechen : -gke-onprem-mgmt oder -gke-onprem-mgmt, je nachdem, ob Sie „VmwareCluster.local_name“ verwendet haben, um Kollisionen zu beheben. Weitere Informationen finden Sie in der Dokumentation zu „VmwareCluster.local_name“. Nachdem der Namespace erstellt wurde, müssen Sie mit kubectl eine Secret-Ressource erstellen. Dieses Secret enthält Kopien Ihrer Seesaw-Anmeldedaten. Das Secret muss den Namen „user-cluster-creds“ haben und die SSH- und Zertifikatsanmeldedaten von Seesaw enthalten. Die Anmeldedaten müssen mit den folgenden Namen versehen werden: „seesaw-ssh-private-key“, „seesaw-ssh-public-key“, „seesaw-ssh-ca-key“, „seesaw-ssh-ca-cert“.

JSON-Darstellung 
{
  "group": string,
  "masterIp": string,
  "ipBlocks": [
    {
      object (VmwareIpBlock)
    }
  ],
  "enableHa": boolean,
  "vms": [
    string
  ],
  "stackdriverName": string
}
Felder
group

string

Im Allgemeinen sollte für den Namen der Seesaw-Gruppe das folgende Format verwendet werden: seesaw-for-[clusterName].
masterIp

string

MasterIP ist die IP-Adresse, die vom Master der Seesaw-Gruppe angekündigt wird.
ipBlocks[]

object (VmwareIpBlock)

Die IP-Blöcke, die vom Seesaw-Load-Balancer verwendet werden sollen
enableHa

boolean

Aktivieren Sie zwei Load-Balancer-VMs, um einen hochverfügbaren Seesaw-Load-Balancer zu erhalten.
vms[]

string

Namen der VMs, die für diese Seesaw-Gruppe erstellt wurden.
stackdriverName

string

Name, der von Stackdriver verwendet werden soll.

VmwareAdminControlPlaneNodeConfig

VmwareAdminControlPlaneNodeConfig enthält die Konfiguration des Steuerungsebenenknotens für den VMware-Administratorcluster.

JSON-Darstellung 
{
  "cpus": string,
  "memory": string,
  "replicas": string
}
Felder
cpus

string (int64 format)

Die Anzahl der CPUs für den Knoten der Steuerungsebene des Administratorclusters.
memory

string (int64 format)

Die Anzahl der Megabyte des Arbeitsspeichers für den Knoten der Steuerungsebene des Administratorclusters.
replicas

string (int64 format)

Die Anzahl der Steuerungsebenenknoten für diesen VMware-Administratorcluster. (Standard: 1 Replikat).

VmwareAdminAddonNodeConfig

VmwareAdminAddonNodeConfig enthält Add-on-Knotenkonfigurationen für den VMware-Administratorcluster.

JSON-Darstellung 
{
  "autoResizeConfig": {
    object (VmwareAutoResizeConfig)
  }
}
Felder
autoResizeConfig

object (VmwareAutoResizeConfig)

Die VmwareAutoResizeConfig-Konfiguration gibt die Konfiguration für die automatische Größenanpassung an.

VmwarePlatformConfig

VmwarePlatformConfig stellt die Konfiguration für die VMware-Plattform dar.

JSON-Darstellung 
{
  "requiredPlatformVersion": string,
  "platformVersion": string,
  "bundles": [
    {
      object (VmwareBundleConfig)
    }
  ],
  "status": {
    object (ResourceStatus)
  }
}
Felder
requiredPlatformVersion

string

Nur Eingabe. Die erforderliche Plattformversion, z.B. 1.13.1. Wenn die aktuelle Plattformversion niedriger als die Zielversion ist, wird die Plattformversion auf die Zielversion aktualisiert. Wenn die Zielversion nicht auf der Plattform installiert ist (Bundle-Versionen), laden Sie das Bundle der Zielversion herunter.
platformVersion

string

Nur Ausgabe. Die Plattformversion, z.B. 1.13.2.
bundles[]

object (VmwareBundleConfig)

Nur Ausgabe. Die Liste der im Administratorcluster installierten Bundles.
status

object (ResourceStatus)

Nur Ausgabe. Ressourcenstatus für die Plattform.

VmwareBundleConfig

VmwareBundleConfig stellt die Konfiguration für das Bundle dar.

JSON-Darstellung 
{
  "version": string,
  "status": {
    object (ResourceStatus)
  }
}
Felder
version

string

Die Version des Bundles.
status

object (ResourceStatus)

Nur Ausgabe. Ressourcenstatus für das Bundle.

VmwareAdminPreparedSecretsConfig

VmwareAdminPreparedSecretsConfig stellt die Konfiguration für vorbereitete Secrets für Administratorcluster dar.

JSON-Darstellung 
{
  "enabled": boolean
}
Felder
enabled

boolean

Gibt an, ob vorbereitete Secrets aktiviert sind.

VmwareAdminAuthorizationConfig

VmwareAdminAuthorizationConfig stellt die Konfiguration für die Autorisierung des Administratorclusters dar.

JSON-Darstellung 
{
  "viewerUsers": [
    {
      object (ClusterUser)
    }
  ]
}
Felder
viewerUsers[]

object (ClusterUser)

Bei VMware-Administratorclustern wird Nutzern die Rolle „cluster-viewer“ für den Cluster gewährt.

VmwareAdminPrivateRegistryConfig

VmwareAdminPrivateRegistryConfig stellt die Konfiguration für die Administratorcluster-Registry dar.

JSON-Darstellung 
{
  "address": string,
  "caCert": string
}
Felder
address

string

Die Adresse der Registry.
caCert

string

Wenn die Containerlaufzeit ein Image aus einer privaten Registry abruft, muss die Registry ihre Identität anhand eines Zertifikats nachweisen. Das Zertifikat der Registry wird von einer Zertifizierungsstelle signiert. Die Containerlaufzeit verwendet das Zertifikat der Zertifizierungsstelle, um das Zertifikat der Registry zu validieren.

Methoden

create

 Erstellt einen neuen VMware-Administratorcluster in einem bestimmten Projekt und an einem bestimmten Standort.

enroll

 Registriert einen vorhandenen VMware-Administratorcluster in der Anthos On-Prem API in einem bestimmten Projekt und an einem bestimmten Standort.

get

 Ruft Details zu einem einzelnen VMware-Administratorcluster ab.

list

 Listet VMware-Administratorcluster in einem bestimmten Projekt und an einem bestimmten Standort auf.

patch

 Aktualisiert die Parameter eines einzelnen VMware-Administratorclusters.