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 Container 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



284
285
286
 
# File 'generated/google/apis/container_v1/classes.rb', line 284

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

Instance Attribute Details

#addons_config ⇒ Google::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

Returns:



148
149
150
 
# File 'generated/google/apis/container_v1/classes.rb', line 148

def addons_config
  @addons_config
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) 


219
220
221
 
# File 'generated/google/apis/container_v1/classes.rb', line 219

def cluster_ipv4_cidr
  @cluster_ipv4_cidr
end

#create_time ⇒ String

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

Returns:

  • (String) 


211
212
213
 
# File 'generated/google/apis/container_v1/classes.rb', line 211

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) 


137
138
139
 
# File 'generated/google/apis/container_v1/classes.rb', line 137

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) 


68
69
70
 
# File 'generated/google/apis/container_v1/classes.rb', line 68

def current_node_count
  @current_node_count
end

#current_node_version ⇒ String

[Output only] 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) 


160
161
162
 
# File 'generated/google/apis/container_v1/classes.rb', line 160

def current_node_version
  @current_node_version
end

#description ⇒ String

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

Returns:

  • (String) 


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

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


276
277
278
 
# File 'generated/google/apis/container_v1/classes.rb', line 276

def enable_kubernetes_alpha
  @enable_kubernetes_alpha
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) 


205
206
207
 
# File 'generated/google/apis/container_v1/classes.rb', line 205

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) 


103
104
105
 
# File 'generated/google/apis/container_v1/classes.rb', line 103

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

Returns:

  • (String) 


190
191
192
 
# File 'generated/google/apis/container_v1/classes.rb', line 190

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) 


231
232
233
 
# File 'generated/google/apis/container_v1/classes.rb', line 231

def initial_node_count
  @initial_node_count
end

#instance_group_urls ⇒ Array<String>

[Output only] The resource URLs of instance groups associated with this cluster. Corresponds to the JSON property instanceGroupUrls

Returns:

  • (Array<String>) 


257
258
259
 
# File 'generated/google/apis/container_v1/classes.rb', line 257

def instance_group_urls
  @instance_group_urls
end

#label_fingerprint ⇒ String

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

Returns:

  • (String) 


90
91
92
 
# File 'generated/google/apis/container_v1/classes.rb', line 90

def label_fingerprint
  @label_fingerprint
end

#legacy_abac ⇒ Google::Apis::ContainerV1::LegacyAbac

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

Returns:



196
197
198
 
# File 'generated/google/apis/container_v1/classes.rb', line 196

def legacy_abac
  @legacy_abac
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>) 


245
246
247
 
# File 'generated/google/apis/container_v1/classes.rb', line 245

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) 


119
120
121
 
# File 'generated/google/apis/container_v1/classes.rb', line 119

def logging_service
  @logging_service
end

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

Returns:



132
133
134
 
# File 'generated/google/apis/container_v1/classes.rb', line 132

def master_auth
  @master_auth
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) 


77
78
79
 
# File 'generated/google/apis/container_v1/classes.rb', line 77

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) 


182
183
184
 
# File 'generated/google/apis/container_v1/classes.rb', line 182

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

Returns:

  • (String) 


85
86
87
 
# File 'generated/google/apis/container_v1/classes.rb', line 85

def network
  @network
end

#node_config ⇒ Google::Apis::ContainerV1::NodeConfig

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

Returns:



142
143
144
 
# File 'generated/google/apis/container_v1/classes.rb', line 142

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) 


110
111
112
 
# File 'generated/google/apis/container_v1/classes.rb', line 110

def node_ipv4_cidr_size
  @node_ipv4_cidr_size
end

#node_pools ⇒ Array<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

Returns:



238
239
240
 
# File 'generated/google/apis/container_v1/classes.rb', line 238

def node_pools
  @node_pools
end

#resource_labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


173
174
175
 
# File 'generated/google/apis/container_v1/classes.rb', line 173

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) 


250
251
252
 
# File 'generated/google/apis/container_v1/classes.rb', line 250

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) 


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

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) 


153
154
155
 
# File 'generated/google/apis/container_v1/classes.rb', line 153

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) 


125
126
127
 
# File 'generated/google/apis/container_v1/classes.rb', line 125

def status_message
  @status_message
end

#subnetwork ⇒ String

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

Returns:

  • (String) 


167
168
169
 
# File 'generated/google/apis/container_v1/classes.rb', line 167

def subnetwork
  @subnetwork
end

#zone ⇒ String

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

Returns:

  • (String) 


97
98
99
 
# File 'generated/google/apis/container_v1/classes.rb', line 97

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'generated/google/apis/container_v1/classes.rb', line 289

def update!(**args)
  @current_node_count = args[:current_node_count] if args.key?(:current_node_count)
  @monitoring_service = args[:monitoring_service] if args.key?(:monitoring_service)
  @network = args[:network] if args.key?(:network)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @zone = args[:zone] if args.key?(:zone)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @node_ipv4_cidr_size = args[:node_ipv4_cidr_size] if args.key?(:node_ipv4_cidr_size)
  @logging_service = args[:logging_service] if args.key?(:logging_service)
  @status_message = args[:status_message] if args.key?(:status_message)
  @master_auth = args[:master_auth] if args.key?(:master_auth)
  @current_master_version = args[:current_master_version] if args.key?(:current_master_version)
  @node_config = args[:node_config] if args.key?(:node_config)
  @addons_config = args[:addons_config] if args.key?(:addons_config)
  @status = args[:status] if args.key?(:status)
  @current_node_version = args[:current_node_version] if args.key?(:current_node_version)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @resource_labels = args[:resource_labels] if args.key?(:resource_labels)
  @name = args[:name] if args.key?(:name)
  @initial_cluster_version = args[:initial_cluster_version] if args.key?(:initial_cluster_version)
  @legacy_abac = args[:legacy_abac] if args.key?(:legacy_abac)
  @endpoint = args[:endpoint] if args.key?(:endpoint)
  @create_time = args[:create_time] if args.key?(:create_time)
  @cluster_ipv4_cidr = args[:cluster_ipv4_cidr] if args.key?(:cluster_ipv4_cidr)
  @initial_node_count = args[:initial_node_count] if args.key?(:initial_node_count)
  @node_pools = args[:node_pools] if args.key?(:node_pools)
  @locations = args[:locations] if args.key?(:locations)
  @self_link = args[:self_link] if args.key?(:self_link)
  @instance_group_urls = args[:instance_group_urls] if args.key?(:instance_group_urls)
  @services_ipv4_cidr = args[:services_ipv4_cidr] if args.key?(:services_ipv4_cidr)
  @enable_kubernetes_alpha = args[:enable_kubernetes_alpha] if args.key?(:enable_kubernetes_alpha)
  @description = args[:description] if args.key?(:description)
end