Class: Google::Apis::ContainerV1::Cluster

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/container_v1/classes.rb,
generated/google/apis/container_v1/representations.rb,
generated/google/apis/container_v1/representations.rb

Overview

A Google Kubernetes Engine cluster.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Cluster

Returns a new instance of Cluster.



722
723
724
# File 'generated/google/apis/container_v1/classes.rb', line 722

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#addons_configGoogle::Apis::ContainerV1::AddonsConfig

Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. Corresponds to the JSON property addonsConfig



372
373
374
# File 'generated/google/apis/container_v1/classes.rb', line 372

def addons_config
  @addons_config
end

#authenticator_groups_configGoogle::Apis::ContainerV1::AuthenticatorGroupsConfig

Configuration for returning group information from authenticators. Corresponds to the JSON property authenticatorGroupsConfig



377
378
379
# File 'generated/google/apis/container_v1/classes.rb', line 377

def authenticator_groups_config
  @authenticator_groups_config
end

#autoscalingGoogle::Apis::ContainerV1::ClusterAutoscaling

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



385
386
387
# File 'generated/google/apis/container_v1/classes.rb', line 385

def autoscaling
  @autoscaling
end

#binary_authorizationGoogle::Apis::ContainerV1::BinaryAuthorization

Configuration for Binary Authorization. Corresponds to the JSON property binaryAuthorization



390
391
392
# File 'generated/google/apis/container_v1/classes.rb', line 390

def binary_authorization
  @binary_authorization
end

#cluster_ipv4_cidrString

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 in 10.0.0.0/8. Corresponds to the JSON property clusterIpv4Cidr

Returns:

  • (String)


398
399
400
# File 'generated/google/apis/container_v1/classes.rb', line 398

def cluster_ipv4_cidr
  @cluster_ipv4_cidr
end

#conditionsArray<Google::Apis::ContainerV1::StatusCondition>

Which conditions caused the current cluster state. Corresponds to the JSON property conditions



403
404
405
# File 'generated/google/apis/container_v1/classes.rb', line 403

def conditions
  @conditions
end

#create_timeString

[Output only] The time the cluster was created, in RFC3339 text format. Corresponds to the JSON property createTime

Returns:

  • (String)


409
410
411
# File 'generated/google/apis/container_v1/classes.rb', line 409

def create_time
  @create_time
end

#current_master_versionString

[Output only] The current software version of the master endpoint. Corresponds to the JSON property currentMasterVersion

Returns:

  • (String)


414
415
416
# File 'generated/google/apis/container_v1/classes.rb', line 414

def current_master_version
  @current_master_version
end

#current_node_countFixnum

