Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Die Cluster API verwendet benutzerdefinierte Kubernetes-Ressourcen und basiert auf dem Kubernetes-Ressourcenmodell (Kubernetes Resource Model, KRM). Sie verwaltet den Lebenszyklus von Clustern in einer bestimmten Organisation, z. B. Installation, Upgrade und Deinstallation.
Wenn Sie die Cluster API verwenden möchten, empfehlen wir die GDC Console. Wenn Ihre Anwendung Ihre eigenen Bibliotheken zum Aufrufen dieser API verwenden muss, verwenden Sie das folgende Beispiel und die vollständige API-Definition, um Ihre Anfragen zu erstellen.
Dienstendpunkt und Discovery-Dokument
Der API-Endpunkt für die Cluster API ist:
https://GDCH_API_SERVER_ENDPOINT/apis/cluster.gdc.goog/v1
Dabei ist GDCH_API_SERVER_ENDPOINT der API-Endpunkt des GDC-API-Servers.
Mit dem Befehl kubectl proxy können Sie in Ihrem Browser oder mit einem Tool wie curl auf diese URL zugreifen, um das Discovery-Dokument für die Cluster API abzurufen.
Mit dem Befehl kubectl proxy wird ein Proxy zum Kubernetes API-Server auf Ihrem lokalen Computer geöffnet. Sobald der Befehl ausgeführt wird, können Sie über die folgende URL auf das Dokument zugreifen: http://127.0.0.1:8001/apis/cluster.gdc.goog/v1.
Beispiel für eine Clusterressource
Das folgende Beispiel zeigt ein Cluster-Objekt, das als Nutzercluster konfiguriert ist:
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-09-04 (UTC)."],[[["\u003cp\u003eThe Cluster API, leveraging Kubernetes custom resources and the Kubernetes Resource Model (KRM), is used to manage cluster lifecycles, including installation, upgrades, and uninstallation.\u003c/p\u003e\n"],["\u003cp\u003eThe recommended method for interacting with the Cluster API is through the GDC console, but custom libraries can be used by referencing the provided API definition and examples.\u003c/p\u003e\n"],["\u003cp\u003eThe Cluster API endpoint is located at \u003ccode\u003ehttps://<GDCH_API_SERVER_ENDPOINT>/apis/cluster.gdc.goog/v1\u003c/code\u003e, where \u003ccode\u003e<GDCH_API_SERVER_ENDPOINT>\u003c/code\u003e represents the GDC API server's endpoint.\u003c/p\u003e\n"],["\u003cp\u003eYou can use the \u003ccode\u003ekubectl proxy\u003c/code\u003e command to access the Cluster API's discovery document at \u003ccode\u003ehttp://127.0.0.1:8001/apis/cluster.gdc.goog/v1\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAn example \u003ccode\u003eCluster\u003c/code\u003e resource is provided, showcasing configuration details like network settings, Kubernetes version, load balancer, node pools and release channel.\u003c/p\u003e\n"]]],[],null,["# Cluster API overview\n\nThe Cluster API uses Kubernetes custom resources and relies on the Kubernetes\nResource Model (KRM). It manages the lifecycle of clusters in a given\norganization, such as installing, upgrading, and uninstalling.\n\nTo use the Cluster API, we recommend that you use the GDC console. If\nyour application needs to use your own libraries to call this API, use the\nfollowing example and the [full API definition](/distributed-cloud/hosted/docs/latest/appliance/apis/service/cluster/cluster-krm-api) to build your\nrequests.\n\nService endpoint and discovery document\n---------------------------------------\n\nThe API endpoint for the Cluster API is:\n`https://`\u003cvar translate=\"no\"\u003eGDCH_API_SERVER_ENDPOINT\u003c/var\u003e`/apis/cluster.gdc.goog/v1`\nwhere \u003cvar translate=\"no\"\u003eGDCH_API_SERVER_ENDPOINT\u003c/var\u003e is the API endpoint of the\nGDC API server.\n\nUsing the `kubectl proxy` command, you can access that URL in your browser or\nwith a tool such as `curl` to get the discovery document for the Cluster API.\nThe `kubectl proxy` command opens up a proxy to the Kubernetes API server on\nyour local machine. Once that command is running, you can access the document at\nthe following URL: `http://127.0.0.1:8001/apis/cluster.gdc.goog/v1`.\n\nExample Cluster resource\n------------------------\n\nThe following is an example of a `Cluster` object configured as a user cluster: \n\n apiVersion: cluster.gdc.goog/v1\n kind: Cluster\n metadata:\n name: user-vm-1\n namespace: platform\n spec:\n clusterNetwork:\n podCIDRSize: 21\n serviceCIDRSize: 23\n initialVersion:\n kubernetesVersion: 1.27.1-gke.700\n loadBalancer:\n ingressServiceIPSize: 21\n nodePools:\n - machineTypeName: n2-standard-8-gdc\n name: worker-node-pool\n nodeCount: 3\n releaseChannel:\n channel: UNSPECIFIED"]]
