Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
La API de clústeres usa recursos personalizados de Kubernetes y se basa en el modelo de recursos de Kubernetes (KRM). Administra el ciclo de vida de los clústeres en una organización determinada, como la instalación, la actualización y la desinstalación.
Para usar la API de Cluster, te recomendamos que uses la consola de GDC. Si tu aplicación necesita usar tus propias bibliotecas para llamar a esta API, usa el siguiente ejemplo y la definición completa de la API para compilar tus solicitudes.
Extremo de servicio y documento de descubrimiento
El extremo de API para la API de Cluster es:
https://GDCH_API_SERVER_ENDPOINT/apis/cluster.gdc.goog/v1
donde GDCH_API_SERVER_ENDPOINT es el extremo de API del servidor de la API de GDC.
Con el comando kubectl proxy, puedes acceder a esa URL en tu navegador o con una herramienta como curl para obtener el documento de descubrimiento de la API de Cluster.
El comando kubectl proxy abre un proxy al servidor de la API de Kubernetes en tu máquina local. Una vez que se ejecute ese comando, podrás acceder al documento en la siguiente URL: http://127.0.0.1:8001/apis/cluster.gdc.goog/v1.
Ejemplo de recurso de clúster
A continuación, se muestra un ejemplo de un objeto Cluster configurado como un clúster de usuario:
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 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"]]
