Get desktop application:
View/edit binary Protocol Buffers messages
Google Container Engine Cluster Manager v1alpha1
Lists all clusters owned by a project in either the specified zone or all zones.
ListClustersRequest lists clusters.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use parent instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field is deprecated, use parent instead.
The parent (project and location) where the clusters will be listed. Specified in the format 'projects/*/locations/*'. Location "-" matches all zones and all regions.
ListClustersResponse is the result of ListClustersRequest.
A list of clusters in the project in the specified zone, or across all ones.
If any zones are listed here, the list of clusters returned may be missing those zones.
Gets the details of a specific cluster.
GetClusterRequest gets the settings of a cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to retrieve. This field is deprecated, use name instead.
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.
CreateClusterRequest creates a cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use parent instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use parent instead.
A [cluster resource](/container-engine/reference/rest/v1alpha1/projects.zones.clusters)
The parent (project and location) where the cluster will be created. Specified in the format 'projects/*/locations/*'.
Updates the settings of a specific cluster.
UpdateClusterRequest updates the settings of a cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to upgrade. This field is deprecated, use name instead.
A description of the update.
The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/*/locations/*/clusters/*'.
Updates the version and/or iamge type of a specific node pool.
SetNodePoolVersionRequest updates the version of a node pool.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to upgrade. This field is deprecated, use name instead.
The name of the node pool to upgrade. This field is deprecated, use name instead.
The Kubernetes version to change the nodes to (typically an upgrade). Use `-` to upgrade to the latest version supported by the server.
The desired image type for the node pool.
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 of a specific node pool.
SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to upgrade. This field is deprecated, use name instead.
The name of the node pool to upgrade. This field is deprecated, use name instead.
Autoscaling configuration for the node pool.
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 of a specific cluster.
SetLoggingServiceRequest sets the logging service of a cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.
The name of the cluster to upgrade. This field is deprecated, use name instead.
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
The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/*/locations/*/clusters/*'.
Sets the monitoring service of a specific cluster.
SetMonitoringServiceRequest sets the monitoring service of a cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to upgrade. This field is deprecated, use name instead.
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
The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/*/locations/*/clusters/*'.
Sets the addons of a specific cluster.
SetAddonsRequest sets the addons associated with the cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to upgrade. This field is deprecated, use name instead.
The desired configurations for the various addons available to run in the cluster.
The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/*/locations/*/clusters/*'.
Sets the locations of a specific cluster.
SetLocationsRequest sets the locations of the cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to upgrade. This field is deprecated, use name instead.
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.
The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/*/locations/*/clusters/*'.
Updates the master of a specific cluster.
UpdateMasterRequest updates the master of the cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to upgrade. This field is deprecated, use name instead.
The Kubernetes version to change the master to. The only valid value is the latest supported version. Use "-" to have the server automatically select the latest version.
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 of a specific cluster. This can be either via password generation or explicitly set. Modify basic_auth.csv and reset the K8S API server.
SetMasterAuthRequest updates the admin password of a cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to upgrade. This field is deprecated, use name instead.
The exact form of action to be taken on the master auth.
A description of the update.
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.
DeleteClusterRequest deletes a cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to delete. This field is deprecated, use name instead.
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.
ListOperationsRequest lists operations.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use parent instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field is deprecated, use parent instead.
The parent (project and location) where the operations will be listed. Specified in the format 'projects/*/locations/*'. Location "-" matches all zones and all regions.
ListOperationsResponse is the result of ListOperationsRequest.
A list of operations in the project in the specified zone.
If any zones are listed here, the list of operations returned may be missing the operations from those zones.
Gets the specified operation.
GetOperationRequest gets a single operation.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The server-assigned `name` of the operation. This field is deprecated, use name instead.
The name (project, location, operation id) of the operation to get. Specified in the format 'projects/*/locations/*/operations/*'.
Cancels the specified operation.
CancelOperationRequest cancels a single operation.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field is deprecated, use name instead.
The server-assigned `name` of the operation. This field is deprecated, use name instead.
The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/*/locations/*/operations/*'.
Returns configuration info about the Container Engine service.
Gets the current Container Engine service configuration.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field is deprecated, use name instead.
The name (project and location) of the server config to get Specified in the format 'projects/*/locations/*'.
Container Engine service configuration.
Version of Kubernetes the service deploys by default.
List of valid node upgrade target versions.
Default image type.
List of valid image types.
List of valid master versions.
Lists the node pools for a cluster.
ListNodePoolsRequest lists the node pool(s) for a cluster.
The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field is deprecated, use parent instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use parent instead.
The name of the cluster. This field is deprecated, use parent instead.
The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/*/locations/*/clusters/*'.
ListNodePoolsResponse is the result of ListNodePoolsRequest.
A list of node pools for a cluster.
Retrieves the node pool requested.
GetNodePoolRequest retrieves a node pool for a cluster.
The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster. This field is deprecated, use name instead.
The name of the node pool. This field is deprecated, use name instead.
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.
CreateNodePoolRequest creates a node pool for a cluster.
The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field is deprecated, use parent instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use parent instead.
The name of the cluster. This field is deprecated, use parent instead.
The node pool to create.
The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
Deletes a node pool from a cluster.
DeleteNodePoolRequest deletes a node pool for a cluster.
The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster. This field is deprecated, use name instead.
The name of the node pool to delete. This field is deprecated, use name instead.
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.
RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to rollback. This field is deprecated, use name instead.
The name of the node pool to rollback. This field is deprecated, use name instead.
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.
SetNodePoolManagementRequest sets the node management properties of a node pool.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to update. This field is deprecated, use name instead.
The name of the node pool to update. This field is deprecated, use name instead.
NodeManagement configuration for the node pool.
The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
Sets labels on a cluster.
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
The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster. This field is deprecated, use name instead.
The labels to set for that cluster.
The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Container 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.
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.
SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to update. This field is deprecated, use name instead.
Whether ABAC authorization will be enabled in the cluster.
The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/*/locations/*/clusters/*'.
Start master IP rotation.
StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster. This field is deprecated, use name instead.
The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/*/locations/*/clusters/*'.
Completes master IP rotation.
CompleteIPRotationRequest moves the cluster master back into single-IP mode.
The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster. This field is deprecated, use name instead.
The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/*/locations/*/clusters/*'.
Sets the size of a specific node pool.
SetNodePoolSizeRequest sets the size a node pool.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster to update. This field is deprecated, use name instead.
The name of the node pool to update. This field is deprecated, use name instead.
The desired node count for the pool.
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.
SetNetworkPolicyRequest enables/disables network policy for a cluster.
The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field is deprecated, use name instead.
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use name instead.
The name of the cluster. This field is deprecated, use name instead.
Configuration options for the NetworkPolicy feature.
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.
SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).
The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.
The name of the cluster to update.
The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/*/locations/*/clusters/*'.
AcceleratorConfig represents a Hardware Accelerator request.
Used in:
The number of the accelerator cards exposed to an instance.
The accelerator type resource name. List of supported accelerators [here](/compute/docs/gpus/#Introduction)
Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.
Used in:
, ,Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
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.
Configuration for the Kubernetes Dashboard.
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.
AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.
Used in:
[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.
[Output only] This field is set when upgrades are about to commence with the description of the upgrade.
Configuration for client certificates on the cluster.
Used in:
Issue a client certificate.
A Google Container Engine cluster.
Used as response type in: ClusterManager.GetCluster
Used as field type in:
,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.
An optional description of this cluster.
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.
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.
The authentication information for accessing the master endpoint.
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.
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.
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.
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`.
Configurations for the various addons available to run in the cluster.
The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected.
The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
The list of Google Compute Engine [locations](/compute/docs/zones#available) in which the cluster's nodes should be located.
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.
Configuration options for the NetworkPolicy feature.
Configuration for cluster IP allocation.
The configuration options for master authorized networks feature.
Configure the maintenance policy for this cluster.
Configuration for the PodSecurityPolicy feature.
[Output only] Server-defined URL for the resource.
[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.
[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.
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.
[Output only] The current software version of the master endpoint.
[Output only] 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.
[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
[Output only] The current status of this cluster.
[Output only] Additional information about the current status of this cluster, if available.
[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range.
[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.
[Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
[Output only] The number of nodes currently in the cluster.
[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
[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:
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.
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.
Used in:
The Kubernetes version to change the nodes to (typically an upgrade). Use `-` to upgrade to the latest version supported by the server.
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
Configurations for the various addons available to run in the cluster.
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.
The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
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.
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.
The desired configuration options for master authorized networks feature.
The desired configuration options for the PodSecurityPolicy feature.
The Kubernetes version to change the master to. The only valid value is the latest supported version. Use "-" to have the server automatically select the latest version.
Time window specified for daily maintenance operations.
Used in:
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.
[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.
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.
Used in:
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.
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.
Used in:
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.
Configuration for controlling how IPs are allocated in the cluster.
Used in:
Whether alias IPs will be used for pod IPs in the cluster.
Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
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.
This field is deprecated, use cluster_ipv4_cidr_block.
This field is deprecated, use node_ipv4_cidr_block.
This field is deprecated, use services_ipv4_cidr_block.
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 if use_ip_aliases is true and create_subnetwork is false.
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.
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.
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.
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.
Configuration for the Kubernetes Dashboard.
Used in:
Whether the Kubernetes Dashboard is enabled for this cluster.
MaintenancePolicy defines the maintenance policy to be used for the cluster.
Used in:
,Specifies the maintenance window in which maintenance may be performed.
MaintenanceWindow defines the maintenance window to be used for the cluster.
Used in:
Unimplemented, reserved for future use. HourlyMaintenanceWindow hourly_maintenance_window = 1;
DailyMaintenanceWindow specifies a daily maintenance operation window.
The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.
Used in:
,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.
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.
Configuration for client certificate authentication on the cluster. If no configuration is specified, a client certificate is issued.
[Output only] Base64-encoded public certificate that is the root of trust for the cluster.
[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
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.
Used in:
,Whether or not master authorized networks is enabled.
cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
CidrBlock contains an optional name and one CIDR block.
Used in:
display_name is an optional field for users to identify CIDR blocks.
cidr_block must be specified in CIDR notation.
Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
Used in:
,The selected network policy provider.
Whether network policy is enabled on the cluster.
Allowed Network Policy providers.
Used in:
Not set
Tigera (Calico Felix).
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.
Used in:
Whether NetworkPolicy is enabled for this cluster.
Parameters that describe the nodes in a cluster.
Used in:
,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`.
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.
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.
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.
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 four reserved keys: "instance-template", "kube-env", "startup-script", and "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.
The image type to use for this node. Note that for a given image type, the latest version of it will be used.
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/
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.
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.
Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.
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.
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)
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/
NodeManagement defines the set of node management services turned on for the node pool.
Used in:
,Whether the nodes will be automatically upgraded.
Whether the nodes will be automatically repaired.
Specifies the Auto Upgrade knobs for the node pool.
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.
Used as response type in: ClusterManager.GetNodePool
Used as field type in:
, ,The name of the node pool.
The node configuration of the pool.
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.
Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
NodeManagement configuration for this NodePool.
[Output only] Server-defined URL for the resource.
[Output only] The version of the Kubernetes of this node.
[Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool.
[Output only] The status of the nodes in this pool instance.
[Output only] Additional information about the current status of this node pool instance, if available.
The current status of the node pool instance.
Used in:
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.
NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.
Used in:
, ,Is autoscaling enabled for this node pool.
Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.
Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.
Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
Used in:
Key for taint.
Value for taint.
Effect for taint.
Possible values for Effect in taint.
Used in:
Not set
NoSchedule
PreferNoSchedule
NoExecute
This 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:
The server-assigned ID for the operation.
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.
The operation type.
The current status of the operation.
Detailed operation progress, if available.
If an error has occurred, a textual description of the error.
Server-defined URL for the resource.
Server-defined URL for the target of the operation.
[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.
[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
[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:
Not set.
The operation has been created.
The operation is currently running.
The operation is done, either cancelled or completed.
The operation is aborting.
Operation type.
Used in:
Not set.
Cluster create.
Cluster delete.
A master upgrade.
A node upgrade.
Cluster repair.
Cluster update.
Node pool create.
Node pool delete.
Set node pool management.
Automatic node pool repair.
Automatic node upgrade.
Set labels.
Set/generate master auth materials
Set node pool size.
Updates network policy for a cluster.
Set the maintenance policy.
Configuration for the PodSecurityPolicy feature.
Used in:
,Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.
Operation type: what type update to perform.
Used in:
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.