Class: Google::Apis::ContainerV1beta1::Cluster

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/container_v1beta1/classes.rb,
generated/google/apis/container_v1beta1/representations.rb,
generated/google/apis/container_v1beta1/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



567
568
569
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 567

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

Instance Attribute Details

#addons_config ⇒ Google::Apis::ContainerV1beta1::AddonsConfig

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

Returns:



240
241
242
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 240

def addons_config
  @addons_config
end

#autoscaling ⇒ Google::Apis::ContainerV1beta1::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

Returns:



248
249
250
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 248

def autoscaling
  @autoscaling
end

#binary_authorization ⇒ Google::Apis::ContainerV1beta1::BinaryAuthorization

Configuration for Binary Authorization. Corresponds to the JSON property binaryAuthorization

Returns:



253
254
255
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 253

def binary_authorization
  @binary_authorization
end

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

Returns:

  • (String) 


261
262
263
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 261

def cluster_ipv4_cidr
  @cluster_ipv4_cidr
end

#conditions ⇒ Array<Google::Apis::ContainerV1beta1::StatusCondition>

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

Returns:



266
267
268
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 266

def conditions
  @conditions
end

#create_time ⇒ String

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

Returns:

  • (String) 


272
273
274
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 272

def create_time
  @create_time
end

#current_master_version ⇒ String

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

Returns:

  • (String) 


277
278
279
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 277

def current_master_version
  @current_master_version
end

#current_node_count ⇒ Fixnum

[Output only] The number of nodes currently in the cluster. Corresponds to the JSON property currentNodeCount

Returns:

  • (Fixnum) 


282
283
284
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 282

def current_node_count
  @current_node_count
end

#current_node_version ⇒ String

[Output only] Deprecated, use NodePool.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) 


292
293
294
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 292

def current_node_version
  @current_node_version
end

#default_max_pods_constraint ⇒ Google::Apis::ContainerV1beta1::MaxPodsConstraint

Constraints applied to pods. Corresponds to the JSON property defaultMaxPodsConstraint

Returns:



297
298
299
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 297

def default_max_pods_constraint
  @default_max_pods_constraint
end

#description ⇒ String

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

Returns:

  • (String) 


302
303
304
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 302

def description
  @description
end

#enable_kubernetes_alpha ⇒ Boolean Also known as: enable_kubernetes_alpha?

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) 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) 


312
313
314
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 312

def enable_kubernetes_alpha
  @enable_kubernetes_alpha
end

#enable_tpu ⇒ Boolean Also known as: enable_tpu?

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

Returns:

  • (Boolean) 


318
319
320
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 318

def enable_tpu
  @enable_tpu
end

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

Returns:

  • (String) 


328
329
330
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 328

def endpoint
  @endpoint
end

#expire_time ⇒ String

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

Returns:

  • (String) 


334
335
336
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 334

def expire_time
  @expire_time
end

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

Returns:

  • (String) 


349
350
351
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 349

def initial_cluster_version
  @initial_cluster_version
end

#initial_node_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


361
362
363
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 361

def initial_node_count
  @initial_node_count
end

#instance_group_urls ⇒ Array<String>

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

Returns:

  • (Array<String>) 


366
367
368
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 366

def instance_group_urls
  @instance_group_urls
end

#ip_allocation_policy ⇒ Google::Apis::ContainerV1beta1::IpAllocationPolicy

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

Returns:



371
372
373
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 371

def ip_allocation_policy
  @ip_allocation_policy
end

#label_fingerprint ⇒ String

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

Returns:

  • (String) 


376
377
378
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 376

def label_fingerprint
  @label_fingerprint
end

#legacy_abac ⇒ Google::Apis::ContainerV1beta1::LegacyAbac

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

Returns:



382
383
384
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 382

def legacy_abac
  @legacy_abac
end

#location ⇒ String

[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) 


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

def location
  @location
end

#locations ⇒ Array<String>

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

Returns:

  • (Array<String>) 


397
398
399
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 397

def locations
  @locations
end

#logging_service ⇒ String

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

  • logging.googleapis.com - the Google Cloud Logging service.
  • none - no logs will be exported from the cluster.
  • if left as an empty string,logging.googleapis.com will be used. Corresponds to the JSON property loggingService

Returns:

  • (String) 


406
407
408
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 406

def logging_service
  @logging_service
end

#maintenance_policy ⇒ Google::Apis::ContainerV1beta1::MaintenancePolicy

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

Returns:



411
412
413
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 411

def maintenance_policy
  @maintenance_policy
end

#master_auth ⇒ Google::Apis::ContainerV1beta1::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

Returns:



