REST Resource: projects.locations.bareMetalAdminClusters

Ressource: BareMetalAdminCluster

Ressource, die einen Bare-Metal-Administratorcluster darstellt.

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

string

Nicht veränderbar. Der Name der Bare-Metal-Administratorclusterressource.

description

string

Eine für Menschen lesbare Beschreibung dieses Bare-Metal-Administratorclusters.

uid

string

Nur Ausgabe. Die eindeutige Kennung des Bare-Metal-Administratorclusters.

bareMetalVersion

string

Die Anthos-Cluster on Bare Metal-Version für das Bare-Metal-Administratorcluster.

state

enum (State)

Nur Ausgabe. Der aktuelle Status des Bare-Metal-Administratorclusters.

endpoint

string

Nur Ausgabe. Der Name der IP-Adresse des API-Servers des Bare-Metal-Administratorclusters.

reconciling

boolean

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

createTime

string (Timestamp format)

Nur Ausgabe. Die Zeit, zu der dieser Bare-Metal-Administratorcluster erstellt 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 Offsets 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 Bare-Metal-Administratorcluster 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 Offsets 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".

deleteTime

string (Timestamp format)

Nur Ausgabe. Die Zeit, zu der dieser Bare-Metal-Administratorcluster gelöscht wurde. Wenn die Ressource nicht gelöscht wird, muss dieses Feld leer sein.

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

localName

string

Nur Ausgabe. Der Objektname der benutzerdefinierten Ressource des Bare-Metal-Clusters. Dieses Feld wird verwendet, um Konfliktnamen zu unterstützen, wenn vorhandene Cluster bei der API registriert werden. Wenn dieses Feld im Rahmen der Clusterregistrierung verwendet wird, unterscheidet es sich von der ID im Ressourcennamen. Bei neuen Clustern stimmt dieses Feld mit dem vom Nutzer angegebenen Clusternamen überein 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. Der lokale Name sollte in den Controller-Logs des Administratorclusters angezeigt werden.

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.

annotations

map (key: string, value: string)

Anmerkungen zum Bare-Metal-Administratorcluster. 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" }.

networkConfig

object (BareMetalAdminNetworkConfig)

Netzwerkkonfiguration

controlPlane

object (BareMetalAdminControlPlaneConfig)

Konfiguration der Steuerungsebene.

loadBalancer

object (BareMetalAdminLoadBalancerConfig)

Load Balancer-Konfiguration.

storage

object (BareMetalAdminStorageConfig)

Speicherkonfiguration

fleet

object (Fleet)

Nur Ausgabe. Flottenkonfiguration für den Cluster.

clusterOperations

object (BareMetalAdminClusterOperationsConfig)

Konfiguration der Clustervorgänge

status

object (ResourceStatus)

Nur Ausgabe. „ResourceStatus“ für den detaillierten Clusterstatus

maintenanceConfig

object (BareMetalAdminMaintenanceConfig)

Wartungskonfiguration.

maintenanceStatus

object (BareMetalAdminMaintenanceStatus)

Nur Ausgabe. „MaintenanceStatus“ gibt den Wartungsstatus an.

validationCheck

object (ValidationCheck)

Nur Ausgabe. „ValidationCheck“, das das Ergebnis der Preflight-Prüfung darstellt.

nodeConfig

object (BareMetalAdminWorkloadNodeConfig)

Konfiguration des Arbeitslastknotens

proxy

object (BareMetalAdminProxyConfig)

Proxy-Konfiguration

securityConfig

object (BareMetalAdminSecurityConfig)

Sicherheitskonfiguration

nodeAccessConfig

object (BareMetalAdminNodeAccessConfig)

Konfigurationen für den Knotenzugriff

osEnvironmentConfig

object (BareMetalAdminOsEnvironmentConfig)

Konfigurationen für die Betriebssystemumgebung

binaryAuthorization

object (BinaryAuthorization)

Konfigurationen im Zusammenhang mit der Binärautorisierung

Status

Der Lebenszyklusstatus des Bare-Metal-Administratorclusters.

