Package types (2.8.1)

API documentation for container_v1beta1.types package.

Classes

AcceleratorConfig

AcceleratorConfig represents a Hardware Accelerator request. .. attribute:: accelerator_count

The number of the accelerator cards exposed to an instance.

:type: int

AddonsConfig

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

AuthenticatorGroupsConfig

Configuration for returning group information from authenticators.

AutoUpgradeOptions

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

Autopilot

Autopilot is the configuration for Autopilot settings on the cluster.

AutoprovisioningNodePoolDefaults

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

BinaryAuthorization

Configuration for Binary Authorization. .. attribute:: enabled

Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binauthz.

:type: bool

CancelOperationRequest

CancelOperationRequest cancels a single operation. .. attribute:: project_id

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

:type: str

ClientCertificateConfig

Configuration for client certificates on the cluster. .. attribute:: issue_client_certificate

Issue a client certificate.

:type: bool

CloudRunConfig

Configuration options for the Cloud Run feature. .. attribute:: disabled

Whether Cloud Run addon is enabled for this cluster.

:type: bool

Cluster

A Google Kubernetes Engine cluster. .. attribute:: name

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

Lowercase letters, numbers, and hyphens only.
Must start with a letter.
Must end with a number or a letter.

:type: str

ClusterAutoscaling

ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.

ClusterTelemetry

Telemetry integration for the cluster. .. attribute:: type_

Type of the integration.

:type: google.cloud.container_v1beta1.types.ClusterTelemetry.Type

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.

CompleteIPRotationRequest

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

ConfidentialNodes

ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.

ConfigConnectorConfig

Configuration options for the Config Connector add-on. .. attribute:: enabled

Whether Cloud Connector is enabled for this cluster.

:type: bool

CreateClusterRequest

CreateClusterRequest creates a cluster. .. attribute:: project_id

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

:type: str

CreateNodePoolRequest

CreateNodePoolRequest creates a node pool for a cluster. .. attribute:: project_id

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

:type: str

DNSConfig

DNSConfig contains the desired set of options for configuring clusterDNS.

DailyMaintenanceWindow

Time window specified for daily maintenance operations. .. attribute:: start_time

Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

:type: str

DatabaseEncryption

Configuration of etcd encryption. .. attribute:: state

Denotes the state of etcd encryption.

:type: google.cloud.container_v1beta1.types.DatabaseEncryption.State

DatapathProvider

The datapath provider selects the implementation of the Kubernetes networking // model for service resolution and network policy enforcement.

DefaultSnatStatus

DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.

DeleteClusterRequest

DeleteClusterRequest deletes a cluster. .. attribute:: project_id

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

:type: str

DeleteNodePoolRequest

DeleteNodePoolRequest deletes a node pool for a cluster. .. attribute:: project_id

:type: str

DnsCacheConfig

Configuration for NodeLocal DNSCache .. attribute:: enabled

Whether NodeLocal DNSCache is enabled for this cluster.

:type: bool

EphemeralStorageConfig

EphemeralStorageConfig contains configuration for the ephemeral storage filesystem.

GcePersistentDiskCsiDriverConfig

Configuration for the Compute Engine PD CSI driver. .. attribute:: enabled

Whether the Compute Engine PD CSI driver is enabled for this cluster.

:type: bool

GetClusterRequest

GetClusterRequest gets the settings of a cluster. .. attribute:: project_id

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

:type: str

GetJSONWebKeysRequest

GetJSONWebKeysRequest gets the public component of the keys used by the cluster to sign token requests. This will be the jwks_uri for the discover document returned by getOpenIDConfig. See the OpenID Connect Discovery 1.0 specification for details.

GetJSONWebKeysResponse

GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517

GetNodePoolRequest

GetNodePoolRequest retrieves a node pool for a cluster. .. attribute:: project_id

:type: str

GetOpenIDConfigRequest

GetOpenIDConfigRequest gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

GetOpenIDConfigResponse

GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

GetOperationRequest

GetOperationRequest gets a single operation. .. attribute:: project_id

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

:type: str

GetServerConfigRequest

Gets the current Kubernetes Engine service configuration. .. attribute:: project_id

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

:type: str

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.

ILBSubsettingConfig

ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster.

IPAllocationPolicy

Configuration for controlling how IPs are allocated in the cluster.

IdentityServiceConfig

IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API

IntraNodeVisibilityConfig

IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.

IstioConfig

Configuration options for Istio addon. .. attribute:: disabled

Whether Istio is enabled for this cluster.

:type: bool

Jwk

Jwk is a JSON Web Key as specified in RFC 7517 .. attribute:: kty

Key Type.

:type: str

KalmConfig

Configuration options for the KALM addon. .. attribute:: enabled

