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



1160
1161
1162
 
# File 'generated/google/apis/container_v1/classes.rb', line 1160

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:



1010
1011
1012
 
# File 'generated/google/apis/container_v1/classes.rb', line 1010

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) 


1081
1082
1083
 
# File 'generated/google/apis/container_v1/classes.rb', line 1081

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) 


1073
1074
1075
 
# File 'generated/google/apis/container_v1/classes.rb', line 1073

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) 


999
1000
1001
 
# File 'generated/google/apis/container_v1/classes.rb', line 999

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) 


1149
1150
1151
 
# File 'generated/google/apis/container_v1/classes.rb', line 1149

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) 


1022
1023
1024
 
# File 'generated/google/apis/container_v1/classes.rb', line 1022

def current_node_version
  @current_node_version
end

#description ⇒ String

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

Returns:

  • (String) 


1144
1145
1146
 
# File 'generated/google/apis/container_v1/classes.rb', line 1144

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) 


1138
1139
1140
 
# File 'generated/google/apis/container_v1/classes.rb', line 1138

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) 


1061
1062
1063
 
# File 'generated/google/apis/container_v1/classes.rb', line 1061

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) 


972
973
974
 
# File 'generated/google/apis/container_v1/classes.rb', line 972

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) 


1052
1053
1054
 
# File 'generated/google/apis/container_v1/classes.rb', line 1052

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) 


1093
1094
1095
 
# File 'generated/google/apis/container_v1/classes.rb', line 1093

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


1119
1120
1121
 
# File 'generated/google/apis/container_v1/classes.rb', line 1119

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) 


952
953
954
 
# File 'generated/google/apis/container_v1/classes.rb', line 952

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:



1067
1068
1069
 
# File 'generated/google/apis/container_v1/classes.rb', line 1067

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


1107
1108
1109
 
# File 'generated/google/apis/container_v1/classes.rb', line 1107

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) 


981
982
983
 
# File 'generated/google/apis/container_v1/classes.rb', line 981

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:



994
995
996
 
# File 'generated/google/apis/container_v1/classes.rb', line 994

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) 


1158
1159
1160
 
# File 'generated/google/apis/container_v1/classes.rb', line 1158

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) 


1044
1045
1046
 
# File 'generated/google/apis/container_v1/classes.rb', line 1044

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) 


947
948
949
 
# File 'generated/google/apis/container_v1/classes.rb', line 947

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:



1004
1005
1006
 
# File 'generated/google/apis/container_v1/classes.rb', line 1004

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) 


966
967
968
 
# File 'generated/google/apis/container_v1/classes.rb', line 966

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:



1100
1101
1102
 
# File 'generated/google/apis/container_v1/classes.rb', line 1100

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


1035
1036
1037
 
# File 'generated/google/apis/container_v1/classes.rb', line 1035

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) 


1112
1113
1114
 
# File 'generated/google/apis/container_v1/classes.rb', line 1112

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) 


1128
1129
1130
 
# File 'generated/google/apis/container_v1/classes.rb', line 1128

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) 


1015
1016
1017
 
# File 'generated/google/apis/container_v1/classes.rb', line 1015

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) 


987
988
989
 
# File 'generated/google/apis/container_v1/classes.rb', line 987

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) 


1029
1030
1031
 
# File 'generated/google/apis/container_v1/classes.rb', line 1029

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) 


959
960
961
 
# File 'generated/google/apis/container_v1/classes.rb', line 959

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
 
# File 'generated/google/apis/container_v1/classes.rb', line 1165

def update!(**args)
  @network = args[:network] if args.key?(:network)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @zone = args[:zone] if args.key?(:zone)
  @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)
  @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)
  @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)
end