Enums
STATE_UNSPECIFIED Nicht definiert.
PROVISIONING Der Status „Bereitstellung“ 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 „ABGLEICHEND“ gibt an, dass der Cluster aktualisiert wird. Er bleibt verfügbar, aber möglicherweise mit reduzierter Leistung.
STOPPING Der Status „STOPPING“ (Anhalten) gibt an, dass der Cluster gelöscht wird.
ERROR Der Status „ERROR“ gibt an, dass der Cluster in einem fehlerhaften Zustand ist, 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.

BareMetalAdminNetworkConfig

Mit BareMetalAdminNetworkConfig wird die Clusternetzwerkkonfiguration angegeben.

JSON-Darstellung
{

  // 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.
}
Felder
Union-Feld cluster_cidr_configuration. Die CIDR-Konfiguration, die im Administratorcluster verwendet werden soll. Für cluster_cidr_configuration ist nur einer der folgenden Werte zulässig:
islandModeCidr

object (BareMetalAdminIslandModeCidrConfig)

Konfiguration für den CIDR-Block des Inselmodus.

BareMetalAdminIslandModeCidrConfig

Mit BareMetalAdminIslandModeCidrConfig wird die CIDR-Konfiguration des Clusters im Modus „Insel“ angegeben.

JSON-Darstellung
{
  "serviceAddressCidrBlocks": [
    string
  ],
  "podAddressCidrBlocks": [
    string
  ]
}
Felder
serviceAddressCidrBlocks[]

string

Erforderlich. Allen Diensten im Cluster wird eine RFC1918-IPv4-Adresse aus diesen Bereichen zugewiesen. 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. Dieses Feld kann nach dem Erstellen nicht mehr geändert werden.

BareMetalAdminControlPlaneConfig

Mit BareMetalAdminControlPlaneConfig wird die Konfiguration der Steuerungsebene angegeben.

JSON-Darstellung
{
  "controlPlaneNodePoolConfig": {
    object (BareMetalAdminControlPlaneNodePoolConfig)
  },
  "apiServerArgs": [
    {
      object (BareMetalAdminApiServerArgument)
    }
  ]
}
Felder
controlPlaneNodePoolConfig

object (BareMetalAdminControlPlaneNodePoolConfig)

Erforderlich. Konfiguriert den Knotenpool, auf dem die Steuerungsebene ausgeführt wird. Wenn Sie einen angeben, wird der entsprechende NodePool für die Steuerungsebene des Clusters erstellt. Der NodePool hat denselben Namen und Namespace wie der Cluster.

apiServerArgs[]

object (BareMetalAdminApiServerArgument)

Hiermit werden die Standard-API-Server-Argumente angepasst. Es werden nur einige benutzerdefinierte Flags unterstützt. Das genaue Format finden Sie in der API-Server-Dokumentation unten: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/

BareMetalAdminControlPlaneNodePoolConfig

In BareMetalAdminControlPlaneNodePoolConfig wird die Konfiguration des Knotenpools der Steuerungsebene angegeben. Wir haben eine steuerungsebenenspezifische Knotenpoolkonfiguration, damit wir in Zukunft flexibel steuerungsebenenspezifische Felder unterstützen können.

JSON-Darstellung
{
  "nodePoolConfig": {
    object (BareMetalNodePoolConfig)
  }
}
Felder
nodePoolConfig

object (BareMetalNodePoolConfig)

Erforderlich. Die generische Konfiguration für einen Knotenpool, auf dem die Steuerungsebene ausgeführt wird.

BareMetalAdminApiServerArgument

„BareMetalAdminApiServerArgument“ steht für ein Arg-Namen-Wert-Paar. Es werden nur einige benutzerdefinierte Flags unterstützt. Das genaue Format finden Sie in der API-Server-Dokumentation unten: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/

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

string

Erforderlich. Der Argumentname, wie er in der Befehlszeile des API-Servers angezeigt wird. Entfernen Sie die vorangestellten Bindestriche.

value

string

Erforderlich. Der Wert von „arg“, der an die Befehlszeile des API-Servers übergeben wird.

