Types for Google Cloud Container v1 API¶
- class google.cloud.container_v1.types.AcceleratorConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAcceleratorConfig represents a Hardware Accelerator request.
- gpu_partition_size¶
Size of partitions to create on the GPU. Valid values are described in the NVIDIA mig user guide.
- Type
- gpu_sharing_config¶
The configuration for GPU sharing options.
This field is a member of oneof
_gpu_sharing_config.
- class google.cloud.container_v1.types.AdditionalNodeNetworkConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
- class google.cloud.container_v1.types.AdditionalPodNetworkConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message
- secondary_pod_range¶
The name of the secondary range on the subnet which provides IP address for this pod range.
- Type
- class google.cloud.container_v1.types.AdditionalPodRangesConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.
- pod_range_names¶
Name for pod secondary ipv4 range which has the actual range defined ahead.
- Type
MutableSequence[str]
- pod_range_info¶
Output only. Information for additional pod range.
- Type
MutableSequence[google.cloud.container_v1.types.RangeInfo]
- class google.cloud.container_v1.types.AddonsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration 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.
- 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.
- 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
- 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.
- cloud_run_config¶
Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.
- dns_cache_config¶
Configuration for NodeLocalDNS, a dns cache running on cluster nodes
- config_connector_config¶
Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
- gce_persistent_disk_csi_driver_config¶
Configuration for the Compute Engine Persistent Disk CSI driver.
- gcp_filestore_csi_driver_config¶
Configuration for the GCP Filestore CSI driver.
- gke_backup_agent_config¶
Configuration for the Backup for GKE agent addon.
- gcs_fuse_csi_driver_config¶
Configuration for the Cloud Storage Fuse CSI driver.
- stateful_ha_config¶
Optional. Configuration for the StatefulHA add-on.
- parallelstore_csi_driver_config¶
Configuration for the Cloud Storage Parallelstore CSI driver.
- ray_operator_config¶
Optional. Configuration for Ray Operator addon.
- class google.cloud.container_v1.types.AdvancedDatapathObservabilityConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.
- relay_mode¶
Method used to make Relay available
- class RelayMode(value)[source]¶
Bases:
proto.enums.EnumSupported Relay modes
- Values:
- RELAY_MODE_UNSPECIFIED (0):
Default value. This shouldn’t be used.
- DISABLED (1):
disabled
- INTERNAL_VPC_LB (3):
exposed via internal load balancer
- EXTERNAL_LB (4):
exposed via external load balancer
- class google.cloud.container_v1.types.AdvancedMachineFeatures(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies options for controlling advanced machine features.
- class google.cloud.container_v1.types.AuthenticatorGroupsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration 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.AutoUpgradeOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.
- class google.cloud.container_v1.types.Autopilot(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAutopilot is the configuration for Autopilot settings on the cluster.
- workload_policy_config¶
Workload policy configuration for Autopilot.
- class google.cloud.container_v1.types.AutopilotCompatibilityIssue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAutopilotCompatibilityIssue contains information about a specific compatibility issue with Autopilot mode.
- last_observation¶
The last time when this issue was observed.
- incompatibility_type¶
The incompatibility type of this issue.
- class IssueType(value)[source]¶
Bases:
proto.enums.EnumThe type of the reported issue.
- Values:
- UNSPECIFIED (0):
Default value, should not be used.
- INCOMPATIBILITY (1):
Indicates that the issue is a known incompatibility between the cluster and Autopilot mode.
- ADDITIONAL_CONFIG_REQUIRED (2):
Indicates the issue is an incompatibility if customers take no further action to resolve.
- PASSED_WITH_OPTIONAL_CONFIG (3):
Indicates the issue is not an incompatibility, but depending on the workloads business logic, there is a potential that they won’t work on Autopilot.
- class google.cloud.container_v1.types.AutoprovisioningNodePoolDefaults(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
- upgrade_settings¶
Specifies the upgrade settings for NAP created node pools
- management¶
Specifies the node management options for NAP created node-pools.
- min_cpu_platform¶
Deprecated. 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. This field is deprecated, min_cpu_platform should be specified using
cloud.google.com/requested-min-cpu-platformlabel selector on the pod. 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.
- 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
- image_type¶
The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
- Type
- class google.cloud.container_v1.types.BestEffortProvisioning(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBest effort provisioning.
- enabled¶
When this is enabled, cluster/node pool creations will ignore non-fatal errors like stockout to best provision as many nodes as possible right now and eventually bring up all target number of nodes
- Type
- class google.cloud.container_v1.types.BinaryAuthorization(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for Binary Authorization.
- enabled¶
This field is deprecated. Leave this unset and instead configure BinaryAuthorization using evaluation_mode. If evaluation_mode is set to anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored.
- Type
- evaluation_mode¶
Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
- class EvaluationMode(value)[source]¶
Bases:
proto.enums.EnumBinary Authorization mode of operation.
- Values:
- EVALUATION_MODE_UNSPECIFIED (0):
Default value
- DISABLED (1):
Disable BinaryAuthorization
- PROJECT_SINGLETON_POLICY_ENFORCE (2):
Enforce Kubernetes admission requests with BinaryAuthorization using the project’s singleton policy. This is equivalent to setting the enabled boolean to true.
- class google.cloud.container_v1.types.BlueGreenSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSettings for blue-green upgrade.
- standard_rollout_policy¶
Standard policy for the blue-green upgrade.
This field is a member of oneof
rollout_policy.
- node_pool_soak_duration¶
Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
This field is a member of oneof
_node_pool_soak_duration.
- class StandardRolloutPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStandard rollout policy is the default policy for blue-green.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- batch_percentage¶
Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
This field is a member of oneof
update_batch_size.- Type
- batch_node_count¶
Number of blue nodes to drain in a batch.
This field is a member of oneof
update_batch_size.- Type
- class google.cloud.container_v1.types.CancelOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCancelOperationRequest 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
nameof the operation. This field has been deprecated and replaced by the name field.- Type
- class google.cloud.container_v1.types.CheckAutopilotCompatibilityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCheckAutopilotCompatibilityRequest requests getting the blockers for the given operation in the cluster.
- class google.cloud.container_v1.types.CheckAutopilotCompatibilityResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCheckAutopilotCompatibilityResponse has a list of compatibility issues.
- issues¶
The list of issues for the given operation.
- Type
MutableSequence[google.cloud.container_v1.types.AutopilotCompatibilityIssue]
- class google.cloud.container_v1.types.ClientCertificateConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for client certificates on the cluster.
- class google.cloud.container_v1.types.CloudRunConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration options for the Cloud Run feature.
- load_balancer_type¶
Which load balancer type is installed for Cloud Run.
- class LoadBalancerType(value)[source]¶
Bases:
proto.enums.EnumLoad balancer type of ingress service of Cloud Run.
- Values:
- LOAD_BALANCER_TYPE_UNSPECIFIED (0):
Load balancer type for Cloud Run is unspecified.
- LOAD_BALANCER_TYPE_EXTERNAL (1):
Install external load balancer for Cloud Run.
- LOAD_BALANCER_TYPE_INTERNAL (2):
Install internal load balancer for Cloud Run.
- class google.cloud.container_v1.types.Cluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.
- 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,
usernamewill be set to “admin”, a random password will be generated, and a client certificate will be issued.
- 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/kuberneteswill be used for GKE 1.14+ orlogging.googleapis.comfor 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/kuberneteswill be used for GKE 1.14+ ormonitoring.googleapis.comfor earlier versions.- Type
- network¶
The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the
defaultnetwork 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/14block in10.0.0.0/8.- Type
- addons_config¶
Configurations for the various addons available to run in the cluster.
- 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
MutableSequence[google.cloud.container_v1.types.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
MutableSequence[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.
- legacy_abac¶
Configuration for the legacy ABAC authorization mode.
- network_policy¶
Configuration options for the NetworkPolicy feature.
- ip_allocation_policy¶
Configuration for cluster IP allocation.
- master_authorized_networks_config¶
The configuration options for master authorized networks feature.
Deprecated: Use [ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config] instead.
- maintenance_policy¶
Configure the maintenance policy for this cluster.
- binary_authorization¶
Configuration for Binary Authorization.
- autoscaling¶
Cluster-level autoscaling configuration.
- network_config¶
Configuration for cluster networking.
- 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.
- resource_usage_export_config¶
Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
- authenticator_groups_config¶
Configuration controlling RBAC group membership information.
- private_cluster_config¶
Configuration for private cluster.
- database_encryption¶
Configuration of etcd encryption.
- vertical_pod_autoscaling¶
Cluster-level Vertical Pod Autoscaling configuration.
- shielded_nodes¶
Shielded Nodes configuration.
- release_channel¶
Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.
- workload_identity_config¶
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
- mesh_certificates¶
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
- cost_management_config¶
Configuration for the fine-grained cost management feature.
- notification_config¶
Notification configuration of the cluster.
- confidential_nodes¶
Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
- identity_service_config¶
Configuration for Identity Service component.
- 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
masterAuthproperty 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.
- 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_cidrrange. 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/16from the container CIDR.- Type
- instance_group_urls¶
Output only. Deprecated. Use node_pools.instance_group_urls.
- Type
MutableSequence[str]
- 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
MutableSequence[google.cloud.container_v1.types.StatusCondition]
- autopilot¶
Autopilot configuration for the cluster.
- node_pool_defaults¶
Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
This field is a member of oneof
_node_pool_defaults.
- logging_config¶
Logging configuration for the cluster.
- monitoring_config¶
Monitoring configuration for the cluster.
- node_pool_auto_config¶
Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
- etag¶
This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
- Type
- fleet¶
Fleet information for the cluster.
- security_posture_config¶
Enable/Disable Security Posture API features for the cluster.
- control_plane_endpoints_config¶
Configuration for all cluster’s control plane endpoints.
- enable_k8s_beta_apis¶
Beta APIs Config
- enterprise_config¶
GKE Enterprise Configuration.
- secret_manager_config¶
Secret CSI driver configuration.
- compliance_posture_config¶
Enable/Disable Compliance Posture features for the cluster.
- satisfies_pzs¶
Output only. Reserved for future use.
This field is a member of oneof
_satisfies_pzs.- Type
- satisfies_pzi¶
Output only. Reserved for future use.
This field is a member of oneof
_satisfies_pzi.- Type
- user_managed_keys_config¶
The Custom keys configuration for the cluster.
This field is a member of oneof
_user_managed_keys_config.
- rbac_binding_config¶
RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
This field is a member of oneof
_rbac_binding_config.
- class ResourceLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class Status(value)[source]¶
Bases:
proto.enums.EnumThe current status of the cluster.
- Values:
- STATUS_UNSPECIFIED (0):
Not set.
- PROVISIONING (1):
The PROVISIONING state indicates the cluster is being created.
- RUNNING (2):
The RUNNING state indicates the cluster has been created and is fully usable.
- RECONCILING (3):
The RECONCILING state indicates that some work is actively being done on the cluster, such as upgrading the master or node software. Details can be found in the
statusMessagefield.- STOPPING (4):
The STOPPING state indicates the cluster is being deleted.
- ERROR (5):
The ERROR state indicates the cluster is unusable. It will be automatically deleted. Details can be found in the
statusMessagefield.- DEGRADED (6):
The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the
statusMessagefield.
- class google.cloud.container_v1.types.ClusterAutoscaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageClusterAutoscaling 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
MutableSequence[google.cloud.container_v1.types.ResourceLimit]
- autoscaling_profile¶
Defines autoscaling behaviour.
- autoprovisioning_node_pool_defaults¶
AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
- autoprovisioning_locations¶
The list of Google Compute Engine zones in which the NodePool’s nodes can be created by NAP.
- Type
MutableSequence[str]
- class AutoscalingProfile(value)[source]¶
Bases:
proto.enums.EnumDefines possible options for autoscaling_profile field.
- Values:
- PROFILE_UNSPECIFIED (0):
No change to autoscaling configuration.
- OPTIMIZE_UTILIZATION (1):
Prioritize optimizing utilization of resources.
- BALANCED (2):
Use default (balanced) autoscaling configuration.
- class google.cloud.container_v1.types.ClusterUpdate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageClusterUpdate 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/kuberneteswill be used for GKE 1.14+ ormonitoring.googleapis.comfor earlier versions.- Type
- desired_addons_config¶
Configurations for the various addons available to run in the cluster.
- 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.
- desired_workload_identity_config¶
Configuration for Workload Identity.
- desired_mesh_certificates¶
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
- desired_shielded_nodes¶
Configuration for Shielded Nodes.
- desired_cost_management_config¶
The desired configuration for the fine-grained cost management feature.
- desired_dns_config¶
DNSConfig contains clusterDNS config for this cluster.
- 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.
- 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
MutableSequence[str]
- desired_master_authorized_networks_config¶
The desired configuration options for master authorized networks feature.
Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.authorized_networks_config instead.
- desired_cluster_autoscaling¶
Cluster-level autoscaling configuration.
- desired_binary_authorization¶
The desired configuration options for the Binary Authorization feature.
- 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/kuberneteswill be used for GKE 1.14+ orlogging.googleapis.comfor earlier versions.- Type
- desired_resource_usage_export_config¶
The desired configuration for exporting resource usage.
- desired_vertical_pod_autoscaling¶
Cluster-level Vertical Pod Autoscaling configuration.
- desired_private_cluster_config¶
The desired private cluster configuration. master_global_access_config is the only field that can be changed via this field. See also [ClusterUpdate.desired_enable_private_endpoint][google.container.v1.ClusterUpdate.desired_enable_private_endpoint] for modifying other fields within [PrivateClusterConfig][google.container.v1.PrivateClusterConfig].
Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.global_access instead.
- desired_intra_node_visibility_config¶
The desired config of Intra-node visibility.
- desired_default_snat_status¶
The desired status of whether to disable default sNAT for this cluster.
- desired_release_channel¶
The desired release channel configuration.
- desired_l4ilb_subsetting_config¶
The desired L4 Internal Load Balancer Subsetting configuration.
- desired_datapath_provider¶
The desired datapath provider for the cluster.
- desired_private_ipv6_google_access¶
The desired state of IPv6 connectivity to Google Services.
- desired_notification_config¶
The desired notification configuration.
- desired_authenticator_groups_config¶
The desired authenticator groups config for the cluster.
- desired_logging_config¶
The desired logging configuration.
- desired_monitoring_config¶
The desired monitoring configuration.
- desired_identity_service_config¶
The desired Identity Service component configuration.
- desired_service_external_ips_config¶
ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.
- desired_enable_private_endpoint¶
Enable/Disable private endpoint for the cluster’s master.
Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true.
This field is a member of oneof
_desired_enable_private_endpoint.- Type
- desired_default_enable_private_nodes¶
Override the default setting of whether future created nodes have private IP addresses only, namely [NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes]
This field is a member of oneof
_desired_default_enable_private_nodes.- Type
- desired_control_plane_endpoints_config¶
[Control plane endpoints][google.container.v1.Cluster.control_plane_endpoints_config] configuration.
- 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
- desired_gcfs_config¶
The desired GCFS config for the cluster
- desired_node_pool_auto_config_network_tags¶
The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
- desired_gateway_api_config¶
The desired config of Gateway API on this cluster.
- etag¶
The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.
- Type
- desired_node_pool_logging_config¶
The desired node pool logging configuration defaults for the cluster.
- desired_fleet¶
The desired fleet configuration for the cluster.
- desired_stack_type¶
The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.
- additional_pod_ranges_config¶
The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.
- removed_additional_pod_ranges_config¶
The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the ‘additional_pod_ranges_config’ argument.
- enable_k8s_beta_apis¶
Kubernetes open source beta apis enabled on the cluster. Only beta apis
- desired_security_posture_config¶
Enable/Disable Security Posture API features for the cluster.
- desired_network_performance_config¶
The desired network performance config.
- desired_enable_fqdn_network_policy¶
Enable/Disable FQDN Network Policy for the cluster.
This field is a member of oneof
_desired_enable_fqdn_network_policy.- Type
- desired_autopilot_workload_policy_config¶
The desired workload policy configuration for the autopilot cluster.
- desired_k8s_beta_apis¶
Desired Beta APIs to be enabled for cluster.
- desired_containerd_config¶
The desired containerd config for the cluster.
- desired_enable_multi_networking¶
Enable/Disable Multi-Networking for the cluster
This field is a member of oneof
_desired_enable_multi_networking.- Type
- desired_node_pool_auto_config_resource_manager_tags¶
The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
- desired_in_transit_encryption_config¶
Specify the details of in-transit encryption.
This field is a member of oneof
_desired_in_transit_encryption_config.
- desired_enable_cilium_clusterwide_network_policy¶
Enable/Disable Cilium Clusterwide Network Policy for the cluster.
This field is a member of oneof
_desired_enable_cilium_clusterwide_network_policy.- Type
- desired_secret_manager_config¶
Enable/Disable Secret Manager Config.
This field is a member of oneof
_desired_secret_manager_config.
- desired_compliance_posture_config¶
Enable/Disable Compliance Posture features for the cluster.
This field is a member of oneof
_desired_compliance_posture_config.
- desired_node_kubelet_config¶
The desired node kubelet config for the cluster.
- desired_node_pool_auto_config_kubelet_config¶
The desired node kubelet config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
- user_managed_keys_config¶
The Custom keys configuration for the cluster.
- desired_rbac_binding_config¶
RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
This field is a member of oneof
_desired_rbac_binding_config.
- desired_enterprise_config¶
The desired enterprise configuration for the cluster.
- desired_node_pool_auto_config_linux_node_config¶
The desired Linux node config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
Currently only
cgroup_modecan be set here.
- class google.cloud.container_v1.types.CompleteIPRotationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCompleteIPRotationRequest 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.CompleteNodePoolUpgradeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCompleteNodePoolUpgradeRequest sets the name of target node pool to complete upgrade.
- class google.cloud.container_v1.types.CompliancePostureConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.
- compliance_standards¶
List of enabled compliance standards.
- Type
MutableSequence[google.cloud.container_v1.types.CompliancePostureConfig.ComplianceStandard]
- class ComplianceStandard(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefines the details of a compliance standard.
- class Mode(value)[source]¶
Bases:
proto.enums.EnumMode defines enablement mode for Compliance Posture.
- Values:
- MODE_UNSPECIFIED (0):
Default value not specified.
- DISABLED (1):
Disables Compliance Posture features on the cluster.
- ENABLED (2):
Enables Compliance Posture features on the cluster.
- class google.cloud.container_v1.types.ConfidentialNodes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.
- class google.cloud.container_v1.types.ConfigConnectorConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration options for the Config Connector add-on.
- class google.cloud.container_v1.types.ContainerdConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContainerdConfig contains configuration to customize containerd.
- private_registry_access_config¶
PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
- class PrivateRegistryAccessConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePrivateRegistryAccessConfig contains access configuration for private container registries.
- certificate_authority_domain_config¶
Private registry access configuration.
- class CertificateAuthorityDomainConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
- fqdns¶
List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples:
my.customdomain.com
10.0.1.2:5000
- Type
MutableSequence[str]
- gcp_secret_manager_certificate_config¶
Google Secret Manager (GCP) certificate configuration.
This field is a member of oneof
certificate_config.
- class GCPSecretManagerCertificateConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGCPSecretManagerCertificateConfig configures a secret from Google Secret Manager.
- class google.cloud.container_v1.types.ControlPlaneEndpointsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for all of the cluster’s control plane endpoints.
- dns_endpoint_config¶
DNS endpoint configuration.
- ip_endpoints_config¶
IP endpoints configuration.
- class DNSEndpointConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes the configuration of a DNS endpoint.
- endpoint¶
Output only. The cluster’s DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of [DNSEndpointConfig.allow_external_traffic][google.container.v1.ControlPlaneEndpointsConfig.DNSEndpointConfig.allow_external_traffic].
- Type
- class IPEndpointsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIP endpoints configuration.
- enable_public_endpoint¶
Controls whether the control plane allows access through a public IP. It is invalid to specify both [PrivateClusterConfig.enablePrivateEndpoint][] and this field at the same time.
This field is a member of oneof
_enable_public_endpoint.- Type
- global_access¶
Controls whether the control plane’s private endpoint is accessible from sources in other regions. It is invalid to specify both [PrivateClusterMasterGlobalAccessConfig.enabled][google.container.v1.PrivateClusterMasterGlobalAccessConfig.enabled] and this field at the same time.
This field is a member of oneof
_global_access.- Type
- authorized_networks_config¶
Configuration of authorized networks. If enabled, restricts access to the control plane based on source IP. It is invalid to specify both [Cluster.masterAuthorizedNetworksConfig][] and this field at the same time.
- public_endpoint¶
Output only. The external IP address of this cluster’s control plane. Only populated if enabled.
- Type
- private_endpoint¶
Output only. The internal IP address of this cluster’s control plane. Only populated if enabled.
- Type
- class google.cloud.container_v1.types.CostManagementConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for fine-grained cost management feature.
- class google.cloud.container_v1.types.CreateClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreateClusterRequest 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
- class google.cloud.container_v1.types.CreateNodePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreateNodePoolRequest 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.
- class google.cloud.container_v1.types.DNSConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDNSConfig contains the desired set of options for configuring clusterDNS.
- cluster_dns¶
cluster_dns indicates which in-cluster DNS provider should be used.
- cluster_dns_scope¶
cluster_dns_scope indicates the scope of access to cluster DNS records.
- class DNSScope(value)[source]¶
Bases:
proto.enums.EnumDNSScope lists the various scopes of access to cluster DNS records.
- Values:
- DNS_SCOPE_UNSPECIFIED (0):
Default value, will be inferred as cluster scope.
- CLUSTER_SCOPE (1):
DNS records are accessible from within the cluster.
- VPC_SCOPE (2):
DNS records are accessible from within the VPC.
- class Provider(value)[source]¶
Bases:
proto.enums.EnumProvider lists the various in-cluster DNS providers.
- Values:
- PROVIDER_UNSPECIFIED (0):
Default value
- PLATFORM_DEFAULT (1):
Use GKE default DNS provider(kube-dns) for DNS resolution.
- CLOUD_DNS (2):
Use CloudDNS for DNS resolution.
- KUBE_DNS (3):
Use KubeDNS for DNS resolution.
- class google.cloud.container_v1.types.DailyMaintenanceWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTime window specified for daily maintenance operations.
- class google.cloud.container_v1.types.DatabaseEncryption(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration of etcd encryption.
- 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
- state¶
The desired state of etcd encryption.
- current_state¶
Output only. The current state of etcd encryption.
This field is a member of oneof
_current_state.
- decryption_keys¶
Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in
key_name.Each item is a CloudKMS key resource.
- Type
MutableSequence[str]
- last_operation_errors¶
Output only. Records errors seen during DatabaseEncryption update operations.
- Type
MutableSequence[google.cloud.container_v1.types.DatabaseEncryption.OperationError]
- class CurrentState(value)[source]¶
Bases:
proto.enums.EnumCurrent State of etcd encryption.
- Values:
- CURRENT_STATE_UNSPECIFIED (0):
Should never be set
- CURRENT_STATE_ENCRYPTED (7):
Secrets in etcd are encrypted.
- CURRENT_STATE_DECRYPTED (2):
Secrets in etcd are stored in plain text (at etcd level) - this is unrelated to Compute Engine level full disk encryption.
- CURRENT_STATE_ENCRYPTION_PENDING (3):
Encryption (or re-encryption with a different CloudKMS key) of Secrets is in progress.
- CURRENT_STATE_ENCRYPTION_ERROR (4):
Encryption (or re-encryption with a different CloudKMS key) of Secrets in etcd encountered an error.
- CURRENT_STATE_DECRYPTION_PENDING (5):
De-crypting Secrets to plain text in etcd is in progress.
- CURRENT_STATE_DECRYPTION_ERROR (6):
De-crypting Secrets to plain text in etcd encountered an error.
- class OperationError(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.
- timestamp¶
Time when the CloudKMS error was seen.
- class State(value)[source]¶
Bases:
proto.enums.EnumState of etcd encryption.
- Values:
- UNKNOWN (0):
Should never be set
- ENCRYPTED (1):
Secrets in etcd are encrypted.
- DECRYPTED (2):
Secrets in etcd are stored in plain text (at etcd level) - this is unrelated to Compute Engine level full disk encryption.
- class google.cloud.container_v1.types.DatapathProvider(value)[source]¶
Bases:
proto.enums.EnumThe datapath provider selects the implementation of the Kubernetes networking model for service resolution and network policy enforcement.
- Values:
- DATAPATH_PROVIDER_UNSPECIFIED (0):
Default value.
- LEGACY_DATAPATH (1):
Use the IPTables implementation based on kube-proxy.
- ADVANCED_DATAPATH (2):
Use the eBPF based GKE Dataplane V2 with additional features. See the GKE Dataplane V2 documentation for more.
- class google.cloud.container_v1.types.DefaultSnatStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.
- class google.cloud.container_v1.types.DeleteClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDeleteClusterRequest 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.DeleteNodePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDeleteNodePoolRequest 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.DesiredEnterpriseConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDesiredEnterpriseConfig is a wrapper used for updating enterprise_config.
- desired_tier¶
desired_tier specifies the desired tier of the cluster.
- class google.cloud.container_v1.types.DnsCacheConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for NodeLocal DNSCache
- class google.cloud.container_v1.types.EnterpriseConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEnterpriseConfig is the cluster enterprise configuration.
- cluster_tier¶
Output only. cluster_tier indicates the effective tier of the cluster.
- desired_tier¶
desired_tier specifies the desired tier of the cluster.
- class ClusterTier(value)[source]¶
Bases:
proto.enums.EnumPremium tiers for GKE Cluster.
- Values:
- CLUSTER_TIER_UNSPECIFIED (0):
CLUSTER_TIER_UNSPECIFIED is when cluster_tier is not set.
- STANDARD (1):
STANDARD indicates a standard GKE cluster.
- ENTERPRISE (2):
ENTERPRISE indicates a GKE Enterprise cluster.
- class google.cloud.container_v1.types.EphemeralStorageLocalSsdConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs.
- local_ssd_count¶
Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces.
A zero (or unset) value has different meanings depending on machine type being used:
For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn’t support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
- Type
- class google.cloud.container_v1.types.FastSocket(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration of Fast Socket feature.
- class google.cloud.container_v1.types.Fleet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFleet is the fleet configuration for the cluster.
- project¶
The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered.
- Type
- membership¶
Output only. The full resource name of the registered fleet membership of the cluster, in the format
//gkehub.googleapis.com/projects/*/locations/*/memberships/*.- Type
- class google.cloud.container_v1.types.GPUDriverInstallationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGPUDriverInstallationConfig specifies the version of GPU driver to be auto installed.
- gpu_driver_version¶
Mode for how the GPU driver is installed.
This field is a member of oneof
_gpu_driver_version.
- class GPUDriverVersion(value)[source]¶
Bases:
proto.enums.EnumThe GPU driver version to install.
- Values:
- GPU_DRIVER_VERSION_UNSPECIFIED (0):
Default value is to not install any GPU driver.
- INSTALLATION_DISABLED (1):
Disable GPU driver auto installation and needs manual installation
- DEFAULT (2):
“Default” GPU driver in COS and Ubuntu.
- LATEST (3):
“Latest” GPU driver in COS.
- class google.cloud.container_v1.types.GPUSharingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators.
The max number of containers that can share a physical GPU.
- Type
- gpu_sharing_strategy¶
The type of GPU sharing strategy to enable on the GPU node.
This field is a member of oneof
_gpu_sharing_strategy.
- class GPUSharingStrategy(value)[source]¶
Bases:
proto.enums.EnumThe type of GPU sharing strategy currently provided.
- Values:
- GPU_SHARING_STRATEGY_UNSPECIFIED (0):
Default value.
- TIME_SHARING (1):
GPUs are time-shared between containers.
- MPS (2):
GPUs are shared between containers with NVIDIA MPS.
- class google.cloud.container_v1.types.GatewayAPIConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGatewayAPIConfig contains the desired config of Gateway API on this cluster.
- channel¶
The Gateway API release channel to use for Gateway API.
- class Channel(value)[source]¶
Bases:
proto.enums.EnumChannel describes if/how Gateway API should be installed and implemented in a cluster.
- Values:
- CHANNEL_UNSPECIFIED (0):
Default value.
- CHANNEL_DISABLED (1):
Gateway API support is disabled
- CHANNEL_EXPERIMENTAL (3):
Deprecated: use CHANNEL_STANDARD instead. Gateway API support is enabled, experimental CRDs are installed
- CHANNEL_STANDARD (4):
Gateway API support is enabled, standard CRDs are installed
- class google.cloud.container_v1.types.GcePersistentDiskCsiDriverConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for the Compute Engine PD CSI driver.
- class google.cloud.container_v1.types.GcfsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGcfsConfig contains configurations of Google Container File System (image streaming).
- class google.cloud.container_v1.types.GcpFilestoreCsiDriverConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for the GCP Filestore CSI driver.
- class google.cloud.container_v1.types.GcsFuseCsiDriverConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for the Cloud Storage Fuse CSI driver.
- class google.cloud.container_v1.types.GetClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGetClusterRequest 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.GetJSONWebKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGetJSONWebKeysRequest 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.GetJSONWebKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGetJSONWebKeysResponse 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
MutableSequence[google.cloud.container_v1.types.Jwk]
- class google.cloud.container_v1.types.GetNodePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGetNodePoolRequest 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.GetOpenIDConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGetOpenIDConfigRequest 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.MessageGetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
- class google.cloud.container_v1.types.GetOperationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGetOperationRequest 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
nameof the operation. This field has been deprecated and replaced by the name field.- Type
- class google.cloud.container_v1.types.GetServerConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGets 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.GkeBackupAgentConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for the Backup for GKE Agent.
- class google.cloud.container_v1.types.HorizontalPodAutoscaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration 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.HttpLoadBalancing(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration 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.ILBSubsettingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster.
- class google.cloud.container_v1.types.IPAllocationPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration 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_aliasesis true.- Type
- subnetwork_name¶
A custom subnetwork name to be used if
create_subnetworkis 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_cidrmust be left blank.This field is only applicable when
use_ip_aliasesis 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_subnetworkis 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_aliasesis 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_aliasesis 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
- use_routes¶
Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
- Type
- stack_type¶
The IP stack type of the cluster
- ipv6_access_type¶
The ipv6 access type (internal or external) when create_subnetwork is true
- pod_cidr_overprovision_config¶
[PRIVATE FIELD] Pod CIDR size overprovisioning config for the cluster.
Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is doubled and then rounded off to next power of 2 to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26).
This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.
- additional_pod_ranges_config¶
Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.
- class google.cloud.container_v1.types.IPv6AccessType(value)[source]¶
Bases:
proto.enums.EnumPossible values for IPv6 access type
- Values:
- IPV6_ACCESS_TYPE_UNSPECIFIED (0):
Default value, will be defaulted as type external.
- INTERNAL (1):
Access type internal (all v6 addresses are internal IPs)
- EXTERNAL (2):
Access type external (all v6 addresses are external IPs)
- class google.cloud.container_v1.types.IdentityServiceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API
- class google.cloud.container_v1.types.InTransitEncryptionConfig(value)[source]¶
Bases:
proto.enums.EnumOptions for in-transit encryption.
- Values:
- IN_TRANSIT_ENCRYPTION_CONFIG_UNSPECIFIED (0):
Unspecified, will be inferred as default - IN_TRANSIT_ENCRYPTION_UNSPECIFIED.
- IN_TRANSIT_ENCRYPTION_DISABLED (1):
In-transit encryption is disabled.
- IN_TRANSIT_ENCRYPTION_INTER_NODE_TRANSPARENT (2):
Data in-transit is encrypted using inter-node transparent encryption.
- class google.cloud.container_v1.types.IntraNodeVisibilityConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.
- class google.cloud.container_v1.types.Jwk(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageJwk is a JSON Web Key as specified in RFC 7517
- class google.cloud.container_v1.types.K8sBetaAPIConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageK8sBetaAPIConfig , configuration for beta APIs
- class google.cloud.container_v1.types.KubernetesDashboard(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for the Kubernetes Dashboard.
- class google.cloud.container_v1.types.LegacyAbac(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for the legacy Attribute Based Access Control authorization mode.
- class google.cloud.container_v1.types.LinuxNodeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageParameters that can be configured on Linux nodes.
- 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.busy_poll net.core.busy_read 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 kernel.shmmni kernel.shmmax kernel.shmall
- cgroup_mode¶
cgroup_mode specifies the cgroup mode to be used on the node.
- class CgroupMode(value)[source]¶
Bases:
proto.enums.EnumPossible cgroup modes that can be used.
- Values:
- CGROUP_MODE_UNSPECIFIED (0):
CGROUP_MODE_UNSPECIFIED is when unspecified cgroup configuration is used. The default for the GKE node OS image will be used.
- CGROUP_MODE_V1 (1):
CGROUP_MODE_V1 specifies to use cgroupv1 for the cgroup configuration on the node image.
- CGROUP_MODE_V2 (2):
CGROUP_MODE_V2 specifies to use cgroupv2 for the cgroup configuration on the node image.
- class HugepagesConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHugepages amount in both 2m and 1g size
- class SysctlsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.container_v1.types.ListClustersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListClustersRequest 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.MessageListClustersResponse is the result of ListClustersRequest.
- clusters¶
A list of clusters in the project in the specified zone, or across all ones.
- Type
MutableSequence[google.cloud.container_v1.types.Cluster]
- class google.cloud.container_v1.types.ListNodePoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListNodePoolsRequest 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.ListNodePoolsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListNodePoolsResponse is the result of ListNodePoolsRequest.
- node_pools¶
A list of node pools for a cluster.
- Type
MutableSequence[google.cloud.container_v1.types.NodePool]
- class google.cloud.container_v1.types.ListOperationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListOperationsRequest 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.ListOperationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListOperationsResponse is the result of ListOperationsRequest.
- operations¶
A list of operations in the project in the specified zone.
- Type
MutableSequence[google.cloud.container_v1.types.Operation]
- class google.cloud.container_v1.types.ListUsableSubnetworksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageListUsableSubnetworksRequest 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
networkProjectIdis 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_tokenis 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.MessageListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.
- subnetworks¶
A list of usable subnetworks in the specified network project.
- Type
MutableSequence[google.cloud.container_v1.types.UsableSubnetwork]
- class google.cloud.container_v1.types.LocalNvmeSsdBlockConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs
- local_ssd_count¶
Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
A zero (or unset) value has different meanings depending on machine type being used:
For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage.
For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn’t support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
- Type
- class google.cloud.container_v1.types.LoggingComponentConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLoggingComponentConfig is cluster logging component configuration.
- enable_components¶
Select components to collect logs. An empty set would disable all logging.
- Type
MutableSequence[google.cloud.container_v1.types.LoggingComponentConfig.Component]
- class Component(value)[source]¶
Bases:
proto.enums.EnumGKE components exposing logs
- Values:
- COMPONENT_UNSPECIFIED (0):
Default value. This shouldn’t be used.
- SYSTEM_COMPONENTS (1):
system components
- WORKLOADS (2):
workloads
- APISERVER (3):
kube-apiserver
- SCHEDULER (4):
kube-scheduler
- CONTROLLER_MANAGER (5):
kube-controller-manager
- KCP_SSHD (7):
kcp-sshd
- KCP_CONNECTION (8):
kcp connection logs
- class google.cloud.container_v1.types.LoggingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLoggingConfig is cluster logging configuration.
- component_config¶
Logging components configuration
- class google.cloud.container_v1.types.LoggingVariantConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLoggingVariantConfig specifies the behaviour of the logging component.
- variant¶
Logging variant deployed on nodes.
- class Variant(value)[source]¶
Bases:
proto.enums.EnumLogging component variants.
- Values:
- VARIANT_UNSPECIFIED (0):
Default value. This shouldn’t be used.
- DEFAULT (1):
default logging variant.
- MAX_THROUGHPUT (2):
maximum logging throughput variant.
- class google.cloud.container_v1.types.MaintenanceExclusionOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the Maintenance exclusion option.
- scope¶
Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
- class Scope(value)[source]¶
Bases:
proto.enums.EnumScope of exclusion.
- Values:
- NO_UPGRADES (0):
NO_UPGRADES excludes all upgrades, including patch upgrades and minor upgrades across control planes and nodes. This is the default exclusion behavior.
- NO_MINOR_UPGRADES (1):
NO_MINOR_UPGRADES excludes all minor upgrades for the cluster, only patches are allowed.
- NO_MINOR_OR_NODE_UPGRADES (2):
NO_MINOR_OR_NODE_UPGRADES excludes all minor upgrades for the cluster, and also exclude all node pool upgrades. Only control plane patches are allowed.
- class google.cloud.container_v1.types.MaintenancePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMaintenancePolicy defines the maintenance policy to be used for the cluster.
- window¶
Specifies the maintenance window in which maintenance may be performed.
- 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.MessageMaintenanceWindow defines the maintenance window to be used for the cluster.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- daily_maintenance_window¶
DailyMaintenanceWindow specifies a daily maintenance operation window.
This field is a member of oneof
policy.
- 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.
This field is a member of oneof
policy.
- maintenance_exclusions¶
Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
- Type
MutableMapping[str, google.cloud.container_v1.types.TimeWindow]
- class MaintenanceExclusionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.container_v1.types.ManagedPrometheusConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.
- class google.cloud.container_v1.types.MasterAuth(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe 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.
- 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. Issued only if client_certificate_config is set.
- Type
- class google.cloud.container_v1.types.MasterAuthorizedNetworksConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration 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
MutableSequence[google.cloud.container_v1.types.MasterAuthorizedNetworksConfig.CidrBlock]
- gcp_public_cidrs_access_enabled¶
Whether master is accessbile via Google Compute Engine Public IP addresses.
This field is a member of oneof
_gcp_public_cidrs_access_enabled.- Type
- private_endpoint_enforcement_enabled¶
Whether master authorized networks is enforced on private endpoint or not.
This field is a member of oneof
_private_endpoint_enforcement_enabled.- Type
- class CidrBlock(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCidrBlock contains an optional name and one CIDR block.
- class google.cloud.container_v1.types.MaxPodsConstraint(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConstraints applied to pods.
- class google.cloud.container_v1.types.MeshCertificates(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for issuance of mTLS keys and certificates to Kubernetes pods.
- enable_certificates¶
enable_certificates controls issuance of workload mTLS certificates.
If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource.
Requires Workload Identity ([workload_pool][google.container.v1.WorkloadIdentityConfig.workload_pool] must be non-empty).
- class google.cloud.container_v1.types.MonitoringComponentConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMonitoringComponentConfig is cluster monitoring component configuration.
- enable_components¶
Select components to collect metrics. An empty set would disable all monitoring.
- Type
MutableSequence[google.cloud.container_v1.types.MonitoringComponentConfig.Component]
- class Component(value)[source]¶
Bases:
proto.enums.EnumGKE components exposing metrics
- Values:
- COMPONENT_UNSPECIFIED (0):
Default value. This shouldn’t be used.
- SYSTEM_COMPONENTS (1):
system components
- APISERVER (3):
kube-apiserver
- SCHEDULER (4):
kube-scheduler
- CONTROLLER_MANAGER (5):
kube-controller-manager
- STORAGE (7):
Storage
- HPA (8):
Horizontal Pod Autoscaling
- POD (9):
Pod
- DAEMONSET (10):
DaemonSet
- DEPLOYMENT (11):
Deployment
- STATEFULSET (12):
Statefulset
- CADVISOR (13):
CADVISOR
- KUBELET (14):
KUBELET
- DCGM (15):
NVIDIA Data Center GPU Manager (DCGM)
- class google.cloud.container_v1.types.MonitoringConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMonitoringConfig is cluster monitoring configuration.
- component_config¶
Monitoring components configuration
- managed_prometheus_config¶
Enable Google Cloud Managed Service for Prometheus in the cluster.
- advanced_datapath_observability_config¶
Configuration of Advanced Datapath Observability features.
- class google.cloud.container_v1.types.NetworkConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNetworkConfig 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.
- datapath_provider¶
The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
- private_ipv6_google_access¶
The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)
- dns_config¶
DNSConfig contains clusterDNS config for this cluster.
- service_external_ips_config¶
ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
- gateway_api_config¶
GatewayAPIConfig contains the desired config of Gateway API on this cluster.
- network_performance_config¶
Network bandwidth tier configuration.
- enable_fqdn_network_policy¶
Whether FQDN Network Policy is enabled on this cluster.
This field is a member of oneof
_enable_fqdn_network_policy.- Type
- in_transit_encryption_config¶
Specify the details of in-transit encryption. Now named inter-node transparent encryption.
This field is a member of oneof
_in_transit_encryption_config.
- enable_cilium_clusterwide_network_policy¶
Whether CiliumClusterwideNetworkPolicy is enabled on this cluster.
This field is a member of oneof
_enable_cilium_clusterwide_network_policy.- Type
- default_enable_private_nodes¶
Controls whether by default nodes have private IP addresses only. It is invalid to specify both [PrivateClusterConfig.enablePrivateNodes][] and this field at the same time. To update the default setting, use [ClusterUpdate.desired_default_enable_private_nodes][google.container.v1.ClusterUpdate.desired_default_enable_private_nodes]
This field is a member of oneof
_default_enable_private_nodes.- Type
- class ClusterNetworkPerformanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration of network bandwidth tiers
- total_egress_bandwidth_tier¶
Specifies the total network bandwidth tier for NodePools in the cluster.
This field is a member of oneof
_total_egress_bandwidth_tier.
- class Tier(value)[source]¶
Bases:
proto.enums.EnumNode network tier
- Values:
- TIER_UNSPECIFIED (0):
Default value
- TIER_1 (1):
Higher bandwidth, actual values based on VM size.
- class google.cloud.container_v1.types.NetworkPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
- provider¶
The selected network policy provider.
- class Provider(value)[source]¶
Bases:
proto.enums.EnumAllowed Network Policy providers.
- Values:
- PROVIDER_UNSPECIFIED (0):
Not set
- CALICO (1):
Tigera (Calico Felix).
- class google.cloud.container_v1.types.NetworkPolicyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration 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.NetworkTags(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCollection of Compute Engine network tags that can be applied to a node’s underlying VM instance.
- class google.cloud.container_v1.types.NodeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageParameters that describe the nodes in a cluster.
GKE Autopilot clusters do not recognize parameters in
NodeConfig. Use [AutoprovisioningNodePoolDefaults][google.container.v1.AutoprovisioningNodePoolDefaults] instead.- 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/computeis required for mounting persistent storage on your nodes.https://www.googleapis.com/auth/devstorage.read_onlyis 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
MutableSequence[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”
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.
- 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. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
- 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/
- 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
- tags¶
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
MutableSequence[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
MutableSequence[google.cloud.container_v1.types.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.
- 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
MutableSequence[google.cloud.container_v1.types.NodeTaint]
- sandbox_config¶
Sandbox configuration for this node.
- 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.
- shielded_instance_config¶
Shielded Instance options.
- linux_node_config¶
Parameters that can be configured on Linux nodes.
- kubelet_config¶
Node kubelet configs.
- 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
- gcfs_config¶
Google Container File System (image streaming) configs.
- advanced_machine_features¶
Advanced features for the Compute Engine VM.
- gvnic¶
Enable or disable gvnic in the node pool.
- spot¶
Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
- Type
- confidential_nodes¶
Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
- fast_socket¶
Enable or disable NCCL fast socket for the node pool.
This field is a member of oneof
_fast_socket.
- resource_labels¶
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
- logging_config¶
Logging configuration.
- windows_node_config¶
Parameters that can be configured on Windows nodes.
- local_nvme_ssd_block_config¶
Parameters for using raw-block Local NVMe SSDs.
- ephemeral_storage_local_ssd_config¶
Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
- sole_tenant_config¶
Parameters for node pools to be backed by shared sole tenant node groups.
- containerd_config¶
Parameters for containerd customization.
- resource_manager_tags¶
A map of resource manager tag keys and values to be attached to the nodes.
- secondary_boot_disks¶
List of secondary boot disks attached to the nodes.
- Type
MutableSequence[google.cloud.container_v1.types.SecondaryBootDisk]
- secondary_boot_disk_update_strategy¶
Secondary boot disk update strategy.
This field is a member of oneof
_secondary_boot_disk_update_strategy.
- local_ssd_encryption_mode¶
Specifies which method should be used for encrypting the Local SSDs attahced to the node.
This field is a member of oneof
_local_ssd_encryption_mode.
- effective_cgroup_mode¶
Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
- class EffectiveCgroupMode(value)[source]¶
Bases:
proto.enums.EnumPossible effective cgroup modes for the node.
- Values:
- EFFECTIVE_CGROUP_MODE_UNSPECIFIED (0):
EFFECTIVE_CGROUP_MODE_UNSPECIFIED means the cgroup configuration for the node pool is unspecified, i.e. the node pool is a Windows node pool.
- EFFECTIVE_CGROUP_MODE_V1 (1):
CGROUP_MODE_V1 means the node pool is configured to use cgroupv1 for the cgroup configuration.
- EFFECTIVE_CGROUP_MODE_V2 (2):
CGROUP_MODE_V2 means the node pool is configured to use cgroupv2 for the cgroup configuration.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class LocalSsdEncryptionMode(value)[source]¶
Bases:
proto.enums.EnumLocalSsdEncryptionMode specifies the method used for encrypting the Local SSDs attached to the node.
- Values:
- LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED (0):
The given node will be encrypted using keys managed by Google infrastructure and the keys will be deleted when the node is deleted.
- STANDARD_ENCRYPTION (1):
The given node will be encrypted using keys managed by Google infrastructure and the keys will be deleted when the node is deleted.
- EPHEMERAL_KEY_ENCRYPTION (2):
The given node will opt-in for using ephemeral key for encryption of Local SSDs. The Local SSDs will not be able to recover data in case of node crash.
- class MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class ResourceLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.container_v1.types.NodeConfigDefaults(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSubset of NodeConfig message that has defaults.
- gcfs_config¶
GCFS (Google Container File System, also known as Riptide) options.
- logging_config¶
Logging configuration for node pools.
- containerd_config¶
Parameters for containerd customization.
- node_kubelet_config¶
NodeKubeletConfig controls the defaults for new node-pools.
Currently only
insecure_kubelet_readonly_port_enabledcan be set here.
- class google.cloud.container_v1.types.NodeKubeletConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNode kubelet configs.
- 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
- cpu_cfs_quota¶
Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all.
Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits.
The default value is ‘true’ if unspecified.
- cpu_cfs_quota_period¶
Set the CPU CFS quota period value ‘cpu.cfs_period_us’.
The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. The value must be a positive duration.
- Type
- pod_pids_limit¶
Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits
Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
- Type
- class google.cloud.container_v1.types.NodeLabels(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCollection of node-level Kubernetes labels.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.container_v1.types.NodeManagement(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNodeManagement defines the set of node management services turned on for the node pool.
- auto_upgrade¶
A flag that specifies whether node auto-upgrade 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-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
- Type
- upgrade_options¶
Specifies the Auto Upgrade knobs for the node pool.
- class google.cloud.container_v1.types.NodeNetworkConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageParameters for node pool-level network config.
- create_pod_range¶
Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for
pod_rangeandpod_ipv4_cidr_blockif they are not specified.If neither
create_pod_rangeorpod_rangeare specified, the cluster-level default (ip_allocation_policy.cluster_ipv4_cidr_block) is used.Only applicable if
ip_allocation_policy.use_ip_aliasesis true.This field cannot be changed after the node pool has been created.
- Type
- pod_range¶
The ID of the secondary range for pod IPs. If
create_pod_rangeis true, this ID is used for the new range. Ifcreate_pod_rangeis false, uses an existing secondary range with this ID.Only applicable if
ip_allocation_policy.use_ip_aliasesis true.This field cannot be changed after the node pool has been created.
- Type
- pod_ipv4_cidr_block¶
The IP address range for pod IPs in this node pool.
Only applicable if
create_pod_rangeis 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) to pick a specific range to use.Only applicable if
ip_allocation_policy.use_ip_aliasesis true.This field cannot be changed after the node pool has been created.
- Type
- enable_private_nodes¶
Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from [Cluster.NetworkConfig.default_enable_private_nodes][]
This field is a member of oneof
_enable_private_nodes.- Type
- network_performance_config¶
Network bandwidth tier configuration.
This field is a member of oneof
_network_performance_config.
- pod_cidr_overprovision_config¶
[PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool.
Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26).
This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.
- additional_node_network_configs¶
We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
- Type
MutableSequence[google.cloud.container_v1.types.AdditionalNodeNetworkConfig]
- additional_pod_network_configs¶
We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node
- Type
MutableSequence[google.cloud.container_v1.types.AdditionalPodNetworkConfig]
- pod_ipv4_range_utilization¶
Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodesnumZonespodIPsPerNode.
- Type
- class NetworkPerformanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration of all network bandwidth tiers
- total_egress_bandwidth_tier¶
Specifies the total network bandwidth tier for the NodePool.
This field is a member of oneof
_total_egress_bandwidth_tier.
- class Tier(value)[source]¶
Bases:
proto.enums.EnumNode network tier
- Values:
- TIER_UNSPECIFIED (0):
Default value
- TIER_1 (1):
Higher bandwidth, actual values based on VM size.
- class google.cloud.container_v1.types.NodePool(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNodePool 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.
- 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
MutableSequence[str]
- network_config¶
Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
- version¶
The version of Kubernetes running on this NodePool’s nodes. If unspecified, it defaults as described here.
- Type
- instance_group_urls¶
Output only. The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
- Type
MutableSequence[str]
- status¶
Output only. The status of the nodes in this pool instance.
- 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.
- management¶
NodeManagement configuration for this NodePool.
- max_pods_constraint¶
The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
- conditions¶
Which conditions caused the current node pool state.
- Type
MutableSequence[google.cloud.container_v1.types.StatusCondition]
- upgrade_settings¶
Upgrade settings control disruption and speed of the upgrade.
- placement_policy¶
Specifies the node placement policy.
- update_info¶
Output only. Update info contains relevant information during a node pool update.
- etag¶
This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
- Type
- queued_provisioning¶
Specifies the configuration of queued provisioning.
- best_effort_provisioning¶
Enable best effort provisioning for nodes
- class PlacementPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePlacementPolicy defines the placement policy used by the node pool.
- type_¶
The type of placement.
- tpu_topology¶
Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
- Type
- policy_name¶
If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
- Type
- class Type(value)[source]¶
Bases:
proto.enums.EnumType defines the type of placement policy.
- Values:
- TYPE_UNSPECIFIED (0):
TYPE_UNSPECIFIED specifies no requirements on nodes placement.
- COMPACT (1):
COMPACT specifies node placement in the same availability domain to ensure low communication latency.
- class QueuedProvisioning(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageQueuedProvisioning defines the queued provisioning used by the node pool.
- class Status(value)[source]¶
Bases:
proto.enums.EnumThe current status of the node pool instance.
- Values:
- STATUS_UNSPECIFIED (0):
Not set.
- PROVISIONING (1):
The PROVISIONING state indicates the node pool is being created.
- RUNNING (2):
The RUNNING state indicates the node pool has been created and is fully usable.
- RUNNING_WITH_ERROR (3):
The RUNNING_WITH_ERROR state indicates the node pool has been created and is partially usable. Some error state has occurred and some functionality may be impaired. Customer may need to reissue a request or trigger a new update.
- RECONCILING (4):
The RECONCILING state indicates that some work is actively being done on the node pool, such as upgrading node software. Details can be found in the
statusMessagefield.- STOPPING (5):
The STOPPING state indicates the node pool is being deleted.
- ERROR (6):
The ERROR state indicates the node pool may be unusable. Details can be found in the
statusMessagefield.
- class UpdateInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade.
- blue_green_info¶
Information of a blue-green upgrade.
- class BlueGreenInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation relevant to blue-green upgrade.
- phase¶
Current blue-green upgrade phase.
- blue_instance_group_urls¶
The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
- Type
MutableSequence[str]
- green_instance_group_urls¶
The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool.
- Type
MutableSequence[str]
- blue_pool_deletion_start_time¶
Time to start deleting blue pool to complete blue-green upgrade, in RFC3339 text format.
- Type
- class Phase(value)[source]¶
Bases:
proto.enums.EnumPhase represents the different stages blue-green upgrade is running in.
- Values:
- PHASE_UNSPECIFIED (0):
Unspecified phase.
- UPDATE_STARTED (1):
blue-green upgrade has been initiated.
- CREATING_GREEN_POOL (2):
Start creating green pool nodes.
- CORDONING_BLUE_POOL (3):
Start cordoning blue pool nodes.
- DRAINING_BLUE_POOL (4):
Start draining blue pool nodes.
- NODE_POOL_SOAKING (5):
Start soaking time after draining entire blue pool.
- DELETING_BLUE_POOL (6):
Start deleting blue nodes.
- ROLLBACK_STARTED (7):
Rollback has been initiated.
- class UpgradeSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThese 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.
These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool.
If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade.
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 controls the number of nodes that can be simultaneously unavailable.
(maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time).
If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings.
standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained.
node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted.
- 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.NodePoolAutoConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNode pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
- network_tags¶
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 creation. Each tag within the list must comply with RFC1035.
- resource_manager_tags¶
Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
- node_kubelet_config¶
NodeKubeletConfig controls the defaults for autoprovisioned node-pools.
Currently only
insecure_kubelet_readonly_port_enabledcan be set here.
- linux_node_config¶
Output only. Configuration options for Linux nodes.
- class google.cloud.container_v1.types.NodePoolAutoscaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNodePoolAutoscaling 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 for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count.
- Type
- max_node_count¶
Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster.
- Type
- location_policy¶
Location policy used when scaling up a nodepool.
- total_min_node_count¶
Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
- Type
- total_max_node_count¶
Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
- Type
- class LocationPolicy(value)[source]¶
Bases:
proto.enums.EnumLocation policy specifies how zones are picked when scaling up the nodepool.
- Values:
- LOCATION_POLICY_UNSPECIFIED (0):
Not set.
- BALANCED (1):
BALANCED is a best effort policy that aims to balance the sizes of different zones.
- ANY (2):
ANY policy picks zones that have the highest capacity available.
- class google.cloud.container_v1.types.NodePoolDefaults(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSubset of Nodepool message that has defaults.
- node_config_defaults¶
Subset of NodeConfig message that has defaults.
- class google.cloud.container_v1.types.NodePoolLoggingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNodePoolLoggingConfig specifies logging configuration for nodepools.
- variant_config¶
Logging variant configuration.
- class google.cloud.container_v1.types.NodePoolUpdateStrategy(value)[source]¶
Bases:
proto.enums.EnumStrategy used for node pool update.
- Values:
- NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED (0):
Default value if unset. GKE internally defaults the update strategy to SURGE for unspecified strategies.
- BLUE_GREEN (2):
blue-green upgrade.
- SURGE (3):
SURGE is the traditional way of upgrade a node pool. max_surge and max_unavailable determines the level of upgrade parallelism.
- class google.cloud.container_v1.types.NodeTaint(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageKubernetes taint is composed 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.
- class Effect(value)[source]¶
Bases:
proto.enums.EnumPossible values for Effect in taint.
- Values:
- EFFECT_UNSPECIFIED (0):
Not set
- NO_SCHEDULE (1):
NoSchedule
- PREFER_NO_SCHEDULE (2):
PreferNoSchedule
- NO_EXECUTE (3):
NoExecute
- class google.cloud.container_v1.types.NodeTaints(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCollection of Kubernetes node taints.
- taints¶
List of node taints.
- Type
MutableSequence[google.cloud.container_v1.types.NodeTaint]
- class google.cloud.container_v1.types.NotificationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNotificationConfig is the configuration of notifications.
- pubsub¶
Notification config for Pub/Sub.
- class EventType(value)[source]¶
Bases:
proto.enums.EnumTypes of notifications currently supported. Can be used to filter what notifications are sent.
- Values:
- EVENT_TYPE_UNSPECIFIED (0):
Not set, will be ignored.
- UPGRADE_AVAILABLE_EVENT (1):
Corresponds with UpgradeAvailableEvent.
- UPGRADE_EVENT (2):
Corresponds with UpgradeEvent.
- SECURITY_BULLETIN_EVENT (3):
Corresponds with SecurityBulletinEvent.
- class Filter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAllows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent
- event_type¶
Event types to allowlist.
- Type
MutableSequence[google.cloud.container_v1.types.NotificationConfig.EventType]
- class PubSub(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePub/Sub specific notification config.
- topic¶
The desired Pub/Sub topic to which notifications will be sent by GKE. Format is
projects/{project}/topics/{topic}.- Type
- filter¶
Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent
- class google.cloud.container_v1.types.Operation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
- zone¶
Output only. 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¶
Output only. The operation type.
- status¶
Output only. The current status of the operation.
- status_message¶
Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- Type
- self_link¶
Output only. Server-defined URI for the operation. Example:
https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123.- Type
- target_link¶
Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target.
Examples:
https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-clusterhttps://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-nphttps://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node- Type
- location¶
Output only. The name of the Google Compute Engine zone or region in which the cluster resides.
- Type
- progress¶
Output only. Progress information for an operation.
- cluster_conditions¶
Which conditions caused the current cluster state. Deprecated. Use field error instead.
- Type
MutableSequence[google.cloud.container_v1.types.StatusCondition]
- nodepool_conditions¶
Which conditions caused the current node pool state. Deprecated. Use field error instead.
- Type
MutableSequence[google.cloud.container_v1.types.StatusCondition]
- error¶
The error result of the operation in case of failure.
- Type
google.rpc.status_pb2.Status
- class Status(value)[source]¶
Bases:
proto.enums.EnumCurrent status of the operation.
- Values:
- STATUS_UNSPECIFIED (0):
Not set.
- PENDING (1):
The operation has been created.
- RUNNING (2):
The operation is currently running.
- DONE (3):
The operation is done, either cancelled or completed.
- ABORTING (4):
The operation is aborting.
- class Type(value)[source]¶
Bases:
proto.enums.EnumOperation type categorizes the operation.
- Values:
- TYPE_UNSPECIFIED (0):
Not set.
- CREATE_CLUSTER (1):
The cluster is being created. The cluster should be assumed to be unusable until the operation finishes.
In the event of the operation failing, the cluster will enter the [ERROR state][Cluster.Status.ERROR] and eventually be deleted.
- DELETE_CLUSTER (2):
The cluster is being deleted. The cluster should be assumed to be unusable as soon as this operation starts.
In the event of the operation failing, the cluster will enter the [ERROR state][Cluster.Status.ERROR] and the deletion will be automatically retried until completed.
- UPGRADE_MASTER (3):
The [cluster version][google.container.v1.ClusterUpdate.desired_master_version] is being updated. Note that this includes “upgrades” to the same version, which are simply a recreation. This also includes auto-upgrades. For more details, see documentation on cluster upgrades.
- UPGRADE_NODES (4):
A node pool is being updated. Despite calling this an “upgrade”, this includes most forms of updates to node pools. This also includes auto-upgrades.
This operation sets the [progress][google.container.v1.Operation.progress] field and may be [canceled][google.container.v1.ClusterManager.CancelOperation].
The upgrade strategy depends on node pool configuration. The nodes are generally still usable during this operation.
- REPAIR_CLUSTER (5):
A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see documentation on repairs.
- UPDATE_CLUSTER (6):
The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters.
Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow maintenance policies.
Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.
- CREATE_NODE_POOL (7):
A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created.
If enabled, node autoprovisioning may have automatically initiated such operations.
- DELETE_NODE_POOL (8):
The node pool is being deleted. The node pool should be assumed to be unusable as soon as this operation starts.
- SET_NODE_POOL_MANAGEMENT (9):
The node pool’s [manamagent][google.container.v1.NodePool.management] field is being updated. These operations only update metadata and may be concurrent with most other operations.
- AUTO_REPAIR_NODES (10):
A problem has been detected with nodes and they are being repaired. This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.
- AUTO_UPGRADE_NODES (11):
Unused. Automatic node upgrade uses [UPGRADE_NODES][google.container.v1.Operation.Type.UPGRADE_NODES].
- SET_LABELS (12):
Unused. Updating labels uses [UPDATE_CLUSTER][google.container.v1.Operation.Type.UPDATE_CLUSTER].
- SET_MASTER_AUTH (13):
Unused. Updating master auth uses [UPDATE_CLUSTER][google.container.v1.Operation.Type.UPDATE_CLUSTER].
- SET_NODE_POOL_SIZE (14):
The node pool is being resized. With the exception of resizing to or from size zero, the node pool is generally usable during this operation.
- SET_NETWORK_POLICY (15):
Unused. Updating network policy uses [UPDATE_CLUSTER][google.container.v1.Operation.Type.UPDATE_CLUSTER].
- SET_MAINTENANCE_POLICY (16):
Unused. Updating maintenance policy uses [UPDATE_CLUSTER][google.container.v1.Operation.Type.UPDATE_CLUSTER].
- RESIZE_CLUSTER (18):
The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see documentation on resizes.
- FLEET_FEATURE_UPGRADE (19):
Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes.
- class google.cloud.container_v1.types.OperationProgress(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation 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.
- 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
MutableSequence[google.cloud.container_v1.types.OperationProgress.Metric]
- stages¶
Substages of an operation or a stage.
- Type
MutableSequence[google.cloud.container_v1.types.OperationProgress]
- class Metric(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageProgress metric is (string, int|float|string) pair.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class google.cloud.container_v1.types.ParallelstoreCsiDriverConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for the Cloud Storage Parallelstore CSI driver.
- class google.cloud.container_v1.types.PodCIDROverprovisionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[PRIVATE FIELD] Config for pod CIDR size overprovisioning.
- class google.cloud.container_v1.types.PrivateClusterConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration 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.
Deprecated: Use [NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes] instead.
- Type
- enable_private_endpoint¶
Whether the master’s internal IP address is used as the cluster endpoint.
Deprecated: Use [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint] instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true.
- 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
- private_endpoint¶
Output only. The internal IP address of this cluster’s master endpoint.
Deprecated: Use [ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint] instead.
- Type
- public_endpoint¶
Output only. The external IP address of this cluster’s master endpoint.
Deprecated:Use [ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint] instead.
- Type
- master_global_access_config¶
Controls master global access settings.
Deprecated: Use [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access][] instead.
- private_endpoint_subnetwork¶
Subnet to provision the master’s private endpoint during cluster creation. Specified in projects//regions//subnetworks/* format.
Deprecated: Use [ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork][google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork] instead.
- Type
- class google.cloud.container_v1.types.PrivateClusterMasterGlobalAccessConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for controlling master global access settings.
- class google.cloud.container_v1.types.PrivateIPv6GoogleAccess(value)[source]¶
Bases:
proto.enums.EnumPrivateIPv6GoogleAccess controls whether and how the pods can communicate with Google Services through gRPC over IPv6.
- Values:
- PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED (0):
Default value. Same as DISABLED
- PRIVATE_IPV6_GOOGLE_ACCESS_DISABLED (1):
No private access to or from Google Services
- PRIVATE_IPV6_GOOGLE_ACCESS_TO_GOOGLE (2):
Enables private IPv6 access to Google Services from GKE
- PRIVATE_IPV6_GOOGLE_ACCESS_BIDIRECTIONAL (3):
Enables private IPv6 access to and from Google Services
- class google.cloud.container_v1.types.RBACBindingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
- class google.cloud.container_v1.types.RangeInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRangeInfo contains the range name and the range utilization by this cluster.
- class google.cloud.container_v1.types.RayClusterLoggingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRayClusterLoggingConfig specifies configuration of Ray logging.
- class google.cloud.container_v1.types.RayClusterMonitoringConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRayClusterMonitoringConfig specifies monitoring configuration for Ray clusters.
- class google.cloud.container_v1.types.RayOperatorConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration options for the Ray Operator add-on.
- ray_cluster_logging_config¶
Optional. Logging configuration for Ray clusters.
- ray_cluster_monitoring_config¶
Optional. Monitoring configuration for Ray clusters.
- class google.cloud.container_v1.types.RecurringTimeWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an arbitrary window of time that recurs.
- window¶
The window of the first recurrence.
- 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,FRTo repeat some window daily (equivalent to the DailyMaintenanceWindow):
FREQ=DAILYFor the first weekend of every month:
FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SUThis 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.ReleaseChannel(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReleaseChannel 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.
- class Channel(value)[source]¶
Bases:
proto.enums.EnumPossible values for ‘channel’.
- Values:
- UNSPECIFIED (0):
No channel specified.
- RAPID (1):
RAPID channel is offered on an early access basis for customers who want to test new releases.
WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.
- REGULAR (2):
Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.
- STABLE (3):
Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.
- EXTENDED (4):
Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production.
- class google.cloud.container_v1.types.ReservationAffinity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReservationAffinity is the configuration of desired reservation which instances could take capacity from.
- consume_reservation_type¶
Corresponds to the type of reservation consumption.
- key¶
Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify “compute.googleapis.com/reservation-name” as the key and specify the name of your reservation as its value.
- Type
- class Type(value)[source]¶
Bases:
proto.enums.EnumIndicates whether to consume capacity from a reservation or not.
- Values:
- UNSPECIFIED (0):
Default value. This should not be used.
- NO_RESERVATION (1):
Do not consume from any reserved capacity.
- ANY_RESERVATION (2):
Consume any reservation available.
- SPECIFIC_RESERVATION (3):
Must consume from a specific reservation. Must specify key value fields for specifying the reservations.
- class google.cloud.container_v1.types.ResourceLabels(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCollection of GCP labels.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.container_v1.types.ResourceLimit(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains information about amount of some resource in the cluster. For memory, value should be in GB.
- class google.cloud.container_v1.types.ResourceManagerTags(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.
- tags¶
TagKeyValue must be in one of the following formats ([KEY]=[VALUE])
tagKeys/{tag_key_id}=tagValues/{tag_value_id}{org_id}/{tag_key_name}={tag_value_name}{project_id}/{tag_key_name}={tag_value_name}
- class TagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.container_v1.types.ResourceUsageExportConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for exporting cluster resource usages.
- bigquery_destination¶
Configuration to use BigQuery as usage export destination.
- 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.
- class BigQueryDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageParameters for using BigQuery as the destination of resource usage export.
- class ConsumptionMeteringConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageParameters for controlling consumption metering.
- class google.cloud.container_v1.types.RollbackNodePoolUpgradeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRollbackNodePoolUpgradeRequest 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
- name¶
The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format
projects/*/locations/*/clusters/*/nodePools/*.- Type
- class google.cloud.container_v1.types.SandboxConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSandboxConfig contains configurations of the sandbox to use for the node.
- type_¶
Type of the sandbox to use for the node.
- class Type(value)[source]¶
Bases:
proto.enums.EnumPossible types of sandboxes.
- Values:
- UNSPECIFIED (0):
Default value. This should not be used.
- GVISOR (1):
Run sandbox using gvisor.
- class google.cloud.container_v1.types.SecondaryBootDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
- mode¶
Disk mode (container image cache, etc.)
- class Mode(value)[source]¶
Bases:
proto.enums.EnumMode specifies how the secondary boot disk will be used. This triggers mode-specified logic in the control plane.
- Values:
- MODE_UNSPECIFIED (0):
MODE_UNSPECIFIED is when mode is not set.
- CONTAINER_IMAGE_CACHE (1):
CONTAINER_IMAGE_CACHE is for using the secondary boot disk as a container image cache.
- class google.cloud.container_v1.types.SecondaryBootDiskUpdateStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks.
- class google.cloud.container_v1.types.SecretManagerConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecretManagerConfig is config for secret manager enablement.
- class google.cloud.container_v1.types.SecurityBulletinEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.
- resource_type_affected¶
The resource type (node/control plane) that has the vulnerability. Multiple notifications (1 notification per resource type) will be sent for a vulnerability that affects > 1 resource type.
- Type
- brief_description¶
A brief description of the bulletin. See the bulletin pointed to by the bulletin_uri field for an expanded description.
- Type
- affected_supported_minors¶
The GKE minor versions affected by this vulnerability.
- Type
MutableSequence[str]
- suggested_upgrade_target¶
This represents a version selected from the patched_versions field that the cluster receiving this notification should most likely want to upgrade to based on its current version. Note that if this notification is being received by a given cluster, it means that this version is currently available as an upgrade target in that cluster’s location.
- Type
- class google.cloud.container_v1.types.SecurityPostureConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API.
- vulnerability_mode¶
Sets which mode to use for vulnerability scanning.
This field is a member of oneof
_vulnerability_mode.
- class Mode(value)[source]¶
Bases:
proto.enums.EnumMode defines enablement mode for GKE Security posture features.
- Values:
- MODE_UNSPECIFIED (0):
Default value not specified.
- DISABLED (1):
Disables Security Posture features on the cluster.
- BASIC (2):
Applies Security Posture features on the cluster.
- ENTERPRISE (3):
Applies the Security Posture off cluster Enterprise level features.
- class VulnerabilityMode(value)[source]¶
Bases:
proto.enums.EnumVulnerabilityMode defines enablement mode for vulnerability scanning.
- Values:
- VULNERABILITY_MODE_UNSPECIFIED (0):
Default value not specified.
- VULNERABILITY_DISABLED (1):
Disables vulnerability scanning on the cluster.
- VULNERABILITY_BASIC (2):
Applies basic vulnerability scanning on the cluster.
- VULNERABILITY_ENTERPRISE (3):
Applies the Security Posture’s vulnerability on cluster Enterprise level features.
- class google.cloud.container_v1.types.ServerConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageKubernetes Engine service configuration.
- valid_node_versions¶
List of valid node upgrade target versions, in descending order.
- Type
MutableSequence[str]
- valid_master_versions¶
List of valid master versions, in descending order.
- Type
MutableSequence[str]
- channels¶
List of release channel configurations.
- Type
MutableSequence[google.cloud.container_v1.types.ServerConfig.ReleaseChannelConfig]
- class ReleaseChannelConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReleaseChannelConfig exposes configuration for a release channel.
- channel¶
The release channel this configuration applies to.
- class google.cloud.container_v1.types.ServiceExternalIPsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfig to block services with externalIPs field.
- class google.cloud.container_v1.types.SetAddonsConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetAddonsConfigRequest 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.
- class google.cloud.container_v1.types.SetLabelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetLabelsRequest 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
- 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 name) 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.MessageSetLegacyAbacRequest 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.SetLocationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetLocationsRequest 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
MutableSequence[str]
- class google.cloud.container_v1.types.SetLoggingServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetLoggingServiceRequest 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/kuberneteswill be used for GKE 1.14+ orlogging.googleapis.comfor earlier versions.- Type
- class google.cloud.container_v1.types.SetMaintenancePolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetMaintenancePolicyRequest 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.
- class google.cloud.container_v1.types.SetMasterAuthRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetMasterAuthRequest 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.
- update¶
Required. A description of the update.
- name¶
The name (project, location, cluster) of the cluster to set auth. Specified in the format
projects/*/locations/*/clusters/*.- Type
- class Action(value)[source]¶
Bases:
proto.enums.EnumOperation type: what type update to perform.
- Values:
- UNKNOWN (0):
Operation is unknown and will error out.
- SET_PASSWORD (1):
Set the password to a user generated value.
- GENERATE_PASSWORD (2):
Generate a new password and set it to that.
- SET_USERNAME (3):
Set the username. If an empty username is provided, basic authentication is disabled for the cluster. If a non-empty username is provided, basic authentication is enabled, with either a provided password or a generated one.
- class google.cloud.container_v1.types.SetMonitoringServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetMonitoringServiceRequest 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/kuberneteswill be used for GKE 1.14+ ormonitoring.googleapis.comfor earlier versions.- Type
- class google.cloud.container_v1.types.SetNetworkPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetNetworkPolicyRequest 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.
- class google.cloud.container_v1.types.SetNodePoolAutoscalingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetNodePoolAutoscalingRequest 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.
- class google.cloud.container_v1.types.SetNodePoolManagementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetNodePoolManagementRequest 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.
- class google.cloud.container_v1.types.SetNodePoolSizeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSetNodePoolSizeRequest sets the size 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
- class google.cloud.container_v1.types.ShieldedInstanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.ShieldedNodes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration of Shielded Nodes feature.
- class google.cloud.container_v1.types.SoleTenantConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool.
- node_affinities¶
NodeAffinities used to match to a shared sole tenant node group.
- Type
MutableSequence[google.cloud.container_v1.types.SoleTenantConfig.NodeAffinity]
- class NodeAffinity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies the NodeAffinity key, values, and affinity operator according to shared sole tenant node group affinities.
- operator¶
Operator for NodeAffinity.
- class Operator(value)[source]¶
Bases:
proto.enums.EnumOperator allows user to specify affinity or anti-affinity for the given key values.
- Values:
- OPERATOR_UNSPECIFIED (0):
Invalid or unspecified affinity operator.
- IN (1):
Affinity operator.
- NOT_IN (2):
Anti-affinity operator.
- class google.cloud.container_v1.types.StackType(value)[source]¶
Bases:
proto.enums.EnumPossible values for IP stack type
- Values:
- STACK_TYPE_UNSPECIFIED (0):
Default value, will be defaulted as IPV4 only
- IPV4 (1):
Cluster is IPV4 only
- IPV4_IPV6 (2):
Cluster can use both IPv4 and IPv6
- class google.cloud.container_v1.types.StartIPRotationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStartIPRotationRequest 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 name) of the cluster to start IP rotation. Specified in the format
projects/*/locations/*/clusters/*.- Type
- class google.cloud.container_v1.types.StatefulHAConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for the Stateful HA add-on.
- class google.cloud.container_v1.types.StatusCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
- code¶
Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
- canonical_code¶
Canonical code of the condition.
- Type
google.rpc.code_pb2.Code
- class Code(value)[source]¶
Bases:
proto.enums.EnumCode for each condition
- Values:
- UNKNOWN (0):
UNKNOWN indicates a generic condition.
- GCE_STOCKOUT (1):
GCE_STOCKOUT indicates that Google Compute Engine resources are temporarily unavailable.
- GKE_SERVICE_ACCOUNT_DELETED (2):
GKE_SERVICE_ACCOUNT_DELETED indicates that the user deleted their robot service account.
- GCE_QUOTA_EXCEEDED (3):
Google Compute Engine quota was exceeded.
- SET_BY_OPERATOR (4):
Cluster state was manually changed by an SRE due to a system logic error.
- CLOUD_KMS_KEY_ERROR (7):
Unable to perform an encrypt operation against the CloudKMS key used for etcd level encryption.
- CA_EXPIRING (9):
Cluster CA is expiring soon.
- class google.cloud.container_v1.types.TimeWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an arbitrary window of time.
- maintenance_exclusion_options¶
MaintenanceExclusionOptions provides maintenance exclusion related options.
This field is a member of oneof
options.
- start_time¶
The time that the window first starts.
- end_time¶
The time that the window ends. The end time should take place after the start time.
- class google.cloud.container_v1.types.UpdateClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdateClusterRequest 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.
- class google.cloud.container_v1.types.UpdateMasterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdateMasterRequest 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.UpdateNodePoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdateNodePoolRequests 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
- image_type¶
Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
- 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
MutableSequence[str]
- workload_metadata_config¶
The desired workload metadata config for the node pool.
- upgrade_settings¶
Upgrade settings control disruption and speed of the upgrade.
- tags¶
The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be replaced with the provided tags.
- taints¶
The desired node taints to be applied to all nodes in the node pool. If this field is not present, the taints will not be changed. Otherwise, the existing node taints will be replaced with the provided taints.
- labels¶
The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be replaced with the provided labels.
- linux_node_config¶
Parameters that can be configured on Linux nodes.
- kubelet_config¶
Node kubelet configs.
- node_network_config¶
Node network config.
- gcfs_config¶
GCFS config.
- confidential_nodes¶
Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
- gvnic¶
Enable or disable gvnic on the node pool.
- etag¶
The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.
- Type
- fast_socket¶
Enable or disable NCCL fast socket for the node pool.
- logging_config¶
Logging configuration.
- resource_labels¶
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
- windows_node_config¶
Parameters that can be configured on Windows nodes.
- 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
MutableSequence[google.cloud.container_v1.types.AcceleratorConfig]
- machine_type¶
Optional. The desired Google Compute Engine machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.
- Type
- disk_type¶
Optional. The desired disk type (e.g. ‘pd-standard’, ‘pd-ssd’ or ‘pd-balanced’) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.
- Type
- disk_size_gb¶
Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size.
- Type
- resource_manager_tags¶
Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.
- containerd_config¶
The desired containerd config for nodes in the node pool. Initiates an upgrade operation that recreates the nodes with the new config.
- queued_provisioning¶
Specifies the configuration of queued provisioning.
- class google.cloud.container_v1.types.UpgradeAvailableEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpgradeAvailableEvent is a notification sent to customers when a new available version is released.
- resource_type¶
The resource type of the release version.
- release_channel¶
The release channel of the version. If empty, it means a non-channel release.
- class google.cloud.container_v1.types.UpgradeEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading.
- resource_type¶
The resource type that is upgrading.
- operation_start_time¶
The time when the operation was started.
- class google.cloud.container_v1.types.UpgradeInfoEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpgradeInfoEvent is a notification sent to customers about the upgrade information of a resource.
- resource_type¶
The resource type associated with the upgrade.
- start_time¶
The time when the operation was started.
- end_time¶
The time when the operation ended.
- resource¶
Optional relative path to the resource. For example in node pool upgrades, the relative path of the node pool.
- Type
- state¶
Output only. The state of the upgrade.
- class State(value)[source]¶
Bases:
proto.enums.EnumThe state of the upgrade.
- Values:
- STATE_UNSPECIFIED (0):
STATE_UNSPECIFIED indicates the state is unspecified.
- STARTED (3):
STARTED indicates the upgrade has started.
- SUCCEEDED (4):
SUCCEEDED indicates the upgrade has completed successfully.
- FAILED (5):
FAILED indicates the upgrade has failed.
- CANCELED (6):
CANCELED indicates the upgrade has canceled.
- class google.cloud.container_v1.types.UpgradeResourceType(value)[source]¶
Bases:
proto.enums.EnumUpgradeResourceType is the resource type that is upgrading. It is used in upgrade notifications.
- Values:
- UPGRADE_RESOURCE_TYPE_UNSPECIFIED (0):
Default value. This shouldn’t be used.
- MASTER (1):
Master / control plane
- NODE_POOL (2):
Node pool
- class google.cloud.container_v1.types.UsableSubnetwork(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUsableSubnetwork 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
MutableSequence[google.cloud.container_v1.types.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.UsableSubnetworkSecondaryRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSecondary 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.
- class Status(value)[source]¶
Bases:
proto.enums.EnumStatus shows the current usage of a secondary IP range.
- Values:
- UNKNOWN (0):
UNKNOWN is the zero value of the Status enum. It’s not a valid status.
- UNUSED (1):
UNUSED denotes that this range is unclaimed by any cluster.
- IN_USE_SERVICE (2):
IN_USE_SERVICE denotes that this range is claimed by cluster(s) for services. User-managed services range can be shared between clusters within the same subnetwork.
- IN_USE_SHAREABLE_POD (3):
IN_USE_SHAREABLE_POD denotes this range was created by the network admin and is currently claimed by a cluster for pods. It can only be used by other clusters as a pod range.
- IN_USE_MANAGED_POD (4):
IN_USE_MANAGED_POD denotes this range was created by GKE and is claimed for pods. It cannot be used for other clusters.
- class google.cloud.container_v1.types.UserManagedKeysConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster.
- cluster_ca¶
The Certificate Authority Service caPool to use for the cluster CA in this cluster.
- Type
- etcd_api_ca¶
Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster.
- Type
- etcd_peer_ca¶
Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster.
- Type
- service_account_signing_keys¶
The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster.
Format:
projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}- Type
MutableSequence[str]
- service_account_verification_keys¶
The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster.
Format:
projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}- Type
MutableSequence[str]
- aggregation_ca¶
The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
- Type
- control_plane_disk_encryption_key¶
The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes.
- Type
- class google.cloud.container_v1.types.VerticalPodAutoscaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVerticalPodAutoscaling 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.VirtualNIC(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration of gVNIC feature.
- class google.cloud.container_v1.types.WindowsNodeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageParameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings
- os_version¶
OSVersion specifies the Windows node config to be used on the node
- class OSVersion(value)[source]¶
Bases:
proto.enums.EnumPossible OS version that can be used.
- Values:
- OS_VERSION_UNSPECIFIED (0):
When OSVersion is not specified
- OS_VERSION_LTSC2019 (1):
LTSC2019 specifies to use LTSC2019 as the Windows Servercore Base Image
- OS_VERSION_LTSC2022 (2):
LTSC2022 specifies to use LTSC2022 as the Windows Servercore Base Image
- class google.cloud.container_v1.types.WorkloadIdentityConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for the use of Kubernetes Service Accounts in GCP IAM policies.
- class google.cloud.container_v1.types.WorkloadMetadataConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageWorkloadMetadataConfig 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.
- class Mode(value)[source]¶
Bases:
proto.enums.EnumMode is the configuration for how to expose metadata to workloads running on the node.
- Values:
- MODE_UNSPECIFIED (0):
Not set.
- GCE_METADATA (1):
Expose all Compute Engine metadata to pods.
- GKE_METADATA (2):
Run the GKE Metadata Server on this node. The GKE Metadata Server exposes a metadata API to workloads that is compatible with the V1 Compute Metadata APIs exposed by the Compute Engine and App Engine Metadata Servers. This feature can only be enabled if Workload Identity is enabled at the cluster level.
- class google.cloud.container_v1.types.WorkloadPolicyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageWorkloadPolicyConfig is the configuration of workload policy for autopilot clusters.
