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



269
270
271
 
# File 'generated/google/apis/container_v1/classes.rb', line 269

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:



59
60
61
 
# File 'generated/google/apis/container_v1/classes.rb', line 59

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) 


130
131
132
 
# File 'generated/google/apis/container_v1/classes.rb', line 130

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) 


122
123
124
 
# File 'generated/google/apis/container_v1/classes.rb', line 122

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) 


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

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) 


198
199
200
 
# File 'generated/google/apis/container_v1/classes.rb', line 198

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) 


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

def current_node_version
  @current_node_version
end

#description ⇒ String

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

Returns:

  • (String) 


193
194
195
 
# File 'generated/google/apis/container_v1/classes.rb', line 193

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) 


187
188
189
 
# File 'generated/google/apis/container_v1/classes.rb', line 187

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) 


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

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) 


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

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) 


101
102
103
 
# File 'generated/google/apis/container_v1/classes.rb', line 101

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) 


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

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


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

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) 


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

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:



116
117
118
 
# File 'generated/google/apis/container_v1/classes.rb', line 116

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


156
157
158
 
# File 'generated/google/apis/container_v1/classes.rb', line 156

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) 


236
237
238
 
# File 'generated/google/apis/container_v1/classes.rb', line 236

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:



262
263
264
 
# File 'generated/google/apis/container_v1/classes.rb', line 262

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) 


207
208
209
 
# File 'generated/google/apis/container_v1/classes.rb', line 207

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) 


93
94
95
 
# File 'generated/google/apis/container_v1/classes.rb', line 93

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) 


215
216
217
 
# File 'generated/google/apis/container_v1/classes.rb', line 215

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:



53
54
55
 
# File 'generated/google/apis/container_v1/classes.rb', line 53

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) 


243
244
245
 
# File 'generated/google/apis/container_v1/classes.rb', line 243

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:



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

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


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

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) 


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

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) 


177
178
179
 
# File 'generated/google/apis/container_v1/classes.rb', line 177

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) 


64
65
66
 
# File 'generated/google/apis/container_v1/classes.rb', line 64

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) 


255
256
257
 
# File 'generated/google/apis/container_v1/classes.rb', line 255

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) 


71
72
73
 
# File 'generated/google/apis/container_v1/classes.rb', line 71

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) 


227
228
229
 
# File 'generated/google/apis/container_v1/classes.rb', line 227

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'generated/google/apis/container_v1/classes.rb', line 274

def update!(**args)
  @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)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @current_node_version = args[:current_node_version] if args.key?(:current_node_version)
  @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)
  @endpoint = args[:endpoint] if args.key?(:endpoint)
  @legacy_abac = args[:legacy_abac] if args.key?(:legacy_abac)
  @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)
  @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)
  @logging_service = args[:logging_service] if args.key?(:logging_service)
  @node_ipv4_cidr_size = args[:node_ipv4_cidr_size] if args.key?(:node_ipv4_cidr_size)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @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)
end