Default request referring to version v1 of the Google Container Engine API. This contains the host and root path used as a starting point for constructing service requests.

View and manage your data across Google Cloud Platform services

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.

See: horizontalPodAutoscaling smart constructor.

Creates a value of HorizontalPodAutoscaling with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• hpaDisabled

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.

ListOperationsResponse is the result of ListOperationsRequest.

See: listOperationsResponse smart constructor.

Creates a value of ListOperationsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lorOperations
• lorMissingZones

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.

CreateClusterRequest creates a cluster.

See: createClusterRequest smart constructor.

Creates a value of CreateClusterRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ccrCluster

A cluster resource

A Google Container Engine cluster.

See: cluster smart constructor.

Creates a value of Cluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cStatus
• cNodePools
• cEnableKubernetesAlpha
• cNodeConfig
• cNodeIPv4CIdRSize
• cClusterIPv4CIdR
• cInitialNodeCount
• cCurrentNodeVersion
• cNetwork
• cInitialClusterVersion
• cZone
• cAddonsConfig
• cServicesIPv4CIdR
• cMasterAuth
• cSelfLink
• cName
• cCurrentMasterVersion
• cStatusMessage
• cSubnetwork
• cCurrentNodeCount
• cEndpoint
• cExpireTime
• cLocations
• cLoggingService
• cDescription
• cInstanceGroupURLs
• cMonitoringService
• cCreateTime

Output only

The current status of this cluster.

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

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.

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.

Output only

The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range.

The IP address range of the container pods in this cluster, in CIDR 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`.

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota 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.

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.

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the `default` network will be used.

Output only

The software version of the master endpoint and kubelets used in the cluster when it was first created. The version can be upgraded over time.

Output only

The name of the Google Compute Engine

zone

(/compute/docs/zones#available) in which the cluster resides.

Configurations for the various addons available to run in the cluster.

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.

The authentication information for accessing the master endpoint.

Output only

Server-defined URL for the resource.

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.

Output only

The current software version of the master endpoint.

Output only

Additional information about the current status of this cluster, if available.

The name of the Google Compute Engine subnetwork to which the cluster is connected.

Output only

The number of nodes currently in the cluster.

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.

Output only

The time the cluster will be automatically deleted in

RFC3339

(https://www.ietf.org/rfc/rfc3339.txt) text format.

The list of Google Compute Engine locations in which the cluster's nodes should be located.

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.

An optional description of this cluster.

Output only

The resource URLs of instance groups associated with this cluster.

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.

Output only

The time the cluster was created, in

RFC3339

(https://www.ietf.org/rfc/rfc3339.txt) text format.

CancelOperationRequest cancels a single operation.

See: cancelOperationRequest smart constructor.

Creates a value of CancelOperationRequest with the minimum fields required to make a request.

UpdateClusterRequest updates the settings of a cluster.

See: updateClusterRequest smart constructor.

Creates a value of UpdateClusterRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ucrUpdate

A description of the update.

Parameters that describe the nodes in a cluster.

See: nodeConfig smart constructor.

Creates a value of NodeConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ncLocalSsdCount
• ncDiskSizeGb
• ncOAuthScopes
• ncServiceAccount
• ncImageType
• ncMachineType
• ncMetadata
• ncLabels
• ncTags
• ncPreemptible

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.

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). 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 image type to use for this node. Note that for a given image type, the latest version of it will be used.

The name of a Google Compute Engine machine type (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.

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 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: http://kubernetes.io/v1.1/docs/user-guide/labels.html

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.

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.

See: hTTPLoadBalancing smart constructor.

Creates a value of HTTPLoadBalancing with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• httplbDisabled

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.

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

See: operation smart constructor.

Creates a value of Operation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• oStatus
• oZone
• oSelfLink
• oName
• oStatusMessage
• oOperationType
• oTargetLink
• oDetail

The current status of the operation.

The name of the Google Compute Engine zone in which the operation is taking place.

Server-defined URL for the resource.

The server-assigned ID for the operation.

If an error has occurred, a textual description of the error.

The operation type.

Server-defined URL for the target of the operation.

Detailed operation progress, if available.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

See: empty smart constructor.

Creates a value of Empty with the minimum fields required to make a request.

NodeManagement defines the set of node management services turned on for the node pool.

See: nodeManagement smart constructor.

Creates a value of NodeManagement with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• nmAutoUpgrade
• nmUpgradeOptions

Whether the nodes will be automatically upgraded.

Specifies the Auto Upgrade knobs for the node pool.

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.

See: nodePoolAutoscaling smart constructor.

Creates a value of NodePoolAutoscaling with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• npaMaxNodeCount
• npaEnabled
• npaMinNodeCount

Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

Is autoscaling enabled for this node pool.

Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.

See: addonsConfig smart constructor.

Creates a value of AddonsConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• acHorizontalPodAutoscaling
• acHTTPLoadBalancing

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 HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.

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.

See: nodePool smart constructor.

Creates a value of NodePool with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• npStatus
• npAutoscaling
• npConfig
• npInitialNodeCount
• npManagement
• npSelfLink
• npName
• npStatusMessage
• npVersion
• npInstanceGroupURLs

Output only

The status of the nodes in this pool instance.

Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

The node configuration of the pool.

The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

NodeManagement configuration for this NodePool.

Output only

Server-defined URL for the resource.

The name of the node pool.

Output only

Additional information about the current status of this node pool instance, if available.

Output only

The version of the Kubernetes of this node.

Output only

The resource URLs of instance groups associated with this node pool.

SetNodePoolManagementRequest sets the node management properties of a node pool.

See: setNodePoolManagementRequest smart constructor.

Creates a value of SetNodePoolManagementRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• snpmrManagement

NodeManagement configuration for the node pool.

The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.

See: masterAuth smart constructor.

Creates a value of MasterAuth with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• maClientKey
• maUsername
• maClientCertificate
• maPassword
• maClusterCaCertificate

Output only

Base64-encoded private key used by clients to authenticate to the cluster endpoint.

The username to use for HTTP basic authentication to the master endpoint.

Output only

Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

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.

Output only

Base64-encoded public certificate that is the root of trust for the cluster.

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.

See: nodeConfigMetadata smart constructor.