Whether KALM is enabled for this cluster.

:type: bool

KubernetesDashboard

Configuration for the Kubernetes Dashboard. .. attribute:: disabled

Whether the Kubernetes Dashboard is enabled for this cluster.

:type: bool

LegacyAbac

Configuration for the legacy Attribute Based Access Control authorization mode.

LinuxNodeConfig

Parameters that can be configured on Linux nodes. .. attribute:: sysctls

The Linux kernel parameters to be applied to the nodes and all pods running on the nodes.

The following parameters are supported.

net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

:type: Sequence[google.cloud.container_v1beta1.types.LinuxNodeConfig.SysctlsEntry]

ListClustersRequest

ListClustersRequest lists clusters. .. attribute:: project_id

:type: str

ListClustersResponse

ListClustersResponse is the result of ListClustersRequest. .. attribute:: clusters

A list of clusters in the project in the specified zone, or across all ones.

:type: Sequence[google.cloud.container_v1beta1.types.Cluster]

ListLocationsRequest

ListLocationsRequest is used to request the locations that offer GKE.

ListLocationsResponse

ListLocationsResponse returns the list of all GKE locations and their recommendation state.

ListNodePoolsRequest

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

:type: str

ListNodePoolsResponse

ListNodePoolsResponse is the result of ListNodePoolsRequest. .. attribute:: node_pools

A list of node pools for a cluster.

:type: Sequence[google.cloud.container_v1beta1.types.NodePool]

ListOperationsRequest

ListOperationsRequest lists operations. .. attribute:: project_id

:type: str

ListOperationsResponse

ListOperationsResponse is the result of ListOperationsRequest.

ListUsableSubnetworksRequest

ListUsableSubnetworksRequest requests the list of usable subnetworks. available to a user for creating clusters.

ListUsableSubnetworksResponse

ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.

Location

Location returns the location name, and if the location is recommended for GKE cluster scheduling.

LoggingComponentConfig

LoggingComponentConfig is cluster logging component configuration.

LoggingConfig

LoggingConfig is cluster logging configuration. .. attribute:: component_config

Logging components configuration

:type: google.cloud.container_v1beta1.types.LoggingComponentConfig

MaintenancePolicy

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

MaintenanceWindow

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

Master

Master is the configuration for components on master.

MasterAuth

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

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.

MaxPodsConstraint

Constraints applied to pods. .. attribute:: max_pods_per_node

Constraint enforced on the max num of pods per node.

:type: int

MonitoringComponentConfig

MonitoringComponentConfig is cluster monitoring component configuration.

MonitoringConfig

MonitoringConfig is cluster monitoring configuration. .. attribute:: component_config

Monitoring components configuration

:type: google.cloud.container_v1beta1.types.MonitoringComponentConfig

NetworkConfig

NetworkConfig reports the relative names of network & subnetwork.

NetworkPolicy

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

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.

NetworkTags

Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See tags field in `NodeConfig </kubernetes-engine/docs/reference/rest/v1/NodeConfig>`__).

NodeConfig

Parameters that describe the nodes in a cluster. .. attribute:: machine_type

The name of a Google Compute Engine machine type <https://cloud.google.com/compute/docs/machine-types>__.

If unspecified, the default machine type is e2-medium.

:type: str

NodeConfigDefaults

Subset of NodeConfig message that has defaults.

NodeKubeletConfig

Node kubelet configs. .. attribute:: cpu_manager_policy

Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer- cluster/cpu-management-policies/ The following values are allowed.

"none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.

:type: str

NodeLabels

Collection of node-level Kubernetes labels <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels>__.

NodeManagement

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

NodeNetworkConfig

Parameters for node pool-level network config. .. attribute:: create_pod_range

Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for pod_range and pod_ipv4_cidr_block if they are not specified.

If neither create_pod_range or pod_range are specified, the cluster-level default (ip_allocation_policy.cluster_ipv4_cidr_block) is used.

Only applicable if ip_allocation_policy.use_ip_aliases is true.

This field cannot be changed after the node pool has been created.

:type: bool

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. These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade.

maxUnavailable controls the number of nodes that can be simultaneously unavailable.

maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes.

(maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time).

Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.)

Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available.

NodePoolAutoscaling

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

NodePoolDefaults

Subset of Nodepool message that has defaults. .. attribute:: node_config_defaults

Subset of NodeConfig message that has defaults.

:type: google.cloud.container_v1beta1.types.NodeConfigDefaults

NodeTaint

Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

See here <https://kubernetes.io/docs/concepts/configuration/taint-and-toleration>__ for more information, including usage and the valid values.

NodeTaints

Collection of Kubernetes node taints <https://kubernetes.io/docs/concepts/configuration/taint-and-toleration>__.

