package google.container.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Google Kubernetes Engine Cluster Manager v1
rpc ListClusters (, )
cluster_service.proto:35Lists all clusters owned by a project in either the specified zone or all zones.
message
cluster_service.proto:1550ListClustersRequest lists clusters.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field.
string parent = 4
The parent (project and location) where the clusters will be listed. Specified in the format 'projects/*/locations/*'. Location "-" matches all zones and all regions.
message
cluster_service.proto:1569ListClustersResponse is the result of ListClustersRequest.
repeated clusters = 1
A list of clusters in the project in the specified zone, or across all ones.
repeated string missing_zones = 2
If any zones are listed here, the list of clusters returned may be missing those zones.
rpc GetCluster (, )
cluster_service.proto:45Gets the details of a specific cluster.
message
cluster_service.proto:1213GetClusterRequest gets the settings of a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.
string name = 5
The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/*/locations/*/clusters/*'.
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](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the cluster 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 is being used by the cluster.
message
cluster_service.proto:1191CreateClusterRequest creates a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
optional cluster = 3
A [cluster resource](/container-engine/reference/rest/v1/projects.zones.clusters)
string parent = 5
The parent (project and location) where the cluster will be created. Specified in the format 'projects/*/locations/*'.
Updates the settings of a specific cluster.
message
cluster_service.proto:1235UpdateClusterRequest updates the settings of a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
optional update = 4
A description of the update.
string name = 5
The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/*/locations/*/clusters/*'.
Updates the version and/or image type for a specific node pool.
message
cluster_service.proto:1260UpdateNodePoolRequests update a node pool's image and/or version.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
string node_pool_id = 4
Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
string node_version = 5
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
string image_type = 6
The desired image type for the node pool.
string name = 8
The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
Sets the autoscaling settings for a specific node pool.
message
cluster_service.proto:1303SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
string node_pool_id = 4
Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
optional autoscaling = 5
Autoscaling configuration for the node pool.
string name = 6
The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
Sets the logging service for a specific cluster.
message
cluster_service.proto:1333SetLoggingServiceRequest sets the logging service of a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
string logging_service = 4
The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no metrics will be exported from the cluster
string name = 5
The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/*/locations/*/clusters/*'.
Sets the monitoring service for a specific cluster.
message
cluster_service.proto:1362SetMonitoringServiceRequest sets the monitoring service of a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
string monitoring_service = 4
The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster
string name = 6
The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/*/locations/*/clusters/*'.
Sets the addons for a specific cluster.
message
cluster_service.proto:1391SetAddonsConfigRequest sets the addons associated with the cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
optional addons_config = 4
The desired configurations for the various addons available to run in the cluster.
string name = 6
The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/*/locations/*/clusters/*'.
Sets the locations for a specific cluster.
message
cluster_service.proto:1417SetLocationsRequest sets the locations of the cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
repeated string locations = 4
The desired list of Google Compute Engine [locations](/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.
string name = 6
The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/*/locations/*/clusters/*'.
Updates the master for a specific cluster.
message
cluster_service.proto:1448UpdateMasterRequest updates the master of the cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
string master_version = 4
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
string name = 7
The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/*/locations/*/clusters/*'.
Used to set master auth materials. Currently supports :- Changing the admin password for a specific cluster. This can be either via password generation or explicitly set the password.
message
cluster_service.proto:1482SetMasterAuthRequest updates the admin password of a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
SetMasterAuthRequest.Action action = 4
The exact form of action to be taken on the master auth.
optional update = 5
A description of the update.
string name = 7
The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects/*/locations/*/clusters/*'.
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 (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.
message
cluster_service.proto:1528DeleteClusterRequest deletes a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.
string name = 4
The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/*/locations/*/clusters/*'.
Lists all operations in a project in a specific zone or all zones.
message
cluster_service.proto:1602ListOperationsRequest lists operations.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.
string parent = 4
The parent (project and location) where the operations will be listed. Specified in the format 'projects/*/locations/*'. Location "-" matches all zones and all regions.
message
cluster_service.proto:1641ListOperationsResponse is the result of ListOperationsRequest.
repeated operations = 1
A list of operations in the project in the specified zone.
repeated string missing_zones = 2
If any zones are listed here, the list of operations returned may be missing the operations from those zones.
Gets the specified operation.
message
cluster_service.proto:1580GetOperationRequest gets a single operation.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string operation_id = 3
Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
string name = 5
The name (project, location, operation id) of the operation to get. Specified in the format 'projects/*/locations/*/operations/*'.
Cancels the specified operation.
message
cluster_service.proto:1620CancelOperationRequest cancels a single operation.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
string operation_id = 3
Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
string name = 4
The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/*/locations/*/operations/*'.
Returns configuration info about the Kubernetes Engine service.
message
cluster_service.proto:1651Gets the current Kubernetes Engine service configuration.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.
string name = 4
The name (project and location) of the server config to get Specified in the format 'projects/*/locations/*'.
message
cluster_service.proto:1668Kubernetes Engine service configuration.
string default_cluster_version = 1
Version of Kubernetes the service deploys by default.
repeated string valid_node_versions = 3
List of valid node upgrade target versions.
string default_image_type = 4
Default image type.
repeated string valid_image_types = 5
List of valid image types.
repeated string valid_master_versions = 6
List of valid master versions.
Lists the node pools for a cluster.
message
cluster_service.proto:1739ListNodePoolsRequest lists the node pool(s) for a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
string cluster_id = 3
Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
string parent = 5
The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/*/locations/*/clusters/*'.
message
cluster_service.proto:2014ListNodePoolsResponse is the result of ListNodePoolsRequest.
repeated node_pools = 1
A list of node pools for a cluster.
rpc GetNodePool (, )
cluster_service.proto:259Retrieves the node pool requested.
message
cluster_service.proto:1761GetNodePoolRequest retrieves a node pool for a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
string node_pool_id = 4
Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.
string name = 6
The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
Creates a node pool for a cluster.
message
cluster_service.proto:1686CreateNodePoolRequest creates a node pool for a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
string cluster_id = 3
Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
optional node_pool = 4
The node pool to create.
string parent = 6
The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/*/locations/*/clusters/*'.
Deletes a node pool from a cluster.
message
cluster_service.proto:1712DeleteNodePoolRequest deletes a node pool for a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
string node_pool_id = 4
Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.
string name = 6
The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
Roll back the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
message
cluster_service.proto:1987RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.
string node_pool_id = 4
Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
string name = 6
The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
Sets the NodeManagement options for a node pool.
message
cluster_service.proto:1924SetNodePoolManagementRequest sets the node management properties of a node pool.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
string node_pool_id = 4
Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
optional management = 5
NodeManagement configuration for the node pool.
string name = 7
The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
rpc SetLabels (, )
cluster_service.proto:316Sets labels on a cluster.
message
cluster_service.proto:2037SetLabelsRequest 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
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
map<string, string> resource_labels = 4
The labels to set for that cluster.
string label_fingerprint = 5
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 <code>get()</code> request to the resource to get the latest fingerprint.
string name = 7
The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects/*/locations/*/clusters/*'.
Enables or disables the ABAC authorization mechanism on a cluster.
message
cluster_service.proto:2071SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
bool enabled = 4
Whether ABAC authorization will be enabled in the cluster.
string name = 6
The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/*/locations/*/clusters/*'.
Start master IP rotation.
message
cluster_service.proto:2097StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
string name = 6
The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/*/locations/*/clusters/*'.
bool rotate_credentials = 7
Whether to rotate credentials during IP rotation.
Completes master IP rotation.
message
cluster_service.proto:2122CompleteIPRotationRequest moves the cluster master back into single-IP mode.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
string name = 7
The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/*/locations/*/clusters/*'.
Sets the size for a specific node pool.
message
cluster_service.proto:1955SetNodePoolSizeRequest sets the size a node pool.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
string node_pool_id = 4
Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
int32 node_count = 5
The desired node count for the pool.
string name = 7
The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
Enables/Disables Network Policy for a cluster.
message
cluster_service.proto:2154SetNetworkPolicyRequest enables/disables network policy for a cluster.
string project_id = 1
Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
string zone = 2
Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
string cluster_id = 3
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
optional network_policy = 4
Configuration options for the NetworkPolicy feature.
string name = 6
The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects/*/locations/*/clusters/*'.
Sets the maintenance policy for a cluster.
message
cluster_service.proto:2179SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
string project_id = 1
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).
string zone = 2
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.
string cluster_id = 3
The name of the cluster to update.
optional maintenance_policy = 4
The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
string name = 5
The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/*/locations/*/clusters/*'.
message
cluster_service.proto:2144AcceleratorConfig represents a Hardware Accelerator request.
Used in:
int64 accelerator_count = 1
The number of the accelerator cards exposed to an instance.
string accelerator_type = 2
The accelerator type resource name. List of supported accelerators [here](/compute/docs/gpus/#Introduction)
message
cluster_service.proto:555Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.
Used in: , ,
optional http_load_balancing = 1
Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
optional horizontal_pod_autoscaling = 2
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.
optional kubernetes_dashboard = 3
Configuration for the Kubernetes Dashboard.
optional network_policy_config = 4
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.
message
cluster_service.proto:1883AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.
Used in:
string auto_upgrade_start_time = 1
[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.
string description = 2
[Output only] This field is set when upgrades are about to commence with the description of the upgrade.
message
cluster_service.proto:548Configuration for client certificates on the cluster.
Used in:
bool issue_client_certificate = 1
Issue a client certificate.
message
cluster_service.proto:775A Google Kubernetes Engine cluster.
Used as response type in: ClusterManager.GetCluster
Used as field type in: ,
string name = 1
The name of this cluster. The name must be unique within this project and zone, 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.
string description = 2
An optional description of this cluster.
int32 initial_node_count = 3
The number of nodes to create in this cluster. You must ensure that your Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> 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.
optional node_config = 4
Parameters used in creating the cluster's nodes. See `nodeConfig` for the description of its properties. 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. If unspecified, the defaults are used.
optional master_auth = 5
The authentication information for accessing the master endpoint.
string logging_service = 6
The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used.
string monitoring_service = 7
The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com` - the Google Cloud Monitoring service. * `none` - no metrics will be exported from the cluster. * if left as an empty string, `monitoring.googleapis.com` will be used.
string network = 8
The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
string cluster_ipv4_cidr = 9
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`.
optional addons_config = 10
Configurations for the various addons available to run in the cluster.
string subnetwork = 11
The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected.
repeated node_pools = 12
The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
repeated string locations = 13
The list of Google Compute Engine [locations](/compute/docs/zones#available) in which the cluster's nodes should be located.
bool enable_kubernetes_alpha = 14
Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) 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.
map<string, string> resource_labels = 15
The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
string label_fingerprint = 16
The fingerprint of the set of labels for this cluster.
optional legacy_abac = 18
Configuration for the legacy ABAC authorization mode.
optional network_policy = 19
Configuration options for the NetworkPolicy feature.
optional ip_allocation_policy = 20
Configuration for cluster IP allocation.
optional master_authorized_networks_config = 22
The configuration options for master authorized networks feature.
optional maintenance_policy = 23
Configure the maintenance policy for this cluster.
optional network_config = 27
Configuration for cluster networking.
optional private_cluster_config = 37
Configuration for private cluster.
string self_link = 100
[Output only] Server-defined URL for the resource.
string zone = 101
[Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
string endpoint = 102
[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.
string initial_cluster_version = 103
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
string current_master_version = 104
[Output only] The current software version of the master endpoint.
string current_node_version = 105
[Output only] Deprecated, use [NodePool.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePool) 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.
string create_time = 106
[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Cluster.Status status = 107
[Output only] The current status of this cluster.
string status_message = 108
[Output only] Additional information about the current status of this cluster, if available.
int32 node_ipv4_cidr_size = 109
[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range.
string services_ipv4_cidr = 110
[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.
repeated string instance_group_urls = 111
Deprecated. Use node_pools.instance_group_urls.
int32 current_node_count = 112
[Output only] The number of nodes currently in the cluster.
string expire_time = 113
[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
string location = 114
[Output only] The name of the Google Compute Engine [zone](/compute/docs/regions-zones/regions-zones#available) or [region](/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
The current status of the cluster.
Used in:
STATUS_UNSPECIFIED = 0
Not set.
PROVISIONING = 1
The PROVISIONING state indicates the cluster is being created.
RUNNING = 2
The RUNNING state indicates the cluster has been created and is fully usable.
RECONCILING = 3
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.
STOPPING = 4
The STOPPING state indicates the cluster is being deleted.
ERROR = 5
The ERROR state indicates the cluster may be unusable. Details can be found in the `statusMessage` field.
DEGRADED = 6
The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the `statusMessage` field.
message
cluster_service.proto:1008ClusterUpdate 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.
Used in:
string desired_node_version = 4
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
string desired_monitoring_service = 5
The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster
optional desired_addons_config = 6
Configurations for the various addons available to run in the cluster.
string desired_node_pool_id = 7
The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.
string desired_image_type = 8
The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
optional desired_node_pool_autoscaling = 9
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.
repeated string desired_locations = 10
The desired list of Google Compute Engine [locations](/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.
optional desired_master_authorized_networks_config = 12
The desired configuration options for master authorized networks feature.
string desired_master_version = 100
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
message
cluster_service.proto:1909Time window specified for daily maintenance operations.
Used in:
string start_time = 2
Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM”, where HH : [00-23] and MM : [00-59] GMT.
string duration = 3
[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".
message
cluster_service.proto:586Configuration 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.
Used in:
bool disabled = 1
Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.
message
cluster_service.proto:576Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
Used in:
bool disabled = 1
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.
message
cluster_service.proto:682Configuration for controlling how IPs are allocated in the cluster.
Used in:
bool use_ip_aliases = 1
Whether alias IPs will be used for pod IPs in the cluster.
bool create_subnetwork = 2
Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
string subnetwork_name = 3
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.
string cluster_ipv4_cidr = 4
This field is deprecated, use cluster_ipv4_cidr_block.
string node_ipv4_cidr = 5
This field is deprecated, use node_ipv4_cidr_block.
string services_ipv4_cidr = 6
This field is deprecated, use services_ipv4_cidr_block.
string cluster_secondary_range_name = 7
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 is true and create_subnetwork is false.
string services_secondary_range_name = 8
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 is true and create_subnetwork is false.
string cluster_ipv4_cidr_block = 9
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.
string node_ipv4_cidr_block = 10
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.
string services_ipv4_cidr_block = 11
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.
message
cluster_service.proto:594Configuration for the Kubernetes Dashboard.
Used in:
bool disabled = 1
Whether the Kubernetes Dashboard is enabled for this cluster.
message
cluster_service.proto:654Configuration for the legacy Attribute Based Access Control authorization mode.
Used in:
bool enabled = 1
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.
message
cluster_service.proto:1895MaintenancePolicy defines the maintenance policy to be used for the cluster.
Used in: ,
optional window = 1
Specifies the maintenance window in which maintenance may be performed.
message
cluster_service.proto:1901MaintenanceWindow defines the maintenance window to be used for the cluster.
Used in:
oneof policy
daily_maintenance_window = 2
DailyMaintenanceWindow specifies a daily maintenance operation window.
message
cluster_service.proto:517The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.
Used in: ,
string username = 1
The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, you can disable basic authentication by providing an empty username.
string password = 2
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.
optional client_certificate_config = 3
Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
string cluster_ca_certificate = 100
[Output only] Base64-encoded public certificate that is the root of trust for the cluster.
string client_certificate = 101
[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
string client_key = 102
[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
message
cluster_service.proto:634Configuration 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.
Used in: ,
bool enabled = 1
Whether or not master authorized networks is enabled.
repeated cidr_blocks = 2
cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
message
cluster_service.proto:636CidrBlock contains an optional name and one CIDR block.
Used in:
string display_name = 1
display_name is an optional field for users to identify CIDR blocks.
string cidr_block = 2
cidr_block must be specified in CIDR notation.
message
cluster_service.proto:2203NetworkConfig reports the relative names of network & subnetwork.
Used in:
string network = 1
Output only. The relative name of the Google Compute Engine [network][google.container.v1.NetworkConfig.network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
string subnetwork = 2
Output only. The relative name of the Google Compute Engine [subnetwork](/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
message
cluster_service.proto:664Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
Used in: ,
NetworkPolicy.Provider provider = 1
The selected network policy provider.
bool enabled = 2
Whether network policy is enabled on the cluster.
Allowed Network Policy providers.
Used in:
PROVIDER_UNSPECIFIED = 0
Not set
CALICO = 1
Tigera (Calico Felix).
message
cluster_service.proto:602Configuration 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.
Used in:
bool disabled = 1
Whether NetworkPolicy is enabled for this cluster.
message
cluster_service.proto:401Parameters that describe the nodes in a cluster.
Used in: ,
string machine_type = 1
The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
int32 disk_size_gb = 2
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.
repeated string oauth_scopes = 3
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](/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.
string service_account = 9
The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used.
map<string, string> metadata = 4
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" "enable-os-login" "gci-update-strategy" "gci-ensure-gke-docker" "instance-template" "kube-env" "startup-script" "user-data" 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.
string image_type = 5
The image type to use for this node. Note that for a given image type, the latest version of it will be used.
map<string, string> labels = 6
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/
int32 local_ssd_count = 7
The number of local SSD disks to be attached to the node. The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits for more information.
repeated string tags = 8
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.
bool preemptible = 10
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.
repeated accelerators = 11
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.
string disk_type = 12
Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'
string min_cpu_platform = 13
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 <code>minCpuPlatform: "Intel Haswell"</code> or <code>minCpuPlatform: "Intel Sandy Bridge"</code>. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
message
cluster_service.proto:1865NodeManagement defines the set of node management services turned on for the node pool.
Used in: ,
bool auto_upgrade = 1
A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
bool auto_repair = 2
A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
optional upgrade_options = 10
Specifies the Auto Upgrade knobs for the node pool.
message
cluster_service.proto:1793NodePool 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.
Used as response type in: ClusterManager.GetNodePool
Used as field type in: , ,
string name = 1
The name of the node pool.
optional config = 2
The node configuration of the pool.
int32 initial_node_count = 3
The initial node count for the pool. You must ensure that your Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> is sufficient for this number of instances. You must also have available firewall and routes quota.
string self_link = 100
[Output only] Server-defined URL for the resource.
string version = 101
The version of the Kubernetes of this node.
repeated string instance_group_urls = 102
[Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool.
NodePool.Status status = 103
[Output only] The status of the nodes in this pool instance.
string status_message = 104
[Output only] Additional information about the current status of this node pool instance, if available.
optional autoscaling = 4
Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
optional management = 5
NodeManagement configuration for this NodePool.
The current status of the node pool instance.
Used in:
STATUS_UNSPECIFIED = 0
Not set.
PROVISIONING = 1
The PROVISIONING state indicates the node pool is being created.
RUNNING = 2
The RUNNING state indicates the node pool has been created and is fully usable.
RUNNING_WITH_ERROR = 3
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.
RECONCILING = 4
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.
STOPPING = 5
The STOPPING state indicates the node pool is being deleted.
ERROR = 6
The ERROR state indicates the node pool may be unusable. Details can be found in the `statusMessage` field.
message
cluster_service.proto:2021NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.
Used in: , ,
bool enabled = 1
Is autoscaling enabled for this node pool.
int32 min_node_count = 2
Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.
int32 max_node_count = 3
Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.
message
cluster_service.proto:1075This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Used as response type in: ClusterManager.CompleteIPRotation, ClusterManager.CreateCluster, ClusterManager.CreateNodePool, ClusterManager.DeleteCluster, ClusterManager.DeleteNodePool, ClusterManager.GetOperation, ClusterManager.RollbackNodePoolUpgrade, ClusterManager.SetAddonsConfig, ClusterManager.SetLabels, ClusterManager.SetLegacyAbac, ClusterManager.SetLocations, ClusterManager.SetLoggingService, ClusterManager.SetMaintenancePolicy, ClusterManager.SetMasterAuth, ClusterManager.SetMonitoringService, ClusterManager.SetNetworkPolicy, ClusterManager.SetNodePoolAutoscaling, ClusterManager.SetNodePoolManagement, ClusterManager.SetNodePoolSize, ClusterManager.StartIPRotation, ClusterManager.UpdateCluster, ClusterManager.UpdateMaster, ClusterManager.UpdateNodePool
Used as field type in:
string name = 1
The server-assigned ID for the operation.
string zone = 2
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Operation.Type operation_type = 3
The operation type.
Operation.Status status = 4
The current status of the operation.
string detail = 8
Detailed operation progress, if available.
string status_message = 5
If an error has occurred, a textual description of the error.
string self_link = 6
Server-defined URL for the resource.
string target_link = 7
Server-defined URL for the target of the operation.
string location = 9
[Output only] The name of the Google Compute Engine [zone](/compute/docs/regions-zones/regions-zones#available) or [region](/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
string start_time = 10
[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
string end_time = 11
[Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Current status of the operation.
Used in:
STATUS_UNSPECIFIED = 0
Not set.
PENDING = 1
The operation has been created.
RUNNING = 2
The operation is currently running.
DONE = 3
The operation is done, either cancelled or completed.
ABORTING = 4
The operation is aborting.
Operation type.
Used in:
TYPE_UNSPECIFIED = 0
Not set.
CREATE_CLUSTER = 1
Cluster create.
DELETE_CLUSTER = 2
Cluster delete.
UPGRADE_MASTER = 3
A master upgrade.
UPGRADE_NODES = 4
A node upgrade.
REPAIR_CLUSTER = 5
Cluster repair.
UPDATE_CLUSTER = 6
Cluster update.
CREATE_NODE_POOL = 7
Node pool create.
DELETE_NODE_POOL = 8
Node pool delete.
SET_NODE_POOL_MANAGEMENT = 9
Set node pool management.
AUTO_REPAIR_NODES = 10
Automatic node pool repair.
AUTO_UPGRADE_NODES = 11
Automatic node upgrade.
SET_LABELS = 12
Set labels.
SET_MASTER_AUTH = 13
Set/generate master auth materials
SET_NODE_POOL_SIZE = 14
Set node pool size.
SET_NETWORK_POLICY = 15
Updates network policy for a cluster.
SET_MAINTENANCE_POLICY = 16
Set the maintenance policy.
message
cluster_service.proto:608Configuration options for private clusters.
Used in:
bool enable_private_nodes = 1
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.
bool enable_private_endpoint = 2
Whether the master's internal IP address is used as the cluster endpoint.
string master_ipv4_cidr_block = 3
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.
string private_endpoint = 4
Output only. The internal IP address of this cluster's master endpoint.
string public_endpoint = 5
Output only. The external IP address of this cluster's master endpoint.
Operation type: what type update to perform.
Used in:
UNKNOWN = 0
Operation is unknown and will error out.
SET_PASSWORD = 1
Set the password to a user generated value.
GENERATE_PASSWORD = 2
Generate a new password and set it to that.
SET_USERNAME = 3
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.