[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. Corresponds to the JSON property currentNodeCount

Returns:

  • (Fixnum)


420
421
422
# File 'generated/google/apis/container_v1/classes.rb', line 420

def current_node_count
  @current_node_count
end

#current_node_versionString

[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. Corresponds to the JSON property currentNodeVersion

Returns:

  • (String)


430
431
432
# File 'generated/google/apis/container_v1/classes.rb', line 430

def current_node_version
  @current_node_version
end

#database_encryptionGoogle::Apis::ContainerV1::DatabaseEncryption

Configuration of etcd encryption. Corresponds to the JSON property databaseEncryption



435
436
437
# File 'generated/google/apis/container_v1/classes.rb', line 435

def database_encryption
  @database_encryption
end

#default_max_pods_constraintGoogle::Apis::ContainerV1::MaxPodsConstraint

Constraints applied to pods. Corresponds to the JSON property defaultMaxPodsConstraint



440
441
442
# File 'generated/google/apis/container_v1/classes.rb', line 440

def default_max_pods_constraint
  @default_max_pods_constraint
end

#descriptionString

An optional description of this cluster. Corresponds to the JSON property description

Returns:

  • (String)


445
446
447
# File 'generated/google/apis/container_v1/classes.rb', line 445

def description
  @description
end

#enable_kubernetes_alphaBoolean Also known as: 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. Corresponds to the JSON property enableKubernetesAlpha

Returns:

  • (Boolean)


455
456
457
# File 'generated/google/apis/container_v1/classes.rb', line 455

def enable_kubernetes_alpha
  @enable_kubernetes_alpha
end

#enable_tpuBoolean Also known as: enable_tpu?

Enable the ability to use Cloud TPUs in this cluster. Corresponds to the JSON property enableTpu

Returns:

  • (Boolean)


461
462
463
# File 'generated/google/apis/container_v1/classes.rb', line 461

def enable_tpu
  @enable_tpu
end

#endpointString

[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. Corresponds to the JSON property endpoint

Returns:

  • (String)


471
472
473
# File 'generated/google/apis/container_v1/classes.rb', line 471

def endpoint
  @endpoint
end

#expire_timeString

[Output only] The time the cluster will be automatically deleted in RFC3339 text format. Corresponds to the JSON property expireTime

Returns:

  • (String)


477
478
479
# File 'generated/google/apis/container_v1/classes.rb', line 477

def expire_time
  @expire_time
end

#initial_cluster_versionString

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 Corresponds to the JSON property initialClusterVersion

Returns:

  • (String)


492
493
494
# File 'generated/google/apis/container_v1/classes.rb', line 492

def initial_cluster_version
  @initial_cluster_version
end

#initial_node_countFixnum

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. Corresponds to the JSON property initialNodeCount

Returns:

  • (Fixnum)


505
506
507
# File 'generated/google/apis/container_v1/classes.rb', line 505

def initial_node_count
  @initial_node_count
end

#instance_group_urlsArray<String>

Deprecated. Use node_pools.instance_group_urls. Corresponds to the JSON property instanceGroupUrls

Returns:

  • (Array<String>)


510
511
512
# File 'generated/google/apis/container_v1/classes.rb', line 510

def instance_group_urls
  @instance_group_urls
end

#ip_allocation_policyGoogle::Apis::ContainerV1::IpAllocationPolicy

Configuration for controlling how IPs are allocated in the cluster. Corresponds to the JSON property ipAllocationPolicy



515
516
517
# File 'generated/google/apis/container_v1/classes.rb', line 515

def ip_allocation_policy
  @ip_allocation_policy
end

#label_fingerprintString

The fingerprint of the set of labels for this cluster. Corresponds to the JSON property labelFingerprint

Returns:

  • (String)


520
521
522
# File 'generated/google/apis/container_v1/classes.rb', line 520

def label_fingerprint
  @label_fingerprint
end

#legacy_abacGoogle::Apis::ContainerV1::LegacyAbac

Configuration for the legacy Attribute Based Access Control authorization mode. Corresponds to the JSON property legacyAbac



526
527
528
# File 'generated/google/apis/container_v1/classes.rb', line 526

def legacy_abac
  @legacy_abac
end

#locationString

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides. Corresponds to the JSON property location

Returns:

  • (String)


537
538
539
# File 'generated/google/apis/container_v1/classes.rb', line 537

def location
  @location
end

#locationsArray<String>

The list of Google Compute Engine zones in which the cluster's nodes should be located. Corresponds to the JSON property locations

Returns:

  • (Array<String>)


544
545
546
# File 'generated/google/apis/container_v1/classes.rb', line 544

def locations
  @locations
end

#logging_serviceString

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 model
  • logging.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+ or logging.googleapis.com for earlier versions. Corresponds to the JSON property loggingService

Returns:

  • (String)


557
558
559
# File 'generated/google/apis/container_v1/classes.rb', line 557

def logging_service
  @logging_service
end

#maintenance_policyGoogle::Apis::ContainerV1::MaintenancePolicy

MaintenancePolicy defines the maintenance policy to be used for the cluster. Corresponds to the JSON property maintenancePolicy



562
563
564
# File 'generated/google/apis/container_v1/classes.rb', line 562

def maintenance_policy
  @maintenance_policy
end

#master_authGoogle::Apis::ContainerV1::MasterAuth

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



569
570
571
# File 'generated/google/apis/container_v1/classes.rb', line 569

def master_auth
  @master_auth
end

#master_authorized_networks_configGoogle::Apis::ContainerV1::MasterAuthorizedNetworksConfig

Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. Corresponds to the JSON property masterAuthorizedNetworksConfig



577
578
579
# File 'generated/google/apis/container_v1/classes.rb', line 577

def master_authorized_networks_config
  @master_authorized_networks_config
end

#monitoring_serviceString

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+ or monitoring.googleapis.com for earlier versions. Corresponds to the JSON property monitoringService

Returns:

  • (String)


590
591
592
# File 'generated/google/apis/container_v1/classes.rb', line 590

def monitoring_service
  @monitoring_service
end

#nameString

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. Corresponds to the JSON property name

Returns:

  • (String)


600
601
602
# File 'generated/google/apis/container_v1/classes.rb', line 600

def name
  @name
end

#networkString

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used. Corresponds to the JSON property network

Returns:

  • (String)


609
610
611
# File 'generated/google/apis/container_v1/classes.rb', line 609

def network
  @network
end

#network_configGoogle::Apis::ContainerV1::NetworkConfig

NetworkConfig reports the relative names of network & subnetwork. Corresponds to the JSON property networkConfig



614
615
616
# File 'generated/google/apis/container_v1/classes.rb', line 614

def network_config
  @network_config
end

#network_policyGoogle::Apis::ContainerV1::NetworkPolicy

Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ Corresponds to the JSON property networkPolicy



620
621
622
# File 'generated/google/apis/container_v1/classes.rb', line 620

def network_policy
  @network_policy
end

#node_configGoogle::Apis::ContainerV1::NodeConfig

Parameters that describe the nodes in a cluster. Corresponds to the JSON property nodeConfig



625
626
627
# File 'generated/google/apis/container_v1/classes.rb', line 625

def node_config
  @node_config
end

#node_ipv4_cidr_sizeFixnum

[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. Corresponds to the JSON property nodeIpv4CidrSize

Returns:

  • (Fixnum)


633
634
635
# File 'generated/google/apis/container_v1/classes.rb', line 633

def node_ipv4_cidr_size
  @node_ipv4_cidr_size
end

#node_poolsArray<Google::Apis::ContainerV1::NodePool>

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. Corresponds to the JSON property nodePools



640
641
642
# File 'generated/google/apis/container_v1/classes.rb', line 640

def node_pools
  @node_pools
end

#private_cluster_configGoogle::Apis::ContainerV1::PrivateClusterConfig

Configuration options for private clusters. Corresponds to the JSON property privateClusterConfig



645
646
647
# File 'generated/google/apis/container_v1/classes.rb', line 645

def private_cluster_config
  @private_cluster_config
end

#resource_labelsHash<String,String>

The resource labels for the cluster to use to annotate any related Google Compute Engine resources. Corresponds to the JSON property resourceLabels

Returns:

  • (Hash<String,String>)


651
652
653
# File 'generated/google/apis/container_v1/classes.rb', line 651

def resource_labels
  @resource_labels
end

#resource_usage_export_configGoogle::Apis::ContainerV1::ResourceUsageExportConfig

Configuration for exporting cluster resource usages. Corresponds to the JSON property resourceUsageExportConfig



656
657
658
# File 'generated/google/apis/container_v1/classes.rb', line 656

def resource_usage_export_config
  @resource_usage_export_config
end

[Output only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String)


661
662
663
# File 'generated/google/apis/container_v1/classes.rb', line 661

def self_link
  @self_link
end

#services_ipv4_cidrString

[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. Corresponds to the JSON property servicesIpv4Cidr

Returns:

  • (String)


670
671
672
# File 'generated/google/apis/container_v1/classes.rb', line 670

def services_ipv4_cidr
  @services_ipv4_cidr
end

#shielded_nodesGoogle::Apis::ContainerV1::ShieldedNodes

Configuration of Shielded Nodes feature. Corresponds to the JSON property shieldedNodes



675
676
677
# File 'generated/google/apis/container_v1/classes.rb', line 675

def shielded_nodes
  @shielded_nodes
end

#statusString

[Output only] The current status of this cluster. Corresponds to the JSON property status

Returns:

  • (String)


680
681
682
# File 'generated/google/apis/container_v1/classes.rb', line 680

def status
  @status
end

#status_messageString

[Output only] Additional information about the current status of this cluster, if available. Corresponds to the JSON property statusMessage

Returns:

  • (String)


686
687
688
# File 'generated/google/apis/container_v1/classes.rb', line 686

def status_message
  @status_message
end

#subnetworkString

The name of the Google Compute Engine subnetwork to which the cluster is connected. Corresponds to the JSON property subnetwork

Returns:

  • (String)


693
694
695
# File 'generated/google/apis/container_v1/classes.rb', line 693

def subnetwork
  @subnetwork
end

#tpu_ipv4_cidr_blockString

[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Corresponds to the JSON property tpuIpv4CidrBlock

Returns:

  • (String)


700
701
702
# File 'generated/google/apis/container_v1/classes.rb', line 700

def tpu_ipv4_cidr_block
  @tpu_ipv4_cidr_block
end

#vertical_pod_autoscalingGoogle::Apis::ContainerV1::VerticalPodAutoscaling

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



707
708
709
# File 'generated/google/apis/container_v1/classes.rb', line 707

def vertical_pod_autoscaling
  @vertical_pod_autoscaling
end

#workload_identity_configGoogle::Apis::ContainerV1::WorkloadIdentityConfig

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. Corresponds to the JSON property workloadIdentityConfig



713
714
715
# File 'generated/google/apis/container_v1/classes.rb', line 713

def workload_identity_config
  @workload_identity_config
end

#zoneString

[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead. Corresponds to the JSON property zone

Returns:

  • (String)


720
721
722
# File 'generated/google/apis/container_v1/classes.rb', line 720

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
# File 'generated/google/apis/container_v1/classes.rb', line 727

def update!(**args)
  @addons_config = args[:addons_config] if args.key?(:addons_config)
  @authenticator_groups_config = args[:authenticator_groups_config] if args.key?(:authenticator_groups_config)
  @autoscaling = args[:autoscaling] if args.key?(:autoscaling)
  @binary_authorization = args[:binary_authorization] if args.key?(:binary_authorization)
  @cluster_ipv4_cidr = args[:cluster_ipv4_cidr] if args.key?(:cluster_ipv4_cidr)
  @conditions = args[:conditions] if args.key?(:conditions)
  @create_time = args[:create_time] if args.key?(:create_time)
  @current_master_version = args[:current_master_version] if args.key?(:current_master_version)
  @current_node_count = args[:current_node_count] if args.key?(:current_node_count)
  @current_node_version = args[:current_node_version] if args.key?(:current_node_version)
  @database_encryption = args[:database_encryption] if args.key?(:database_encryption)
  @default_max_pods_constraint = args[:default_max_pods_constraint] if args.key?(:default_max_pods_constraint)
  @description = args[:description] if args.key?(:description)
  @enable_kubernetes_alpha = args[:enable_kubernetes_alpha] if args.key?(:enable_kubernetes_alpha)
  @enable_tpu = args[:enable_tpu] if args.key?(:enable_tpu)
  @endpoint = args[:endpoint] if args.key?(:endpoint)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @initial_cluster_version = args[:initial_cluster_version] if args.key?(:initial_cluster_version)
  @initial_node_count = args[:initial_node_count] if args.key?(:initial_node_count)
  @instance_group_urls = args[:instance_group_urls] if args.key?(:instance_group_urls)
  @ip_allocation_policy = args[:ip_allocation_policy] if args.key?(:ip_allocation_policy)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @legacy_abac = args[:legacy_abac] if args.key?(:legacy_abac)
  @location = args[:location] if args.key?(:location)
  @locations = args[:locations] if args.key?(:locations)
  @logging_service = args[:logging_service] if args.key?(:logging_service)
  @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy)
  @master_auth = args[:master_auth] if args.key?(:master_auth)
  @master_authorized_networks_config = args[:master_authorized_networks_config] if args.key?(:master_authorized_networks_config)
  @monitoring_service = args[:monitoring_service] if args.key?(:monitoring_service)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @network_config = args[:network_config] if args.key?(:network_config)
  @network_policy = args[:network_policy] if args.key?(:network_policy)
  @node_config = args[:node_config] if args.key?(:node_config)
  @node_ipv4_cidr_size = args[:node_ipv4_cidr_size] if args.key?(:node_ipv4_cidr_size)
  @node_pools = args[:node_pools] if args.key?(:node_pools)
  @private_cluster_config = args[:private_cluster_config] if args.key?(:private_cluster_config)
  @resource_labels = args[:resource_labels] if args.key?(:resource_labels)
  @resource_usage_export_config = args[:resource_usage_export_config] if args.key?(:resource_usage_export_config)
  @self_link = args[:self_link] if args.key?(:self_link)
  @services_ipv4_cidr = args[:services_ipv4_cidr] if args.key?(:services_ipv4_cidr)
  @shielded_nodes = args[:shielded_nodes] if args.key?(:shielded_nodes)
  @status = args[:status] if args.key?(:status)
  @status_message = args[:status_message] if args.key?(:status_message)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @tpu_ipv4_cidr_block = args[:tpu_ipv4_cidr_block] if args.key?(:tpu_ipv4_cidr_block)
  @vertical_pod_autoscaling = args[:vertical_pod_autoscaling] if args.key?(:vertical_pod_autoscaling)
  @workload_identity_config = args[:workload_identity_config] if args.key?(:workload_identity_config)
  @zone = args[:zone] if args.key?(:zone)
end