BareMetalAdminLoadBalancerConfig

Mit BareMetalAdminLoadBalancerConfig wird die Load Balancer-Konfiguration angegeben.

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

object (BareMetalAdminVipConfig)

Die vom Load Balancer verwendeten VIPs.

portConfig

object (BareMetalAdminPortConfig)

Hiermit werden die Ports konfiguriert, auf denen der Load Balancer überwacht.

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

object (BareMetalAdminManualLbConfig)

Manuell konfigurierte Load Balancer

BareMetalAdminVipConfig

BareMetalAdminVipConfig für Bare-Metal-Load Balancer-Konfigurationen.

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

string

Die VIP, die Sie zuvor für die Kubernetes API dieses Bare-Metal-Administratorclusters reserviert haben.

BareMetalAdminPortConfig

BareMetalAdminPortConfig ist die Spezifikation der Load Balancer-Ports.

JSON-Darstellung
{
  "controlPlaneLoadBalancerPort": integer
}
Felder
controlPlaneLoadBalancerPort

integer

Der Port, auf dem von der Steuerungsebene gehostete Load Balancer lauschen.

BareMetalAdminManualLbConfig

„BareMetalAdminManualLbConfig“ steht für Konfigurationsparameter für einen manuellen Load Balancer.

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

boolean

Gibt an, ob das manuelle Load Balancing aktiviert ist.

BareMetalAdminStorageConfig

In BareMetalAdminStorageConfig wird die Clusterspeicherkonfiguration angegeben.

JSON-Darstellung
{
  "lvpShareConfig": {
    object (BareMetalLvpShareConfig)
  },
  "lvpNodeMountsConfig": {
    object (BareMetalLvpConfig)
  }
}
Felder
lvpShareConfig

object (BareMetalLvpShareConfig)

Erforderlich. Gibt die Konfiguration für lokale PersistentVolumes an, die von Unterverzeichnissen in einem freigegebenen Dateisystem gestützt werden. Diese Unterverzeichnisse werden bei der Clustererstellung automatisch erstellt.

lvpNodeMountsConfig

object (BareMetalLvpConfig)

Erforderlich. Gibt die Konfiguration für lokale PersistentVolumes an, die durch bereitgestellte Knotenlaufwerke unterstützt werden. Diese Laufwerke müssen vom Nutzer formatiert und bereitgestellt werden, was vor oder nach der Clustererstellung erfolgen kann.

BareMetalAdminClusterOperationsConfig

Mit BareMetalAdminClusterOperationsConfig wird die Observability-Infrastruktur des Administratorclusters angegeben.

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

boolean

Ob die Erfassung von Anwendungsprotokollen/-messwerten (zusätzlich zu Systemprotokollen/-messwerten) aktiviert werden soll.

BareMetalAdminMaintenanceConfig

Mit BareMetalAdminMaintenanceConfig werden Konfigurationen angegeben, um Bare Metal-Administratorcluster-CR-Knoten in den Wartungsmodus zu versetzen und wieder daraus zu entfernen.

JSON-Darstellung
{
  "maintenanceAddressCidrBlocks": [
    string
  ]
}
Felder
maintenanceAddressCidrBlocks[]

string

Erforderlich. Alle IPv4-Adressen aus diesen Bereichen werden in den Wartungsmodus versetzt. Knoten im Wartungsmodus werden abgesperrt und entleert. Wenn beides zutrifft, wird die Anmerkung „baremetal.cluster.gke.io/maintenance“ auf der Knotenressource festgelegt.

BareMetalAdminMaintenanceStatus

„BareMetalAdminMaintenanceStatus“ gibt den Wartungsstatus für die Knoten des Bare-Metal-Administratorclusters an.

JSON-Darstellung
{
  "machineDrainStatus": {
    object (BareMetalAdminMachineDrainStatus)
  }
}
Felder
machineDrainStatus

object (BareMetalAdminMachineDrainStatus)

Stellt den Status von entladenen und entladenen Maschinenknoten dar. Damit wird der Fortschritt des Clusterupgrades angezeigt.