418
419
420
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 418

def master_auth
  @master_auth
end

#master_authorized_networks_config ⇒ Google::Apis::ContainerV1beta1::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

Returns:



426
427
428
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 426

def master_authorized_networks_config
  @master_authorized_networks_config
end

#master_ipv4_cidr_block ⇒ String

The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. Corresponds to the JSON property masterIpv4CidrBlock

Returns:

  • (String) 


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

def master_ipv4_cidr_block
  @master_ipv4_cidr_block
end

#monitoring_service ⇒ String

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

  • monitoring.googleapis.com - the Google Cloud Monitoring service.
  • none - no metrics will be exported from the cluster.
  • if left as an empty string, monitoring.googleapis.com will be used. Corresponds to the JSON property monitoringService

Returns:

  • (String) 


444
445
446
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 444

def monitoring_service
  @monitoring_service
end

#name ⇒ String

The name of this cluster. The name must be unique within this project and zone, 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) 


453
454
455
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 453

def name
  @name
end

#network ⇒ String

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

Returns:

  • (String) 


462
463
464
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 462

def network
  @network
end

#network_config ⇒ Google::Apis::ContainerV1beta1::NetworkConfig

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

Returns:



467
468
469
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 467

def network_config
  @network_config
end

#network_policy ⇒ Google::Apis::ContainerV1beta1::NetworkPolicy

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

Returns:



473
474
475
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 473

def network_policy
  @network_policy
end

#node_config ⇒ Google::Apis::ContainerV1beta1::NodeConfig

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

Returns:



478
479
480
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 478

def node_config
  @node_config
end

#node_ipv4_cidr_size ⇒ Fixnum

[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. Corresponds to the JSON property nodeIpv4CidrSize

Returns:

  • (Fixnum) 


485
486
487
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 485

def node_ipv4_cidr_size
  @node_ipv4_cidr_size
end

#node_pools ⇒ Array<Google::Apis::ContainerV1beta1::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

Returns:



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

def node_pools
  @node_pools
end

#pod_security_policy_config ⇒ Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig

Configuration for the PodSecurityPolicy feature. Corresponds to the JSON property podSecurityPolicyConfig

Returns:



497
498
499
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 497

def pod_security_policy_config
  @pod_security_policy_config
end

#private_cluster ⇒ Boolean Also known as: private_cluster?

If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enabled instead. Corresponds to the JSON property privateCluster

Returns:

  • (Boolean) 


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

def private_cluster
  @private_cluster
end

#private_cluster_config ⇒ Google::Apis::ContainerV1beta1::PrivateClusterConfig

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

Returns:



511
512
513
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 511

def private_cluster_config
  @private_cluster_config
end

#resource_labels ⇒ Hash<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>) 


517
518
519
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 517

def resource_labels
  @resource_labels
end

#self_link ⇒ String

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

Returns:

  • (String) 


522
523
524
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 522

def self_link
  @self_link
end

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

Returns:

  • (String) 


531
532
533
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 531

def services_ipv4_cidr
  @services_ipv4_cidr
end

#status ⇒ String

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

Returns:

  • (String) 


536
537
538
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 536

def status
  @status
end

#status_message ⇒ String

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

Returns:

  • (String) 


542
543
544
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 542

def status_message
  @status_message
end

#subnetwork ⇒ String

The name of the Google Compute Engine subnetwork to which the cluster is connected. On output this shows the subnetwork ID instead of the name. Corresponds to the JSON property subnetwork

Returns:

  • (String) 


550
551
552
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 550

def subnetwork
  @subnetwork
end

#tpu_ipv4_cidr_block ⇒ String

[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) 


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

def tpu_ipv4_cidr_block
  @tpu_ipv4_cidr_block
end

#zone ⇒ String

[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) 


565
566
567
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 565

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 572

def update!(**args)
  @addons_config = args[:addons_config] if args.key?(:addons_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)
  @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)
  @master_ipv4_cidr_block = args[:master_ipv4_cidr_block] if args.key?(:master_ipv4_cidr_block)
  @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)
  @pod_security_policy_config = args[:pod_security_policy_config] if args.key?(:pod_security_policy_config)
  @private_cluster = args[:private_cluster] if args.key?(:private_cluster)
  @private_cluster_config = args[:private_cluster_config] if args.key?(:private_cluster_config)
  @resource_labels = args[:resource_labels] if args.key?(:resource_labels)
  @self_link = args[:self_link] if args.key?(:self_link)
  @services_ipv4_cidr = args[:services_ipv4_cidr] if args.key?(:services_ipv4_cidr)
  @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)
  @zone = args[:zone] if args.key?(:zone)
end