Stay organized with collections
Save and categorize content based on your preferences.
The Upgrade API uses Kubernetes custom resources and relies on the Kubernetes
Resource Model (KRM). It manages the schedule for tenant organization upgrades.
To use the Upgrade API, we recommend that you use the GDC console or
kubectl CLI. If your application needs to use your own libraries to call this
API, use the following example and the
full API definition to build
your requests.
Service endpoint and discovery document
The API endpoint for the Upgrade API is
https://MANAGEMENT_API_SERVER_ENDPOINT/apis/upgrade.gdc.goog/v1,
where MANAGEMENT_API_SERVER_ENDPOINT is the endpoint of the
Management API server.
Using the kubectl proxy command, you can access that URL in your browser or
with a tool such as curl to get the discovery document for the Upgrade API.
The kubectl proxy command opens up a proxy to the Kubernetes API server on
your local machine. After that command is running, you can access the document at
the following URL: http://127.0.0.1:8001/apis/upgrade.gdc.goog/v1.
Example upgrade MaintenanceWindow resource
You can interact with maintenance windows using the GDC console and
kubectl CLI in GDC. There are two maintenance windows
for every tenant organization, one for patch upgrades and the other for minor
upgrades.
The following is an example of a MaintenanceWindow object configured to define
a maintenance window for GDC minor upgrades:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe Upgrade API utilizes Kubernetes custom resources and the Kubernetes Resource Model (KRM) to manage tenant organization upgrade scheduling.\u003c/p\u003e\n"],["\u003cp\u003eThe GDC console or \u003ccode\u003ekubectl\u003c/code\u003e CLI are the recommended tools for interacting with the Upgrade API, but custom libraries can be used by referencing the API definition.\u003c/p\u003e\n"],["\u003cp\u003eThe Upgrade API endpoint is accessible via a specific URL structure, with the Management API server endpoint variable.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ekubectl proxy\u003c/code\u003e can be used to access the Upgrade API's discovery document, which is located at a local URL after running the command.\u003c/p\u003e\n"],["\u003cp\u003eEach tenant organization has two maintenance windows, one for patch upgrades and one for minor upgrades, which can be managed through the GDC console and \u003ccode\u003ekubectl\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
