Module types (0.3.0)

API documentation for container_v1.types module.

Classes

AcceleratorConfig

AcceleratorConfig represents a Hardware Accelerator request.

The accelerator type resource name. List of supported accelerators here </compute/docs/gpus/#Introduction>__

AddonsConfig

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

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 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

AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.

[Output only] This field is set when upgrades are about to commence with the description of the upgrade.

CancelOperationRequest

CancelOperationRequest cancels a single operation.

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.

The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects//locations//operations/*'.

ClientCertificateConfig

Configuration for client certificates on the cluster.

Cluster

A Google Kubernetes Engine cluster.

An optional description of this cluster.

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 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 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.

Configurations for the various addons available to run in the 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.

The fingerprint of the set of labels for this cluster.

Configuration options for the NetworkPolicy feature.

The configuration options for master authorized networks feature.

Configuration for cluster networking.

[Output only] Server-defined URL for the resource.

[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 current software version of the master endpoint.

[Output only] The time the cluster was created, in RFC3339 <https://www.ietf.org/rfc/rfc3339.txt>__ text format.

[Output only] Additional information about the current status of this cluster, if available.

[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 number of nodes currently in the cluster.

[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.

ClusterUpdate

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.

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 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.

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 configuration options for master authorized networks feature.

CompleteIPRotationRequest

CompleteIPRotationRequest moves the cluster master back into single-IP mode.

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.

The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects//locations//clusters/*'.

CreateClusterRequest

CreateClusterRequest creates a cluster.

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.

The parent (project and location) where the cluster will be created. Specified in the format 'projects//locations/'.

CreateNodePoolRequest

CreateNodePoolRequest creates a node pool for a cluster.

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.

The node pool to create.

DailyMaintenanceWindow

Time window specified for daily maintenance operations.

[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".

DeleteClusterRequest

DeleteClusterRequest deletes a cluster.

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.

The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects//locations//clusters/*'.

DeleteNodePoolRequest

DeleteNodePoolRequest deletes a node pool for a cluster.

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.

Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.

Empty

API documentation for container_v1.types.Empty class.

GetClusterRequest

GetClusterRequest gets the settings of a cluster.

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.

The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects//locations//clusters/*'.

GetNodePoolRequest

GetNodePoolRequest retrieves a node pool for a cluster.

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.

Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.

GetOperationRequest

GetOperationRequest gets a single operation.

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.

The name (project, location, operation id) of the operation to get. Specified in the format 'projects//locations//operations/*'.

GetServerConfigRequest

Gets the current Kubernetes Engine service configuration.

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.

HorizontalPodAutoscaling

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.

HttpLoadBalancing

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.

IPAllocationPolicy

Configuration for controlling how IPs are allocated 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.

This field is deprecated, use cluster_ipv4_cidr_block.

This field is deprecated, use services_ipv4_cidr_block.

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 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.

KubernetesDashboard

Configuration for the Kubernetes Dashboard.

LegacyAbac

Configuration for the legacy Attribute Based Access Control authorization mode.

ListClustersRequest

ListClustersRequest lists clusters.

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.

ListClustersResponse

ListClustersResponse is the result of ListClustersRequest.

If any zones are listed here, the list of clusters returned may be missing those zones.

ListNodePoolsRequest

ListNodePoolsRequest lists the node pool(s) for a cluster.

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.

The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects//locations//clusters/*'.

ListNodePoolsResponse

ListNodePoolsResponse is the result of ListNodePoolsRequest.

ListOperationsRequest

ListOperationsRequest lists operations.

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.

ListOperationsResponse

ListOperationsResponse is the result of ListOperationsRequest.

If any zones are listed here, the list of operations returned may be missing the operations from those zones.

MaintenancePolicy

MaintenancePolicy defines the maintenance policy to be used for the cluster.

MaintenanceWindow

MaintenanceWindow defines the maintenance window to be used for the cluster.

MasterAuth

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

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.

[Output only] Base64-encoded public certificate that is the root of trust for the cluster.

[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

MasterAuthorizedNetworksConfig

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.

cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.

NetworkConfig

NetworkConfig reports the relative names of network & subnetwork.

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

NetworkPolicy

Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Whether network policy is enabled on the cluster.

NetworkPolicyConfig

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.

NodeConfig

Parameters that describe the nodes in a cluster.

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 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 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.

Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd- standard'

NodeManagement

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

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.

NodePool

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.

The node configuration of the pool.

[Output only] Server-defined URL for the resource.

[Output only] The resource URLs of the managed instance groups </compute/docs/instance-groups/creating-groups-of- managed-instances>__ associated with this node pool.

[Output only] Additional information about the current status of this node pool instance, if available.

NodeManagement configuration for this NodePool.

NodePoolAutoscaling

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

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

Operation

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

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 current status of the operation.

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

Server-defined URL for the target of the operation.

[Output only] The time the operation started, in RFC3339 <https://www.ietf.org/rfc/rfc3339.txt>__ text format.

PrivateClusterConfig

Configuration options for private clusters.

Whether the master's internal IP address is used as the cluster endpoint.

Output only. The internal IP address of this cluster's master endpoint.

RollbackNodePoolUpgradeRequest

RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.

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.

Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.

ServerConfig

Kubernetes Engine service configuration.

List of valid node upgrade target versions.

List of valid image types.

SetAddonsConfigRequest

SetAddonsConfigRequest sets the addons associated with the cluster.

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.

The desired configurations for the various addons available to run in the cluster.

SetLabelsRequest

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

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.

The labels to set for that cluster.

The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects//locations//clusters/*'.

SetLegacyAbacRequest

SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

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.

Whether ABAC authorization will be enabled in the cluster.

SetLocationsRequest

SetLocationsRequest sets the locations of the cluster.

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.

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.

SetLoggingServiceRequest

SetLoggingServiceRequest sets the logging service of a cluster.

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.

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

SetMaintenancePolicyRequest

SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

The name of the Google Compute Engine zone </compute/docs/zones#available>__ in which the cluster resides.

The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.

SetMasterAuthRequest

SetMasterAuthRequest updates the admin password of a cluster.

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.

The exact form of action to be taken on the master auth.

The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects//locations//clusters/*'.

SetMonitoringServiceRequest

SetMonitoringServiceRequest sets the monitoring service of a cluster.

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.

SetNetworkPolicyRequest

SetNetworkPolicyRequest enables/disables network policy for a cluster.

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.

Configuration options for the NetworkPolicy feature.

SetNodePoolAutoscalingRequest

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

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.

Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.

The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects//locations//clusters//nodePools/'.

SetNodePoolManagementRequest

SetNodePoolManagementRequest sets the node management properties of a node pool.

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.

Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.

The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects//locations//clusters//nodePools/'.

SetNodePoolSizeRequest

SetNodePoolSizeRequest sets the size a node pool.

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.

Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.

The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects//locations//clusters//nodePools/'.

StartIPRotationRequest

StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.

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.

The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects//locations//clusters/*'.

UpdateClusterRequest

UpdateClusterRequest updates the settings of a cluster.

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.

A description of the update.

UpdateMasterRequest

UpdateMasterRequest updates the master of the cluster.

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.

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

UpdateNodePoolRequest

UpdateNodePoolRequests update a node pool's image and/or version.

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.

Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.

The desired image type for the node pool.