Reference documentation and code samples for the Kubernetes Engine V1 API class Google::Cloud::Container::V1::Cluster.
A Google Kubernetes Engine cluster.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#addons_config
def addons_config() -> ::Google::Cloud::Container::V1::AddonsConfig
- (::Google::Cloud::Container::V1::AddonsConfig) — Configurations for the various addons available to run in the cluster.
#addons_config=
def addons_config=(value) -> ::Google::Cloud::Container::V1::AddonsConfig
- value (::Google::Cloud::Container::V1::AddonsConfig) — Configurations for the various addons available to run in the cluster.
- (::Google::Cloud::Container::V1::AddonsConfig) — Configurations for the various addons available to run in the cluster.
#authenticator_groups_config
def authenticator_groups_config() -> ::Google::Cloud::Container::V1::AuthenticatorGroupsConfig
- (::Google::Cloud::Container::V1::AuthenticatorGroupsConfig) — Configuration controlling RBAC group membership information.
#authenticator_groups_config=
def authenticator_groups_config=(value) -> ::Google::Cloud::Container::V1::AuthenticatorGroupsConfig
- value (::Google::Cloud::Container::V1::AuthenticatorGroupsConfig) — Configuration controlling RBAC group membership information.
- (::Google::Cloud::Container::V1::AuthenticatorGroupsConfig) — Configuration controlling RBAC group membership information.
#autopilot
def autopilot() -> ::Google::Cloud::Container::V1::Autopilot
- (::Google::Cloud::Container::V1::Autopilot) — Autopilot configuration for the cluster.
#autopilot=
def autopilot=(value) -> ::Google::Cloud::Container::V1::Autopilot
- value (::Google::Cloud::Container::V1::Autopilot) — Autopilot configuration for the cluster.
- (::Google::Cloud::Container::V1::Autopilot) — Autopilot configuration for the cluster.
#autoscaling
def autoscaling() -> ::Google::Cloud::Container::V1::ClusterAutoscaling
- (::Google::Cloud::Container::V1::ClusterAutoscaling) — Cluster-level autoscaling configuration.
#autoscaling=
def autoscaling=(value) -> ::Google::Cloud::Container::V1::ClusterAutoscaling
- value (::Google::Cloud::Container::V1::ClusterAutoscaling) — Cluster-level autoscaling configuration.
- (::Google::Cloud::Container::V1::ClusterAutoscaling) — Cluster-level autoscaling configuration.
#binary_authorization
def binary_authorization() -> ::Google::Cloud::Container::V1::BinaryAuthorization
- (::Google::Cloud::Container::V1::BinaryAuthorization) — Configuration for Binary Authorization.
#binary_authorization=
def binary_authorization=(value) -> ::Google::Cloud::Container::V1::BinaryAuthorization
- value (::Google::Cloud::Container::V1::BinaryAuthorization) — Configuration for Binary Authorization.
- (::Google::Cloud::Container::V1::BinaryAuthorization) — Configuration for Binary Authorization.
#cluster_ipv4_cidr
def cluster_ipv4_cidr() -> ::String
-
(::String) — The IP address range of the container pods in this cluster, in
CIDR
notation (e.g.
10.96.0.0/14
). Leave blank to have one automatically chosen or specify a/14
block in10.0.0.0/8
.
#cluster_ipv4_cidr=
def cluster_ipv4_cidr=(value) -> ::String
-
value (::String) — The IP address range of the container pods in this cluster, in
CIDR
notation (e.g.
10.96.0.0/14
). Leave blank to have one automatically chosen or specify a/14
block in10.0.0.0/8
.
-
(::String) — The IP address range of the container pods in this cluster, in
CIDR
notation (e.g.
10.96.0.0/14
). Leave blank to have one automatically chosen or specify a/14
block in10.0.0.0/8
.
#conditions
def conditions() -> ::Array<::Google::Cloud::Container::V1::StatusCondition>
- (::Array<::Google::Cloud::Container::V1::StatusCondition>) — Which conditions caused the current cluster state.
#conditions=
def conditions=(value) -> ::Array<::Google::Cloud::Container::V1::StatusCondition>
- value (::Array<::Google::Cloud::Container::V1::StatusCondition>) — Which conditions caused the current cluster state.
- (::Array<::Google::Cloud::Container::V1::StatusCondition>) — Which conditions caused the current cluster state.
#confidential_nodes
def confidential_nodes() -> ::Google::Cloud::Container::V1::ConfidentialNodes
- (::Google::Cloud::Container::V1::ConfidentialNodes) — Configuration of Confidential Nodes
#confidential_nodes=
def confidential_nodes=(value) -> ::Google::Cloud::Container::V1::ConfidentialNodes
- value (::Google::Cloud::Container::V1::ConfidentialNodes) — Configuration of Confidential Nodes
- (::Google::Cloud::Container::V1::ConfidentialNodes) — Configuration of Confidential Nodes
#create_time
def create_time() -> ::String
- (::String) — [Output only] The time the cluster was created, in RFC3339 text format.
#create_time=
def create_time=(value) -> ::String
- value (::String) — [Output only] The time the cluster was created, in RFC3339 text format.
- (::String) — [Output only] The time the cluster was created, in RFC3339 text format.
#current_master_version
def current_master_version() -> ::String
- (::String) — [Output only] The current software version of the master endpoint.
#current_master_version=
def current_master_version=(value) -> ::String
- value (::String) — [Output only] The current software version of the master endpoint.
- (::String) — [Output only] The current software version of the master endpoint.
#current_node_count
def current_node_count() -> ::Integer
- (::Integer) — [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
#current_node_count=
def current_node_count=(value) -> ::Integer
- value (::Integer) — [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
- (::Integer) — [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
#current_node_version
def current_node_version() -> ::String
- (::String) — [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.
#current_node_version=
def current_node_version=(value) -> ::String
- value (::String) — [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.
- (::String) — [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.
#database_encryption
def database_encryption() -> ::Google::Cloud::Container::V1::DatabaseEncryption
- (::Google::Cloud::Container::V1::DatabaseEncryption) — Configuration of etcd encryption.
#database_encryption=
def database_encryption=(value) -> ::Google::Cloud::Container::V1::DatabaseEncryption
- value (::Google::Cloud::Container::V1::DatabaseEncryption) — Configuration of etcd encryption.
- (::Google::Cloud::Container::V1::DatabaseEncryption) — Configuration of etcd encryption.
#default_max_pods_constraint
def default_max_pods_constraint() -> ::Google::Cloud::Container::V1::MaxPodsConstraint
- (::Google::Cloud::Container::V1::MaxPodsConstraint) — 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.
#default_max_pods_constraint=
def default_max_pods_constraint=(value) -> ::Google::Cloud::Container::V1::MaxPodsConstraint
- value (::Google::Cloud::Container::V1::MaxPodsConstraint) — 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.
- (::Google::Cloud::Container::V1::MaxPodsConstraint) — 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.
#description
def description() -> ::String
- (::String) — An optional description of this cluster.
#description=
def description=(value) -> ::String
- value (::String) — An optional description of this cluster.
- (::String) — An optional description of this cluster.
#enable_kubernetes_alpha
def enable_kubernetes_alpha() -> ::Boolean
- (::Boolean) — 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.
#enable_kubernetes_alpha=
def enable_kubernetes_alpha=(value) -> ::Boolean
- value (::Boolean) — 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.
- (::Boolean) — 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.
#enable_tpu
def enable_tpu() -> ::Boolean
- (::Boolean) — Enable the ability to use Cloud TPUs in this cluster.
#enable_tpu=
def enable_tpu=(value) -> ::Boolean
- value (::Boolean) — Enable the ability to use Cloud TPUs in this cluster.
- (::Boolean) — Enable the ability to use Cloud TPUs in this cluster.
#endpoint
def endpoint() -> ::String
-
(::String) — [Output only] The IP address of this cluster's master endpoint.
The endpoint can be accessed from the internet at
https://username:password@endpoint/
.See the
masterAuth
property of this resource for username and password information.
#endpoint=
def endpoint=(value) -> ::String
-
value (::String) — [Output only] The IP address of this cluster's master endpoint.
The endpoint can be accessed from the internet at
https://username:password@endpoint/
.See the
masterAuth
property of this resource for username and password information.
-
(::String) — [Output only] The IP address of this cluster's master endpoint.
The endpoint can be accessed from the internet at
https://username:password@endpoint/
.See the
masterAuth
property of this resource for username and password information.
#expire_time
def expire_time() -> ::String
- (::String) — [Output only] The time the cluster will be automatically deleted in RFC3339 text format.
#expire_time=
def expire_time=(value) -> ::String
- value (::String) — [Output only] The time the cluster will be automatically deleted in RFC3339 text format.
- (::String) — [Output only] The time the cluster will be automatically deleted in RFC3339 text format.
#id
def id() -> ::String
- (::String) — Output only. Unique id for the cluster.
#initial_cluster_version
def initial_cluster_version() -> ::String
-
(::String) —
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
#initial_cluster_version=
def initial_cluster_version=(value) -> ::String
-
value (::String) —
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
-
(::String) —
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
#initial_node_count
def initial_node_count() -> ::Integer
-
(::Integer) — 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.
#initial_node_count=
def initial_node_count=(value) -> ::Integer
-
value (::Integer) — 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.
-
(::Integer) — 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.
#instance_group_urls
def instance_group_urls() -> ::Array<::String>
- (::Array<::String>) — Deprecated. Use node_pools.instance_group_urls.
#instance_group_urls=
def instance_group_urls=(value) -> ::Array<::String>
- value (::Array<::String>) — Deprecated. Use node_pools.instance_group_urls.
- (::Array<::String>) — Deprecated. Use node_pools.instance_group_urls.
#ip_allocation_policy
def ip_allocation_policy() -> ::Google::Cloud::Container::V1::IPAllocationPolicy
- (::Google::Cloud::Container::V1::IPAllocationPolicy) — Configuration for cluster IP allocation.
#ip_allocation_policy=
def ip_allocation_policy=(value) -> ::Google::Cloud::Container::V1::IPAllocationPolicy
- value (::Google::Cloud::Container::V1::IPAllocationPolicy) — Configuration for cluster IP allocation.
- (::Google::Cloud::Container::V1::IPAllocationPolicy) — Configuration for cluster IP allocation.
#label_fingerprint
def label_fingerprint() -> ::String
- (::String) — The fingerprint of the set of labels for this cluster.
#label_fingerprint=
def label_fingerprint=(value) -> ::String
- value (::String) — The fingerprint of the set of labels for this cluster.
- (::String) — The fingerprint of the set of labels for this cluster.
#legacy_abac
def legacy_abac() -> ::Google::Cloud::Container::V1::LegacyAbac
- (::Google::Cloud::Container::V1::LegacyAbac) — Configuration for the legacy ABAC authorization mode.
#legacy_abac=
def legacy_abac=(value) -> ::Google::Cloud::Container::V1::LegacyAbac
- value (::Google::Cloud::Container::V1::LegacyAbac) — Configuration for the legacy ABAC authorization mode.
- (::Google::Cloud::Container::V1::LegacyAbac) — Configuration for the legacy ABAC authorization mode.
#location
def location() -> ::String
#location=
def location=(value) -> ::String
#locations
def locations() -> ::Array<::String>
-
(::Array<::String>) — 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.
#locations=
def locations=(value) -> ::Array<::String>
-
value (::Array<::String>) — 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.
-
(::Array<::String>) — 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.
#logging_config
def logging_config() -> ::Google::Cloud::Container::V1::LoggingConfig
- (::Google::Cloud::Container::V1::LoggingConfig) — Logging configuration for the cluster.
#logging_config=
def logging_config=(value) -> ::Google::Cloud::Container::V1::LoggingConfig
- value (::Google::Cloud::Container::V1::LoggingConfig) — Logging configuration for the cluster.
- (::Google::Cloud::Container::V1::LoggingConfig) — Logging configuration for the cluster.
#logging_service
def logging_service() -> ::String
-
(::String) — The logging service the cluster should use to write logs.
Currently available options:
logging.googleapis.com/kubernetes
- The Cloud Logging service with a Kubernetes-native resource modellogging.googleapis.com
- The legacy Cloud Logging service (no longer available as of GKE 1.15).none
- no logs will be exported from the cluster.
If left as an empty string,
logging.googleapis.com/kubernetes
will be used for GKE 1.14+ orlogging.googleapis.com
for earlier versions.
#logging_service=
def logging_service=(value) -> ::String
-
value (::String) — The logging service the cluster should use to write logs.
Currently available options:
logging.googleapis.com/kubernetes
- The Cloud Logging service with a Kubernetes-native resource modellogging.googleapis.com
- The legacy Cloud Logging service (no longer available as of GKE 1.15).none
- no logs will be exported from the cluster.
If left as an empty string,
logging.googleapis.com/kubernetes
will be used for GKE 1.14+ orlogging.googleapis.com
for earlier versions.
-
(::String) — The logging service the cluster should use to write logs.
Currently available options:
logging.googleapis.com/kubernetes
- The Cloud Logging service with a Kubernetes-native resource modellogging.googleapis.com
- The legacy Cloud Logging service (no longer available as of GKE 1.15).none
- no logs will be exported from the cluster.
If left as an empty string,
logging.googleapis.com/kubernetes
will be used for GKE 1.14+ orlogging.googleapis.com
for earlier versions.
#maintenance_policy
def maintenance_policy() -> ::Google::Cloud::Container::V1::MaintenancePolicy
- (::Google::Cloud::Container::V1::MaintenancePolicy) — Configure the maintenance policy for this cluster.
#maintenance_policy=
def maintenance_policy=(value) -> ::Google::Cloud::Container::V1::MaintenancePolicy
- value (::Google::Cloud::Container::V1::MaintenancePolicy) — Configure the maintenance policy for this cluster.
- (::Google::Cloud::Container::V1::MaintenancePolicy) — Configure the maintenance policy for this cluster.
#master_auth
def master_auth() -> ::Google::Cloud::Container::V1::MasterAuth
-
(::Google::Cloud::Container::V1::MasterAuth) — The authentication information for accessing the master endpoint.
If unspecified, the defaults are used:
For clusters before v1.12, if master_auth is unspecified,
username
will be set to "admin", a random password will be generated, and a client certificate will be issued.
#master_auth=
def master_auth=(value) -> ::Google::Cloud::Container::V1::MasterAuth
-
value (::Google::Cloud::Container::V1::MasterAuth) — The authentication information for accessing the master endpoint.
If unspecified, the defaults are used:
For clusters before v1.12, if master_auth is unspecified,
username
will be set to "admin", a random password will be generated, and a client certificate will be issued.
-
(::Google::Cloud::Container::V1::MasterAuth) — The authentication information for accessing the master endpoint.
If unspecified, the defaults are used:
For clusters before v1.12, if master_auth is unspecified,
username
will be set to "admin", a random password will be generated, and a client certificate will be issued.
#master_authorized_networks_config
def master_authorized_networks_config() -> ::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig
- (::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig) — The configuration options for master authorized networks feature.
#master_authorized_networks_config=
def master_authorized_networks_config=(value) -> ::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig
- value (::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig) — The configuration options for master authorized networks feature.
- (::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig) — The configuration options for master authorized networks feature.
#mesh_certificates
def mesh_certificates() -> ::Google::Cloud::Container::V1::MeshCertificates
- (::Google::Cloud::Container::V1::MeshCertificates) — Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
#mesh_certificates=
def mesh_certificates=(value) -> ::Google::Cloud::Container::V1::MeshCertificates
- value (::Google::Cloud::Container::V1::MeshCertificates) — Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
- (::Google::Cloud::Container::V1::MeshCertificates) — Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
#monitoring_config
def monitoring_config() -> ::Google::Cloud::Container::V1::MonitoringConfig
- (::Google::Cloud::Container::V1::MonitoringConfig) — Monitoring configuration for the cluster.
#monitoring_config=
def monitoring_config=(value) -> ::Google::Cloud::Container::V1::MonitoringConfig
- value (::Google::Cloud::Container::V1::MonitoringConfig) — Monitoring configuration for the cluster.
- (::Google::Cloud::Container::V1::MonitoringConfig) — Monitoring configuration for the cluster.
#monitoring_service
def monitoring_service() -> ::String
-
(::String) — The monitoring service the cluster should use to write metrics.
Currently available options:
- "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
monitoring.googleapis.com
- The legacy Cloud Monitoring service (no longer available as of GKE 1.15).none
- No metrics will be exported from the cluster.
If left as an empty string,
monitoring.googleapis.com/kubernetes
will be used for GKE 1.14+ ormonitoring.googleapis.com
for earlier versions.
#monitoring_service=
def monitoring_service=(value) -> ::String
-
value (::String) — The monitoring service the cluster should use to write metrics.
Currently available options:
- "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
monitoring.googleapis.com
- The legacy Cloud Monitoring service (no longer available as of GKE 1.15).none
- No metrics will be exported from the cluster.
If left as an empty string,
monitoring.googleapis.com/kubernetes
will be used for GKE 1.14+ ormonitoring.googleapis.com
for earlier versions.
-
(::String) — The monitoring service the cluster should use to write metrics.
Currently available options:
- "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
monitoring.googleapis.com
- The legacy Cloud Monitoring service (no longer available as of GKE 1.15).none
- No metrics will be exported from the cluster.
If left as an empty string,
monitoring.googleapis.com/kubernetes
will be used for GKE 1.14+ ormonitoring.googleapis.com
for earlier versions.
#name
def name() -> ::String
-
(::String) —
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.
#name=
def name=(value) -> ::String
-
value (::String) —
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.
-
(::String) —
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.
#network
def network() -> ::String
-
(::String) — The name of the Google Compute Engine
network
to which the cluster is connected. If left unspecified, the
default
network will be used.
#network=
def network=(value) -> ::String
-
value (::String) — The name of the Google Compute Engine
network
to which the cluster is connected. If left unspecified, the
default
network will be used.
-
(::String) — The name of the Google Compute Engine
network
to which the cluster is connected. If left unspecified, the
default
network will be used.
#network_config
def network_config() -> ::Google::Cloud::Container::V1::NetworkConfig
- (::Google::Cloud::Container::V1::NetworkConfig) — Configuration for cluster networking.
#network_config=
def network_config=(value) -> ::Google::Cloud::Container::V1::NetworkConfig
- value (::Google::Cloud::Container::V1::NetworkConfig) — Configuration for cluster networking.
- (::Google::Cloud::Container::V1::NetworkConfig) — Configuration for cluster networking.
#network_policy
def network_policy() -> ::Google::Cloud::Container::V1::NetworkPolicy
- (::Google::Cloud::Container::V1::NetworkPolicy) — Configuration options for the NetworkPolicy feature.
#network_policy=
def network_policy=(value) -> ::Google::Cloud::Container::V1::NetworkPolicy
- value (::Google::Cloud::Container::V1::NetworkPolicy) — Configuration options for the NetworkPolicy feature.
- (::Google::Cloud::Container::V1::NetworkPolicy) — Configuration options for the NetworkPolicy feature.
#node_config
def node_config() -> ::Google::Cloud::Container::V1::NodeConfig
-
(::Google::Cloud::Container::V1::NodeConfig) — 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.
#node_config=
def node_config=(value) -> ::Google::Cloud::Container::V1::NodeConfig
-
value (::Google::Cloud::Container::V1::NodeConfig) — 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.
-
(::Google::Cloud::Container::V1::NodeConfig) — 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.
#node_ipv4_cidr_size
def node_ipv4_cidr_size() -> ::Integer
-
(::Integer) — [Output only] The size of the address space on each node for hosting
containers. This is provisioned from within the
container_ipv4_cidr
range. This field will only be set when cluster is in route-based network mode.
#node_ipv4_cidr_size=
def node_ipv4_cidr_size=(value) -> ::Integer
-
value (::Integer) — [Output only] The size of the address space on each node for hosting
containers. This is provisioned from within the
container_ipv4_cidr
range. This field will only be set when cluster is in route-based network mode.
-
(::Integer) — [Output only] The size of the address space on each node for hosting
containers. This is provisioned from within the
container_ipv4_cidr
range. This field will only be set when cluster is in route-based network mode.
#node_pool_defaults
def node_pool_defaults() -> ::Google::Cloud::Container::V1::NodePoolDefaults
- (::Google::Cloud::Container::V1::NodePoolDefaults) — Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
#node_pool_defaults=
def node_pool_defaults=(value) -> ::Google::Cloud::Container::V1::NodePoolDefaults
- value (::Google::Cloud::Container::V1::NodePoolDefaults) — Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
- (::Google::Cloud::Container::V1::NodePoolDefaults) — Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
#node_pools
def node_pools() -> ::Array<::Google::Cloud::Container::V1::NodePool>
- (::Array<::Google::Cloud::Container::V1::NodePool>) — The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
#node_pools=
def node_pools=(value) -> ::Array<::Google::Cloud::Container::V1::NodePool>
- value (::Array<::Google::Cloud::Container::V1::NodePool>) — The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
- (::Array<::Google::Cloud::Container::V1::NodePool>) — The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
#notification_config
def notification_config() -> ::Google::Cloud::Container::V1::NotificationConfig
- (::Google::Cloud::Container::V1::NotificationConfig) — Notification configuration of the cluster.
#notification_config=
def notification_config=(value) -> ::Google::Cloud::Container::V1::NotificationConfig
- value (::Google::Cloud::Container::V1::NotificationConfig) — Notification configuration of the cluster.
- (::Google::Cloud::Container::V1::NotificationConfig) — Notification configuration of the cluster.
#private_cluster_config
def private_cluster_config() -> ::Google::Cloud::Container::V1::PrivateClusterConfig
- (::Google::Cloud::Container::V1::PrivateClusterConfig) — Configuration for private cluster.
#private_cluster_config=
def private_cluster_config=(value) -> ::Google::Cloud::Container::V1::PrivateClusterConfig
- value (::Google::Cloud::Container::V1::PrivateClusterConfig) — Configuration for private cluster.
- (::Google::Cloud::Container::V1::PrivateClusterConfig) — Configuration for private cluster.
#release_channel
def release_channel() -> ::Google::Cloud::Container::V1::ReleaseChannel
- (::Google::Cloud::Container::V1::ReleaseChannel) — Release channel configuration.
#release_channel=
def release_channel=(value) -> ::Google::Cloud::Container::V1::ReleaseChannel
- value (::Google::Cloud::Container::V1::ReleaseChannel) — Release channel configuration.
- (::Google::Cloud::Container::V1::ReleaseChannel) — Release channel configuration.
#resource_labels
def resource_labels() -> ::Google::Protobuf::Map{::String => ::String}
- (::Google::Protobuf::Map{::String => ::String}) — The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
#resource_labels=
def resource_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
- value (::Google::Protobuf::Map{::String => ::String}) — The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
- (::Google::Protobuf::Map{::String => ::String}) — The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
#resource_usage_export_config
def resource_usage_export_config() -> ::Google::Cloud::Container::V1::ResourceUsageExportConfig
- (::Google::Cloud::Container::V1::ResourceUsageExportConfig) — Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
#resource_usage_export_config=
def resource_usage_export_config=(value) -> ::Google::Cloud::Container::V1::ResourceUsageExportConfig
- value (::Google::Cloud::Container::V1::ResourceUsageExportConfig) — Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
- (::Google::Cloud::Container::V1::ResourceUsageExportConfig) — Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
#self_link
def self_link() -> ::String
- (::String) — [Output only] Server-defined URL for the resource.
#self_link=
def self_link=(value) -> ::String
- value (::String) — [Output only] Server-defined URL for the resource.
- (::String) — [Output only] Server-defined URL for the resource.
#services_ipv4_cidr
def services_ipv4_cidr() -> ::String
-
(::String) — [Output only] The IP address range of the Kubernetes services in
this cluster, in
CIDR
notation (e.g.
1.2.3.4/29
). Service addresses are typically put in the last/16
from the container CIDR.
#services_ipv4_cidr=
def services_ipv4_cidr=(value) -> ::String
-
value (::String) — [Output only] The IP address range of the Kubernetes services in
this cluster, in
CIDR
notation (e.g.
1.2.3.4/29
). Service addresses are typically put in the last/16
from the container CIDR.
-
(::String) — [Output only] The IP address range of the Kubernetes services in
this cluster, in
CIDR
notation (e.g.
1.2.3.4/29
). Service addresses are typically put in the last/16
from the container CIDR.
#shielded_nodes
def shielded_nodes() -> ::Google::Cloud::Container::V1::ShieldedNodes
- (::Google::Cloud::Container::V1::ShieldedNodes) — Shielded Nodes configuration.
#shielded_nodes=
def shielded_nodes=(value) -> ::Google::Cloud::Container::V1::ShieldedNodes
- value (::Google::Cloud::Container::V1::ShieldedNodes) — Shielded Nodes configuration.
- (::Google::Cloud::Container::V1::ShieldedNodes) — Shielded Nodes configuration.
#status
def status() -> ::Google::Cloud::Container::V1::Cluster::Status
- (::Google::Cloud::Container::V1::Cluster::Status) — [Output only] The current status of this cluster.
#status=
def status=(value) -> ::Google::Cloud::Container::V1::Cluster::Status
- value (::Google::Cloud::Container::V1::Cluster::Status) — [Output only] The current status of this cluster.
- (::Google::Cloud::Container::V1::Cluster::Status) — [Output only] The current status of this cluster.
#status_message
def status_message() -> ::String
- (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
#status_message=
def status_message=(value) -> ::String
- value (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
- (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
#subnetwork
def subnetwork() -> ::String
- (::String) — The name of the Google Compute Engine subnetwork to which the cluster is connected.
#subnetwork=
def subnetwork=(value) -> ::String
- value (::String) — The name of the Google Compute Engine subnetwork to which the cluster is connected.
- (::String) — The name of the Google Compute Engine subnetwork to which the cluster is connected.
#tpu_ipv4_cidr_block
def tpu_ipv4_cidr_block() -> ::String
-
(::String) — [Output only] The IP address range of the Cloud TPUs in this cluster, in
CIDR
notation (e.g.
1.2.3.4/29
).
#tpu_ipv4_cidr_block=
def tpu_ipv4_cidr_block=(value) -> ::String
-
value (::String) — [Output only] The IP address range of the Cloud TPUs in this cluster, in
CIDR
notation (e.g.
1.2.3.4/29
).
-
(::String) — [Output only] The IP address range of the Cloud TPUs in this cluster, in
CIDR
notation (e.g.
1.2.3.4/29
).
#vertical_pod_autoscaling
def vertical_pod_autoscaling() -> ::Google::Cloud::Container::V1::VerticalPodAutoscaling
- (::Google::Cloud::Container::V1::VerticalPodAutoscaling) — Cluster-level Vertical Pod Autoscaling configuration.
#vertical_pod_autoscaling=
def vertical_pod_autoscaling=(value) -> ::Google::Cloud::Container::V1::VerticalPodAutoscaling
- value (::Google::Cloud::Container::V1::VerticalPodAutoscaling) — Cluster-level Vertical Pod Autoscaling configuration.
- (::Google::Cloud::Container::V1::VerticalPodAutoscaling) — Cluster-level Vertical Pod Autoscaling configuration.
#workload_identity_config
def workload_identity_config() -> ::Google::Cloud::Container::V1::WorkloadIdentityConfig
- (::Google::Cloud::Container::V1::WorkloadIdentityConfig) — Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
#workload_identity_config=
def workload_identity_config=(value) -> ::Google::Cloud::Container::V1::WorkloadIdentityConfig
- value (::Google::Cloud::Container::V1::WorkloadIdentityConfig) — Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
- (::Google::Cloud::Container::V1::WorkloadIdentityConfig) — Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
#zone
def zone() -> ::String
- (::String) — [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
#zone=
def zone=(value) -> ::String
- value (::String) — [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
- (::String) — [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.