{ "discoveryVersion": "v1", "fullyEncodeReservedExpansion": true, "batchPath": "batch", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "mtlsRootUrl": "https://container.mtls.googleapis.com/", "resources": { "projects": { "resources": { "locations": { "methods": { "getServerConfig": { "id": "container.projects.locations.getServerConfig", "path": "v1beta1/{+name}/serverConfig", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig", "httpMethod": "GET", "parameters": { "name": { "description": "The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ServerConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns configuration info about the Google Kubernetes Engine service." }, "list": { "id": "container.projects.locations.list", "path": "v1beta1/{+parent}/locations", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Contains the name of the resource requested. Specified in the format `projects/*`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Fetches locations that offer Google Kubernetes Engine." } }, "resources": { "clusters": { "methods": { "list": { "id": "container.projects.locations.clusters.list", "path": "v1beta1/{+parent}/clusters", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters", "httpMethod": "GET", "parameters": { "parent": { "description": "The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location \"-\" matches all zones and all regions.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", "location": "query", "deprecated": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListClustersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all clusters owned by a project in either the specified zone or all zones." }, "get": { "id": "container.projects.locations.clusters.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Cluster" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the details for a specific cluster." }, "create": { "id": "container.projects.locations.clusters.create", "path": "v1beta1/{+parent}/clusters", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters", "httpMethod": "POST", "parameters": { "parent": { "description": "The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "CreateClusterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using." }, "update": { "id": "container.projects.locations.clusters.update", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "httpMethod": "PUT", "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "UpdateClusterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the settings for a specific cluster." }, "setLogging": { "id": "container.projects.locations.clusters.setLogging", "path": "v1beta1/{+name}:setLogging", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLogging", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetLoggingServiceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the logging service for a specific cluster." }, "setMonitoring": { "id": "container.projects.locations.clusters.setMonitoring", "path": "v1beta1/{+name}:setMonitoring", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetMonitoringServiceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the monitoring service for a specific cluster." }, "setAddons": { "id": "container.projects.locations.clusters.setAddons", "path": "v1beta1/{+name}:setAddons", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetAddonsConfigRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the addons for a specific cluster." }, "setLocations": { "id": "container.projects.locations.clusters.setLocations", "path": "v1beta1/{+name}:setLocations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetLocationsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead." }, "updateMaster": { "id": "container.projects.locations.clusters.updateMaster", "path": "v1beta1/{+name}:updateMaster", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "UpdateMasterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the master for a specific cluster." }, "setMasterAuth": { "id": "container.projects.locations.clusters.setMasterAuth", "path": "v1beta1/{+name}:setMasterAuth", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetMasterAuthRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password." }, "delete": { "id": "container.projects.locations.clusters.delete", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created." }, "getJwks": { "id": "container.projects.locations.clusters.getJwks", "path": "v1beta1/{+parent}/jwks", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/jwks", "httpMethod": "GET", "parameters": { "parent": { "description": "The cluster (project, location, cluster name) to get keys for. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GetJSONWebKeysResponse" }, "description": "Gets the public component of the cluster signing keys in JSON Web Key format." }, "setResourceLabels": { "id": "container.projects.locations.clusters.setResourceLabels", "path": "v1beta1/{+name}:setResourceLabels", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets labels on a cluster." }, "setLegacyAbac": { "id": "container.projects.locations.clusters.setLegacyAbac", "path": "v1beta1/{+name}:setLegacyAbac", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetLegacyAbacRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Enables or disables the ABAC authorization mechanism on a cluster." }, "startIpRotation": { "id": "container.projects.locations.clusters.startIpRotation", "path": "v1beta1/{+name}:startIpRotation", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "StartIPRotationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts master IP rotation." }, "completeIpRotation": { "id": "container.projects.locations.clusters.completeIpRotation", "path": "v1beta1/{+name}:completeIpRotation", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CompleteIPRotationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Completes master IP rotation." }, "setNetworkPolicy": { "id": "container.projects.locations.clusters.setNetworkPolicy", "path": "v1beta1/{+name}:setNetworkPolicy", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster name) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetNetworkPolicyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Enables or disables Network Policy for a cluster." }, "setMaintenancePolicy": { "id": "container.projects.locations.clusters.setMaintenancePolicy", "path": "v1beta1/{+name}:setMaintenancePolicy", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetMaintenancePolicyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the maintenance policy for a cluster." }, "checkAutopilotCompatibility": { "id": "container.projects.locations.clusters.checkAutopilotCompatibility", "path": "v1beta1/{+name}:checkAutopilotCompatibility", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:checkAutopilotCompatibility", "httpMethod": "GET", "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "CheckAutopilotCompatibilityResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues." } }, "resources": { "nodePools": { "methods": { "update": { "id": "container.projects.locations.clusters.nodePools.update", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", "httpMethod": "PUT", "parameters": { "name": { "description": "The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "UpdateNodePoolRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the version and/or image type of a specific node pool." }, "setAutoscaling": { "id": "container.projects.locations.clusters.nodePools.setAutoscaling", "path": "v1beta1/{+name}:setAutoscaling", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetNodePoolAutoscalingRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the autoscaling settings of a specific node pool." }, "list": { "id": "container.projects.locations.clusters.nodePools.list", "path": "v1beta1/{+parent}/nodePools", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools", "httpMethod": "GET", "parameters": { "parent": { "description": "The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "query", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", "location": "query", "deprecated": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListNodePoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the node pools for a cluster." }, "get": { "id": "container.projects.locations.clusters.nodePools.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "NodePool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Retrieves the requested node pool." }, "create": { "id": "container.projects.locations.clusters.nodePools.create", "path": "v1beta1/{+parent}/nodePools", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools", "httpMethod": "POST", "parameters": { "parent": { "description": "The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "CreateNodePoolRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a node pool for a cluster." }, "delete": { "id": "container.projects.locations.clusters.nodePools.delete", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a node pool from a cluster." }, "completeUpgrade": { "id": "container.projects.locations.clusters.nodePools.completeUpgrade", "path": "v1beta1/{+name}:completeUpgrade", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:completeUpgrade", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to complete upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CompleteNodePoolUpgradeRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete." }, "rollback": { "id": "container.projects.locations.clusters.nodePools.rollback", "path": "v1beta1/{+name}:rollback", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "RollbackNodePoolUpgradeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed." }, "setManagement": { "id": "container.projects.locations.clusters.nodePools.setManagement", "path": "v1beta1/{+name}:setManagement", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetNodePoolManagementRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the NodeManagement options for a node pool." }, "setSize": { "id": "container.projects.locations.clusters.nodePools.setSize", "path": "v1beta1/{+name}:setSize", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setSize", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SetNodePoolSizeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "SetNodePoolSizeRequest sets the size of a node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations." } } }, "well-known": { "methods": { "getOpenid-configuration": { "id": "container.projects.locations.clusters.well-known.getOpenid-configuration", "path": "v1beta1/{+parent}/.well-known/openid-configuration", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/.well-known/openid-configuration", "httpMethod": "GET", "parameters": { "parent": { "description": "The cluster (project, location, cluster name) to get the discovery document for. Specified in the format `projects/*/locations/*/clusters/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GetOpenIDConfigResponse" }, "description": "Gets the OIDC discovery document for the cluster. See the [OpenID Connect Discovery 1.0 specification](https://openid.net/specs/openid-connect-discovery-1_0.html) for details." } } } } }, "operations": { "methods": { "list": { "id": "container.projects.locations.operations.list", "path": "v1beta1/{+parent}/operations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "parent": { "description": "The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location \"-\" matches all zones and all regions.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", "location": "query", "deprecated": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all operations in a project in the specified zone or all zones." }, "get": { "id": "container.projects.locations.operations.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" }, "operationId": { "description": "Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", "location": "query", "deprecated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the specified operation." }, "cancel": { "id": "container.projects.locations.operations.cancel", "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Cancels the specified operation." } } } } }, "zones": { "methods": { "getServerconfig": { "id": "container.projects.zones.getServerconfig", "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig", "httpMethod": "GET", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`.", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId", "zone" ], "response": { "$ref": "ServerConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns configuration info about the Google Kubernetes Engine service." } }, "resources": { "clusters": { "methods": { "list": { "id": "container.projects.zones.clusters.list", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters", "httpMethod": "GET", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "parent": { "description": "The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location \"-\" matches all zones and all regions.", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId", "zone" ], "response": { "$ref": "ListClustersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all clusters owned by a project in either the specified zone or all zones." }, "get": { "id": "container.projects.zones.clusters.get", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "httpMethod": "GET", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "response": { "$ref": "Cluster" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the details for a specific cluster." }, "create": { "id": "container.projects.zones.clusters.create", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone" ], "request": { "$ref": "CreateClusterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using." }, "update": { "id": "container.projects.zones.clusters.update", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "httpMethod": "PUT", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "UpdateClusterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the settings for a specific cluster." }, "logging": { "id": "container.projects.zones.clusters.logging", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "SetLoggingServiceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the logging service for a specific cluster." }, "monitoring": { "id": "container.projects.zones.clusters.monitoring", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "SetMonitoringServiceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the monitoring service for a specific cluster." }, "addons": { "id": "container.projects.zones.clusters.addons", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "SetAddonsConfigRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the addons for a specific cluster." }, "locations": { "id": "container.projects.zones.clusters.locations", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "SetLocationsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead." }, "master": { "id": "container.projects.zones.clusters.master", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "UpdateMasterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the master for a specific cluster." }, "setMasterAuth": { "id": "container.projects.zones.clusters.setMasterAuth", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "SetMasterAuthRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password." }, "delete": { "id": "container.projects.zones.clusters.delete", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "httpMethod": "DELETE", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created." }, "resourceLabels": { "id": "container.projects.zones.clusters.resourceLabels", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "SetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets labels on a cluster." }, "legacyAbac": { "id": "container.projects.zones.clusters.legacyAbac", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "SetLegacyAbacRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Enables or disables the ABAC authorization mechanism on a cluster." }, "startIpRotation": { "id": "container.projects.zones.clusters.startIpRotation", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "StartIPRotationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts master IP rotation." }, "completeIpRotation": { "id": "container.projects.zones.clusters.completeIpRotation", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "CompleteIPRotationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Completes master IP rotation." }, "setNetworkPolicy": { "id": "container.projects.zones.clusters.setNetworkPolicy", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "SetNetworkPolicyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Enables or disables Network Policy for a cluster." }, "setMaintenancePolicy": { "id": "container.projects.zones.clusters.setMaintenancePolicy", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. The name of the cluster to update.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "SetMaintenancePolicyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the maintenance policy for a cluster." } }, "resources": { "nodePools": { "methods": { "update": { "id": "container.projects.zones.clusters.nodePools.update", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "request": { "$ref": "UpdateNodePoolRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the version and/or image type of a specific node pool." }, "autoscaling": { "id": "container.projects.zones.clusters.nodePools.autoscaling", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "request": { "$ref": "SetNodePoolAutoscalingRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the autoscaling settings of a specific node pool." }, "list": { "id": "container.projects.zones.clusters.nodePools.list", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", "httpMethod": "GET", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "parent": { "description": "The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`.", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "response": { "$ref": "ListNodePoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the node pools for a cluster." }, "get": { "id": "container.projects.zones.clusters.nodePools.get", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", "httpMethod": "GET", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "response": { "$ref": "NodePool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Retrieves the requested node pool." }, "create": { "id": "container.projects.zones.clusters.nodePools.create", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId" ], "request": { "$ref": "CreateNodePoolRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a node pool for a cluster." }, "delete": { "id": "container.projects.zones.clusters.nodePools.delete", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", "httpMethod": "DELETE", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a node pool from a cluster." }, "rollback": { "id": "container.projects.zones.clusters.nodePools.rollback", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "request": { "$ref": "RollbackNodePoolUpgradeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed." }, "setManagement": { "id": "container.projects.zones.clusters.nodePools.setManagement", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "request": { "$ref": "SetNodePoolManagementRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the NodeManagement options for a node pool." }, "setSize": { "id": "container.projects.zones.clusters.nodePools.setSize", "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "request": { "$ref": "SetNodePoolSizeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "SetNodePoolSizeRequest sets the size of a node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations." } } } } }, "operations": { "methods": { "list": { "id": "container.projects.zones.operations.list", "path": "v1beta1/projects/{projectId}/zones/{zone}/operations", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations", "httpMethod": "GET", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "parent": { "description": "The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location \"-\" matches all zones and all regions.", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId", "zone" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all operations in a project in the specified zone or all zones." }, "get": { "id": "container.projects.zones.operations.get", "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}", "httpMethod": "GET", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "operationId": { "description": "Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`.", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId", "zone", "operationId" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the specified operation." }, "cancel": { "id": "container.projects.zones.operations.cancel", "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "operationId": { "description": "Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "projectId", "zone", "operationId" ], "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Cancels the specified operation." } } } } }, "aggregated": { "resources": { "usableSubnetworks": { "methods": { "list": { "id": "container.projects.aggregated.usableSubnetworks.list", "path": "v1beta1/{+parent}/aggregated/usableSubnetworks", "flatPath": "v1beta1/projects/{projectsId}/aggregated/usableSubnetworks", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent project where subnetworks are usable. Specified in the format `projects/*`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Filtering currently only supports equality on the networkProjectId and must be in the form: \"networkProjectId=[PROJECTID]\", where `networkProjectId` is the project which owns the listed subnetworks. This defaults to the parent project ID.", "location": "query", "type": "string" }, "pageSize": { "description": "The max number of results per page that should be returned. If the number of available results is larger than `page_size`, a `next_page_token` is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListUsableSubnetworksResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists subnetworks that can be used for creating clusters in a project." } } } } } } } }, "description": "Builds and manages container-based applications, powered by the open source Kubernetes technology.", "protocol": "rest", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "servicePath": "", "version_module": true, "schemas": { "ListClustersResponse": { "id": "ListClustersResponse", "description": "ListClustersResponse is the result of ListClustersRequest.", "type": "object", "properties": { "clusters": { "description": "A list of clusters in the project in the specified zone, or across all ones.", "type": "array", "items": { "$ref": "Cluster" } }, "missingZones": { "description": "If any zones are listed here, the list of clusters returned may be missing those zones.", "type": "array", "items": { "type": "string" } } } }, "Cluster": { "id": "Cluster", "description": "A Google Kubernetes Engine cluster.", "type": "object", "properties": { "name": { "description": "The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.", "type": "string" }, "description": { "description": "An optional description of this cluster.", "type": "string" }, "initialNodeCount": { "description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.", "deprecated": true, "type": "integer", "format": "int32" }, "nodeConfig": { "description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.", "deprecated": true, "$ref": "NodeConfig" }, "masterAuth": { "description": "The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to \"admin\", a random password will be generated, and a client certificate will be issued.", "$ref": "MasterAuth" }, "loggingService": { "description": "The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.", "type": "string" }, "monitoringService": { "description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, "network": { "description": "The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.", "type": "string" }, "clusterIpv4Cidr": { "description": "The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.", "type": "string" }, "addonsConfig": { "description": "Configurations for the various addons available to run in the cluster.", "$ref": "AddonsConfig" }, "subnetwork": { "description": "The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.", "type": "string" }, "nodePools": { "description": "The node pools associated with this cluster. This field should not be set if \"node_config\" or \"initial_node_count\" are specified.", "type": "array", "items": { "$ref": "NodePool" } }, "locations": { "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.", "type": "array", "items": { "type": "string" } }, "enableKubernetesAlpha": { "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.", "type": "boolean" }, "enableK8sBetaApis": { "description": "Kubernetes open source beta apis enabled on the cluster. Only beta apis.", "$ref": "K8sBetaAPIConfig" }, "resourceLabels": { "description": "The resource labels for the cluster to use to annotate any related Google Compute Engine resources.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "The fingerprint of the set of labels for this cluster.", "type": "string" }, "legacyAbac": { "description": "Configuration for the legacy ABAC authorization mode.", "$ref": "LegacyAbac" }, "networkPolicy": { "description": "Configuration options for the NetworkPolicy feature.", "$ref": "NetworkPolicy" }, "ipAllocationPolicy": { "description": "Configuration for cluster IP allocation.", "$ref": "IPAllocationPolicy" }, "masterAuthorizedNetworksConfig": { "description": "The configuration options for master authorized networks feature.", "$ref": "MasterAuthorizedNetworksConfig" }, "maintenancePolicy": { "description": "Configure the maintenance policy for this cluster.", "$ref": "MaintenancePolicy" }, "binaryAuthorization": { "description": "Configuration for Binary Authorization.", "$ref": "BinaryAuthorization" }, "podSecurityPolicyConfig": { "description": "Configuration for the PodSecurityPolicy feature.", "$ref": "PodSecurityPolicyConfig" }, "autoscaling": { "description": "Cluster-level autoscaling configuration.", "$ref": "ClusterAutoscaling" }, "networkConfig": { "description": "Configuration for cluster networking.", "$ref": "NetworkConfig" }, "privateCluster": { "description": "If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.", "deprecated": true, "type": "boolean" }, "masterIpv4CidrBlock": { "description": "The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.", "deprecated": true, "type": "string" }, "defaultMaxPodsConstraint": { "description": "The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.", "$ref": "MaxPodsConstraint" }, "resourceUsageExportConfig": { "description": "Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified.", "$ref": "ResourceUsageExportConfig" }, "authenticatorGroupsConfig": { "description": "Configuration controlling RBAC group membership information.", "$ref": "AuthenticatorGroupsConfig" }, "privateClusterConfig": { "description": "Configuration for private cluster.", "$ref": "PrivateClusterConfig" }, "verticalPodAutoscaling": { "description": "Cluster-level Vertical Pod Autoscaling configuration.", "$ref": "VerticalPodAutoscaling" }, "shieldedNodes": { "description": "Shielded Nodes configuration.", "$ref": "ShieldedNodes" }, "releaseChannel": { "description": "Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.", "$ref": "ReleaseChannel" }, "workloadIdentityConfig": { "description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.", "$ref": "WorkloadIdentityConfig" }, "workloadCertificates": { "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods.", "$ref": "WorkloadCertificates" }, "meshCertificates": { "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods.", "$ref": "MeshCertificates" }, "workloadAltsConfig": { "description": "Configuration for direct-path (via ALTS) with workload identity.", "$ref": "WorkloadALTSConfig" }, "costManagementConfig": { "description": "Configuration for the fine-grained cost management feature.", "$ref": "CostManagementConfig" }, "clusterTelemetry": { "description": "Telemetry integration for the cluster.", "$ref": "ClusterTelemetry" }, "tpuConfig": { "description": "Configuration for Cloud TPU support;", "$ref": "TpuConfig" }, "notificationConfig": { "description": "Notification configuration of the cluster.", "$ref": "NotificationConfig" }, "confidentialNodes": { "description": "Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.", "$ref": "ConfidentialNodes" }, "identityServiceConfig": { "description": "Configuration for Identity Service component.", "$ref": "IdentityServiceConfig" }, "selfLink": { "description": "[Output only] Server-defined URL for the resource.", "type": "string" }, "zone": { "description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", "deprecated": true, "type": "string" }, "endpoint": { "description": "[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", "type": "string" }, "initialClusterVersion": { "description": "The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"\",\"-\": picks the default Kubernetes version", "type": "string" }, "currentMasterVersion": { "description": "[Output only] The current software version of the master endpoint.", "type": "string" }, "currentNodeVersion": { "description": "[Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", "deprecated": true, "type": "string" }, "createTime": { "description": "[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "status": { "description": "[Output only] The current status of this cluster.", "type": "string", "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the cluster is being created.", "The RUNNING state indicates the cluster has been created and is fully usable.", "The RECONCILING state indicates that some work is actively being done on the cluster, such as upgrading the master or node software. Details can be found in the `statusMessage` field.", "The STOPPING state indicates the cluster is being deleted.", "The ERROR state indicates the cluster may be unusable. Details can be found in the `statusMessage` field.", "The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the `statusMessage` field." ], "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", "RUNNING", "RECONCILING", "STOPPING", "ERROR", "DEGRADED" ] }, "statusMessage": { "description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", "deprecated": true, "type": "string" }, "nodeIpv4CidrSize": { "description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", "type": "integer", "format": "int32" }, "servicesIpv4Cidr": { "description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", "type": "string" }, "instanceGroupUrls": { "description": "Deprecated. Use node_pools.instance_group_urls.", "deprecated": true, "type": "array", "items": { "type": "string" } }, "currentNodeCount": { "description": "[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", "deprecated": true, "type": "integer", "format": "int32" }, "expireTime": { "description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "location": { "description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", "type": "string" }, "enableTpu": { "description": "Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.", "type": "boolean" }, "tpuIpv4CidrBlock": { "description": "[Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", "type": "string" }, "databaseEncryption": { "description": "Configuration of etcd encryption.", "$ref": "DatabaseEncryption" }, "conditions": { "description": "Which conditions caused the current cluster state.", "type": "array", "items": { "$ref": "StatusCondition" } }, "master": { "description": "Configuration for master components.", "$ref": "Master" }, "autopilot": { "description": "Autopilot configuration for the cluster.", "$ref": "Autopilot" }, "id": { "description": "Output only. Unique id for the cluster.", "readOnly": true, "type": "string" }, "parentProductConfig": { "description": "The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster.", "$ref": "ParentProductConfig" }, "nodePoolDefaults": { "description": "Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.", "$ref": "NodePoolDefaults" }, "loggingConfig": { "description": "Logging configuration for the cluster.", "$ref": "LoggingConfig" }, "monitoringConfig": { "description": "Monitoring configuration for the cluster.", "$ref": "MonitoringConfig" }, "nodePoolAutoConfig": { "description": "Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.", "$ref": "NodePoolAutoConfig" }, "protectConfig": { "description": "Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.", "deprecated": true, "$ref": "ProtectConfig" }, "etag": { "description": "This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "fleet": { "description": "Fleet information for the cluster.", "$ref": "Fleet" }, "securityPostureConfig": { "description": "Enable/Disable Security Posture API features for the cluster.", "$ref": "SecurityPostureConfig" }, "enterpriseConfig": { "description": "GKE Enterprise Configuration.", "$ref": "EnterpriseConfig" }, "secretManagerConfig": { "description": "Secret CSI driver configuration.", "$ref": "SecretManagerConfig" }, "compliancePostureConfig": { "description": "Enable/Disable Compliance Posture features for the cluster.", "$ref": "CompliancePostureConfig" }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" } } }, "NodeConfig": { "id": "NodeConfig", "description": "Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead.", "type": "object", "properties": { "machineType": { "description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.", "type": "string" }, "diskSizeGb": { "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.", "type": "integer", "format": "int32" }, "oauthScopes": { "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", "type": "array", "items": { "type": "string" } }, "serviceAccount": { "description": "The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the \"default\" service account is used.", "type": "string" }, "metadata": { "description": "The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - \"cluster-location\" - \"cluster-name\" - \"cluster-uid\" - \"configure-sh\" - \"containerd-configure-sh\" - \"enable-oslogin\" - \"gci-ensure-gke-docker\" - \"gci-metrics-enabled\" - \"gci-update-strategy\" - \"instance-template\" - \"kube-env\" - \"startup-script\" - \"user-data\" - \"disable-address-manager\" - \"windows-startup-script-ps1\" - \"common-psm1\" - \"k8s-node-setup-psm1\" - \"install-ssh-psm1\" - \"user-profile-psm1\" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.", "type": "object", "additionalProperties": { "type": "string" } }, "imageType": { "description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "labels": { "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": "object", "additionalProperties": { "type": "string" } }, "localSsdCount": { "description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.", "type": "integer", "format": "int32" }, "tags": { "description": "The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.", "type": "array", "items": { "type": "string" } }, "preemptible": { "description": "Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.", "type": "boolean" }, "accelerators": { "description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.", "type": "array", "items": { "$ref": "AcceleratorConfig" } }, "sandboxConfig": { "description": "Sandbox configuration for this node.", "$ref": "SandboxConfig" }, "nodeGroup": { "description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).", "type": "string" }, "reservationAffinity": { "description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.", "$ref": "ReservationAffinity" }, "diskType": { "description": "Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'", "type": "string" }, "minCpuPlatform": { "description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).", "type": "string" }, "workloadMetadataConfig": { "description": "The workload metadata configuration for this node.", "$ref": "WorkloadMetadataConfig" }, "taints": { "description": "List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/", "type": "array", "items": { "$ref": "NodeTaint" } }, "bootDiskKmsKey": { "description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption", "type": "string" }, "shieldedInstanceConfig": { "description": "Shielded Instance options.", "$ref": "ShieldedInstanceConfig" }, "linuxNodeConfig": { "description": "Parameters that can be configured on Linux nodes.", "$ref": "LinuxNodeConfig" }, "kubeletConfig": { "description": "Node kubelet configs.", "$ref": "NodeKubeletConfig" }, "ephemeralStorageConfig": { "description": "Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.", "$ref": "EphemeralStorageConfig" }, "gcfsConfig": { "description": "GCFS (Google Container File System) configs.", "$ref": "GcfsConfig" }, "advancedMachineFeatures": { "description": "Advanced features for the Compute Engine VM.", "$ref": "AdvancedMachineFeatures" }, "gvnic": { "description": "Enable or disable gvnic on the node pool.", "$ref": "VirtualNIC" }, "spot": { "description": "Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.", "type": "boolean" }, "confidentialNodes": { "description": "Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.", "$ref": "ConfidentialNodes" }, "fastSocket": { "description": "Enable or disable NCCL fast socket for the node pool.", "$ref": "FastSocket" }, "resourceLabels": { "description": "The resource labels for the node pool to use to annotate any related Google Compute Engine resources.", "type": "object", "additionalProperties": { "type": "string" } }, "loggingConfig": { "description": "Logging configuration.", "$ref": "NodePoolLoggingConfig" }, "windowsNodeConfig": { "description": "Parameters that can be configured on Windows nodes.", "$ref": "WindowsNodeConfig" }, "localNvmeSsdBlockConfig": { "description": "Parameters for using raw-block Local NVMe SSDs.", "$ref": "LocalNvmeSsdBlockConfig" }, "ephemeralStorageLocalSsdConfig": { "description": "Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config", "$ref": "EphemeralStorageLocalSsdConfig" }, "soleTenantConfig": { "description": "Parameters for node pools to be backed by shared sole tenant node groups.", "$ref": "SoleTenantConfig" }, "containerdConfig": { "description": "Parameters for containerd customization.", "$ref": "ContainerdConfig" }, "hostMaintenancePolicy": { "description": "HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.", "$ref": "HostMaintenancePolicy" }, "resourceManagerTags": { "description": "A map of resource manager tag keys and values to be attached to the nodes.", "$ref": "ResourceManagerTags" }, "enableConfidentialStorage": { "description": "Optional. Reserved for future use.", "type": "boolean" }, "secondaryBootDisks": { "description": "List of secondary boot disks attached to the nodes.", "type": "array", "items": { "$ref": "SecondaryBootDisk" } }, "secondaryBootDiskUpdateStrategy": { "description": "Secondary boot disk update strategy.", "$ref": "SecondaryBootDiskUpdateStrategy" } } }, "AcceleratorConfig": { "id": "AcceleratorConfig", "description": "AcceleratorConfig represents a Hardware Accelerator request.", "type": "object", "properties": { "acceleratorCount": { "description": "The number of the accelerator cards exposed to an instance.", "type": "string", "format": "int64" }, "acceleratorType": { "description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)", "type": "string" }, "gpuPartitionSize": { "description": "Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).", "type": "string" }, "maxTimeSharedClientsPerGpu": { "description": "The number of time-shared GPU resources to expose for each physical GPU.", "deprecated": true, "type": "string", "format": "int64" }, "gpuSharingConfig": { "description": "The configuration for GPU sharing options.", "$ref": "GPUSharingConfig" }, "gpuDriverInstallationConfig": { "description": "The configuration for auto installation of GPU driver.", "$ref": "GPUDriverInstallationConfig" } } }, "GPUSharingConfig": { "id": "GPUSharingConfig", "description": "GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators.", "type": "object", "properties": { "maxSharedClientsPerGpu": { "description": "The max number of containers that can share a physical GPU.", "type": "string", "format": "int64" }, "gpuSharingStrategy": { "description": "The type of GPU sharing strategy to enable on the GPU node.", "type": "string", "enumDescriptions": [ "Default value.", "GPUs are time-shared between containers.", "GPUs are shared between containers with NVIDIA MPS." ], "enum": [ "GPU_SHARING_STRATEGY_UNSPECIFIED", "TIME_SHARING", "MPS" ] } } }, "GPUDriverInstallationConfig": { "id": "GPUDriverInstallationConfig", "description": "GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed.", "type": "object", "properties": { "gpuDriverVersion": { "description": "Mode for how the GPU driver is installed.", "type": "string", "enumDescriptions": [ "Default value is to not install any GPU driver.", "Disable GPU driver auto installation and needs manual installation", "\"Default\" GPU driver in COS and Ubuntu.", "\"Latest\" GPU driver in COS." ], "enum": [ "GPU_DRIVER_VERSION_UNSPECIFIED", "INSTALLATION_DISABLED", "DEFAULT", "LATEST" ] } } }, "SandboxConfig": { "id": "SandboxConfig", "description": "SandboxConfig contains configurations of the sandbox to use for the node.", "type": "object", "properties": { "sandboxType": { "description": "Type of the sandbox to use for the node (e.g. 'gvisor')", "deprecated": true, "type": "string" }, "type": { "description": "Type of the sandbox to use for the node.", "type": "string", "enumDescriptions": [ "Default value. This should not be used.", "Run sandbox using gvisor." ], "enum": [ "UNSPECIFIED", "GVISOR" ] } } }, "ReservationAffinity": { "id": "ReservationAffinity", "description": "[ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.", "type": "object", "properties": { "consumeReservationType": { "description": "Corresponds to the type of reservation consumption.", "type": "string", "enumDescriptions": [ "Default value. This should not be used.", "Do not consume from any reserved capacity.", "Consume any reservation available.", "Must consume from a specific reservation. Must specify key value fields for specifying the reservations." ], "enum": [ "UNSPECIFIED", "NO_RESERVATION", "ANY_RESERVATION", "SPECIFIC_RESERVATION" ] }, "key": { "description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify \"compute.googleapis.com/reservation-name\" as the key and specify the name of your reservation as its value.", "type": "string" }, "values": { "description": "Corresponds to the label value(s) of reservation resource(s).", "type": "array", "items": { "type": "string" } } } }, "WorkloadMetadataConfig": { "id": "WorkloadMetadataConfig", "description": "WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.", "type": "object", "properties": { "nodeMetadata": { "description": "NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.", "deprecated": true, "type": "string", "enumDescriptions": [ "Not set.", "Prevent workloads not in hostNetwork from accessing certain VM metadata, specifically kube-env, which contains Kubelet credentials, and the instance identity token. Metadata concealment is a temporary security solution available while the bootstrapping process for cluster nodes is being redesigned with significant security improvements. This feature is scheduled to be deprecated in the future and later removed.", "Expose all VM metadata to pods.", "Run the GKE Metadata Server on this node. The GKE Metadata Server exposes a metadata API to workloads that is compatible with the V1 Compute Metadata APIs exposed by the Compute Engine and App Engine Metadata Servers. This feature can only be enabled if Workload Identity is enabled at the cluster level." ], "enum": [ "UNSPECIFIED", "SECURE", "EXPOSE", "GKE_METADATA_SERVER" ] }, "mode": { "description": "Mode is the configuration for how to expose metadata to workloads running on the node pool.", "type": "string", "enumDescriptions": [ "Not set.", "Expose all Compute Engine metadata to pods.", "Run the GKE Metadata Server on this node. The GKE Metadata Server exposes a metadata API to workloads that is compatible with the V1 Compute Metadata APIs exposed by the Compute Engine and App Engine Metadata Servers. This feature can only be enabled if Workload Identity is enabled at the cluster level." ], "enum": [ "MODE_UNSPECIFIED", "GCE_METADATA", "GKE_METADATA" ] } } }, "NodeTaint": { "id": "NodeTaint", "description": "Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.", "type": "object", "properties": { "key": { "description": "Key for taint.", "type": "string" }, "value": { "description": "Value for taint.", "type": "string" }, "effect": { "description": "Effect for taint.", "type": "string", "enumDescriptions": [ "Not set", "NoSchedule", "PreferNoSchedule", "NoExecute" ], "enum": [ "EFFECT_UNSPECIFIED", "NO_SCHEDULE", "PREFER_NO_SCHEDULE", "NO_EXECUTE" ] } } }, "ShieldedInstanceConfig": { "id": "ShieldedInstanceConfig", "description": "A set of Shielded Instance options.", "type": "object", "properties": { "enableSecureBoot": { "description": "Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.", "type": "boolean" }, "enableIntegrityMonitoring": { "description": "Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.", "type": "boolean" } } }, "LinuxNodeConfig": { "id": "LinuxNodeConfig", "description": "Parameters that can be configured on Linux nodes.", "type": "object", "properties": { "sysctls": { "description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse", "type": "object", "additionalProperties": { "type": "string" } }, "cgroupMode": { "description": "cgroup_mode specifies the cgroup mode to be used on the node.", "type": "string", "enumDescriptions": [ "CGROUP_MODE_UNSPECIFIED is when unspecified cgroup configuration is used. The default for the GKE node OS image will be used.", "CGROUP_MODE_V1 specifies to use cgroupv1 for the cgroup configuration on the node image.", "CGROUP_MODE_V2 specifies to use cgroupv2 for the cgroup configuration on the node image." ], "enum": [ "CGROUP_MODE_UNSPECIFIED", "CGROUP_MODE_V1", "CGROUP_MODE_V2" ] }, "hugepages": { "description": "Optional. Amounts for 2M and 1G hugepages", "$ref": "HugepagesConfig" } } }, "HugepagesConfig": { "id": "HugepagesConfig", "description": "Hugepages amount in both 2m and 1g size", "type": "object", "properties": { "hugepageSize2m": { "description": "Optional. Amount of 2M hugepages", "type": "integer", "format": "int32" }, "hugepageSize1g": { "description": "Optional. Amount of 1G hugepages", "type": "integer", "format": "int32" } } }, "NodeKubeletConfig": { "id": "NodeKubeletConfig", "description": "Node kubelet configs.", "type": "object", "properties": { "cpuManagerPolicy": { "description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * \"none\": the default, which represents the existing scheduling behavior. * \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.", "type": "string" }, "cpuCfsQuota": { "description": "Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.", "type": "boolean" }, "cpuCfsQuotaPeriod": { "description": "Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". The value must be a positive duration.", "type": "string" }, "podPidsLimit": { "description": "Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.", "type": "string", "format": "int64" }, "insecureKubeletReadonlyPortEnabled": { "description": "Enable or disable Kubelet read only port.", "type": "boolean" } } }, "EphemeralStorageConfig": { "id": "EphemeralStorageConfig", "description": "EphemeralStorageConfig contains configuration for the ephemeral storage filesystem.", "type": "object", "properties": { "localSsdCount": { "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "type": "integer", "format": "int32" } } }, "GcfsConfig": { "id": "GcfsConfig", "description": "GcfsConfig contains configurations of Google Container File System.", "type": "object", "properties": { "enabled": { "description": "Whether to use GCFS.", "type": "boolean" } } }, "AdvancedMachineFeatures": { "id": "AdvancedMachineFeatures", "description": "Specifies options for controlling advanced machine features.", "type": "object", "properties": { "threadsPerCore": { "description": "The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.", "type": "string", "format": "int64" }, "enableNestedVirtualization": { "description": "Whether or not to enable nested virtualization (defaults to false).", "type": "boolean" } } }, "VirtualNIC": { "id": "VirtualNIC", "description": "Configuration of gVNIC feature.", "type": "object", "properties": { "enabled": { "description": "Whether gVNIC features are enabled in the node pool.", "type": "boolean" } } }, "ConfidentialNodes": { "id": "ConfidentialNodes", "description": "ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.", "type": "object", "properties": { "enabled": { "description": "Whether Confidential Nodes feature is enabled.", "type": "boolean" } } }, "FastSocket": { "id": "FastSocket", "description": "Configuration of Fast Socket feature.", "type": "object", "properties": { "enabled": { "description": "Whether Fast Socket features are enabled in the node pool.", "type": "boolean" } } }, "NodePoolLoggingConfig": { "id": "NodePoolLoggingConfig", "description": "NodePoolLoggingConfig specifies logging configuration for nodepools.", "type": "object", "properties": { "variantConfig": { "description": "Logging variant configuration.", "$ref": "LoggingVariantConfig" } } }, "LoggingVariantConfig": { "id": "LoggingVariantConfig", "description": "LoggingVariantConfig specifies the behaviour of the logging component.", "type": "object", "properties": { "variant": { "description": "Logging variant deployed on nodes.", "type": "string", "enumDescriptions": [ "Default value. This shouldn't be used.", "default logging variant.", "maximum logging throughput variant." ], "enum": [ "VARIANT_UNSPECIFIED", "DEFAULT", "MAX_THROUGHPUT" ] } } }, "WindowsNodeConfig": { "id": "WindowsNodeConfig", "description": "Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings", "type": "object", "properties": { "osVersion": { "description": "OSVersion specifies the Windows node config to be used on the node", "type": "string", "enumDescriptions": [ "When OSVersion is not specified", "LTSC2019 specifies to use LTSC2019 as the Windows Servercore Base Image", "LTSC2022 specifies to use LTSC2022 as the Windows Servercore Base Image" ], "enum": [ "OS_VERSION_UNSPECIFIED", "OS_VERSION_LTSC2019", "OS_VERSION_LTSC2022" ] } } }, "LocalNvmeSsdBlockConfig": { "id": "LocalNvmeSsdBlockConfig", "description": "LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs", "type": "object", "properties": { "localSsdCount": { "description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "type": "integer", "format": "int32" } } }, "EphemeralStorageLocalSsdConfig": { "id": "EphemeralStorageLocalSsdConfig", "description": "EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs.", "type": "object", "properties": { "localSsdCount": { "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "type": "integer", "format": "int32" } } }, "SoleTenantConfig": { "id": "SoleTenantConfig", "description": "SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool.", "type": "object", "properties": { "nodeAffinities": { "description": "NodeAffinities used to match to a shared sole tenant node group.", "type": "array", "items": { "$ref": "NodeAffinity" } } } }, "NodeAffinity": { "id": "NodeAffinity", "description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).", "type": "object", "properties": { "key": { "description": "Key for NodeAffinity.", "type": "string" }, "operator": { "description": "Operator for NodeAffinity.", "type": "string", "enumDescriptions": [ "Invalid or unspecified affinity operator.", "Affinity operator.", "Anti-affinity operator." ], "enum": [ "OPERATOR_UNSPECIFIED", "IN", "NOT_IN" ] }, "values": { "description": "Values for NodeAffinity.", "type": "array", "items": { "type": "string" } } } }, "ContainerdConfig": { "id": "ContainerdConfig", "description": "ContainerdConfig contains configuration to customize containerd.", "type": "object", "properties": { "privateRegistryAccessConfig": { "description": "PrivateRegistryAccessConfig is used to configure access configuration for private container registries.", "$ref": "PrivateRegistryAccessConfig" } } }, "PrivateRegistryAccessConfig": { "id": "PrivateRegistryAccessConfig", "description": "PrivateRegistryAccessConfig contains access configuration for private container registries.", "type": "object", "properties": { "enabled": { "description": "Private registry access is enabled.", "type": "boolean" }, "certificateAuthorityDomainConfig": { "description": "Private registry access configuration.", "type": "array", "items": { "$ref": "CertificateAuthorityDomainConfig" } } } }, "CertificateAuthorityDomainConfig": { "id": "CertificateAuthorityDomainConfig", "description": "CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.", "type": "object", "properties": { "fqdns": { "description": "List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000", "type": "array", "items": { "type": "string" } }, "gcpSecretManagerCertificateConfig": { "description": "Google Secret Manager (GCP) certificate configuration.", "$ref": "GCPSecretManagerCertificateConfig" } } }, "GCPSecretManagerCertificateConfig": { "id": "GCPSecretManagerCertificateConfig", "description": "GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager).", "type": "object", "properties": { "secretUri": { "description": "Secret URI, in the form \"projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION\". Version can be fixed (e.g. \"2\") or \"latest\"", "type": "string" } } }, "HostMaintenancePolicy": { "id": "HostMaintenancePolicy", "description": "HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on.", "type": "object", "properties": { "maintenanceInterval": { "description": "Specifies the frequency of planned maintenance events.", "type": "string", "enumDescriptions": [ "The maintenance interval is not explicitly specified.", "Nodes are eligible to receive infrastructure and hypervisor updates as they become available. This may result in more maintenance operations (live migrations or terminations) for the node than the PERIODIC option.", "Nodes receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean underlying VMs will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available." ], "enum": [ "MAINTENANCE_INTERVAL_UNSPECIFIED", "AS_NEEDED", "PERIODIC" ] }, "opportunisticMaintenanceStrategy": { "description": "Strategy that will trigger maintenance on behalf of the customer.", "$ref": "OpportunisticMaintenanceStrategy" } } }, "OpportunisticMaintenanceStrategy": { "id": "OpportunisticMaintenanceStrategy", "description": "Strategy that will trigger maintenance on behalf of the customer.", "type": "object", "properties": { "nodeIdleTimeWindow": { "description": "The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.", "type": "string", "format": "google-duration" }, "maintenanceAvailabilityWindow": { "description": "The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).", "type": "string", "format": "google-duration" }, "minNodesPerPool": { "description": "The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.", "type": "string", "format": "int64" } } }, "ResourceManagerTags": { "id": "ResourceManagerTags", "description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.", "type": "object", "properties": { "tags": { "description": "Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`", "type": "object", "additionalProperties": { "type": "string" } } } }, "SecondaryBootDisk": { "id": "SecondaryBootDisk", "description": "SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.", "type": "object", "properties": { "mode": { "description": "Disk mode (container image cache, etc.)", "type": "string", "enumDescriptions": [ "MODE_UNSPECIFIED is when mode is not set.", "CONTAINER_IMAGE_CACHE is for using the secondary boot disk as a container image cache." ], "enum": [ "MODE_UNSPECIFIED", "CONTAINER_IMAGE_CACHE" ] }, "diskImage": { "description": "Fully-qualified resource ID for an existing disk image.", "type": "string" } } }, "SecondaryBootDiskUpdateStrategy": { "id": "SecondaryBootDiskUpdateStrategy", "description": "SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks.", "type": "object", "properties": {} }, "MasterAuth": { "id": "MasterAuth", "description": "The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.", "type": "object", "properties": { "username": { "description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication", "deprecated": true, "type": "string" }, "password": { "description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication", "deprecated": true, "type": "string" }, "clientCertificateConfig": { "description": "Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.", "$ref": "ClientCertificateConfig" }, "clusterCaCertificate": { "type": "string" }, "clientCertificate": { "description": "[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", "type": "string" }, "clientKey": { "description": "[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.", "type": "string" } } }, "ClientCertificateConfig": { "id": "ClientCertificateConfig", "description": "Configuration for client certificates on the cluster.", "type": "object", "properties": { "issueClientCertificate": { "description": "Issue a client certificate.", "type": "boolean" } } }, "AddonsConfig": { "id": "AddonsConfig", "description": "Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.", "type": "object", "properties": { "httpLoadBalancing": { "description": "Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.", "$ref": "HttpLoadBalancing" }, "horizontalPodAutoscaling": { "description": "Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.", "$ref": "HorizontalPodAutoscaling" }, "kubernetesDashboard": { "description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards", "deprecated": true, "$ref": "KubernetesDashboard" }, "networkPolicyConfig": { "description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.", "$ref": "NetworkPolicyConfig" }, "istioConfig": { "description": "Configuration for Istio, an open platform to connect, manage, and secure microservices.", "deprecated": true, "$ref": "IstioConfig" }, "cloudRunConfig": { "description": "Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.", "$ref": "CloudRunConfig" }, "dnsCacheConfig": { "description": "Configuration for NodeLocalDNS, a dns cache running on cluster nodes", "$ref": "DnsCacheConfig" }, "configConnectorConfig": { "description": "Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API", "$ref": "ConfigConnectorConfig" }, "gcePersistentDiskCsiDriverConfig": { "description": "Configuration for the Compute Engine Persistent Disk CSI driver.", "$ref": "GcePersistentDiskCsiDriverConfig" }, "kalmConfig": { "description": "Configuration for the KALM addon, which manages the lifecycle of k8s applications.", "deprecated": true, "$ref": "KalmConfig" }, "gcpFilestoreCsiDriverConfig": { "description": "Configuration for the GCP Filestore CSI driver.", "$ref": "GcpFilestoreCsiDriverConfig" }, "gkeBackupAgentConfig": { "description": "Configuration for the Backup for GKE agent addon.", "$ref": "GkeBackupAgentConfig" }, "gcsFuseCsiDriverConfig": { "description": "Configuration for the Cloud Storage Fuse CSI driver.", "$ref": "GcsFuseCsiDriverConfig" }, "statefulHaConfig": { "description": "Optional. Configuration for the StatefulHA add-on.", "$ref": "StatefulHAConfig" } } }, "HttpLoadBalancing": { "id": "HttpLoadBalancing", "description": "Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.", "type": "object", "properties": { "disabled": { "description": "Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.", "type": "boolean" } } }, "HorizontalPodAutoscaling": { "id": "HorizontalPodAutoscaling", "description": "Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.", "type": "object", "properties": { "disabled": { "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.", "type": "boolean" } } }, "KubernetesDashboard": { "id": "KubernetesDashboard", "description": "Configuration for the Kubernetes Dashboard.", "type": "object", "properties": { "disabled": { "description": "Whether the Kubernetes Dashboard is enabled for this cluster.", "type": "boolean" } } }, "NetworkPolicyConfig": { "id": "NetworkPolicyConfig", "description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.", "type": "object", "properties": { "disabled": { "description": "Whether NetworkPolicy is enabled for this cluster.", "type": "boolean" } } }, "IstioConfig": { "id": "IstioConfig", "description": "Configuration options for Istio addon.", "type": "object", "properties": { "disabled": { "description": "Whether Istio is enabled for this cluster.", "deprecated": true, "type": "boolean" }, "auth": { "description": "The specified Istio auth mode, either none, or mutual TLS.", "deprecated": true, "type": "string", "enumDescriptions": [ "auth not enabled", "auth mutual TLS enabled" ], "enum": [ "AUTH_NONE", "AUTH_MUTUAL_TLS" ] } } }, "CloudRunConfig": { "id": "CloudRunConfig", "description": "Configuration options for the Cloud Run feature.", "type": "object", "properties": { "disabled": { "description": "Whether Cloud Run addon is enabled for this cluster.", "type": "boolean" }, "loadBalancerType": { "description": "Which load balancer type is installed for Cloud Run.", "type": "string", "enumDescriptions": [ "Load balancer type for Cloud Run is unspecified.", "Install external load balancer for Cloud Run.", "Install internal load balancer for Cloud Run." ], "enum": [ "LOAD_BALANCER_TYPE_UNSPECIFIED", "LOAD_BALANCER_TYPE_EXTERNAL", "LOAD_BALANCER_TYPE_INTERNAL" ] } } }, "DnsCacheConfig": { "id": "DnsCacheConfig", "description": "Configuration for NodeLocal DNSCache", "type": "object", "properties": { "enabled": { "description": "Whether NodeLocal DNSCache is enabled for this cluster.", "type": "boolean" } } }, "ConfigConnectorConfig": { "id": "ConfigConnectorConfig", "description": "Configuration options for the Config Connector add-on.", "type": "object", "properties": { "enabled": { "description": "Whether Cloud Connector is enabled for this cluster.", "type": "boolean" } } }, "GcePersistentDiskCsiDriverConfig": { "id": "GcePersistentDiskCsiDriverConfig", "description": "Configuration for the Compute Engine PD CSI driver.", "type": "object", "properties": { "enabled": { "description": "Whether the Compute Engine PD CSI driver is enabled for this cluster.", "type": "boolean" } } }, "KalmConfig": { "id": "KalmConfig", "description": "Configuration options for the KALM addon.", "type": "object", "properties": { "enabled": { "description": "Whether KALM is enabled for this cluster.", "deprecated": true, "type": "boolean" } } }, "GcpFilestoreCsiDriverConfig": { "id": "GcpFilestoreCsiDriverConfig", "description": "Configuration for the GCP Filestore CSI driver.", "type": "object", "properties": { "enabled": { "description": "Whether the GCP Filestore CSI driver is enabled for this cluster.", "type": "boolean" } } }, "GkeBackupAgentConfig": { "id": "GkeBackupAgentConfig", "description": "Configuration for the Backup for GKE Agent.", "type": "object", "properties": { "enabled": { "description": "Whether the Backup for GKE agent is enabled for this cluster.", "type": "boolean" } } }, "GcsFuseCsiDriverConfig": { "id": "GcsFuseCsiDriverConfig", "description": "Configuration for the Cloud Storage Fuse CSI driver.", "type": "object", "properties": { "enabled": { "description": "Whether the Cloud Storage Fuse CSI driver is enabled for this cluster.", "type": "boolean" } } }, "StatefulHAConfig": { "id": "StatefulHAConfig", "description": "Configuration for the Stateful HA add-on.", "type": "object", "properties": { "enabled": { "description": "Whether the Stateful HA add-on is enabled for this cluster.", "type": "boolean" } } }, "NodePool": { "id": "NodePool", "description": "NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.", "type": "object", "properties": { "name": { "description": "The name of the node pool.", "type": "string" }, "config": { "description": "The node configuration of the pool.", "$ref": "NodeConfig" }, "initialNodeCount": { "description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.", "type": "integer", "format": "int32" }, "locations": { "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.", "type": "array", "items": { "type": "string" } }, "networkConfig": { "description": "Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.", "$ref": "NodeNetworkConfig" }, "selfLink": { "description": "[Output only] Server-defined URL for the resource.", "type": "string" }, "version": { "description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).", "type": "string" }, "instanceGroupUrls": { "description": "[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "type": "array", "items": { "type": "string" } }, "status": { "description": "[Output only] The status of the nodes in this pool instance.", "type": "string", "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the node pool is being created.", "The RUNNING state indicates the node pool has been created and is fully usable.", "The RUNNING_WITH_ERROR state indicates the node pool has been created and is partially usable. Some error state has occurred and some functionality may be impaired. Customer may need to reissue a request or trigger a new update.", "The RECONCILING state indicates that some work is actively being done on the node pool, such as upgrading node software. Details can be found in the `statusMessage` field.", "The STOPPING state indicates the node pool is being deleted.", "The ERROR state indicates the node pool may be unusable. Details can be found in the `statusMessage` field." ], "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", "RUNNING", "RUNNING_WITH_ERROR", "RECONCILING", "STOPPING", "ERROR" ] }, "statusMessage": { "description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", "deprecated": true, "type": "string" }, "autoscaling": { "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.", "$ref": "NodePoolAutoscaling" }, "management": { "description": "NodeManagement configuration for this NodePool.", "$ref": "NodeManagement" }, "maxPodsConstraint": { "description": "The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.", "$ref": "MaxPodsConstraint" }, "conditions": { "description": "Which conditions caused the current node pool state.", "type": "array", "items": { "$ref": "StatusCondition" } }, "podIpv4CidrSize": { "description": "[Output only] The pod CIDR block size per node in this node pool.", "type": "integer", "format": "int32" }, "upgradeSettings": { "description": "Upgrade settings control disruption and speed of the upgrade.", "$ref": "UpgradeSettings" }, "placementPolicy": { "description": "Specifies the node placement policy.", "$ref": "PlacementPolicy" }, "updateInfo": { "description": "Output only. [Output only] Update info contains relevant information during a node pool update.", "readOnly": true, "$ref": "UpdateInfo" }, "etag": { "description": "This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "queuedProvisioning": { "description": "Specifies the configuration of queued provisioning.", "$ref": "QueuedProvisioning" }, "bestEffortProvisioning": { "description": "Enable best effort provisioning for nodes", "$ref": "BestEffortProvisioning" } } }, "NodeNetworkConfig": { "id": "NodeNetworkConfig", "description": "Parameters for node pool-level network config.", "type": "object", "properties": { "createPodRange": { "description": "Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.", "type": "boolean" }, "podRange": { "description": "The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.", "type": "string" }, "podIpv4CidrBlock": { "description": "The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.", "type": "string" }, "enablePrivateNodes": { "description": "Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from cluster.privateClusterConfig.enablePrivateNodes", "type": "boolean" }, "networkPerformanceConfig": { "description": "Network bandwidth tier configuration.", "$ref": "NetworkPerformanceConfig" }, "podCidrOverprovisionConfig": { "description": "[PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.", "$ref": "PodCIDROverprovisionConfig" }, "additionalNodeNetworkConfigs": { "description": "We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface", "type": "array", "items": { "$ref": "AdditionalNodeNetworkConfig" } }, "additionalPodNetworkConfigs": { "description": "We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node", "type": "array", "items": { "$ref": "AdditionalPodNetworkConfig" } }, "podIpv4RangeUtilization": { "description": "Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "readOnly": true, "type": "number", "format": "double" } } }, "NetworkPerformanceConfig": { "id": "NetworkPerformanceConfig", "description": "Configuration of all network bandwidth tiers", "type": "object", "properties": { "totalEgressBandwidthTier": { "description": "Specifies the total network bandwidth tier for the NodePool.", "type": "string", "enumDescriptions": [ "Default value", "Higher bandwidth, actual values based on VM size." ], "enum": [ "TIER_UNSPECIFIED", "TIER_1" ] }, "externalIpEgressBandwidthTier": { "description": "Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses.", "type": "string", "enumDescriptions": [ "Default value", "Higher bandwidth, actual values based on VM size." ], "enum": [ "TIER_UNSPECIFIED", "TIER_1" ] } } }, "PodCIDROverprovisionConfig": { "id": "PodCIDROverprovisionConfig", "description": "[PRIVATE FIELD] Config for pod CIDR size overprovisioning.", "type": "object", "properties": { "disable": { "description": "Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.", "type": "boolean" } } }, "AdditionalNodeNetworkConfig": { "id": "AdditionalNodeNetworkConfig", "description": "AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message", "type": "object", "properties": { "network": { "description": "Name of the VPC where the additional interface belongs", "type": "string" }, "subnetwork": { "description": "Name of the subnetwork where the additional interface belongs", "type": "string" } } }, "AdditionalPodNetworkConfig": { "id": "AdditionalPodNetworkConfig", "description": "AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message", "type": "object", "properties": { "subnetwork": { "description": "Name of the subnetwork where the additional pod network belongs", "type": "string" }, "secondaryPodRange": { "description": "The name of the secondary range on the subnet which provides IP address for this pod range", "type": "string" }, "maxPodsPerNode": { "description": "The maximum number of pods per node which use this pod network", "$ref": "MaxPodsConstraint" } } }, "MaxPodsConstraint": { "id": "MaxPodsConstraint", "description": "Constraints applied to pods.", "type": "object", "properties": { "maxPodsPerNode": { "description": "Constraint enforced on the max num of pods per node.", "type": "string", "format": "int64" } } }, "NodePoolAutoscaling": { "id": "NodePoolAutoscaling", "description": "NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.", "type": "object", "properties": { "enabled": { "description": "Is autoscaling enabled for this node pool.", "type": "boolean" }, "minNodeCount": { "description": "Minimum number of nodes for one location in the NodePool. Must be \u003e= 1 and \u003c= max_node_count.", "type": "integer", "format": "int32" }, "maxNodeCount": { "description": "Maximum number of nodes for one location in the NodePool. Must be \u003e= min_node_count. There has to be enough quota to scale up the cluster.", "type": "integer", "format": "int32" }, "autoprovisioned": { "description": "Can this node pool be deleted automatically.", "type": "boolean" }, "locationPolicy": { "description": "Location policy used when scaling up a nodepool.", "type": "string", "enumDescriptions": [ "Not set.", "BALANCED is a best effort policy that aims to balance the sizes of different zones.", "ANY policy picks zones that have the highest capacity available." ], "enum": [ "LOCATION_POLICY_UNSPECIFIED", "BALANCED", "ANY" ] }, "totalMinNodeCount": { "description": "Minimum number of nodes in the node pool. Must be greater than 1 less than total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields.", "type": "integer", "format": "int32" }, "totalMaxNodeCount": { "description": "Maximum number of nodes in the node pool. Must be greater than total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields.", "type": "integer", "format": "int32" } } }, "NodeManagement": { "id": "NodeManagement", "description": "NodeManagement defines the set of node management services turned on for the node pool.", "type": "object", "properties": { "autoUpgrade": { "description": "Whether the nodes will be automatically upgraded.", "type": "boolean" }, "autoRepair": { "description": "Whether the nodes will be automatically repaired.", "type": "boolean" }, "upgradeOptions": { "description": "Specifies the Auto Upgrade knobs for the node pool.", "$ref": "AutoUpgradeOptions" } } }, "AutoUpgradeOptions": { "id": "AutoUpgradeOptions", "description": "AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.", "type": "object", "properties": { "autoUpgradeStartTime": { "description": "[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "description": { "description": "[Output only] This field is set when upgrades are about to commence with the description of the upgrade.", "type": "string" } } }, "StatusCondition": { "id": "StatusCondition", "description": "StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).", "type": "object", "properties": { "code": { "description": "Machine-friendly representation of the condition Deprecated. Use canonical_code instead.", "deprecated": true, "type": "string", "enumDescriptions": [ "UNKNOWN indicates a generic condition.", "GCE_STOCKOUT indicates that Google Compute Engine resources are temporarily unavailable.", "GKE_SERVICE_ACCOUNT_DELETED indicates that the user deleted their robot service account.", "Google Compute Engine quota was exceeded.", "Cluster state was manually changed by an SRE due to a system logic error.", "Unable to perform an encrypt operation against the CloudKMS key used for etcd level encryption.", "Cluster CA is expiring soon. More codes TBA" ], "enum": [ "UNKNOWN", "GCE_STOCKOUT", "GKE_SERVICE_ACCOUNT_DELETED", "GCE_QUOTA_EXCEEDED", "SET_BY_OPERATOR", "CLOUD_KMS_KEY_ERROR", "CA_EXPIRING" ] }, "message": { "description": "Human-friendly representation of the condition", "type": "string" }, "canonicalCode": { "description": "Canonical code of the condition.", "type": "string", "enumDescriptions": [ "Not an error; returned on success. HTTP Mapping: 200 OK", "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" ], "enum": [ "OK", "CANCELLED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "UNAUTHENTICATED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS" ] } } }, "UpgradeSettings": { "id": "UpgradeSettings", "description": "These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted.", "type": "object", "properties": { "maxSurge": { "description": "The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.", "type": "integer", "format": "int32" }, "maxUnavailable": { "description": "The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.", "type": "integer", "format": "int32" }, "strategy": { "description": "Update strategy of the node pool.", "type": "string", "enumDescriptions": [ "Default value if unset. GKE internally defaults the update strategy to SURGE for unspecified strategies.", "blue-green upgrade.", "SURGE is the traditional way of upgrading a node pool. max_surge and max_unavailable determines the level of upgrade parallelism." ], "enum": [ "NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED", "BLUE_GREEN", "SURGE" ] }, "blueGreenSettings": { "description": "Settings for blue-green upgrade strategy.", "$ref": "BlueGreenSettings" } } }, "BlueGreenSettings": { "id": "BlueGreenSettings", "description": "Settings for blue-green upgrade.", "type": "object", "properties": { "standardRolloutPolicy": { "description": "Standard policy for the blue-green upgrade.", "$ref": "StandardRolloutPolicy" }, "autoscaledRolloutPolicy": { "description": "Autoscaled policy for cluster autoscaler enabled blue-green upgrade.", "$ref": "AutoscaledRolloutPolicy" }, "nodePoolSoakDuration": { "description": "Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.", "type": "string", "format": "google-duration" } } }, "StandardRolloutPolicy": { "id": "StandardRolloutPolicy", "description": "Standard rollout policy is the default policy for blue-green.", "type": "object", "properties": { "batchPercentage": { "description": "Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].", "type": "number", "format": "float" }, "batchNodeCount": { "description": "Number of blue nodes to drain in a batch.", "type": "integer", "format": "int32" }, "batchSoakDuration": { "description": "Soak time after each batch gets drained. Default to zero.", "type": "string", "format": "google-duration" } } }, "AutoscaledRolloutPolicy": { "id": "AutoscaledRolloutPolicy", "description": "Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools.", "type": "object", "properties": {} }, "PlacementPolicy": { "id": "PlacementPolicy", "description": "PlacementPolicy defines the placement policy used by the node pool.", "type": "object", "properties": { "type": { "description": "The type of placement.", "type": "string", "enumDescriptions": [ "TYPE_UNSPECIFIED specifies no requirements on nodes placement.", "COMPACT specifies node placement in the same availability domain to ensure low communication latency." ], "enum": [ "TYPE_UNSPECIFIED", "COMPACT" ] }, "tpuTopology": { "description": "TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies", "type": "string" }, "policyName": { "description": "If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.", "type": "string" } } }, "UpdateInfo": { "id": "UpdateInfo", "description": "UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade.", "type": "object", "properties": { "blueGreenInfo": { "description": "Information of a blue-green upgrade.", "$ref": "BlueGreenInfo" } } }, "BlueGreenInfo": { "id": "BlueGreenInfo", "description": "Information relevant to blue-green upgrade.", "type": "object", "properties": { "phase": { "description": "Current blue-green upgrade phase.", "type": "string", "enumDescriptions": [ "Unspecified phase.", "blue-green upgrade has been initiated.", "Start creating green pool nodes.", "Start cordoning blue pool nodes.", "Start waiting after cordoning the blue pool and before draining it.", "Start draining blue pool nodes.", "Start soaking time after draining entire blue pool.", "Start deleting blue nodes.", "Rollback has been initiated." ], "enum": [ "PHASE_UNSPECIFIED", "UPDATE_STARTED", "CREATING_GREEN_POOL", "CORDONING_BLUE_POOL", "WAITING_TO_DRAIN_BLUE_POOL", "DRAINING_BLUE_POOL", "NODE_POOL_SOAKING", "DELETING_BLUE_POOL", "ROLLBACK_STARTED" ] }, "blueInstanceGroupUrls": { "description": "The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.", "type": "array", "items": { "type": "string" } }, "greenInstanceGroupUrls": { "description": "The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool.", "type": "array", "items": { "type": "string" } }, "bluePoolDeletionStartTime": { "description": "Time to start deleting blue pool to complete blue-green upgrade, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "greenPoolVersion": { "description": "Version of green pool.", "type": "string" } } }, "QueuedProvisioning": { "id": "QueuedProvisioning", "description": "QueuedProvisioning defines the queued provisioning used by the node pool.", "type": "object", "properties": { "enabled": { "description": "Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.", "type": "boolean" } } }, "BestEffortProvisioning": { "id": "BestEffortProvisioning", "description": "Best effort provisioning.", "type": "object", "properties": { "enabled": { "description": "When this is enabled, cluster/node pool creations will ignore non-fatal errors like stockout to best provision as many nodes as possible right now and eventually bring up all target number of nodes", "type": "boolean" }, "minProvisionNodes": { "description": "Minimum number of nodes to be provisioned to be considered as succeeded, and the rest of nodes will be provisioned gradually and eventually when stockout issue has been resolved.", "type": "integer", "format": "int32" } } }, "K8sBetaAPIConfig": { "id": "K8sBetaAPIConfig", "description": "Kubernetes open source beta apis enabled on the cluster.", "type": "object", "properties": { "enabledApis": { "description": "api name, e.g. storage.k8s.io/v1beta1/csistoragecapacities.", "type": "array", "items": { "type": "string" } } } }, "LegacyAbac": { "id": "LegacyAbac", "description": "Configuration for the legacy Attribute Based Access Control authorization mode.", "type": "object", "properties": { "enabled": { "description": "Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.", "type": "boolean" } } }, "NetworkPolicy": { "id": "NetworkPolicy", "description": "Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/", "type": "object", "properties": { "provider": { "description": "The selected network policy provider.", "type": "string", "enumDescriptions": [ "Not set", "Tigera (Calico Felix)." ], "enum": [ "PROVIDER_UNSPECIFIED", "CALICO" ] }, "enabled": { "description": "Whether network policy is enabled on the cluster.", "type": "boolean" } } }, "IPAllocationPolicy": { "id": "IPAllocationPolicy", "description": "Configuration for controlling how IPs are allocated in the cluster.", "type": "object", "properties": { "useIpAliases": { "description": "Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode", "type": "boolean" }, "createSubnetwork": { "description": "Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.", "type": "boolean" }, "subnetworkName": { "description": "A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.", "type": "string" }, "clusterIpv4Cidr": { "description": "This field is deprecated, use cluster_ipv4_cidr_block.", "deprecated": true, "type": "string" }, "nodeIpv4Cidr": { "description": "This field is deprecated, use node_ipv4_cidr_block.", "deprecated": true, "type": "string" }, "servicesIpv4Cidr": { "description": "This field is deprecated, use services_ipv4_cidr_block.", "deprecated": true, "type": "string" }, "clusterSecondaryRangeName": { "description": "The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false.", "type": "string" }, "servicesSecondaryRangeName": { "description": "The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false.", "type": "string" }, "clusterIpv4CidrBlock": { "description": "The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.", "type": "string" }, "nodeIpv4CidrBlock": { "description": "The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.", "type": "string" }, "servicesIpv4CidrBlock": { "description": "The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.", "type": "string" }, "allowRouteOverlap": { "description": "If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.", "type": "boolean" }, "tpuIpv4CidrBlock": { "description": "The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.", "type": "string" }, "useRoutes": { "description": "Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode", "type": "boolean" }, "stackType": { "description": "IP stack type", "type": "string", "enumDescriptions": [ "By default, the clusters will be IPV4 only", "The value used if the cluster is a IPV4 only", "The value used if the cluster is a dual stack cluster" ], "enum": [ "STACK_TYPE_UNSPECIFIED", "IPV4", "IPV4_IPV6" ] }, "ipv6AccessType": { "description": "The ipv6 access type (internal or external) when create_subnetwork is true", "type": "string", "enumDescriptions": [ "Default value, will be defaulted as type external.", "Access type internal (all v6 addresses are internal IPs)", "Access type external (all v6 addresses are external IPs)" ], "enum": [ "IPV6_ACCESS_TYPE_UNSPECIFIED", "INTERNAL", "EXTERNAL" ] }, "podCidrOverprovisionConfig": { "description": "[PRIVATE FIELD] Pod CIDR size overprovisioning config for the cluster. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is doubled and then rounded off to next power of 2 to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.", "$ref": "PodCIDROverprovisionConfig" }, "subnetIpv6CidrBlock": { "description": "Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.", "readOnly": true, "type": "string" }, "servicesIpv6CidrBlock": { "description": "Output only. [Output only] The services IPv6 CIDR block for the cluster.", "readOnly": true, "type": "string" }, "additionalPodRangesConfig": { "description": "Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", "readOnly": true, "$ref": "AdditionalPodRangesConfig" }, "defaultPodIpv4RangeUtilization": { "description": "Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "readOnly": true, "type": "number", "format": "double" } } }, "AdditionalPodRangesConfig": { "id": "AdditionalPodRangesConfig", "description": "AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.", "type": "object", "properties": { "podRangeNames": { "description": "Name for pod secondary ipv4 range which has the actual range defined ahead.", "type": "array", "items": { "type": "string" } }, "podRangeInfo": { "description": "Output only. [Output only] Information for additional pod range.", "readOnly": true, "type": "array", "items": { "$ref": "RangeInfo" } } } }, "RangeInfo": { "id": "RangeInfo", "description": "RangeInfo contains the range name and the range utilization by this cluster.", "type": "object", "properties": { "rangeName": { "description": "Output only. [Output only] Name of a range.", "readOnly": true, "type": "string" }, "utilization": { "description": "Output only. [Output only] The utilization of the range.", "readOnly": true, "type": "number", "format": "double" } } }, "MasterAuthorizedNetworksConfig": { "id": "MasterAuthorizedNetworksConfig", "description": "Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.", "type": "object", "properties": { "enabled": { "description": "Whether or not master authorized networks is enabled.", "type": "boolean" }, "cidrBlocks": { "description": "cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.", "type": "array", "items": { "$ref": "CidrBlock" } }, "gcpPublicCidrsAccessEnabled": { "description": "Whether master is accessbile via Google Compute Engine Public IP addresses.", "type": "boolean" } } }, "CidrBlock": { "id": "CidrBlock", "description": "CidrBlock contains an optional name and one CIDR block.", "type": "object", "properties": { "displayName": { "description": "display_name is an optional field for users to identify CIDR blocks.", "type": "string" }, "cidrBlock": { "description": "cidr_block must be specified in CIDR notation.", "type": "string" } } }, "MaintenancePolicy": { "id": "MaintenancePolicy", "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.", "type": "object", "properties": { "window": { "description": "Specifies the maintenance window in which maintenance may be performed.", "$ref": "MaintenanceWindow" }, "resourceVersion": { "description": "A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.", "type": "string" } } }, "MaintenanceWindow": { "id": "MaintenanceWindow", "description": "MaintenanceWindow defines the maintenance window to be used for the cluster.", "type": "object", "properties": { "dailyMaintenanceWindow": { "description": "DailyMaintenanceWindow specifies a daily maintenance operation window.", "$ref": "DailyMaintenanceWindow" }, "recurringWindow": { "description": "RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.", "$ref": "RecurringTimeWindow" }, "maintenanceExclusions": { "description": "Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.", "type": "object", "additionalProperties": { "$ref": "TimeWindow" } } } }, "DailyMaintenanceWindow": { "id": "DailyMaintenanceWindow", "description": "Time window specified for daily maintenance operations.", "type": "object", "properties": { "startTime": { "description": "Time within the maintenance window to start the maintenance operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-59] GMT.", "type": "string" }, "duration": { "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", "type": "string" } } }, "RecurringTimeWindow": { "id": "RecurringTimeWindow", "description": "Represents an arbitrary window of time that recurs.", "type": "object", "properties": { "window": { "description": "The window of the first recurrence.", "$ref": "TimeWindow" }, "recurrence": { "description": "An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.", "type": "string" } } }, "TimeWindow": { "id": "TimeWindow", "description": "Represents an arbitrary window of time.", "type": "object", "properties": { "maintenanceExclusionOptions": { "description": "MaintenanceExclusionOptions provides maintenance exclusion related options.", "$ref": "MaintenanceExclusionOptions" }, "startTime": { "description": "The time that the window first starts.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "The time that the window ends. The end time should take place after the start time.", "type": "string", "format": "google-datetime" } } }, "MaintenanceExclusionOptions": { "id": "MaintenanceExclusionOptions", "description": "Represents the Maintenance exclusion option.", "type": "object", "properties": { "scope": { "description": "Scope specifies the upgrade scope which upgrades are blocked by the exclusion.", "type": "string", "enumDescriptions": [ "NO_UPGRADES excludes all upgrades, including patch upgrades and minor upgrades across control planes and nodes. This is the default exclusion behavior.", "NO_MINOR_UPGRADES excludes all minor upgrades for the cluster, only patches are allowed.", "NO_MINOR_OR_NODE_UPGRADES excludes all minor upgrades for the cluster, and also exclude all node pool upgrades. Only control plane patches are allowed." ], "enum": [ "NO_UPGRADES", "NO_MINOR_UPGRADES", "NO_MINOR_OR_NODE_UPGRADES" ] } } }, "BinaryAuthorization": { "id": "BinaryAuthorization", "description": "Configuration for Binary Authorization.", "type": "object", "properties": { "enabled": { "description": "This field is deprecated. Leave this unset and instead configure BinaryAuthorization using evaluation_mode. If evaluation_mode is set to anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored.", "deprecated": true, "type": "boolean" }, "evaluationMode": { "description": "Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.", "type": "string", "enumDescriptions": [ "Default value", "Disable BinaryAuthorization", "Enforce Kubernetes admission requests with BinaryAuthorization using the project's singleton policy. This is equivalent to setting the enabled boolean to true.", "Use Binary Authorization Continuous Validation with the policies specified in policy_bindings.", "Use Binary Authorization Continuous Validation with the policies specified in policy_bindings and enforce Kubernetes admission requests with Binary Authorization using the project's singleton policy." ], "enum": [ "EVALUATION_MODE_UNSPECIFIED", "DISABLED", "PROJECT_SINGLETON_POLICY_ENFORCE", "POLICY_BINDINGS", "POLICY_BINDINGS_AND_PROJECT_SINGLETON_POLICY_ENFORCE" ] }, "policyBindings": { "description": "Optional. Binauthz policies that apply to this cluster.", "type": "array", "items": { "$ref": "PolicyBinding" } } } }, "PolicyBinding": { "id": "PolicyBinding", "description": "Binauthz policy that applies to this cluster.", "type": "object", "properties": { "name": { "description": "The relative resource name of the binauthz platform policy to evaluate. GKE platform policies have the following format: `projects/{project_number}/platforms/gke/policies/{policy_id}`.", "type": "string" } } }, "PodSecurityPolicyConfig": { "id": "PodSecurityPolicyConfig", "description": "Configuration for the PodSecurityPolicy feature.", "type": "object", "properties": { "enabled": { "description": "Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.", "type": "boolean" } } }, "ClusterAutoscaling": { "id": "ClusterAutoscaling", "description": "ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.", "type": "object", "properties": { "enableNodeAutoprovisioning": { "description": "Enables automatic node pool creation and deletion.", "type": "boolean" }, "resourceLimits": { "description": "Contains global constraints regarding minimum and maximum amount of resources in the cluster.", "type": "array", "items": { "$ref": "ResourceLimit" } }, "autoscalingProfile": { "description": "Defines autoscaling behaviour.", "type": "string", "enumDescriptions": [ "No change to autoscaling configuration.", "Prioritize optimizing utilization of resources.", "Use default (balanced) autoscaling configuration." ], "enum": [ "PROFILE_UNSPECIFIED", "OPTIMIZE_UTILIZATION", "BALANCED" ] }, "autoprovisioningNodePoolDefaults": { "description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.", "$ref": "AutoprovisioningNodePoolDefaults" }, "autoprovisioningLocations": { "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.", "type": "array", "items": { "type": "string" } } } }, "ResourceLimit": { "id": "ResourceLimit", "description": "Contains information about amount of some resource in the cluster. For memory, value should be in GB.", "type": "object", "properties": { "resourceType": { "description": "Resource name \"cpu\", \"memory\" or gpu-specific string.", "type": "string" }, "minimum": { "description": "Minimum amount of the resource in the cluster.", "type": "string", "format": "int64" }, "maximum": { "description": "Maximum amount of the resource in the cluster.", "type": "string", "format": "int64" } } }, "AutoprovisioningNodePoolDefaults": { "id": "AutoprovisioningNodePoolDefaults", "description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.", "type": "object", "properties": { "oauthScopes": { "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", "type": "array", "items": { "type": "string" } }, "serviceAccount": { "description": "The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the \"default\" service account is used.", "type": "string" }, "upgradeSettings": { "description": "Upgrade settings control disruption and speed of the upgrade.", "$ref": "UpgradeSettings" }, "management": { "description": "NodeManagement configuration for this NodePool.", "$ref": "NodeManagement" }, "minCpuPlatform": { "description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", "deprecated": true, "type": "string" }, "diskSizeGb": { "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.", "type": "integer", "format": "int32" }, "diskType": { "description": "Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'", "type": "string" }, "shieldedInstanceConfig": { "description": "Shielded Instance options.", "$ref": "ShieldedInstanceConfig" }, "bootDiskKmsKey": { "description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption", "type": "string" }, "imageType": { "description": "The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "insecureKubeletReadonlyPortEnabled": { "description": "Enable or disable Kubelet read only port.", "type": "boolean" } } }, "NetworkConfig": { "id": "NetworkConfig", "description": "NetworkConfig reports the relative names of network & subnetwork.", "type": "object", "properties": { "network": { "description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "type": "string" }, "subnetwork": { "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", "type": "string" }, "enableIntraNodeVisibility": { "description": "Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.", "type": "boolean" }, "defaultSnatStatus": { "description": "Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic.", "$ref": "DefaultSnatStatus" }, "enableL4ilbSubsetting": { "description": "Whether L4ILB Subsetting is enabled for this cluster.", "type": "boolean" }, "datapathProvider": { "description": "The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.", "type": "string", "enumDescriptions": [ "Default value.", "Use the IPTables implementation based on kube-proxy.", "Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more." ], "enum": [ "DATAPATH_PROVIDER_UNSPECIFIED", "LEGACY_DATAPATH", "ADVANCED_DATAPATH" ] }, "privateIpv6GoogleAccess": { "description": "The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)", "type": "string", "enumDescriptions": [ "Default value. Same as DISABLED", "No private access to or from Google Services", "Enables private IPv6 access to Google Services from GKE", "Enables private IPv6 access to and from Google Services" ], "enum": [ "PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED", "PRIVATE_IPV6_GOOGLE_ACCESS_DISABLED", "PRIVATE_IPV6_GOOGLE_ACCESS_TO_GOOGLE", "PRIVATE_IPV6_GOOGLE_ACCESS_BIDIRECTIONAL" ] }, "dnsConfig": { "description": "DNSConfig contains clusterDNS config for this cluster.", "$ref": "DNSConfig" }, "serviceExternalIpsConfig": { "description": "ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.", "$ref": "ServiceExternalIPsConfig" }, "gatewayApiConfig": { "description": "GatewayAPIConfig contains the desired config of Gateway API on this cluster.", "$ref": "GatewayAPIConfig" }, "enableMultiNetworking": { "description": "Whether multi-networking is enabled for this cluster.", "type": "boolean" }, "networkPerformanceConfig": { "description": "Network bandwidth tier configuration.", "$ref": "ClusterNetworkPerformanceConfig" }, "enableFqdnNetworkPolicy": { "description": "Whether FQDN Network Policy is enabled on this cluster.", "type": "boolean" }, "inTransitEncryptionConfig": { "description": "Specify the details of in-transit encryption.", "type": "string", "enumDescriptions": [ "Unspecified, will be inferred as default - IN_TRANSIT_ENCRYPTION_UNSPECIFIED.", "In-transit encryption is disabled.", "Data in-transit is encrypted using inter-node transparent encryption." ], "enum": [ "IN_TRANSIT_ENCRYPTION_CONFIG_UNSPECIFIED", "IN_TRANSIT_ENCRYPTION_DISABLED", "IN_TRANSIT_ENCRYPTION_INTER_NODE_TRANSPARENT" ] }, "enableCiliumClusterwideNetworkPolicy": { "description": "Whether CiliumClusterWideNetworkPolicy is enabled on this cluster.", "type": "boolean" } } }, "DefaultSnatStatus": { "id": "DefaultSnatStatus", "description": "DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.", "type": "object", "properties": { "disabled": { "description": "Disables cluster default sNAT rules.", "type": "boolean" } } }, "DNSConfig": { "id": "DNSConfig", "description": "DNSConfig contains the desired set of options for configuring clusterDNS.", "type": "object", "properties": { "clusterDns": { "description": "cluster_dns indicates which in-cluster DNS provider should be used.", "type": "string", "enumDescriptions": [ "Default value", "Use GKE default DNS provider(kube-dns) for DNS resolution.", "Use CloudDNS for DNS resolution.", "Use KubeDNS for DNS resolution." ], "enum": [ "PROVIDER_UNSPECIFIED", "PLATFORM_DEFAULT", "CLOUD_DNS", "KUBE_DNS" ] }, "clusterDnsScope": { "description": "cluster_dns_scope indicates the scope of access to cluster DNS records.", "type": "string", "enumDescriptions": [ "Default value, will be inferred as cluster scope.", "DNS records are accessible from within the cluster.", "DNS records are accessible from within the VPC." ], "enum": [ "DNS_SCOPE_UNSPECIFIED", "CLUSTER_SCOPE", "VPC_SCOPE" ] }, "clusterDnsDomain": { "description": "cluster_dns_domain is the suffix used for all cluster service records.", "type": "string" }, "additiveVpcScopeDnsDomain": { "description": "Optional. The domain used in Additive VPC scope.", "type": "string" } } }, "ServiceExternalIPsConfig": { "id": "ServiceExternalIPsConfig", "description": "Config to block services with externalIPs field.", "type": "object", "properties": { "enabled": { "description": "Whether Services with ExternalIPs field are allowed or not.", "type": "boolean" } } }, "GatewayAPIConfig": { "id": "GatewayAPIConfig", "description": "GatewayAPIConfig contains the desired config of Gateway API on this cluster.", "type": "object", "properties": { "channel": { "description": "The Gateway API release channel to use for Gateway API.", "type": "string", "enumDescriptions": [ "Default value.", "Gateway API support is disabled", "Deprecated: use CHANNEL_STANDARD instead. Gateway API support is enabled, experimental CRDs are installed", "Gateway API support is enabled, standard CRDs are installed" ], "enumDeprecated": [ false, false, true, false ], "enum": [ "CHANNEL_UNSPECIFIED", "CHANNEL_DISABLED", "CHANNEL_EXPERIMENTAL", "CHANNEL_STANDARD" ] } } }, "ClusterNetworkPerformanceConfig": { "id": "ClusterNetworkPerformanceConfig", "description": "Configuration of all network bandwidth tiers", "type": "object", "properties": { "totalEgressBandwidthTier": { "description": "Specifies the total network bandwidth tier for the NodePool.", "type": "string", "enumDescriptions": [ "Default value", "Higher bandwidth, actual values based on VM size." ], "enum": [ "TIER_UNSPECIFIED", "TIER_1" ] } } }, "ResourceUsageExportConfig": { "id": "ResourceUsageExportConfig", "description": "Configuration for exporting cluster resource usages.", "type": "object", "properties": { "bigqueryDestination": { "description": "Configuration to use BigQuery as usage export destination.", "$ref": "BigQueryDestination" }, "enableNetworkEgressMetering": { "description": "Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.", "type": "boolean" }, "consumptionMeteringConfig": { "description": "Configuration to enable resource consumption metering.", "$ref": "ConsumptionMeteringConfig" } } }, "BigQueryDestination": { "id": "BigQueryDestination", "description": "Parameters for using BigQuery as the destination of resource usage export.", "type": "object", "properties": { "datasetId": { "description": "The ID of a BigQuery Dataset.", "type": "string" } } }, "ConsumptionMeteringConfig": { "id": "ConsumptionMeteringConfig", "description": "Parameters for controlling consumption metering.", "type": "object", "properties": { "enabled": { "description": "Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.", "type": "boolean" } } }, "AuthenticatorGroupsConfig": { "id": "AuthenticatorGroupsConfig", "description": "Configuration for returning group information from authenticators.", "type": "object", "properties": { "enabled": { "description": "Whether this cluster should return group membership lookups during authentication using a group of security groups.", "type": "boolean" }, "securityGroup": { "description": "The name of the security group-of-groups to be used. Only relevant if enabled = true.", "type": "string" } } }, "PrivateClusterConfig": { "id": "PrivateClusterConfig", "description": "Configuration options for private clusters.", "type": "object", "properties": { "enablePrivateNodes": { "description": "Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.", "type": "boolean" }, "enablePrivateEndpoint": { "description": "Whether the master's internal IP address is used as the cluster endpoint.", "type": "boolean" }, "masterIpv4CidrBlock": { "description": "The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.", "type": "string" }, "privateEndpoint": { "description": "Output only. The internal IP address of this cluster's master endpoint.", "type": "string" }, "publicEndpoint": { "description": "Output only. The external IP address of this cluster's master endpoint.", "type": "string" }, "peeringName": { "description": "Output only. The peering name in the customer VPC used by this cluster.", "type": "string" }, "masterGlobalAccessConfig": { "description": "Controls master global access settings.", "$ref": "PrivateClusterMasterGlobalAccessConfig" }, "privateEndpointSubnetwork": { "description": "Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format.", "type": "string" } } }, "PrivateClusterMasterGlobalAccessConfig": { "id": "PrivateClusterMasterGlobalAccessConfig", "description": "Configuration for controlling master global access settings.", "type": "object", "properties": { "enabled": { "description": "Whenever master is accessible globally or not.", "type": "boolean" } } }, "VerticalPodAutoscaling": { "id": "VerticalPodAutoscaling", "description": "VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.", "type": "object", "properties": { "enabled": { "description": "Enables vertical pod autoscaling.", "type": "boolean" } } }, "ShieldedNodes": { "id": "ShieldedNodes", "description": "Configuration of Shielded Nodes feature.", "type": "object", "properties": { "enabled": { "description": "Whether Shielded Nodes features are enabled on all nodes in this cluster.", "type": "boolean" } } }, "ReleaseChannel": { "id": "ReleaseChannel", "description": "ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled.", "type": "object", "properties": { "channel": { "description": "channel specifies which release channel the cluster is subscribed to.", "type": "string", "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", "Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." ], "enum": [ "UNSPECIFIED", "RAPID", "REGULAR", "STABLE" ] } } }, "WorkloadIdentityConfig": { "id": "WorkloadIdentityConfig", "description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.", "type": "object", "properties": { "identityNamespace": { "description": "IAM Identity Namespace to attach all Kubernetes Service Accounts to.", "deprecated": true, "type": "string" }, "workloadPool": { "description": "The workload pool to attach all Kubernetes service accounts to.", "type": "string" }, "identityProvider": { "description": "identity provider is the third party identity provider.", "type": "string" } } }, "WorkloadCertificates": { "id": "WorkloadCertificates", "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods.", "type": "object", "properties": { "enableCertificates": { "description": "enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty).", "type": "boolean" } } }, "MeshCertificates": { "id": "MeshCertificates", "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods.", "type": "object", "properties": { "enableCertificates": { "description": "enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty).", "type": "boolean" } } }, "WorkloadALTSConfig": { "id": "WorkloadALTSConfig", "description": "Configuration for direct-path (via ALTS) with workload identity.", "type": "object", "properties": { "enableAlts": { "description": "enable_alts controls whether the alts handshaker should be enabled or not for direct-path. Requires Workload Identity (workload_pool must be non-empty).", "type": "boolean" } } }, "CostManagementConfig": { "id": "CostManagementConfig", "description": "Configuration for fine-grained cost management feature.", "type": "object", "properties": { "enabled": { "description": "Whether the feature is enabled or not.", "type": "boolean" } } }, "ClusterTelemetry": { "id": "ClusterTelemetry", "description": "Telemetry integration for the cluster.", "type": "object", "properties": { "type": { "description": "Type of the integration.", "type": "string", "enumDescriptions": [ "Not set.", "Monitoring integration is disabled.", "Monitoring integration is enabled.", "Only system components are monitored and logged." ], "enum": [ "UNSPECIFIED", "DISABLED", "ENABLED", "SYSTEM_ONLY" ] } } }, "TpuConfig": { "id": "TpuConfig", "description": "Configuration for Cloud TPU.", "type": "object", "properties": { "enabled": { "description": "Whether Cloud TPU integration is enabled or not.", "type": "boolean" }, "useServiceNetworking": { "description": "Whether to use service networking for Cloud TPU or not.", "type": "boolean" }, "ipv4CidrBlock": { "description": "IPv4 CIDR block reserved for Cloud TPU in the VPC.", "type": "string" } } }, "NotificationConfig": { "id": "NotificationConfig", "description": "NotificationConfig is the configuration of notifications.", "type": "object", "properties": { "pubsub": { "description": "Notification config for Pub/Sub.", "$ref": "PubSub" } } }, "PubSub": { "id": "PubSub", "description": "Pub/Sub specific notification config.", "type": "object", "properties": { "enabled": { "description": "Enable notifications for Pub/Sub.", "type": "boolean" }, "topic": { "description": "The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.", "type": "string" }, "filter": { "description": "Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent", "$ref": "Filter" } } }, "Filter": { "id": "Filter", "description": "Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent", "type": "object", "properties": { "eventType": { "description": "Event types to allowlist.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Not set, will be ignored.", "Corresponds with UpgradeAvailableEvent.", "Corresponds with UpgradeEvent.", "Corresponds with SecurityBulletinEvent." ], "enum": [ "EVENT_TYPE_UNSPECIFIED", "UPGRADE_AVAILABLE_EVENT", "UPGRADE_EVENT", "SECURITY_BULLETIN_EVENT" ] } } } }, "IdentityServiceConfig": { "id": "IdentityServiceConfig", "description": "IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API", "type": "object", "properties": { "enabled": { "description": "Whether to enable the Identity Service component", "type": "boolean" } } }, "DatabaseEncryption": { "id": "DatabaseEncryption", "description": "Configuration of etcd encryption.", "type": "object", "properties": { "keyName": { "description": "Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key", "type": "string" }, "state": { "description": "The desired state of etcd encryption.", "type": "string", "enumDescriptions": [ "Should never be set", "Secrets in etcd are encrypted.", "Secrets in etcd are stored in plain text (at etcd level) - this is unrelated to Compute Engine level full disk encryption." ], "enum": [ "UNKNOWN", "ENCRYPTED", "DECRYPTED" ] }, "currentState": { "description": "Output only. The current state of etcd encryption.", "readOnly": true, "type": "string", "enumDescriptions": [ "Should never be set", "Secrets in etcd are encrypted.", "Secrets in etcd are stored in plain text (at etcd level) - this is unrelated to Compute Engine level full disk encryption.", "Encryption (or re-encryption with a different CloudKMS key) of Secrets is in progress.", "Encryption (or re-encryption with a different CloudKMS key) of Secrets in etcd encountered an error.", "De-crypting Secrets to plain text in etcd is in progress.", "De-crypting Secrets to plain text in etcd encountered an error." ], "enum": [ "CURRENT_STATE_UNSPECIFIED", "CURRENT_STATE_ENCRYPTED", "CURRENT_STATE_DECRYPTED", "CURRENT_STATE_ENCRYPTION_PENDING", "CURRENT_STATE_ENCRYPTION_ERROR", "CURRENT_STATE_DECRYPTION_PENDING", "CURRENT_STATE_DECRYPTION_ERROR" ] }, "decryptionKeys": { "description": "Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "lastOperationErrors": { "description": "Output only. Records errors seen during DatabaseEncryption update operations.", "readOnly": true, "type": "array", "items": { "$ref": "OperationError" } } } }, "OperationError": { "id": "OperationError", "description": "OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.", "type": "object", "properties": { "keyName": { "description": "CloudKMS key resource that had the error.", "type": "string" }, "errorMessage": { "description": "Description of the error seen during the operation.", "type": "string" }, "timestamp": { "description": "Time when the CloudKMS error was seen.", "type": "string", "format": "google-datetime" } } }, "Master": { "id": "Master", "description": "Master is the configuration for components on master.", "type": "object", "properties": {} }, "Autopilot": { "id": "Autopilot", "description": "Autopilot is the configuration for Autopilot settings on the cluster.", "type": "object", "properties": { "enabled": { "description": "Enable Autopilot", "type": "boolean" }, "workloadPolicyConfig": { "description": "Workload policy configuration for Autopilot.", "$ref": "WorkloadPolicyConfig" }, "conversionStatus": { "description": "Output only. ConversionStatus shows conversion status.", "readOnly": true, "$ref": "AutopilotConversionStatus" } } }, "WorkloadPolicyConfig": { "id": "WorkloadPolicyConfig", "description": "WorkloadPolicyConfig is the configuration of workload policy for autopilot clusters.", "type": "object", "properties": { "allowNetAdmin": { "description": "If true, workloads can use NET_ADMIN capability.", "type": "boolean" } } }, "AutopilotConversionStatus": { "id": "AutopilotConversionStatus", "description": "AutopilotConversionStatus represents conversion status.", "type": "object", "properties": { "state": { "description": "Output only. The current state of the conversion.", "readOnly": true, "type": "string", "enumDescriptions": [ "STATE_UNSPECIFIED indicates the state is unspecified.", "DONE indicates the conversion has been completed. Old node pools will continue being deleted in the background." ], "enum": [ "STATE_UNSPECIFIED", "DONE" ] } } }, "ParentProductConfig": { "id": "ParentProductConfig", "description": "ParentProductConfig is the configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of a GKE cluster and take the ownership of the cluster.", "type": "object", "properties": { "productName": { "description": "Name of the parent product associated with the cluster.", "type": "string" }, "labels": { "description": "Labels contain the configuration of the parent product.", "type": "object", "additionalProperties": { "type": "string" } } } }, "NodePoolDefaults": { "id": "NodePoolDefaults", "description": "Subset of Nodepool message that has defaults.", "type": "object", "properties": { "nodeConfigDefaults": { "description": "Subset of NodeConfig message that has defaults.", "$ref": "NodeConfigDefaults" } } }, "NodeConfigDefaults": { "id": "NodeConfigDefaults", "description": "Subset of NodeConfig message that has defaults.", "type": "object", "properties": { "gcfsConfig": { "description": "GCFS (Google Container File System, also known as Riptide) options.", "$ref": "GcfsConfig" }, "loggingConfig": { "description": "Logging configuration for node pools.", "$ref": "NodePoolLoggingConfig" }, "containerdConfig": { "description": "Parameters for containerd customization.", "$ref": "ContainerdConfig" }, "hostMaintenancePolicy": { "description": "HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.", "$ref": "HostMaintenancePolicy" }, "nodeKubeletConfig": { "description": "NodeKubeletConfig controls the defaults for new node-pools. Currently only `insecure_kubelet_readonly_port_enabled` can be set here.", "$ref": "NodeKubeletConfig" } } }, "LoggingConfig": { "id": "LoggingConfig", "description": "LoggingConfig is cluster logging configuration.", "type": "object", "properties": { "componentConfig": { "description": "Logging components configuration", "$ref": "LoggingComponentConfig" } } }, "LoggingComponentConfig": { "id": "LoggingComponentConfig", "description": "LoggingComponentConfig is cluster logging component configuration.", "type": "object", "properties": { "enableComponents": { "description": "Select components to collect logs. An empty set would disable all logging.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Default value. This shouldn't be used.", "system components", "workloads", "kube-apiserver", "kube-scheduler", "kube-controller-manager" ], "enum": [ "COMPONENT_UNSPECIFIED", "SYSTEM_COMPONENTS", "WORKLOADS", "APISERVER", "SCHEDULER", "CONTROLLER_MANAGER" ] } } } }, "MonitoringConfig": { "id": "MonitoringConfig", "description": "MonitoringConfig is cluster monitoring configuration.", "type": "object", "properties": { "componentConfig": { "description": "Monitoring components configuration", "$ref": "MonitoringComponentConfig" }, "managedPrometheusConfig": { "description": "Enable Google Cloud Managed Service for Prometheus in the cluster.", "$ref": "ManagedPrometheusConfig" }, "advancedDatapathObservabilityConfig": { "description": "Configuration of Advanced Datapath Observability features.", "$ref": "AdvancedDatapathObservabilityConfig" } } }, "MonitoringComponentConfig": { "id": "MonitoringComponentConfig", "description": "MonitoringComponentConfig is cluster monitoring component configuration.", "type": "object", "properties": { "enableComponents": { "description": "Select components to collect metrics. An empty set would disable all monitoring.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Default value. This shouldn't be used.", "system components", "Deprecated: Use Google Cloud Managed Service for Prometheus.", "kube-apiserver", "kube-scheduler", "kube-controller-manager", "Storage", "Horizontal Pod Autoscaling", "Pod", "DaemonSet", "Deployment", "Statefulset", "CADVISOR", "KUBELET", "NVIDIA Data Center GPU Manager (DCGM)" ], "enumDeprecated": [ false, false, true, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "COMPONENT_UNSPECIFIED", "SYSTEM_COMPONENTS", "WORKLOADS", "APISERVER", "SCHEDULER", "CONTROLLER_MANAGER", "STORAGE", "HPA", "POD", "DAEMONSET", "DEPLOYMENT", "STATEFULSET", "CADVISOR", "KUBELET", "DCGM" ] } } } }, "ManagedPrometheusConfig": { "id": "ManagedPrometheusConfig", "description": "ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.", "type": "object", "properties": { "enabled": { "description": "Enable Managed Collection.", "type": "boolean" } } }, "AdvancedDatapathObservabilityConfig": { "id": "AdvancedDatapathObservabilityConfig", "description": "AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.", "type": "object", "properties": { "enableMetrics": { "description": "Expose flow metrics on nodes", "type": "boolean" }, "relayMode": { "description": "Method used to make Relay available", "type": "string", "enumDescriptions": [ "Default value. This shouldn't be used.", "disabled", "exposed via internal load balancer", "exposed via external load balancer" ], "enum": [ "RELAY_MODE_UNSPECIFIED", "DISABLED", "INTERNAL_VPC_LB", "EXTERNAL_LB" ] }, "enableRelay": { "description": "Enable Relay component", "type": "boolean" } } }, "NodePoolAutoConfig": { "id": "NodePoolAutoConfig", "description": "node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters", "type": "object", "properties": { "networkTags": { "description": "The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035.", "$ref": "NetworkTags" }, "resourceManagerTags": { "description": "Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.", "$ref": "ResourceManagerTags" }, "nodeKubeletConfig": { "description": "NodeKubeletConfig controls the defaults for autoprovisioned node-pools. Currently only `insecure_kubelet_readonly_port_enabled` can be set here.", "$ref": "NodeKubeletConfig" } } }, "NetworkTags": { "id": "NetworkTags", "description": "Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)).", "type": "object", "properties": { "tags": { "description": "List of network tags.", "type": "array", "items": { "type": "string" } } } }, "ProtectConfig": { "id": "ProtectConfig", "description": "ProtectConfig defines the flags needed to enable/disable features for the Protect API.", "type": "object", "properties": { "workloadConfig": { "description": "WorkloadConfig defines which actions are enabled for a cluster's workload configurations.", "$ref": "WorkloadConfig" }, "workloadVulnerabilityMode": { "description": "Sets which mode to use for Protect workload vulnerability scanning feature.", "type": "string", "enumDescriptions": [ "Default value not specified.", "Disables Workload Vulnerability Scanning feature on the cluster.", "Applies basic vulnerability scanning settings for cluster workloads." ], "enum": [ "WORKLOAD_VULNERABILITY_MODE_UNSPECIFIED", "DISABLED", "BASIC" ] } } }, "WorkloadConfig": { "id": "WorkloadConfig", "description": "WorkloadConfig defines the flags to enable or disable the workload configurations for the cluster.", "type": "object", "properties": { "auditMode": { "description": "Sets which mode of auditing should be used for the cluster's workloads.", "type": "string", "enumDescriptions": [ "Default value meaning that no mode has been specified.", "This disables Workload Configuration auditing on the cluster, meaning that nothing is surfaced.", "Applies the default set of policy auditing to a cluster's workloads.", "Surfaces configurations that are not in line with the Pod Security Standard Baseline policy.", "Surfaces configurations that are not in line with the Pod Security Standard Restricted policy." ], "enumDeprecated": [ false, false, false, true, true ], "enum": [ "MODE_UNSPECIFIED", "DISABLED", "BASIC", "BASELINE", "RESTRICTED" ] } } }, "Fleet": { "id": "Fleet", "description": "Fleet is the fleet configuration for the cluster.", "type": "object", "properties": { "project": { "description": "The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered.", "type": "string" }, "membership": { "description": "[Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", "type": "string" }, "preRegistered": { "description": "[Output only] Whether the cluster has been registered through the fleet API.", "type": "boolean" } } }, "SecurityPostureConfig": { "id": "SecurityPostureConfig", "description": "SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API.", "type": "object", "properties": { "mode": { "description": "Sets which mode to use for Security Posture features.", "type": "string", "enumDescriptions": [ "Default value not specified.", "Disables Security Posture features on the cluster.", "Applies Security Posture features on the cluster.", "Applies the Security Posture off cluster Enterprise level features." ], "enum": [ "MODE_UNSPECIFIED", "DISABLED", "BASIC", "ENTERPRISE" ] }, "vulnerabilityMode": { "description": "Sets which mode to use for vulnerability scanning.", "type": "string", "enumDescriptions": [ "Default value not specified.", "Disables vulnerability scanning on the cluster.", "Applies basic vulnerability scanning on the cluster.", "Applies the Security Posture's vulnerability on cluster Enterprise level features." ], "enum": [ "VULNERABILITY_MODE_UNSPECIFIED", "VULNERABILITY_DISABLED", "VULNERABILITY_BASIC", "VULNERABILITY_ENTERPRISE" ] } } }, "EnterpriseConfig": { "id": "EnterpriseConfig", "description": "EnterpriseConfig is the cluster enterprise configuration.", "type": "object", "properties": { "clusterTier": { "description": "Output only. [Output only] cluster_tier specifies the premium tier of the cluster.", "readOnly": true, "type": "string", "enumDescriptions": [ "CLUSTER_TIER_UNSPECIFIED is when cluster_tier is not set.", "STANDARD indicates a standard GKE cluster.", "ENTERPRISE indicates a GKE Enterprise cluster." ], "enum": [ "CLUSTER_TIER_UNSPECIFIED", "STANDARD", "ENTERPRISE" ] } } }, "SecretManagerConfig": { "id": "SecretManagerConfig", "description": "SecretManagerConfig is config for secret manager enablement.", "type": "object", "properties": { "enabled": { "description": "Whether the cluster is configured to use secret manager CSI component.", "type": "boolean" } } }, "CompliancePostureConfig": { "id": "CompliancePostureConfig", "description": "CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.", "type": "object", "properties": { "mode": { "description": "Defines the enablement mode for Compliance Posture.", "type": "string", "enumDescriptions": [ "Default value not specified.", "Disables Compliance Posture features on the cluster.", "Enables Compliance Posture features on the cluster." ], "enum": [ "MODE_UNSPECIFIED", "DISABLED", "ENABLED" ] }, "complianceStandards": { "description": "List of enabled compliance standards.", "type": "array", "items": { "$ref": "ComplianceStandard" } } } }, "ComplianceStandard": { "id": "ComplianceStandard", "description": "Defines the details of a compliance standard.", "type": "object", "properties": { "standard": { "description": "Name of the compliance standard.", "type": "string" } } }, "CreateClusterRequest": { "id": "CreateClusterRequest", "description": "CreateClusterRequest creates a cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "deprecated": true, "type": "string" }, "cluster": { "description": "Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters)", "$ref": "Cluster" }, "parent": { "description": "The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.", "type": "string" } } }, "Operation": { "id": "Operation", "description": "This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.", "type": "object", "properties": { "name": { "description": "The server-assigned ID for the operation.", "type": "string" }, "zone": { "description": "The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", "deprecated": true, "type": "string" }, "operationType": { "description": "The operation type.", "type": "string", "enumDescriptions": [ "Not set.", "The cluster is being created. The cluster should be assumed to be unusable until the operation finishes. In the event of the operation failing, the cluster will enter the ERROR state and eventually be deleted.", "The cluster is being deleted. The cluster should be assumed to be unusable as soon as this operation starts. In the event of the operation failing, the cluster will enter the ERROR state and the deletion will be automatically retried until completed.", "The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).", "A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.", "A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.", "A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.", "The node pool is being deleted. The node pool should be assumed to be unusable as soon as this operation starts.", "The node pool's manamagent field is being updated. These operations only update metadata and may be concurrent with most other operations.", "A problem has been detected with nodes and [they are being repaired](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.", "Unused. Automatic node upgrade uses UPGRADE_NODES.", "Unused. Updating labels uses UPDATE_CLUSTER.", "Unused. Updating master auth uses UPDATE_CLUSTER.", "The node pool is being resized. With the exception of resizing to or from size zero, the node pool is generally usable during this operation.", "Unused. Updating network policy uses UPDATE_CLUSTER.", "Unused. Updating maintenance policy uses UPDATE_CLUSTER.", "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], "enumDeprecated": [ false, false, false, false, false, false, false, false, false, false, false, true, true, true, false, true, true, false, false ], "enum": [ "TYPE_UNSPECIFIED", "CREATE_CLUSTER", "DELETE_CLUSTER", "UPGRADE_MASTER", "UPGRADE_NODES", "REPAIR_CLUSTER", "UPDATE_CLUSTER", "CREATE_NODE_POOL", "DELETE_NODE_POOL", "SET_NODE_POOL_MANAGEMENT", "AUTO_REPAIR_NODES", "AUTO_UPGRADE_NODES", "SET_LABELS", "SET_MASTER_AUTH", "SET_NODE_POOL_SIZE", "SET_NETWORK_POLICY", "SET_MAINTENANCE_POLICY", "RESIZE_CLUSTER", "FLEET_FEATURE_UPGRADE" ] }, "status": { "description": "The current status of the operation.", "type": "string", "enumDescriptions": [ "Not set.", "The operation has been created.", "The operation is currently running.", "The operation is done, either cancelled or completed.", "The operation is aborting." ], "enum": [ "STATUS_UNSPECIFIED", "PENDING", "RUNNING", "DONE", "ABORTING" ] }, "detail": { "description": "Detailed operation progress, if available.", "type": "string" }, "statusMessage": { "description": "Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.", "readOnly": true, "deprecated": true, "type": "string" }, "selfLink": { "description": "Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", "type": "string" }, "targetLink": { "description": "Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", "type": "string" }, "location": { "description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", "type": "string" }, "startTime": { "description": "[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "endTime": { "description": "[Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "progress": { "description": "Output only. [Output only] Progress information for an operation.", "readOnly": true, "$ref": "OperationProgress" }, "clusterConditions": { "description": "Which conditions caused the current cluster state. Deprecated. Use field error instead.", "deprecated": true, "type": "array", "items": { "$ref": "StatusCondition" } }, "nodepoolConditions": { "description": "Which conditions caused the current node pool state. Deprecated. Use field error instead.", "deprecated": true, "type": "array", "items": { "$ref": "StatusCondition" } }, "error": { "description": "The error result of the operation in case of failure.", "$ref": "Status" } } }, "OperationProgress": { "id": "OperationProgress", "description": "Information about operation (or operation stage) progress.", "type": "object", "properties": { "name": { "description": "A non-parameterized string describing an operation stage. Unset for single-stage operations.", "type": "string" }, "status": { "description": "Status of an operation stage. Unset for single-stage operations.", "type": "string", "enumDescriptions": [ "Not set.", "The operation has been created.", "The operation is currently running.", "The operation is done, either cancelled or completed.", "The operation is aborting." ], "enum": [ "STATUS_UNSPECIFIED", "PENDING", "RUNNING", "DONE", "ABORTING" ] }, "metrics": { "description": "Progress metric bundle, for example: metrics: [{name: \"nodes done\", int_value: 15}, {name: \"nodes total\", int_value: 32}] or metrics: [{name: \"progress\", double_value: 0.56}, {name: \"progress scale\", double_value: 1.0}]", "type": "array", "items": { "$ref": "Metric" } }, "stages": { "description": "Substages of an operation or a stage.", "type": "array", "items": { "$ref": "OperationProgress" } } } }, "Metric": { "id": "Metric", "description": "Progress metric is (string, int|float|string) pair.", "type": "object", "properties": { "name": { "description": "Required. Metric name, e.g., \"nodes total\", \"percent done\".", "type": "string" }, "intValue": { "description": "For metrics with integer value.", "type": "string", "format": "int64" }, "doubleValue": { "description": "For metrics with floating point value.", "type": "number", "format": "double" }, "stringValue": { "description": "For metrics with custom values (ratios, visual progress, etc.).", "type": "string" } } }, "Status": { "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "UpdateClusterRequest": { "id": "UpdateClusterRequest", "description": "UpdateClusterRequest updates the settings of a cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "update": { "description": "Required. A description of the update.", "$ref": "ClusterUpdate" }, "name": { "description": "The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "ClusterUpdate": { "id": "ClusterUpdate", "description": "ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.", "type": "object", "properties": { "desiredNodeVersion": { "description": "The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the Kubernetes master version", "type": "string" }, "desiredMonitoringService": { "description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, "desiredAddonsConfig": { "description": "Configurations for the various addons available to run in the cluster.", "$ref": "AddonsConfig" }, "desiredNodePoolId": { "description": "The node pool to be upgraded. This field is mandatory if \"desired_node_version\", \"desired_image_family\", \"desired_node_pool_autoscaling\", or \"desired_workload_metadata_config\" is specified and there is more than one node pool on the cluster.", "type": "string" }, "desiredImageType": { "description": "The desired image type for the node pool. NOTE: Set the \"desired_node_pool\" field as well.", "type": "string" }, "desiredNodePoolAutoscaling": { "description": "Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.", "$ref": "NodePoolAutoscaling" }, "desiredLocations": { "description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.", "type": "array", "items": { "type": "string" } }, "desiredMasterAuthorizedNetworksConfig": { "description": "The desired configuration options for master authorized networks feature.", "$ref": "MasterAuthorizedNetworksConfig" }, "desiredPodSecurityPolicyConfig": { "description": "The desired configuration options for the PodSecurityPolicy feature.", "$ref": "PodSecurityPolicyConfig" }, "desiredClusterAutoscaling": { "description": "Cluster-level autoscaling configuration.", "$ref": "ClusterAutoscaling" }, "desiredBinaryAuthorization": { "description": "The desired configuration options for the Binary Authorization feature.", "$ref": "BinaryAuthorization" }, "desiredLoggingService": { "description": "The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.", "type": "string" }, "desiredResourceUsageExportConfig": { "description": "The desired configuration for exporting resource usage.", "$ref": "ResourceUsageExportConfig" }, "desiredVerticalPodAutoscaling": { "description": "Cluster-level Vertical Pod Autoscaling configuration.", "$ref": "VerticalPodAutoscaling" }, "desiredPrivateClusterConfig": { "description": "The desired private cluster configuration. master_global_access_config is the only field that can be changed via this field. See also ClusterUpdate.desired_enable_private_endpoint for modifying other fields within PrivateClusterConfig.", "$ref": "PrivateClusterConfig" }, "desiredIntraNodeVisibilityConfig": { "description": "The desired config of Intra-node visibility.", "$ref": "IntraNodeVisibilityConfig" }, "desiredDefaultSnatStatus": { "description": "The desired status of whether to disable default sNAT for this cluster.", "$ref": "DefaultSnatStatus" }, "desiredClusterTelemetry": { "description": "The desired telemetry integration for the cluster.", "$ref": "ClusterTelemetry" }, "desiredReleaseChannel": { "description": "The desired release channel configuration.", "$ref": "ReleaseChannel" }, "privateClusterConfig": { "description": "The desired private cluster configuration. Has no effect. Use desired_private_cluster_config instead.", "deprecated": true, "$ref": "PrivateClusterConfig" }, "desiredTpuConfig": { "description": "The desired Cloud TPU configuration.", "$ref": "TpuConfig" }, "desiredL4ilbSubsettingConfig": { "description": "The desired L4 Internal Load Balancer Subsetting configuration.", "$ref": "ILBSubsettingConfig" }, "desiredDatapathProvider": { "description": "The desired datapath provider for the cluster.", "type": "string", "enumDescriptions": [ "Default value.", "Use the IPTables implementation based on kube-proxy.", "Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more." ], "enum": [ "DATAPATH_PROVIDER_UNSPECIFIED", "LEGACY_DATAPATH", "ADVANCED_DATAPATH" ] }, "desiredPrivateIpv6GoogleAccess": { "description": "The desired state of IPv6 connectivity to Google Services.", "type": "string", "enumDescriptions": [ "Default value. Same as DISABLED", "No private access to or from Google Services", "Enables private IPv6 access to Google Services from GKE", "Enables private IPv6 access to and from Google Services" ], "enum": [ "PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED", "PRIVATE_IPV6_GOOGLE_ACCESS_DISABLED", "PRIVATE_IPV6_GOOGLE_ACCESS_TO_GOOGLE", "PRIVATE_IPV6_GOOGLE_ACCESS_BIDIRECTIONAL" ] }, "desiredNotificationConfig": { "description": "The desired notification configuration.", "$ref": "NotificationConfig" }, "desiredMasterVersion": { "description": "The Kubernetes version to change the master to. The only valid value is the latest supported version. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the default Kubernetes version", "type": "string" }, "desiredParentProductConfig": { "description": "The desired parent product config for the cluster.", "$ref": "ParentProductConfig" }, "desiredGcfsConfig": { "description": "The desired GCFS config for the cluster.", "$ref": "GcfsConfig" }, "desiredDatabaseEncryption": { "description": "Configuration of etcd encryption.", "$ref": "DatabaseEncryption" }, "desiredWorkloadIdentityConfig": { "description": "Configuration for Workload Identity.", "$ref": "WorkloadIdentityConfig" }, "desiredWorkloadCertificates": { "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods.", "$ref": "WorkloadCertificates" }, "desiredMeshCertificates": { "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods.", "$ref": "MeshCertificates" }, "desiredWorkloadAltsConfig": { "description": "Configuration for direct-path (via ALTS) with workload identity.", "$ref": "WorkloadALTSConfig" }, "desiredShieldedNodes": { "description": "Configuration for Shielded Nodes.", "$ref": "ShieldedNodes" }, "desiredCostManagementConfig": { "description": "The desired configuration for the fine-grained cost management feature.", "$ref": "CostManagementConfig" }, "desiredMaster": { "description": "Configuration for master components.", "$ref": "Master" }, "desiredDnsConfig": { "description": "DNSConfig contains clusterDNS config for this cluster.", "$ref": "DNSConfig" }, "desiredServiceExternalIpsConfig": { "description": "ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.", "$ref": "ServiceExternalIPsConfig" }, "desiredAuthenticatorGroupsConfig": { "description": "AuthenticatorGroupsConfig specifies the config for the cluster security groups settings.", "$ref": "AuthenticatorGroupsConfig" }, "desiredLoggingConfig": { "description": "The desired logging configuration.", "$ref": "LoggingConfig" }, "desiredMonitoringConfig": { "description": "The desired monitoring configuration.", "$ref": "MonitoringConfig" }, "desiredIdentityServiceConfig": { "description": "The desired Identity Service component configuration.", "$ref": "IdentityServiceConfig" }, "desiredEnablePrivateEndpoint": { "description": "Enable/Disable private endpoint for the cluster's master.", "type": "boolean" }, "desiredNodePoolAutoConfigNetworkTags": { "description": "The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.", "$ref": "NetworkTags" }, "desiredProtectConfig": { "description": "Deprecated: Use DesiredSecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.", "deprecated": true, "$ref": "ProtectConfig" }, "desiredGatewayApiConfig": { "description": "The desired config of Gateway API on this cluster.", "$ref": "GatewayAPIConfig" }, "etag": { "description": "The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.", "type": "string" }, "desiredNodePoolLoggingConfig": { "description": "The desired node pool logging configuration defaults for the cluster.", "$ref": "NodePoolLoggingConfig" }, "desiredFleet": { "description": "The desired fleet configuration for the cluster.", "$ref": "Fleet" }, "desiredStackType": { "description": "The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.", "type": "string", "enumDescriptions": [ "By default, the clusters will be IPV4 only", "The value used if the cluster is a IPV4 only", "The value used if the cluster is a dual stack cluster" ], "enum": [ "STACK_TYPE_UNSPECIFIED", "IPV4", "IPV4_IPV6" ] }, "additionalPodRangesConfig": { "description": "The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.", "$ref": "AdditionalPodRangesConfig" }, "removedAdditionalPodRangesConfig": { "description": "The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument.", "$ref": "AdditionalPodRangesConfig" }, "enableK8sBetaApis": { "description": "Kubernetes open source beta apis enabled on the cluster. Only beta apis", "$ref": "K8sBetaAPIConfig" }, "desiredSecurityPostureConfig": { "description": "Enable/Disable Security Posture API features for the cluster.", "$ref": "SecurityPostureConfig" }, "desiredNetworkPerformanceConfig": { "description": "The desired network performance config.", "$ref": "ClusterNetworkPerformanceConfig" }, "desiredEnableFqdnNetworkPolicy": { "description": "Enable/Disable FQDN Network Policy for the cluster.", "type": "boolean" }, "desiredAutopilotWorkloadPolicyConfig": { "description": "The desired workload policy configuration for the autopilot cluster.", "$ref": "WorkloadPolicyConfig" }, "desiredK8sBetaApis": { "description": "Beta APIs enabled for cluster.", "$ref": "K8sBetaAPIConfig" }, "desiredHostMaintenancePolicy": { "description": "HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.", "$ref": "HostMaintenancePolicy" }, "desiredContainerdConfig": { "description": "The desired containerd config for the cluster.", "$ref": "ContainerdConfig" }, "desiredEnableMultiNetworking": { "description": "Enable/Disable Multi-Networking for the cluster", "type": "boolean" }, "desiredNodePoolAutoConfigResourceManagerTags": { "description": "The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.", "$ref": "ResourceManagerTags" }, "desiredInTransitEncryptionConfig": { "description": "Specify the details of in-transit encryption. Now named inter-node transparent encryption.", "type": "string", "enumDescriptions": [ "Unspecified, will be inferred as default - IN_TRANSIT_ENCRYPTION_UNSPECIFIED.", "In-transit encryption is disabled.", "Data in-transit is encrypted using inter-node transparent encryption." ], "enum": [ "IN_TRANSIT_ENCRYPTION_CONFIG_UNSPECIFIED", "IN_TRANSIT_ENCRYPTION_DISABLED", "IN_TRANSIT_ENCRYPTION_INTER_NODE_TRANSPARENT" ] }, "desiredEnableCiliumClusterwideNetworkPolicy": { "description": "Enable/Disable Cilium Clusterwide Network Policy for the cluster.", "type": "boolean" }, "desiredSecretManagerConfig": { "description": "Enable/Disable Secret Manager Config.", "$ref": "SecretManagerConfig" }, "desiredNodeKubeletConfig": { "description": "The desired node kubelet config for the cluster.", "$ref": "NodeKubeletConfig" }, "desiredNodePoolAutoConfigKubeletConfig": { "description": "The desired node kubelet config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.", "$ref": "NodeKubeletConfig" } } }, "IntraNodeVisibilityConfig": { "id": "IntraNodeVisibilityConfig", "description": "IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.", "type": "object", "properties": { "enabled": { "description": "Enables intra node visibility for this cluster.", "type": "boolean" } } }, "ILBSubsettingConfig": { "id": "ILBSubsettingConfig", "description": "ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster.", "type": "object", "properties": { "enabled": { "description": "Enables l4 ILB subsetting for this cluster", "type": "boolean" } } }, "UpdateNodePoolRequest": { "id": "UpdateNodePoolRequest", "description": "SetNodePoolVersionRequest updates the version of a node pool.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "nodeVersion": { "description": "Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the Kubernetes master version", "type": "string" }, "imageType": { "description": "Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "locations": { "description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.", "type": "array", "items": { "type": "string" } }, "workloadMetadataConfig": { "description": "The desired workload metadata config for the node pool.", "$ref": "WorkloadMetadataConfig" }, "name": { "description": "The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "upgradeSettings": { "description": "Upgrade settings control disruption and speed of the upgrade.", "$ref": "UpgradeSettings" }, "tags": { "description": "The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags.", "$ref": "NetworkTags" }, "taints": { "description": "The desired node taints to be applied to all nodes in the node pool. If this field is not present, the taints will not be changed. Otherwise, the existing node taints will be *replaced* with the provided taints.", "$ref": "NodeTaints" }, "labels": { "description": "The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be *replaced* with the provided labels.", "$ref": "NodeLabels" }, "linuxNodeConfig": { "description": "Parameters that can be configured on Linux nodes.", "$ref": "LinuxNodeConfig" }, "kubeletConfig": { "description": "Node kubelet configs.", "$ref": "NodeKubeletConfig" }, "nodeNetworkConfig": { "description": "Node network config.", "$ref": "NodeNetworkConfig" }, "gcfsConfig": { "description": "GCFS config.", "$ref": "GcfsConfig" }, "confidentialNodes": { "description": "Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.", "$ref": "ConfidentialNodes" }, "gvnic": { "description": "Enable or disable gvnic on the node pool.", "$ref": "VirtualNIC" }, "etag": { "description": "The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.", "type": "string" }, "fastSocket": { "description": "Enable or disable NCCL fast socket for the node pool.", "$ref": "FastSocket" }, "loggingConfig": { "description": "Logging configuration.", "$ref": "NodePoolLoggingConfig" }, "resourceLabels": { "description": "The resource labels for the node pool to use to annotate any related Google Compute Engine resources.", "$ref": "ResourceLabels" }, "windowsNodeConfig": { "description": "Parameters that can be configured on Windows nodes.", "$ref": "WindowsNodeConfig" }, "accelerators": { "description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.", "type": "array", "items": { "$ref": "AcceleratorConfig" } }, "machineType": { "description": "Optional. The desired machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.", "type": "string" }, "diskType": { "description": "Optional. The desired disk type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.", "type": "string" }, "diskSizeGb": { "description": "Optional. The desired disk size for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size.", "type": "string", "format": "int64" }, "resourceManagerTags": { "description": "Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.", "$ref": "ResourceManagerTags" }, "containerdConfig": { "description": "The desired containerd config for nodes in the node pool. Initiates an upgrade operation that recreates the nodes with the new config.", "$ref": "ContainerdConfig" }, "queuedProvisioning": { "description": "Specifies the configuration of queued provisioning.", "$ref": "QueuedProvisioning" } } }, "NodeTaints": { "id": "NodeTaints", "description": "Collection of Kubernetes [node taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration).", "type": "object", "properties": { "taints": { "description": "List of node taints.", "type": "array", "items": { "$ref": "NodeTaint" } } } }, "NodeLabels": { "id": "NodeLabels", "description": "Collection of node-level [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels).", "type": "object", "properties": { "labels": { "description": "Map of node label keys and node label values.", "type": "object", "additionalProperties": { "type": "string" } } } }, "ResourceLabels": { "id": "ResourceLabels", "description": "Collection of [GCP labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels).", "type": "object", "properties": { "labels": { "description": "Map of node label keys and node label values.", "type": "object", "additionalProperties": { "type": "string" } } } }, "SetNodePoolAutoscalingRequest": { "id": "SetNodePoolAutoscalingRequest", "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "autoscaling": { "description": "Required. Autoscaling configuration for the node pool.", "$ref": "NodePoolAutoscaling" }, "name": { "description": "The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" } } }, "SetLoggingServiceRequest": { "id": "SetLoggingServiceRequest", "description": "SetLoggingServiceRequest sets the logging service of a cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "loggingService": { "description": "Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "SetMonitoringServiceRequest": { "id": "SetMonitoringServiceRequest", "description": "SetMonitoringServiceRequest sets the monitoring service of a cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "monitoringService": { "description": "Required. The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "SetAddonsConfigRequest": { "id": "SetAddonsConfigRequest", "description": "SetAddonsRequest sets the addons associated with the cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "addonsConfig": { "description": "Required. The desired configurations for the various addons available to run in the cluster.", "$ref": "AddonsConfig" }, "name": { "description": "The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "SetLocationsRequest": { "id": "SetLocationsRequest", "description": "SetLocationsRequest sets the locations of the cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "locations": { "description": "Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "UpdateMasterRequest": { "id": "UpdateMasterRequest", "description": "UpdateMasterRequest updates the master of the cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "masterVersion": { "description": "Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the default Kubernetes version", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "SetMasterAuthRequest": { "id": "SetMasterAuthRequest", "description": "SetMasterAuthRequest updates the admin password of a cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "action": { "description": "Required. The exact form of action to be taken on the master auth.", "type": "string", "enumDescriptions": [ "Operation is unknown and will error out.", "Set the password to a user generated value.", "Generate a new password and set it to that.", "Set the username. If an empty username is provided, basic authentication is disabled for the cluster. If a non-empty username is provided, basic authentication is enabled, with either a provided password or a generated one." ], "enum": [ "UNKNOWN", "SET_PASSWORD", "GENERATE_PASSWORD", "SET_USERNAME" ] }, "update": { "description": "Required. A description of the update.", "$ref": "MasterAuth" }, "name": { "description": "The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "ListOperationsResponse is the result of ListOperationsRequest.", "type": "object", "properties": { "operations": { "description": "A list of operations in the project in the specified zone.", "type": "array", "items": { "$ref": "Operation" } }, "missingZones": { "description": "If any zones are listed here, the list of operations returned may be missing the operations from those zones.", "type": "array", "items": { "type": "string" } } } }, "CancelOperationRequest": { "id": "CancelOperationRequest", "description": "CancelOperationRequest cancels a single operation.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "operationId": { "description": "Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "name": { "description": "The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`.", "type": "string" } } }, "Empty": { "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "ServerConfig": { "id": "ServerConfig", "description": "Kubernetes Engine service configuration.", "type": "object", "properties": { "defaultClusterVersion": { "description": "Version of Kubernetes the service deploys by default.", "type": "string" }, "validNodeVersions": { "description": "List of valid node upgrade target versions, in descending order.", "type": "array", "items": { "type": "string" } }, "defaultImageType": { "description": "Default image type.", "type": "string" }, "validImageTypes": { "description": "List of valid image types.", "type": "array", "items": { "type": "string" } }, "validMasterVersions": { "description": "List of valid master versions, in descending order.", "type": "array", "items": { "type": "string" } }, "channels": { "description": "List of release channel configurations.", "type": "array", "items": { "$ref": "ReleaseChannelConfig" } }, "windowsVersionMaps": { "description": "Maps of Kubernetes version and supported Windows server versions.", "type": "object", "additionalProperties": { "$ref": "WindowsVersions" } } } }, "ReleaseChannelConfig": { "id": "ReleaseChannelConfig", "description": "ReleaseChannelConfig exposes configuration for a release channel.", "type": "object", "properties": { "channel": { "description": "The release channel this configuration applies to.", "type": "string", "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", "Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." ], "enum": [ "UNSPECIFIED", "RAPID", "REGULAR", "STABLE" ] }, "defaultVersion": { "description": "The default version for newly created clusters on the channel.", "type": "string" }, "availableVersions": { "description": "Deprecated. This field has been deprecated and replaced with the valid_versions field.", "deprecated": true, "type": "array", "items": { "$ref": "AvailableVersion" } }, "validVersions": { "description": "List of valid versions for the channel.", "type": "array", "items": { "type": "string" } } } }, "AvailableVersion": { "id": "AvailableVersion", "deprecated": true, "description": "Deprecated.", "type": "object", "properties": { "version": { "description": "Kubernetes version.", "type": "string" }, "reason": { "description": "Reason for availability.", "type": "string" } } }, "WindowsVersions": { "id": "WindowsVersions", "description": "Windows server versions.", "type": "object", "properties": { "windowsVersions": { "description": "List of Windows server versions.", "type": "array", "items": { "$ref": "WindowsVersion" } } } }, "WindowsVersion": { "id": "WindowsVersion", "description": "Windows server version.", "type": "object", "properties": { "imageType": { "description": "Windows server image type", "type": "string" }, "osVersion": { "description": "Windows server build number", "type": "string" }, "supportEndDate": { "description": "Mainstream support end date", "$ref": "Date" } } }, "Date": { "id": "Date", "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "type": "object", "properties": { "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "type": "integer", "format": "int32" }, "month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "type": "integer", "format": "int32" }, "day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "type": "integer", "format": "int32" } } }, "GetOpenIDConfigResponse": { "id": "GetOpenIDConfigResponse", "description": "GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.", "type": "object", "properties": { "issuer": { "description": "OIDC Issuer.", "type": "string" }, "jwks_uri": { "description": "JSON Web Key uri.", "type": "string" }, "response_types_supported": { "description": "Supported response types.", "type": "array", "items": { "type": "string" } }, "subject_types_supported": { "description": "Supported subject types.", "type": "array", "items": { "type": "string" } }, "id_token_signing_alg_values_supported": { "description": "supported ID Token signing Algorithms.", "type": "array", "items": { "type": "string" } }, "claims_supported": { "description": "Supported claims.", "type": "array", "items": { "type": "string" } }, "grant_types": { "description": "Supported grant types.", "type": "array", "items": { "type": "string" } }, "cacheHeader": { "description": "OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header.", "$ref": "HttpCacheControlResponseHeader" } } }, "HttpCacheControlResponseHeader": { "id": "HttpCacheControlResponseHeader", "description": "RFC-2616: cache control support", "type": "object", "properties": { "directive": { "description": "14.9 request and response directives", "type": "string" }, "age": { "description": "14.6 response cache age, in seconds since the response is generated", "type": "string", "format": "int64" }, "expires": { "description": "14.21 response cache expires, in RFC 1123 date format", "type": "string" } } }, "GetJSONWebKeysResponse": { "id": "GetJSONWebKeysResponse", "description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517", "type": "object", "properties": { "keys": { "description": "The public component of the keys used by the cluster to sign token requests.", "type": "array", "items": { "$ref": "Jwk" } }, "cacheHeader": { "description": "OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header.", "$ref": "HttpCacheControlResponseHeader" } } }, "Jwk": { "id": "Jwk", "description": "Jwk is a JSON Web Key as specified in RFC 7517", "type": "object", "properties": { "kty": { "description": "Key Type.", "type": "string" }, "alg": { "description": "Algorithm.", "type": "string" }, "use": { "description": "Permitted uses for the public keys.", "type": "string" }, "kid": { "description": "Key ID.", "type": "string" }, "n": { "description": "Used for RSA keys.", "type": "string" }, "e": { "description": "Used for RSA keys.", "type": "string" }, "x": { "description": "Used for ECDSA keys.", "type": "string" }, "y": { "description": "Used for ECDSA keys.", "type": "string" }, "crv": { "description": "Used for ECDSA keys.", "type": "string" } } }, "ListNodePoolsResponse": { "id": "ListNodePoolsResponse", "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.", "type": "object", "properties": { "nodePools": { "description": "A list of node pools for a cluster.", "type": "array", "items": { "$ref": "NodePool" } } } }, "CreateNodePoolRequest": { "id": "CreateNodePoolRequest", "description": "CreateNodePoolRequest creates a node pool for a cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", "deprecated": true, "type": "string" }, "nodePool": { "description": "Required. The node pool to create.", "$ref": "NodePool" }, "parent": { "description": "The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "CompleteNodePoolUpgradeRequest": { "id": "CompleteNodePoolUpgradeRequest", "description": "CompleteNodePoolUpgradeRequest sets the name of target node pool to complete upgrade.", "type": "object", "properties": {} }, "RollbackNodePoolUpgradeRequest": { "id": "RollbackNodePoolUpgradeRequest", "description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, "respectPdb": { "description": "Option for rollback to ignore the PodDisruptionBudget. Default value is false.", "type": "boolean" } } }, "SetNodePoolManagementRequest": { "id": "SetNodePoolManagementRequest", "description": "SetNodePoolManagementRequest sets the node management properties of a node pool.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "management": { "description": "Required. NodeManagement configuration for the node pool.", "$ref": "NodeManagement" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" } } }, "SetLabelsRequest": { "id": "SetLabelsRequest", "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "resourceLabels": { "description": "Required. The labels to set for that cluster.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint.", "type": "string" }, "name": { "description": "The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "SetLegacyAbacRequest": { "id": "SetLegacyAbacRequest", "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "enabled": { "description": "Required. Whether ABAC authorization will be enabled in the cluster.", "type": "boolean" }, "name": { "description": "The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "StartIPRotationRequest": { "id": "StartIPRotationRequest", "description": "StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "name": { "description": "The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" }, "rotateCredentials": { "description": "Whether to rotate credentials during IP rotation.", "type": "boolean" } } }, "CompleteIPRotationRequest": { "id": "CompleteIPRotationRequest", "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "name": { "description": "The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "SetNodePoolSizeRequest": { "id": "SetNodePoolSizeRequest", "description": "SetNodePoolSizeRequest sets the size of a node pool.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "nodeCount": { "description": "Required. The desired node count for the pool.", "type": "integer", "format": "int32" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" } } }, "SetNetworkPolicyRequest": { "id": "SetNetworkPolicyRequest", "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.", "type": "object", "properties": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "deprecated": true, "type": "string" }, "networkPolicy": { "description": "Required. Configuration options for the NetworkPolicy feature.", "$ref": "NetworkPolicy" }, "name": { "description": "The name (project, location, cluster name) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "SetMaintenancePolicyRequest": { "id": "SetMaintenancePolicyRequest", "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.", "type": "object", "properties": { "projectId": { "description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).", "type": "string" }, "zone": { "description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.", "type": "string" }, "clusterId": { "description": "Required. The name of the cluster to update.", "type": "string" }, "maintenancePolicy": { "description": "Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.", "$ref": "MaintenancePolicy" }, "name": { "description": "The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.", "type": "string" } } }, "ListUsableSubnetworksResponse": { "id": "ListUsableSubnetworksResponse", "description": "ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.", "type": "object", "properties": { "subnetworks": { "description": "A list of usable subnetworks in the specified network project.", "type": "array", "items": { "$ref": "UsableSubnetwork" } }, "nextPageToken": { "description": "This token allows you to get the next page of results for list requests. If the number of results is larger than `page_size`, use the `next_page_token` as a value for the query parameter `page_token` in the next request. The value will become empty when there are no more pages.", "type": "string" } } }, "UsableSubnetwork": { "id": "UsableSubnetwork", "description": "UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range.", "type": "object", "properties": { "subnetwork": { "description": "Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", "type": "string" }, "network": { "description": "Network Name. Example: projects/my-project/global/networks/my-network", "type": "string" }, "ipCidrRange": { "description": "The range of internal addresses that are owned by this subnetwork.", "type": "string" }, "secondaryIpRanges": { "description": "Secondary IP ranges.", "type": "array", "items": { "$ref": "UsableSubnetworkSecondaryRange" } }, "statusMessage": { "description": "A human readable status message representing the reasons for cases where the caller cannot use the secondary ranges under the subnet. For example if the secondary_ip_ranges is empty due to a permission issue, an insufficient permission message will be given by status_message.", "type": "string" } } }, "UsableSubnetworkSecondaryRange": { "id": "UsableSubnetworkSecondaryRange", "description": "Secondary IP range of a usable subnetwork.", "type": "object", "properties": { "rangeName": { "description": "The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance.", "type": "string" }, "ipCidrRange": { "description": "The range of IP addresses belonging to this subnetwork secondary range.", "type": "string" }, "status": { "description": "This field is to determine the status of the secondary range programmably.", "type": "string", "enumDescriptions": [ "UNKNOWN is the zero value of the Status enum. It's not a valid status.", "UNUSED denotes that this range is unclaimed by any cluster.", "IN_USE_SERVICE denotes that this range is claimed by a cluster for services. It cannot be used for other clusters.", "IN_USE_SHAREABLE_POD denotes this range was created by the network admin and is currently claimed by a cluster for pods. It can only be used by other clusters as a pod range.", "IN_USE_MANAGED_POD denotes this range was created by GKE and is claimed for pods. It cannot be used for other clusters." ], "enum": [ "UNKNOWN", "UNUSED", "IN_USE_SERVICE", "IN_USE_SHAREABLE_POD", "IN_USE_MANAGED_POD" ] } } }, "CheckAutopilotCompatibilityResponse": { "id": "CheckAutopilotCompatibilityResponse", "description": "CheckAutopilotCompatibilityResponse has a list of compatibility issues.", "type": "object", "properties": { "issues": { "description": "The list of issues for the given operation.", "type": "array", "items": { "$ref": "AutopilotCompatibilityIssue" } }, "summary": { "description": "The summary of the autopilot compatibility response.", "type": "string" } } }, "AutopilotCompatibilityIssue": { "id": "AutopilotCompatibilityIssue", "description": "AutopilotCompatibilityIssue contains information about a specific compatibility issue with Autopilot mode.", "type": "object", "properties": { "lastObservation": { "description": "The last time when this issue was observed.", "type": "string", "format": "google-datetime" }, "constraintType": { "description": "The constraint type of the issue.", "type": "string" }, "incompatibilityType": { "description": "The incompatibility type of this issue.", "type": "string", "enumDescriptions": [ "Default value, should not be used.", "Indicates that the issue is a known incompatibility between the cluster and Autopilot mode.", "Indicates the issue is an incompatibility if customers take no further action to resolve.", "Indicates the issue is not an incompatibility, but depending on the workloads business logic, there is a potential that they won't work on Autopilot." ], "enum": [ "UNSPECIFIED", "INCOMPATIBILITY", "ADDITIONAL_CONFIG_REQUIRED", "PASSED_WITH_OPTIONAL_CONFIG" ] }, "subjects": { "description": "The name of the resources which are subject to this issue.", "type": "array", "items": { "type": "string" } }, "documentationUrl": { "description": "A URL to a public documnetation, which addresses resolving this issue.", "type": "string" }, "description": { "description": "The description of the issue.", "type": "string" } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "ListLocationsResponse returns the list of all GKE locations and their recommendation state.", "type": "object", "properties": { "locations": { "description": "A full list of GKE locations.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "Only return ListLocationsResponse that occur after the page_token. This value should be populated from the ListLocationsResponse.next_page_token if that response token was set (which happens when listing more Locations than fit in a single ListLocationsResponse).", "type": "string" } } }, "Location": { "id": "Location", "description": "Location returns the location name, and if the location is recommended for GKE cluster scheduling.", "type": "object", "properties": { "type": { "description": "Contains the type of location this Location is for. Regional or Zonal.", "type": "string", "enumDescriptions": [ "LOCATION_TYPE_UNSPECIFIED means the location type was not determined.", "A GKE Location where Zonal clusters can be created.", "A GKE Location where Regional clusters can be created." ], "enum": [ "LOCATION_TYPE_UNSPECIFIED", "ZONE", "REGION" ] }, "name": { "description": "Contains the name of the resource requested. Specified in the format `projects/*/locations/*`.", "type": "string" }, "recommended": { "description": "Whether the location is recommended for GKE cluster scheduling.", "type": "boolean" } } }, "UpgradeEvent": { "id": "UpgradeEvent", "description": "UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading.", "type": "object", "properties": { "resourceType": { "description": "The resource type that is upgrading.", "type": "string", "enumDescriptions": [ "Default value. This shouldn't be used.", "Master / control plane", "Node pool" ], "enum": [ "UPGRADE_RESOURCE_TYPE_UNSPECIFIED", "MASTER", "NODE_POOL" ] }, "operation": { "description": "The operation associated with this upgrade.", "type": "string" }, "operationStartTime": { "description": "The time when the operation was started.", "type": "string", "format": "google-datetime" }, "currentVersion": { "description": "The current version before the upgrade.", "type": "string" }, "targetVersion": { "description": "The target version for the upgrade.", "type": "string" }, "resource": { "description": "Optional relative path to the resource. For example in node pool upgrades, the relative path of the node pool.", "type": "string" } } }, "UpgradeAvailableEvent": { "id": "UpgradeAvailableEvent", "description": "UpgradeAvailableEvent is a notification sent to customers when a new available version is released.", "type": "object", "properties": { "version": { "description": "The release version available for upgrade.", "type": "string" }, "resourceType": { "description": "The resource type of the release version.", "type": "string", "enumDescriptions": [ "Default value. This shouldn't be used.", "Master / control plane", "Node pool" ], "enum": [ "UPGRADE_RESOURCE_TYPE_UNSPECIFIED", "MASTER", "NODE_POOL" ] }, "releaseChannel": { "description": "The release channel of the version. If empty, it means a non-channel release.", "$ref": "ReleaseChannel" }, "resource": { "description": "Optional relative path to the resource. For example, the relative path of the node pool.", "type": "string" }, "windowsVersions": { "description": "Windows node versions info.", "$ref": "WindowsVersions" } } }, "SecurityBulletinEvent": { "id": "SecurityBulletinEvent", "description": "SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.", "type": "object", "properties": { "resourceTypeAffected": { "description": "The resource type (node/control plane) that has the vulnerability. Multiple notifications (1 notification per resource type) will be sent for a vulnerability that affects \u003e 1 resource type.", "type": "string" }, "bulletinId": { "description": "The ID of the bulletin corresponding to the vulnerability.", "type": "string" }, "cveIds": { "description": "The CVEs associated with this bulletin.", "type": "array", "items": { "type": "string" } }, "severity": { "description": "The severity of this bulletin as it relates to GKE.", "type": "string" }, "bulletinUri": { "description": "The URI link to the bulletin on the website for more information.", "type": "string" }, "briefDescription": { "description": "A brief description of the bulletin. See the bulletin pointed to by the bulletin_uri field for an expanded description.", "type": "string" }, "affectedSupportedMinors": { "description": "The GKE minor versions affected by this vulnerability.", "type": "array", "items": { "type": "string" } }, "patchedVersions": { "description": "The GKE versions where this vulnerability is patched.", "type": "array", "items": { "type": "string" } }, "suggestedUpgradeTarget": { "description": "This represents a version selected from the patched_versions field that the cluster receiving this notification should most likely want to upgrade to based on its current version. Note that if this notification is being received by a given cluster, it means that this version is currently available as an upgrade target in that cluster's location.", "type": "string" }, "manualStepsRequired": { "description": "If this field is specified, it means there are manual steps that the user must take to make their clusters safe.", "type": "boolean" } } } }, "baseUrl": "https://container.googleapis.com/", "canonicalName": "Container", "basePath": "", "version": "v1beta1", "ownerDomain": "google.com", "name": "container", "revision": "20240608", "documentationLink": "https://cloud.google.com/container-engine/", "id": "container:v1beta1", "ownerName": "Google", "rootUrl": "https://container.googleapis.com/", "kind": "discovery#restDescription", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "title": "Kubernetes Engine API" }