NotificationConfig

NotificationConfig is the configuration of notifications. .. attribute:: pubsub

Notification config for Pub/Sub.

:type: google.cloud.container_v1beta1.types.NotificationConfig.PubSub

Operation

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

OperationProgress

Information about operation (or operation stage) progress. .. attribute:: name

A non-parameterized string describing an operation stage. Unset for single-stage operations.

:type: str

PodSecurityPolicyConfig

Configuration for the PodSecurityPolicy feature. .. attribute:: enabled

Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.

:type: bool

PrivateClusterConfig

Configuration options for private clusters. .. attribute:: enable_private_nodes

Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.

:type: bool

PrivateClusterMasterGlobalAccessConfig

Configuration for controlling master global access settings. .. attribute:: enabled

Whenever master is accessible globally or not.

:type: bool

PrivateIPv6GoogleAccess

PrivateIPv6GoogleAccess controls whether and how the pods can communicate with Google Services through gRPC over IPv6.

RecurringTimeWindow

Represents an arbitrary window of time that recurs. .. attribute:: window

The window of the first recurrence.

:type: google.cloud.container_v1beta1.types.TimeWindow

ReleaseChannel

ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled.

ReservationAffinity

ReservationAffinity <https://cloud.google.com/compute/docs/instances/reserving-zonal-resources>__ is the configuration of desired reservation which instances could take capacity from.

ResourceLimit

Contains information about amount of some resource in the cluster. For memory, value should be in GB.

ResourceUsageExportConfig

Configuration for exporting cluster resource usages. .. attribute:: bigquery_destination

Configuration to use BigQuery as usage export destination.

:type: google.cloud.container_v1beta1.types.ResourceUsageExportConfig.BigQueryDestination

RollbackNodePoolUpgradeRequest

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

SandboxConfig

SandboxConfig contains configurations of the sandbox to use for the node.

ServerConfig

Kubernetes Engine service configuration. .. attribute:: default_cluster_version

Version of Kubernetes the service deploys by default.

:type: str

ServiceExternalIPsConfig

Config to block services with externalIPs field. .. attribute:: enabled

Whether Services with ExternalIPs field are allowed or not.

:type: bool

SetAddonsConfigRequest

SetAddonsRequest sets the addons associated with the cluster. .. attribute:: project_id

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

:type: str

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

SetLegacyAbacRequest

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

SetLocationsRequest

SetLocationsRequest sets the locations of the cluster. .. attribute:: project_id

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

:type: str

SetLoggingServiceRequest

SetLoggingServiceRequest sets the logging service of a cluster.

SetMaintenancePolicyRequest

SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

SetMasterAuthRequest

SetMasterAuthRequest updates the admin password of a cluster. .. attribute:: project_id

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

:type: str

SetMonitoringServiceRequest

SetMonitoringServiceRequest sets the monitoring service of a cluster.

SetNetworkPolicyRequest

SetNetworkPolicyRequest enables/disables network policy for a cluster.

SetNodePoolAutoscalingRequest

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

SetNodePoolManagementRequest

SetNodePoolManagementRequest sets the node management properties of a node pool.

SetNodePoolSizeRequest

SetNodePoolSizeRequest sets the size of a node pool. .. attribute:: project_id

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

:type: str

ShieldedInstanceConfig

A set of Shielded Instance options. .. attribute:: enable_secure_boot

Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

:type: bool

ShieldedNodes

Configuration of Shielded Nodes feature. .. attribute:: enabled

Whether Shielded Nodes features are enabled on all nodes in this cluster.

:type: bool

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.

StatusCondition

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

TimeWindow

Represents an arbitrary window of time. .. attribute:: start_time

The time that the window first starts.

:type: google.protobuf.timestamp_pb2.Timestamp

TpuConfig

Configuration for Cloud TPU. .. attribute:: enabled

Whether Cloud TPU integration is enabled or not.

:type: bool

UpdateClusterRequest

UpdateClusterRequest updates the settings of a cluster. .. attribute:: project_id

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

:type: str

UpdateMasterRequest

UpdateMasterRequest updates the master of the cluster. .. attribute:: project_id

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

:type: str

UpdateNodePoolRequest

SetNodePoolVersionRequest updates the version of a node pool. .. attribute:: project_id

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

:type: str

VerticalPodAutoscaling

VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.

VirtualNIC

Configuration of gVNIC feature. .. attribute:: enabled

Whether gVNIC features are enabled in the node pool.

:type: bool

WindowsVersions

Windows server versions. .. attribute:: windows_versions

List of Windows server versions.

:type: Sequence[google.cloud.container_v1beta1.types.WindowsVersions.WindowsVersion]