BareMetalAdminMachineDrainStatus

„BareMetalAdminMachineDrainStatus“ gibt den Status von Bare-Metal-Knotenmaschinen an, die gerade entladen werden.

JSON-Darstellung
{
  "drainingMachines": [
    {
      object (BareMetalAdminDrainingMachine)
    }
  ],
  "drainedMachines": [
    {
      object (BareMetalAdminDrainedMachine)
    }
  ]
}
Felder
drainingMachines[]

object (BareMetalAdminDrainingMachine)

Die Liste der Abpumpmaschinen.

drainedMachines[]

object (BareMetalAdminDrainedMachine)

Die Liste der entladenen Maschinen.

BareMetalAdminDrainingMachine

„BareMetalAdminDrainingMachine“ steht für die Maschinen, die derzeit entladen werden.

JSON-Darstellung
{
  "nodeIp": string,
  "podCount": integer
}
Felder
nodeIp

string

IP-Adresse des Geräts, das gesendet wird.

podCount

integer

Die Anzahl der Pods, die noch geleert werden müssen.

BareMetalAdminDrainedMachine

„BareMetalAdminDrainedMachine“ steht für die Maschinen, die entladen werden.

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

string

IP-Adresse des entladenen Geräts.

BareMetalAdminWorkloadNodeConfig

In BareMetalAdminWorkloadNodeConfig werden die Arbeitslastknotenkonfigurationen angegeben.

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

string (int64 format)

Die maximale Anzahl von Pods, die auf einem Knoten ausgeführt werden können. Die Größe des dem Knoten zugewiesenen CIDR-Bereichs wird aus diesem Parameter abgeleitet. Standardmäßig werden pro Knoten 110 Pods erstellt. Die Obergrenze beträgt 250 für HA- und Nicht-HA-Administratorcluster. Die Untergrenze beträgt 64 für einen Administratorcluster ohne Hochverfügbarkeit und 32 für einen HA-Administratorcluster.

BareMetalAdminProxyConfig

„BareMetalAdminProxyConfig“ gibt die Cluster-Proxykonfiguration an.

JSON-Darstellung
{
  "uri": string,
  "noProxy": [
    string
  ]
}
Felder
uri

string

Erforderlich. Gibt die Adresse Ihres Proxyservers an. Beispiele: http://domain

WARNUNG: Geben Sie keine Anmeldedaten im Format http://(username:password@)domain an. Diese werden vom Server abgelehnt.

noProxy[]

string

Eine Liste von IP-Adressen, Hostnamen und Domains, die den Proxy umgehen sollen. Beispiele: ["127.0.0.1", "beispiel.de", ".corp", "localhost"].

BareMetalAdminSecurityConfig

Gibt die sicherheitsbezogenen Einstellungen für den Bare-Metal-Administratorcluster an.

JSON-Darstellung
{
  "authorization": {
    object (Authorization)
  }
}
Felder
authorization

object (Authorization)

Hier wird der Nutzerzugriff auf den Administratorcluster konfiguriert.

BareMetalAdminNodeAccessConfig

Gibt die Einstellungen für den Knotenzugriff für den Bare-Metal-Administratorcluster an.

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

string

Erforderlich. „LoginUser“ ist der Nutzername, der für den Zugriff auf Knotenmaschinen verwendet wird. Wenn kein Wert festgelegt wird, ist die Standardeinstellung „root“.

BareMetalAdminOsEnvironmentConfig

Gibt die Betriebseinstellungen des Betriebssystems für die Clusterbereitstellung an.

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

boolean

Gibt an, ob das Paket-Repository beim Initialisieren von Bare-Metal-Maschinen hinzugefügt werden soll.

Methoden

create

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

enroll

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

get

Ruft Details zu einem einzelnen Bare-Metal-Administratorcluster ab.

list

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

patch

Aktualisiert die Parameter eines einzelnen Bare-Metal-Administratorclusters.

queryVersionConfig

Die Versionskonfiguration des Bare Metal-Administratorclusters wird abgefragt.