Types for Google Container v1 API¶
-
class
google.cloud.container_v1.types.
NodeConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Parameters that describe the nodes in a cluster.
-
machine_type
¶ The name of a Google Compute Engine machine type
If unspecified, the default machine type is
e2-medium
.- Type
-
disk_size_gb
¶ 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.
- Type
-
oauth_scopes
¶ 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.
- Type
Sequence[str]
-
service_account
¶ The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the “default” service account is used.
- Type
-
metadata
¶ The metadata key/value pairs assigned to instances in the cluster.
Keys must conform to the regexp
[a-zA-Z0-9-_]+
and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys:“cluster-location”
“cluster-name”
“cluster-uid”
“configure-sh”
“containerd-configure-sh”
“enable-os-login”
“gci-ensure-gke-docker”
“gci-metrics-enabled”
“gci-update-strategy”
“instance-template”
“kube-env”
“startup-script”
“user-data”
“disable-address-manager”
“windows-startup-script-ps1”
“common-psm1”
“k8s-node-setup-psm1”
“install-ssh-psm1”
“user-profile-psm1”
The following keys are reserved for Windows nodes:
“serial-port-logging-enable”
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.
- Type
Sequence[MetadataEntry]
-
image_type
¶ The image type to use for this node. Note that for a given image type, the latest version of it will be used.
- Type
-
labels
¶ 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/
- Type
Sequence[LabelsEntry]
-
local_ssd_count
¶ The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local- ssd for more information.
- Type
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.
- Type
Sequence[str]
-
preemptible
¶ 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
-
accelerators
¶ 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.
- Type
Sequence[AcceleratorConfig]
-
disk_type
¶ Type of the disk attached to each node (e.g. ‘pd-standard’, ‘pd-ssd’ or ‘pd-balanced’)
If unspecified, the default disk type is ‘pd- standard’
- Type
-
min_cpu_platform
¶ 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
minCpuPlatform: "Intel Haswell"
orminCpuPlatform: "Intel Sandy Bridge"
. For more information, read how to specify min CPU platform- Type
-
workload_metadata_config
¶ The workload metadata configuration for this node.
- Type
WorkloadMetadataConfig
-
taints
¶ 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/
- Type
Sequence[NodeTaint]
-
sandbox_config
¶ Sandbox configuration for this node.
- Type
SandboxConfig
-
node_group
¶ Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes.
- Type
-
reservation_affinity
¶ The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.
- Type
ReservationAffinity
-
shielded_instance_config
¶ Shielded Instance options.
- Type
ShieldedInstanceConfig
-
boot_disk_kms_key
¶ The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
- Type
-
class
LabelsEntry
(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶ Bases:
proto.message.Message
-
class
MetadataEntry
(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶ Bases:
proto.message.Message
-
-
class
google.cloud.container_v1.types.
ShieldedInstanceConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
A set of Shielded Instance options.
-
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
-
enable_integrity_monitoring
¶ Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
- Type
-
-
class
google.cloud.container_v1.types.
SandboxConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SandboxConfig contains configurations of the sandbox to use for the node.
-
type_
¶ Type of the sandbox to use for the node.
- Type
Type
-
class
Type
[source]¶ Bases:
proto.enums.Enum
Possible types of sandboxes.
-
-
class
google.cloud.container_v1.types.
ReservationAffinity
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
ReservationAffinity is the configuration of desired reservation which instances could take capacity from.
-
consume_reservation_type
¶ Corresponds to the type of reservation consumption.
- Type
Type
-
key
¶ Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify “googleapis.com/reservation-name” as the key and specify the name of your reservation as its value.
- Type
-
class
Type
[source]¶ Bases:
proto.enums.Enum
Indicates whether to consume capacity from a reservation or not.
-
-
class
google.cloud.container_v1.types.
NodeTaint
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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 for more information, including usage and the valid values.
-
effect
¶ Effect for taint.
- Type
Effect
-
class
Effect
[source]¶ Bases:
proto.enums.Enum
Possible values for Effect in taint.
-
-
class
google.cloud.container_v1.types.
MasterAuth
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.
-
username
¶ The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes- engine/docs/how-to/api-server-authentication
- Type
-
password
¶ 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.
Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes- engine/docs/how-to/api-server-authentication
- Type
-
client_certificate_config
¶ Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
- Type
ClientCertificateConfig
-
cluster_ca_certificate
¶ [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
- Type
-
client_certificate
¶ [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
- Type
-
-
class
google.cloud.container_v1.types.
ClientCertificateConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for client certificates on the cluster.
-
class
google.cloud.container_v1.types.
AddonsConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.
-
http_load_balancing
¶ Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
- Type
HttpLoadBalancing
-
horizontal_pod_autoscaling
¶ 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.
- Type
HorizontalPodAutoscaling
-
kubernetes_dashboard
¶ Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes- engine/docs/concepts/dashboards
- Type
KubernetesDashboard
-
network_policy_config
¶ 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.
- Type
NetworkPolicyConfig
-
cloud_run_config
¶ Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.
- Type
CloudRunConfig
-
dns_cache_config
¶ Configuration for NodeLocalDNS, a dns cache running on cluster nodes
- Type
DnsCacheConfig
-
config_connector_config
¶ Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
- Type
ConfigConnectorConfig
-
-
class
google.cloud.container_v1.types.
HttpLoadBalancing
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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.
-
class
google.cloud.container_v1.types.
HorizontalPodAutoscaling
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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.
-
class
google.cloud.container_v1.types.
KubernetesDashboard
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for the Kubernetes Dashboard.
-
class
google.cloud.container_v1.types.
NetworkPolicyConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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.
-
class
google.cloud.container_v1.types.
DnsCacheConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for NodeLocal DNSCache
-
class
google.cloud.container_v1.types.
PrivateClusterMasterGlobalAccessConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for controlling master global access settings.
-
class
google.cloud.container_v1.types.
PrivateClusterConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration options for private clusters.
-
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
-
enable_private_endpoint
¶ Whether the master’s internal IP address is used as the cluster endpoint.
- Type
-
master_ipv4_cidr_block
¶ The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster’s network.
- Type
-
master_global_access_config
¶ Controls master global access settings.
- Type
PrivateClusterMasterGlobalAccessConfig
-
-
class
google.cloud.container_v1.types.
AuthenticatorGroupsConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for returning group information from authenticators.
-
enabled
¶ Whether this cluster should return group membership lookups during authentication using a group of security groups.
- Type
-
-
class
google.cloud.container_v1.types.
CloudRunConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration options for the Cloud Run feature.
-
load_balancer_type
¶ Which load balancer type is installed for Cloud Run.
- Type
LoadBalancerType
-
class
LoadBalancerType
[source]¶ Bases:
proto.enums.Enum
Load balancer type of ingress service of Cloud Run.
-
-
class
google.cloud.container_v1.types.
ConfigConnectorConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration options for the Config Connector add-on.
-
class
google.cloud.container_v1.types.
MasterAuthorizedNetworksConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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
¶ cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
- Type
Sequence[CidrBlock]
-
class
CidrBlock
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
CidrBlock contains an optional name and one CIDR block.
-
-
class
google.cloud.container_v1.types.
LegacyAbac
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for the legacy Attribute Based Access Control authorization mode.
-
class
google.cloud.container_v1.types.
NetworkPolicy
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services- networking/networkpolicies/
-
provider
¶ The selected network policy provider.
- Type
Provider
-
class
Provider
[source]¶ Bases:
proto.enums.Enum
Allowed Network Policy providers.
-
-
class
google.cloud.container_v1.types.
BinaryAuthorization
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for Binary Authorization.
-
class
google.cloud.container_v1.types.
IPAllocationPolicy
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for controlling how IPs are allocated in the cluster.
-
use_ip_aliases
¶ Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
- Type
-
create_subnetwork
¶ Whether a new subnetwork will be created automatically for the cluster.
This field is only applicable when
use_ip_aliases
is true.- Type
-
subnetwork_name
¶ 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.- Type
-
cluster_secondary_range_name
¶ The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork.
This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
- Type
-
services_secondary_range_name
¶ 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.
- Type
-
cluster_ipv4_cidr_block
¶ 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 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.- Type
-
node_ipv4_cidr_block
¶ 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 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.- Type
-
services_ipv4_cidr_block
¶ 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 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.- Type
-
tpu_ipv4_cidr_block
¶ The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size.
This field is only applicable when
use_ip_aliases
is true.If unspecified, the range will use the default size.
Set to /netmask (e.g.
/14
) to have a range chosen with a specific netmask.Set to a CIDR 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.- Type
-
-
class
google.cloud.container_v1.types.
Cluster
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
A Google Kubernetes Engine cluster.
-
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
-
initial_node_count
¶ 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.
This field is deprecated, use node_pool.initial_node_count instead.
- Type
-
node_config
¶ Parameters used in creating the cluster’s nodes. 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. (For configuration of each node pool, see
node_pool.config
)If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
- Type
NodeConfig
-
master_auth
¶ The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified,
username
will be set to “admin”, a random password will be generated, and a client certificate will be issued.- Type
MasterAuth
-
logging_service
¶ The logging service the cluster should use to write logs. Currently available options:
logging.googleapis.com/kubernetes
- The Cloud Logging service with a Kubernetes-native resource modellogging.googleapis.com
- The legacy Cloud Logging service (no longer available as of GKE 1.15).none
- no logs will be exported from the cluster.
If left as an empty string,
logging.googleapis.com/kubernetes
will be used for GKE 1.14+ orlogging.googleapis.com
for earlier versions.- Type
-
monitoring_service
¶ The monitoring service the cluster should use to write metrics. Currently available options:
“monitoring.googleapis.com/kubernetes” - The Cloud Monitoring service with a Kubernetes-native resource model
monitoring.googleapis.com
- The legacy Cloud Monitoring service (no longer available as of GKE 1.15).none
- No metrics will be exported from the cluster.
If left as an empty string,
monitoring.googleapis.com/kubernetes
will be used for GKE 1.14+ ormonitoring.googleapis.com
for earlier versions.- Type
-
network
¶ The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the
default
network will be used.- Type
-
cluster_ipv4_cidr
¶ 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 in10.0.0.0/8
.- Type
-
addons_config
¶ Configurations for the various addons available to run in the cluster.
- Type
AddonsConfig
-
subnetwork
¶ The name of the Google Compute Engine subnetwork to which the cluster is connected.
- Type
-
node_pools
¶ The node pools associated with this cluster. This field should not be set if “node_config” or “initial_node_count” are specified.
- Type
Sequence[NodePool]
-
locations
¶ The list of Google Compute Engine zones in which the cluster’s nodes should be located.
This field provides a default value if NodePool.Locations are not specified during node pool creation.
Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.
- Type
Sequence[str]
-
enable_kubernetes_alpha
¶ 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.
- Type
-
resource_labels
¶ The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
- Type
Sequence[ResourceLabelsEntry]
-
legacy_abac
¶ Configuration for the legacy ABAC authorization mode.
- Type
LegacyAbac
-
network_policy
¶ Configuration options for the NetworkPolicy feature.
- Type
NetworkPolicy
-
ip_allocation_policy
¶ Configuration for cluster IP allocation.
- Type
IPAllocationPolicy
The configuration options for master authorized networks feature.
- Type
MasterAuthorizedNetworksConfig
-
maintenance_policy
¶ Configure the maintenance policy for this cluster.
- Type
MaintenancePolicy
Configuration for Binary Authorization.
- Type
BinaryAuthorization
-
autoscaling
¶ Cluster-level autoscaling configuration.
- Type
ClusterAutoscaling
-
network_config
¶ Configuration for cluster networking.
- Type
NetworkConfig
-
default_max_pods_constraint
¶ The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.
- Type
MaxPodsConstraint
-
resource_usage_export_config
¶ Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
- Type
ResourceUsageExportConfig
-
authenticator_groups_config
¶ Configuration controlling RBAC group membership information.
- Type
AuthenticatorGroupsConfig
-
private_cluster_config
¶ Configuration for private cluster.
- Type
PrivateClusterConfig
-
database_encryption
¶ Configuration of etcd encryption.
- Type
DatabaseEncryption
-
vertical_pod_autoscaling
¶ Cluster-level Vertical Pod Autoscaling configuration.
- Type
VerticalPodAutoscaling
-
shielded_nodes
¶ Shielded Nodes configuration.
- Type
ShieldedNodes
-
release_channel
¶ Release channel configuration.
- Type
ReleaseChannel
-
workload_identity_config
¶ Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
- Type
WorkloadIdentityConfig
-
zone
¶ [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
- Type
-
endpoint
¶ [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.- Type
-
initial_cluster_version
¶ The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.
Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - “latest”: picks the highest valid Kubernetes version - “1.X”: picks the highest valid patch+gke.N patch in the 1.X version - “1.X.Y”: picks the highest valid gke.N patch in the 1.X.Y version - “1.X.Y-gke.N”: picks an explicit Kubernetes version - “”,”-“: picks the default Kubernetes version
- Type
-
current_node_version
¶ [Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they’re in the process of being upgraded, this reflects the minimum version of all nodes.
- Type
-
status
¶ [Output only] The current status of this cluster.
- Type
Status
-
status_message
¶ [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
- Type
-
node_ipv4_cidr_size
¶ [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the
container_ipv4_cidr
range. This field will only be set when cluster is in route-based network mode.- Type
-
services_ipv4_cidr
¶ [Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g.
1.2.3.4/29
). Service addresses are typically put in the last/16
from the container CIDR.- Type
-
current_node_count
¶ [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
- Type
-
expire_time
¶ [Output only] The time the cluster will be automatically deleted in RFC3339 text format.
- Type
-
location
¶ [Output only] The name of the Google Compute Engine zone or region in which the cluster resides.
- Type
-
tpu_ipv4_cidr_block
¶ [Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g.
1.2.3.4/29
).- Type
-
conditions
¶ Which conditions caused the current cluster state.
- Type
Sequence[StatusCondition]
-
class
ResourceLabelsEntry
(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶ Bases:
proto.message.Message
-
class
Status
[source]¶ Bases:
proto.enums.Enum
The current status of the cluster.
-
-
class
google.cloud.container_v1.types.
ClusterUpdate
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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.
-
desired_node_version
¶ The Kubernetes version to change the nodes to (typically an upgrade).
Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - “latest”: picks the highest valid Kubernetes version - “1.X”: picks the highest valid patch+gke.N patch in the 1.X version - “1.X.Y”: picks the highest valid gke.N patch in the 1.X.Y version - “1.X.Y-gke.N”: picks an explicit Kubernetes version - “-“: picks the Kubernetes master version
- Type
-
desired_monitoring_service
¶ The monitoring service the cluster should use to write metrics. Currently available options:
“monitoring.googleapis.com/kubernetes” - The Cloud Monitoring service with a Kubernetes-native resource model
monitoring.googleapis.com
- The legacy Cloud Monitoring service (no longer available as of GKE 1.15).none
- No metrics will be exported from the cluster.
If left as an empty string,
monitoring.googleapis.com/kubernetes
will be used for GKE 1.14+ ormonitoring.googleapis.com
for earlier versions.- Type
-
desired_addons_config
¶ Configurations for the various addons available to run in the cluster.
- Type
AddonsConfig
-
desired_node_pool_id
¶ 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.
- Type
-
desired_image_type
¶ The desired image type for the node pool. NOTE: Set the “desired_node_pool” field as well.
- Type
-
desired_database_encryption
¶ Configuration of etcd encryption.
- Type
DatabaseEncryption
-
desired_workload_identity_config
¶ Configuration for Workload Identity.
- Type
WorkloadIdentityConfig
-
desired_shielded_nodes
¶ Configuration for Shielded Nodes.
- Type
ShieldedNodes
-
desired_node_pool_autoscaling
¶ 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.
- Type
NodePoolAutoscaling
-
desired_locations
¶ The desired list of Google Compute Engine zones in which the cluster’s nodes should be located.
This list must always include the cluster’s primary zone.
Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
- Type
Sequence[str]
The desired configuration options for master authorized networks feature.
- Type
MasterAuthorizedNetworksConfig
-
desired_cluster_autoscaling
¶ Cluster-level autoscaling configuration.
- Type
ClusterAutoscaling
The desired configuration options for the Binary Authorization feature.
- Type
BinaryAuthorization
-
desired_logging_service
¶ The logging service the cluster should use to write logs. Currently available options:
logging.googleapis.com/kubernetes
- The Cloud Logging service with a Kubernetes-native resource modellogging.googleapis.com
- The legacy Cloud Logging service (no longer available as of GKE 1.15).none
- no logs will be exported from the cluster.
If left as an empty string,
logging.googleapis.com/kubernetes
will be used for GKE 1.14+ orlogging.googleapis.com
for earlier versions.- Type
-
desired_resource_usage_export_config
¶ The desired configuration for exporting resource usage.
- Type
ResourceUsageExportConfig
-
desired_vertical_pod_autoscaling
¶ Cluster-level Vertical Pod Autoscaling configuration.
- Type
VerticalPodAutoscaling
-
desired_private_cluster_config
¶ The desired private cluster configuration.
- Type
PrivateClusterConfig
-
desired_intra_node_visibility_config
¶ The desired config of Intra-node visibility.
- Type
IntraNodeVisibilityConfig
-
desired_default_snat_status
¶ The desired status of whether to disable default sNAT for this cluster.
- Type
DefaultSnatStatus
-
desired_release_channel
¶ The desired release channel configuration.
- Type
ReleaseChannel
-
desired_master_version
¶ 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
- Type
-
-
class
google.cloud.container_v1.types.
Operation
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
-
zone
¶ The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.
- Type
-
operation_type
¶ The operation type.
- Type
Type
-
status
¶ The current status of the operation.
- Type
Status
-
location
¶ [Output only] The name of the Google Compute Engine zone or region in which the cluster resides.
- Type
-
progress
¶ Output only. [Output only] Progress information for an operation.
- Type
OperationProgress
-
cluster_conditions
¶ Which conditions caused the current cluster state.
- Type
Sequence[StatusCondition]
-
nodepool_conditions
¶ Which conditions caused the current node pool state.
- Type
Sequence[StatusCondition]
-
class
Status
[source]¶ Bases:
proto.enums.Enum
Current status of the operation.
-
class
Type
[source]¶ Bases:
proto.enums.Enum
Operation type.
-
-
class
google.cloud.container_v1.types.
OperationProgress
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Information about operation (or operation stage) progress.
-
name
¶ A non-parameterized string describing an operation stage. Unset for single-stage operations.
- Type
-
status
¶ Status of an operation stage. Unset for single-stage operations.
- Type
Status
-
metrics
¶ Progress metric bundle, for example: metrics: [{name: “nodes done”, int_value: 15}, {name: “nodes total”, int_value: 32}] or metrics: [{name: “progress”, double_value: 0.56}, {name: “progress scale”, double_value: 1.0}]
- Type
Sequence[Metric]
-
stages
¶ Substages of an operation or a stage.
- Type
Sequence[OperationProgress]
-
class
Metric
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Progress metric is (string, int|float|string) pair.
-
-
class
google.cloud.container_v1.types.
CreateClusterRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
CreateClusterRequest creates a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
- Type
-
cluster
¶ Required. A cluster resource
- Type
Cluster
-
-
class
google.cloud.container_v1.types.
GetClusterRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
GetClusterRequest gets the settings of a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.
- Type
-
-
class
google.cloud.container_v1.types.
UpdateClusterRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
UpdateClusterRequest updates the settings of a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
update
¶ Required. A description of the update.
- Type
ClusterUpdate
-
-
class
google.cloud.container_v1.types.
UpdateNodePoolRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
UpdateNodePoolRequests update a node pool’s image and/or version.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
node_pool_id
¶ Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
node_version
¶ Required. The Kubernetes version to change the nodes to (typically an upgrade).
Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - “latest”: picks the highest valid Kubernetes version - “1.X”: picks the highest valid patch+gke.N patch in the 1.X version - “1.X.Y”: picks the highest valid gke.N patch in the 1.X.Y version - “1.X.Y-gke.N”: picks an explicit Kubernetes version - “-“: picks the Kubernetes master version
- Type
-
name
¶ The name (project, location, cluster, node pool) of the node pool to update. Specified in the format
projects/*/locations/*/clusters/*/nodePools/*
.- Type
-
locations
¶ The desired list of Google Compute Engine zones in which the node pool’s nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.
- Type
Sequence[str]
-
workload_metadata_config
¶ The desired workload metadata config for the node pool.
- Type
WorkloadMetadataConfig
-
upgrade_settings
¶ Upgrade settings control disruption and speed of the upgrade.
- Type
UpgradeSettings
-
-
class
google.cloud.container_v1.types.
SetNodePoolAutoscalingRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
node_pool_id
¶ Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
autoscaling
¶ Required. Autoscaling configuration for the node pool.
- Type
NodePoolAutoscaling
-
-
class
google.cloud.container_v1.types.
SetLoggingServiceRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetLoggingServiceRequest sets the logging service of a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
logging_service
¶ Required. The logging service the cluster should use to write logs. Currently available options:
logging.googleapis.com/kubernetes
- The Cloud Logging service with a Kubernetes-native resource modellogging.googleapis.com
- The legacy Cloud Logging service (no longer available as of GKE 1.15).none
- no logs will be exported from the cluster.
If left as an empty string,
logging.googleapis.com/kubernetes
will be used for GKE 1.14+ orlogging.googleapis.com
for earlier versions.- Type
-
-
class
google.cloud.container_v1.types.
SetMonitoringServiceRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetMonitoringServiceRequest sets the monitoring service of a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
monitoring_service
¶ Required. The monitoring service the cluster should use to write metrics. Currently available options:
“monitoring.googleapis.com/kubernetes” - The Cloud Monitoring service with a Kubernetes-native resource model
monitoring.googleapis.com
- The legacy Cloud Monitoring service (no longer available as of GKE 1.15).none
- No metrics will be exported from the cluster.
If left as an empty string,
monitoring.googleapis.com/kubernetes
will be used for GKE 1.14+ ormonitoring.googleapis.com
for earlier versions.- Type
-
-
class
google.cloud.container_v1.types.
SetAddonsConfigRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetAddonsConfigRequest sets the addons associated with the cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
addons_config
¶ Required. The desired configurations for the various addons available to run in the cluster.
- Type
AddonsConfig
-
-
class
google.cloud.container_v1.types.
SetLocationsRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetLocationsRequest sets the locations of the cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
locations
¶ Required. The desired list of Google Compute Engine zones 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.
- Type
Sequence[str]
-
-
class
google.cloud.container_v1.types.
UpdateMasterRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
UpdateMasterRequest updates the master of the cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
master_version
¶ Required. 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
- Type
-
-
class
google.cloud.container_v1.types.
SetMasterAuthRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetMasterAuthRequest updates the admin password of a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
- Type
-
action
¶ Required. The exact form of action to be taken on the master auth.
- Type
Action
-
update
¶ Required. A description of the update.
- Type
MasterAuth
-
name
¶ The name (project, location, cluster) of the cluster to set auth. Specified in the format
projects/*/locations/*/clusters/*
.- Type
-
class
Action
[source]¶ Bases:
proto.enums.Enum
Operation type: what type update to perform.
-
-
class
google.cloud.container_v1.types.
DeleteClusterRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
DeleteClusterRequest deletes a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.
- Type
-
-
class
google.cloud.container_v1.types.
ListClustersRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
ListClustersRequest lists clusters.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
- Type
-
-
class
google.cloud.container_v1.types.
ListClustersResponse
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
ListClustersResponse is the result of ListClustersRequest.
-
clusters
¶ A list of clusters in the project in the specified zone, or across all ones.
- Type
Sequence[Cluster]
-
-
class
google.cloud.container_v1.types.
GetOperationRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
GetOperationRequest gets a single operation.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
operation_id
¶ Deprecated. The server-assigned
name
of the operation. This field has been deprecated and replaced by the name field.- Type
-
-
class
google.cloud.container_v1.types.
ListOperationsRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
ListOperationsRequest lists operations.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
- Type
-
-
class
google.cloud.container_v1.types.
CancelOperationRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
CancelOperationRequest cancels a single operation.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.
- Type
-
operation_id
¶ Deprecated. The server-assigned
name
of the operation. This field has been deprecated and replaced by the name field.- Type
-
-
class
google.cloud.container_v1.types.
ListOperationsResponse
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
ListOperationsResponse is the result of ListOperationsRequest.
-
operations
¶ A list of operations in the project in the specified zone.
- Type
Sequence[Operation]
-
-
class
google.cloud.container_v1.types.
GetServerConfigRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Gets the current Kubernetes Engine service configuration.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
-
class
google.cloud.container_v1.types.
ServerConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Kubernetes Engine service configuration.
-
valid_node_versions
¶ List of valid node upgrade target versions, in descending order.
- Type
Sequence[str]
-
channels
¶ List of release channel configurations.
- Type
Sequence[ReleaseChannelConfig]
-
class
ReleaseChannelConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
ReleaseChannelConfig exposes configuration for a release channel.
-
channel
¶ The release channel this configuration applies to.
- Type
Channel
-
-
-
class
google.cloud.container_v1.types.
CreateNodePoolRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
CreateNodePoolRequest creates a node pool for a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
- Type
-
node_pool
¶ Required. The node pool to create.
- Type
NodePool
-
-
class
google.cloud.container_v1.types.
DeleteNodePoolRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
DeleteNodePoolRequest deletes a node pool for a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
- Type
-
node_pool_id
¶ Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.
- Type
-
-
class
google.cloud.container_v1.types.
ListNodePoolsRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
ListNodePoolsRequest lists the node pool(s) for a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
- Type
-
-
class
google.cloud.container_v1.types.
GetNodePoolRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
GetNodePoolRequest retrieves a node pool for a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
- Type
-
node_pool_id
¶ Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.
- Type
-
-
class
google.cloud.container_v1.types.
NodePool
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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.
-
config
¶ The node configuration of the pool.
- Type
NodeConfig
-
initial_node_count
¶ 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.
- Type
-
locations
¶ The list of Google Compute Engine zones in which the NodePool’s nodes should be located.
If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead.
Warning: changing node pool locations will result in nodes being added and/or removed.
- Type
Sequence[str]
-
instance_group_urls
¶ [Output only] The resource URLs of the managed instance groups associated with this node pool.
- Type
Sequence[str]
-
status
¶ [Output only] The status of the nodes in this pool instance.
- Type
Status
-
status_message
¶ [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
- Type
-
autoscaling
¶ Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
- Type
NodePoolAutoscaling
-
management
¶ NodeManagement configuration for this NodePool.
- Type
NodeManagement
-
max_pods_constraint
¶ The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
- Type
MaxPodsConstraint
-
conditions
¶ Which conditions caused the current node pool state.
- Type
Sequence[StatusCondition]
-
upgrade_settings
¶ Upgrade settings control disruption and speed of the upgrade.
- Type
UpgradeSettings
-
class
Status
[source]¶ Bases:
proto.enums.Enum
The current status of the node pool instance.
-
class
UpgradeSettings
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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.
-
max_surge
¶ The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
- Type
The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
- Type
-
-
-
class
google.cloud.container_v1.types.
NodeManagement
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
NodeManagement defines the set of node management services turned on for the node pool.
-
auto_upgrade
¶ A flag that specifies whether node auto- pgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
- Type
-
auto_repair
¶ A flag that specifies whether the node auto- epair 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.
- Type
-
upgrade_options
¶ Specifies the Auto Upgrade knobs for the node pool.
- Type
AutoUpgradeOptions
-
-
class
google.cloud.container_v1.types.
AutoUpgradeOptions
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.
-
class
google.cloud.container_v1.types.
MaintenancePolicy
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
MaintenancePolicy defines the maintenance policy to be used for the cluster.
-
window
¶ Specifies the maintenance window in which maintenance may be performed.
- Type
MaintenanceWindow
-
resource_version
¶ A hash identifying the version of this policy, so that updates to fields of the policy won’t accidentally undo intermediate changes (and so that users of the API unaware of some fields won’t accidentally remove other fields). Make a
get()
request to the cluster to get the current resource version and include it with requests to set the policy.- Type
-
-
class
google.cloud.container_v1.types.
MaintenanceWindow
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
MaintenanceWindow defines the maintenance window to be used for the cluster.
-
daily_maintenance_window
¶ DailyMaintenanceWindow specifies a daily maintenance operation window.
- Type
DailyMaintenanceWindow
-
recurring_window
¶ RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.
- Type
RecurringTimeWindow
-
maintenance_exclusions
¶ Exceptions to maintenance window. Non- mergency maintenance should not occur in these windows.
- Type
Sequence[MaintenanceExclusionsEntry]
-
class
MaintenanceExclusionsEntry
(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶ Bases:
proto.message.Message
-
-
class
google.cloud.container_v1.types.
TimeWindow
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Represents an arbitrary window of time.
-
start_time
¶ The time that the window first starts.
- Type
Timestamp
-
end_time
¶ The time that the window ends. The end time should take place after the start time.
- Type
Timestamp
-
-
class
google.cloud.container_v1.types.
RecurringTimeWindow
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Represents an arbitrary window of time that recurs.
-
window
¶ The window of the first recurrence.
- Type
TimeWindow
-
recurrence
¶ An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time.
For example, to have something repeat every weekday, you’d use:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
To repeat some window daily (equivalent to the DailyMaintenanceWindow):
FREQ=DAILY
For the first weekend of every month:
FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU
This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you’d use something like:
start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC:
start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA
Note the start and end time’s specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
- Type
-
-
class
google.cloud.container_v1.types.
DailyMaintenanceWindow
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Time window specified for daily maintenance operations.
-
class
google.cloud.container_v1.types.
SetNodePoolManagementRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetNodePoolManagementRequest sets the node management properties of a node pool.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
- Type
-
node_pool_id
¶ Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
- Type
-
management
¶ Required. NodeManagement configuration for the node pool.
- Type
NodeManagement
-
-
class
google.cloud.container_v1.types.
SetNodePoolSizeRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetNodePoolSizeRequest sets the size a node pool.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
- Type
-
node_pool_id
¶ Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
- Type
-
-
class
google.cloud.container_v1.types.
RollbackNodePoolUpgradeRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.
- Type
-
node_pool_id
¶ Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
- Type
-
-
class
google.cloud.container_v1.types.
ListNodePoolsResponse
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
ListNodePoolsResponse is the result of ListNodePoolsRequest.
-
node_pools
¶ A list of node pools for a cluster.
- Type
Sequence[NodePool]
-
-
class
google.cloud.container_v1.types.
ClusterAutoscaling
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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.
-
resource_limits
¶ Contains global constraints regarding minimum and maximum amount of resources in the cluster.
- Type
Sequence[ResourceLimit]
-
autoprovisioning_node_pool_defaults
¶ AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
- Type
AutoprovisioningNodePoolDefaults
-
-
class
google.cloud.container_v1.types.
AutoprovisioningNodePoolDefaults
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-
upgrade_settings
¶ Specifies the upgrade settings for NAP created node pools
- Type
UpgradeSettings
-
management
¶ Specifies the node management options for NAP created node-pools.
- Type
NodeManagement
-
min_cpu_platform
¶ Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read how to specify min CPU platform To unset the min cpu platform field pass “automatic” as field value.
- Type
-
disk_size_gb
¶ 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.
- Type
-
disk_type
¶ Type of the disk attached to each node (e.g. ‘pd-standard’, ‘pd-ssd’ or ‘pd-balanced’)
If unspecified, the default disk type is ‘pd- standard’
- Type
-
shielded_instance_config
¶ Shielded Instance options.
- Type
ShieldedInstanceConfig
-
boot_disk_kms_key
¶ The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
- Type
-
-
class
google.cloud.container_v1.types.
ResourceLimit
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Contains information about amount of some resource in the cluster. For memory, value should be in GB.
-
class
google.cloud.container_v1.types.
NodePoolAutoscaling
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.
-
min_node_count
¶ Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.
- Type
-
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.
- Type
-
-
class
google.cloud.container_v1.types.
SetLabelsRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
- Type
-
resource_labels
¶ Required. The labels to set for that cluster.
- Type
Sequence[ResourceLabelsEntry]
-
label_fingerprint
¶ Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a
get()
request to the resource to get the latest fingerprint.- Type
-
name
¶ The name (project, location, cluster id) of the cluster to set labels. Specified in the format
projects/*/locations/*/clusters/*
.- Type
-
class
ResourceLabelsEntry
(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶ Bases:
proto.message.Message
-
-
class
google.cloud.container_v1.types.
SetLegacyAbacRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
- Type
-
-
class
google.cloud.container_v1.types.
StartIPRotationRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
- Type
-
name
¶ The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format
projects/*/locations/*/clusters/*
.- Type
-
-
class
google.cloud.container_v1.types.
CompleteIPRotationRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
CompleteIPRotationRequest moves the cluster master back into single-IP mode.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
- Type
-
-
class
google.cloud.container_v1.types.
AcceleratorConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
AcceleratorConfig represents a Hardware Accelerator request.
-
class
google.cloud.container_v1.types.
WorkloadMetadataConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.
-
mode
¶ Mode is the configuration for how to expose metadata to workloads running on the node pool.
- Type
Mode
-
class
Mode
[source]¶ Bases:
proto.enums.Enum
Mode is the configuration for how to expose metadata to workloads running on the node.
-
-
class
google.cloud.container_v1.types.
SetNetworkPolicyRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetNetworkPolicyRequest enables/disables network policy for a cluster.
-
project_id
¶ Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
- Type
-
zone
¶ Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
- Type
-
cluster_id
¶ Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
- Type
-
network_policy
¶ Required. Configuration options for the NetworkPolicy feature.
- Type
NetworkPolicy
-
-
class
google.cloud.container_v1.types.
SetMaintenancePolicyRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
-
project_id
¶ Required. The Google Developers Console project ID or project number.
- Type
-
maintenance_policy
¶ Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
- Type
MaintenancePolicy
-
-
class
google.cloud.container_v1.types.
StatusCondition
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
-
code
¶ Machine-friendly representation of the condition
- Type
Code
-
class
Code
[source]¶ Bases:
proto.enums.Enum
Code for each condition
-
-
class
google.cloud.container_v1.types.
NetworkConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
NetworkConfig reports the relative names of network & subnetwork.
-
network
¶ Output only. The relative name of the Google Compute Engine [network]`google.container.v1.NetworkConfig.network <https://cloud.google.com/compute/docs/networks-and-firewalls#networks>`__ to which the cluster is connected. Example: projects/my-project/global/networks/my-network
- Type
-
subnetwork
¶ Output only. The relative name of the Google Compute Engine subnetwork to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
- Type
-
enable_intra_node_visibility
¶ Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.
- Type
-
default_snat_status
¶ Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic.
- Type
DefaultSnatStatus
-
-
class
google.cloud.container_v1.types.
GetOpenIDConfigRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
GetOpenIDConfigRequest gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
-
class
google.cloud.container_v1.types.
GetOpenIDConfigResponse
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
-
class
google.cloud.container_v1.types.
GetJSONWebKeysRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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.
-
class
google.cloud.container_v1.types.
Jwk
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Jwk is a JSON Web Key as specified in RFC 7517
-
class
google.cloud.container_v1.types.
GetJSONWebKeysResponse
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517
-
keys
¶ The public component of the keys used by the cluster to sign token requests.
- Type
Sequence[Jwk]
-
-
class
google.cloud.container_v1.types.
ReleaseChannel
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
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.
-
channel
¶ channel specifies which release channel the cluster is subscribed to.
- Type
Channel
-
class
Channel
[source]¶ Bases:
proto.enums.Enum
Possible values for ‘channel’.
-
-
class
google.cloud.container_v1.types.
IntraNodeVisibilityConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.
-
class
google.cloud.container_v1.types.
MaxPodsConstraint
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Constraints applied to pods.
-
class
google.cloud.container_v1.types.
WorkloadIdentityConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
-
class
google.cloud.container_v1.types.
DatabaseEncryption
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration of etcd encryption.
-
state
¶ Denotes the state of etcd encryption.
- Type
State
-
key_name
¶ Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my- project/locations/global/keyRings/my- ring/cryptoKeys/my-key
- Type
-
class
State
[source]¶ Bases:
proto.enums.Enum
State of etcd encryption.
-
-
class
google.cloud.container_v1.types.
ListUsableSubnetworksRequest
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
ListUsableSubnetworksRequest requests the list of usable subnetworks available to a user for creating clusters.
-
parent
¶ The parent project where subnetworks are usable. Specified in the format
projects/*
.- Type
-
filter
¶ Filtering currently only supports equality on the networkProjectId and must be in the form: “networkProjectId=[PROJECTID]”, where
networkProjectId
is the project which owns the listed subnetworks. This defaults to the parent project ID.- Type
-
page_size
¶ The max number of results per page that should be returned. If the number of available results is larger than
page_size
, anext_page_token
is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)- Type
-
-
class
google.cloud.container_v1.types.
ListUsableSubnetworksResponse
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.
-
subnetworks
¶ A list of usable subnetworks in the specified network project.
- Type
Sequence[UsableSubnetwork]
-
-
class
google.cloud.container_v1.types.
UsableSubnetworkSecondaryRange
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Secondary IP range of a usable subnetwork.
-
range_name
¶ The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance.
- Type
-
status
¶ This field is to determine the status of the secondary range programmably.
- Type
Status
-
class
Status
[source]¶ Bases:
proto.enums.Enum
Status shows the current usage of a secondary IP range.
-
-
class
google.cloud.container_v1.types.
UsableSubnetwork
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range.
-
subnetwork
¶ Subnetwork Name. Example: projects/my-project/regions/us- central1/subnetworks/my-subnet
- Type
-
secondary_ip_ranges
¶ Secondary IP ranges.
- Type
Sequence[UsableSubnetworkSecondaryRange]
-
status_message
¶ A human readable status message representing the reasons for cases where the caller cannot use the secondary ranges under the subnet. For example if the secondary_ip_ranges is empty due to a permission issue, an insufficient permission message will be given by status_message.
- Type
-
-
class
google.cloud.container_v1.types.
ResourceUsageExportConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration for exporting cluster resource usages.
-
bigquery_destination
¶ Configuration to use BigQuery as usage export destination.
- Type
BigQueryDestination
-
enable_network_egress_metering
¶ Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
- Type
-
consumption_metering_config
¶ Configuration to enable resource consumption metering.
- Type
ConsumptionMeteringConfig
-
class
BigQueryDestination
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Parameters for using BigQuery as the destination of resource usage export.
-
class
ConsumptionMeteringConfig
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Parameters for controlling consumption metering.
-
-
class
google.cloud.container_v1.types.
VerticalPodAutoscaling
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.
-
class
google.cloud.container_v1.types.
DefaultSnatStatus
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.
-
class
google.cloud.container_v1.types.
ShieldedNodes
(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶ Bases:
proto.message.Message
Configuration of Shielded Nodes feature.