Class: Google::Container::V1::ClusterUpdate

Inherits:

Object

• Object
• Google::Container::V1::ClusterUpdate

Defined in:

lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb

Overview

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

Instance Attribute Summary

• #desired_addons_config ⇒ Google::Container::V1::AddonsConfig

  Configurations for the various addons available to run in the cluster.

• #desired_binary_authorization ⇒ Google::Container::V1::BinaryAuthorization

  The desired configuration options for the Binary Authorization feature.

• #desired_cluster_autoscaling ⇒ Google::Container::V1::ClusterAutoscaling

  Cluster-level autoscaling configuration.

• #desired_database_encryption ⇒ Google::Container::V1::DatabaseEncryption

  Configuration of etcd encryption.

• #desired_image_type ⇒ String

  The desired image type for the node pool.

• #desired_intra_node_visibility_config ⇒ Google::Container::V1::IntraNodeVisibilityConfig

  The desired config of Intra-node visibility.

• #desired_locations ⇒ Array<String>

  The desired list of Google Compute Engine zones in which the cluster's nodes should be located.

• #desired_logging_service ⇒ String

  The logging service the cluster should use to write logs.

• #desired_master_authorized_networks_config ⇒ Google::Container::V1::MasterAuthorizedNetworksConfig

  The desired configuration options for master authorized networks feature.

• #desired_master_version ⇒ String

  The Kubernetes version to change the master to.

• #desired_monitoring_service ⇒ String

  The monitoring service the cluster should use to write metrics.

• #desired_node_pool_autoscaling ⇒ Google::Container::V1::NodePoolAutoscaling

  Autoscaler configuration for the node pool specified in desired_node_pool_id.

• #desired_node_pool_id ⇒ String

  The node pool to be upgraded.

• #desired_node_version ⇒ String

  The Kubernetes version to change the nodes to (typically an upgrade).

• #desired_resource_usage_export_config ⇒ Google::Container::V1::ResourceUsageExportConfig

  The desired configuration for exporting resource usage.

• #desired_vertical_pod_autoscaling ⇒ Google::Container::V1::VerticalPodAutoscaling

  Cluster-level Vertical Pod Autoscaling configuration.

Instance Attribute Details

#desired_addons_config ⇒ Google::Container::V1::AddonsConfig

Returns Configurations for the various addons available to run in the cluster.

Returns:

• (Google::Container::V1::AddonsConfig) —

  Configurations for the various addons available to run in the cluster.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_binary_authorization ⇒ Google::Container::V1::BinaryAuthorization

Returns The desired configuration options for the Binary Authorization feature.

Returns:

• (Google::Container::V1::BinaryAuthorization) —

  The desired configuration options for the Binary Authorization feature.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_cluster_autoscaling ⇒ Google::Container::V1::ClusterAutoscaling

Returns Cluster-level autoscaling configuration.

Returns:

• (Google::Container::V1::ClusterAutoscaling) —

  Cluster-level autoscaling configuration.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_database_encryption ⇒ Google::Container::V1::DatabaseEncryption

Returns Configuration of etcd encryption.

Returns:

• (Google::Container::V1::DatabaseEncryption) —

  Configuration of etcd encryption.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_image_type ⇒ String

Returns The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

Returns:

• (String) —

  The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_intra_node_visibility_config ⇒ Google::Container::V1::IntraNodeVisibilityConfig

Returns The desired config of Intra-node visibility.

Returns:

• (Google::Container::V1::IntraNodeVisibilityConfig) —

  The desired config of Intra-node visibility.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_locations ⇒ Array<String>

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

Returns:

• (Array<String>) —

  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.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_logging_service ⇒ String

Returns The logging service the cluster should use to write logs. Currently available options:

• "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model
• "logging.googleapis.com" - the Google Cloud Logging service
• "none" - no logs will be exported from the cluster.

Returns:

• (String) —

  The logging service the cluster should use to write logs. Currently available options:

  • "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model
  • "logging.googleapis.com" - the Google Cloud Logging service
  • "none" - no logs will be exported from the cluster

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_master_authorized_networks_config ⇒ Google::Container::V1::MasterAuthorizedNetworksConfig

Returns The desired configuration options for master authorized networks feature.

Returns:

• (Google::Container::V1::MasterAuthorizedNetworksConfig) —

  The desired configuration options for master authorized networks feature.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_master_version ⇒ String

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

Returns:

• (String) —

  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

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_monitoring_service ⇒ String

Returns The monitoring service the cluster should use to write metrics. Currently available options:

• "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model
• "monitoring.googleapis.com" - the Google Cloud Monitoring service
• "none" - no metrics will be exported from the cluster.

Returns:

• (String) —

  The monitoring service the cluster should use to write metrics. Currently available options:

  • "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model
  • "monitoring.googleapis.com" - the Google Cloud Monitoring service
  • "none" - no metrics will be exported from the cluster

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_node_pool_autoscaling ⇒ Google::Container::V1::NodePoolAutoscaling

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

Returns:

• (Google::Container::V1::NodePoolAutoscaling) —

  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.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_node_pool_id ⇒ String

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

Returns:

• (String) —

  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.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_node_version ⇒ String

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

Returns:

• (String) —

  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

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_resource_usage_export_config ⇒ Google::Container::V1::ResourceUsageExportConfig

Returns The desired configuration for exporting resource usage.

Returns:

• (Google::Container::V1::ResourceUsageExportConfig) —

  The desired configuration for exporting resource usage.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end

#desired_vertical_pod_autoscaling ⇒ Google::Container::V1::VerticalPodAutoscaling

Returns Cluster-level Vertical Pod Autoscaling configuration.

Returns:

• (Google::Container::V1::VerticalPodAutoscaling) —

  Cluster-level Vertical Pod Autoscaling configuration.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 881

class ClusterUpdate; end