Class: Google::Apis::ContainerV1beta1::ClusterUpdate

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

Overview

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ClusterUpdate

Returns a new instance of ClusterUpdate.



1385
1386
1387
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1385

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

Instance Attribute Details

#desired_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 desiredAddonsConfig

Returns:



1139
1140
1141
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1139

def desired_addons_config
  @desired_addons_config
end

#desired_authenticator_groups_config ⇒ Google::Apis::ContainerV1beta1::AuthenticatorGroupsConfig

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

Returns:



1144
1145
1146
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1144

def desired_authenticator_groups_config
  @desired_authenticator_groups_config
end

#desired_binary_authorization ⇒ Google::Apis::ContainerV1beta1::BinaryAuthorization

Configuration for Binary Authorization. Corresponds to the JSON property desiredBinaryAuthorization

Returns:



1149
1150
1151
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1149

def desired_binary_authorization
  @desired_binary_authorization
end

#desired_cluster_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 desiredClusterAutoscaling

Returns:



1156
1157
1158
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1156

def desired_cluster_autoscaling
  @desired_cluster_autoscaling
end

#desired_cluster_telemetry ⇒ Google::Apis::ContainerV1beta1::ClusterTelemetry

Telemetry integration for the cluster. Corresponds to the JSON property desiredClusterTelemetry

Returns:



1161
1162
1163
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1161

def desired_cluster_telemetry
  @desired_cluster_telemetry
end

#desired_database_encryption ⇒ Google::Apis::ContainerV1beta1::DatabaseEncryption

Configuration of etcd encryption. Corresponds to the JSON property desiredDatabaseEncryption

Returns:



1166
1167
1168
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1166

def desired_database_encryption
  @desired_database_encryption
end

#desired_datapath_provider ⇒ String

The desired datapath provider for the cluster. Corresponds to the JSON property desiredDatapathProvider

Returns:

  • (String) 


1171
1172
1173
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1171

def desired_datapath_provider
  @desired_datapath_provider
end

#desired_default_snat_status ⇒ Google::Apis::ContainerV1beta1::DefaultSnatStatus

DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. Corresponds to the JSON property desiredDefaultSnatStatus

Returns:



1177
1178
1179
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1177

def desired_default_snat_status
  @desired_default_snat_status
end

#desired_dns_config ⇒ Google::Apis::ContainerV1beta1::DnsConfig

DNSConfig contains the desired set of options for configuring clusterDNS. Corresponds to the JSON property desiredDnsConfig

Returns:



1182
1183
1184
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1182

def desired_dns_config
  @desired_dns_config
end

#desired_gcfs_config ⇒ Google::Apis::ContainerV1beta1::GcfsConfig

GcfsConfig contains configurations of Google Container File System. Corresponds to the JSON property desiredGcfsConfig

Returns:



1187
1188
1189
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1187

def desired_gcfs_config
  @desired_gcfs_config
end

#desired_identity_service_config ⇒ Google::Apis::ContainerV1beta1::IdentityServiceConfig

IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API Corresponds to the JSON property desiredIdentityServiceConfig

Returns:



1193
1194
1195
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1193

def desired_identity_service_config
  @desired_identity_service_config
end

#desired_image_type ⇒ String

The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. Corresponds to the JSON property desiredImageType

Returns:

  • (String) 


1199
1200
1201
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1199

def desired_image_type
  @desired_image_type
end

#desired_intra_node_visibility_config ⇒ Google::Apis::ContainerV1beta1::IntraNodeVisibilityConfig

IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. Corresponds to the JSON property desiredIntraNodeVisibilityConfig

Returns:



1205
1206
1207
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1205

def desired_intra_node_visibility_config
  @desired_intra_node_visibility_config
end

#desired_l4ilb_subsetting_config ⇒ Google::Apis::ContainerV1beta1::IlbSubsettingConfig

ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. Corresponds to the JSON property desiredL4ilbSubsettingConfig

Returns:



1211
1212
1213
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1211

def desired_l4ilb_subsetting_config
  @desired_l4ilb_subsetting_config
end

#desired_locations ⇒ Array<String>

The desired list of Google Compute Engine zones in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. Corresponds to the JSON property desiredLocations

Returns:

  • (Array<String>) 


1220
1221
1222
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1220

def desired_locations
  @desired_locations
end

#desired_logging_config ⇒ Google::Apis::ContainerV1beta1::LoggingConfig

LoggingConfig is cluster logging configuration. Corresponds to the JSON property desiredLoggingConfig

Returns:



1225
1226
1227
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1225

def desired_logging_config
  @desired_logging_config
end

#desired_logging_service ⇒ String

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 desiredLoggingService

Returns:

  • (String) 


1236
1237
1238
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1236

def desired_logging_service
  @desired_logging_service
end

#desired_master ⇒ Google::Apis::ContainerV1beta1::Master

Master is the configuration for components on master. Corresponds to the JSON property desiredMaster

Returns:



1241
1242
1243
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1241

def desired_master
  @desired_master
end

#desired_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 desiredMasterAuthorizedNetworksConfig

Returns:



1249
1250
1251
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1249

def desired_master_authorized_networks_config
  @desired_master_authorized_networks_config
end

#desired_master_version ⇒ String

The Kubernetes version to change the master to. The only valid value is the latest supported version. 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 desiredMasterVersion

Returns:

  • (String) 


1260
1261
1262
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1260

def desired_master_version
  @desired_master_version
end

#desired_mesh_certificates ⇒ Google::Apis::ContainerV1beta1::MeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods. Corresponds to the JSON property desiredMeshCertificates

Returns:



1265
1266
1267
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1265

def desired_mesh_certificates
  @desired_mesh_certificates
end

#desired_monitoring_config ⇒ Google::Apis::ContainerV1beta1::MonitoringConfig

MonitoringConfig is cluster monitoring configuration. Corresponds to the JSON property desiredMonitoringConfig

Returns:



1270
1271
1272
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1270

def desired_monitoring_config
  @desired_monitoring_config
end

#desired_monitoring_service ⇒ String

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 desiredMonitoringService

Returns:

  • (String) 


1281
1282
1283
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1281

def desired_monitoring_service
  @desired_monitoring_service
end

#desired_node_pool_auto_config_network_tags ⇒ Google::Apis::ContainerV1beta1::NetworkTags

Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See tags field in NodeConfig). Corresponds to the JSON property desiredNodePoolAutoConfigNetworkTags

Returns:



1288
1289
1290
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1288

def desired_node_pool_auto_config_network_tags
  @desired_node_pool_auto_config_network_tags
end

#desired_node_pool_autoscaling ⇒ Google::Apis::ContainerV1beta1::NodePoolAutoscaling

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Corresponds to the JSON property desiredNodePoolAutoscaling

Returns:



1294
1295
1296
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1294

def desired_node_pool_autoscaling
  @desired_node_pool_autoscaling
end

#desired_node_pool_id ⇒ String

The node pool to be upgraded. This field is mandatory if "desired_node_version" , "desired_image_family", "desired_node_pool_autoscaling", or " desired_workload_metadata_config" is specified and there is more than one node pool on the cluster. Corresponds to the JSON property desiredNodePoolId

Returns:

  • (String) 


1302
1303
1304
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1302

def desired_node_pool_id
  @desired_node_pool_id
end

#desired_node_version ⇒ String

The Kubernetes version to change the nodes to (typically an upgrade). 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 Kubernetes master version Corresponds to the JSON property desiredNodeVersion

Returns:

  • (String) 


1313
1314
1315
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1313

def desired_node_version
  @desired_node_version
end

#desired_notification_config ⇒ Google::Apis::ContainerV1beta1::NotificationConfig

NotificationConfig is the configuration of notifications. Corresponds to the JSON property desiredNotificationConfig

Returns:



1318
1319
1320
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1318

def desired_notification_config
  @desired_notification_config
end

#desired_pod_security_policy_config ⇒ Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig

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

Returns:



1323
1324
1325
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1323

def desired_pod_security_policy_config
  @desired_pod_security_policy_config
end

#desired_private_cluster_config ⇒ Google::Apis::ContainerV1beta1::PrivateClusterConfig

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

Returns:



1328
1329
1330
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1328

def desired_private_cluster_config
  @desired_private_cluster_config
end

#desired_private_ipv6_google_access ⇒ String

The desired state of IPv6 connectivity to Google Services. Corresponds to the JSON property desiredPrivateIpv6GoogleAccess

Returns:

  • (String) 


1333
1334
1335
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1333

def desired_private_ipv6_google_access
  @desired_private_ipv6_google_access
end

#desired_release_channel ⇒ Google::Apis::ContainerV1beta1::ReleaseChannel

ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. Corresponds to the JSON property desiredReleaseChannel

Returns:



1341
1342
1343
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1341

def desired_release_channel
  @desired_release_channel
end

#desired_resource_usage_export_config ⇒ Google::Apis::ContainerV1beta1::ResourceUsageExportConfig

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

Returns:



1346
1347
1348
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1346

def desired_resource_usage_export_config
  @desired_resource_usage_export_config
end

#desired_service_external_ips_config ⇒ Google::Apis::ContainerV1beta1::ServiceExternalIPsConfig

Config to block services with externalIPs field. Corresponds to the JSON property desiredServiceExternalIpsConfig

Returns:



1351
1352
1353
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1351

def desired_service_external_ips_config
  @desired_service_external_ips_config
end

#desired_shielded_nodes ⇒ Google::Apis::ContainerV1beta1::ShieldedNodes

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

Returns:



1356
1357
1358
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1356

def desired_shielded_nodes
  @desired_shielded_nodes
end

#desired_tpu_config ⇒ Google::Apis::ContainerV1beta1::TpuConfig

Configuration for Cloud TPU. Corresponds to the JSON property desiredTpuConfig

Returns:



1361
1362
1363
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1361

def desired_tpu_config
  @desired_tpu_config
end

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

Returns:



1368
1369
1370
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1368

def desired_vertical_pod_autoscaling
  @desired_vertical_pod_autoscaling
end

#desired_workload_alts_config ⇒ Google::Apis::ContainerV1beta1::WorkloadAltsConfig

Configuration for direct-path (via ALTS) with workload identity. Corresponds to the JSON property desiredWorkloadAltsConfig

Returns:



1373
1374
1375
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1373

def desired_workload_alts_config
  @desired_workload_alts_config
end

#desired_workload_certificates ⇒ Google::Apis::ContainerV1beta1::WorkloadCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods. Corresponds to the JSON property desiredWorkloadCertificates

Returns:



1378
1379
1380
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1378

def desired_workload_certificates
  @desired_workload_certificates
end

#desired_workload_identity_config ⇒ Google::Apis::ContainerV1beta1::WorkloadIdentityConfig

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

Returns:



1383
1384
1385
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1383

def desired_workload_identity_config
  @desired_workload_identity_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 1390

def update!(**args)
  @desired_addons_config = args[:desired_addons_config] if args.key?(:desired_addons_config)
  @desired_authenticator_groups_config = args[:desired_authenticator_groups_config] if args.key?(:desired_authenticator_groups_config)
  @desired_binary_authorization = args[:desired_binary_authorization] if args.key?(:desired_binary_authorization)
  @desired_cluster_autoscaling = args[:desired_cluster_autoscaling] if args.key?(:desired_cluster_autoscaling)
  @desired_cluster_telemetry = args[:desired_cluster_telemetry] if args.key?(:desired_cluster_telemetry)
  @desired_database_encryption = args[:desired_database_encryption] if args.key?(:desired_database_encryption)
  @desired_datapath_provider = args[:desired_datapath_provider] if args.key?(:desired_datapath_provider)
  @desired_default_snat_status = args[:desired_default_snat_status] if args.key?(:desired_default_snat_status)
  @desired_dns_config = args[:desired_dns_config] if args.key?(:desired_dns_config)
  @desired_gcfs_config = args[:desired_gcfs_config] if args.key?(:desired_gcfs_config)
  @desired_identity_service_config = args[:desired_identity_service_config] if args.key?(:desired_identity_service_config)
  @desired_image_type = args[:desired_image_type] if args.key?(:desired_image_type)
  @desired_intra_node_visibility_config = args[:desired_intra_node_visibility_config] if args.key?(:desired_intra_node_visibility_config)
  @desired_l4ilb_subsetting_config = args[:desired_l4ilb_subsetting_config] if args.key?(:desired_l4ilb_subsetting_config)
  @desired_locations = args[:desired_locations] if args.key?(:desired_locations)
  @desired_logging_config = args[:desired_logging_config] if args.key?(:desired_logging_config)
  @desired_logging_service = args[:desired_logging_service] if args.key?(:desired_logging_service)
  @desired_master = args[:desired_master] if args.key?(:desired_master)
  @desired_master_authorized_networks_config = args[:desired_master_authorized_networks_config] if args.key?(:desired_master_authorized_networks_config)
  @desired_master_version = args[:desired_master_version] if args.key?(:desired_master_version)
  @desired_mesh_certificates = args[:desired_mesh_certificates] if args.key?(:desired_mesh_certificates)
  @desired_monitoring_config = args[:desired_monitoring_config] if args.key?(:desired_monitoring_config)
  @desired_monitoring_service = args[:desired_monitoring_service] if args.key?(:desired_monitoring_service)
  @desired_node_pool_auto_config_network_tags = args[:desired_node_pool_auto_config_network_tags] if args.key?(:desired_node_pool_auto_config_network_tags)
  @desired_node_pool_autoscaling = args[:desired_node_pool_autoscaling] if args.key?(:desired_node_pool_autoscaling)
  @desired_node_pool_id = args[:desired_node_pool_id] if args.key?(:desired_node_pool_id)
  @desired_node_version = args[:desired_node_version] if args.key?(:desired_node_version)
  @desired_notification_config = args[:desired_notification_config] if args.key?(:desired_notification_config)
  @desired_pod_security_policy_config = args[:desired_pod_security_policy_config] if args.key?(:desired_pod_security_policy_config)
  @desired_private_cluster_config = args[:desired_private_cluster_config] if args.key?(:desired_private_cluster_config)
  @desired_private_ipv6_google_access = args[:desired_private_ipv6_google_access] if args.key?(:desired_private_ipv6_google_access)
  @desired_release_channel = args[:desired_release_channel] if args.key?(:desired_release_channel)
  @desired_resource_usage_export_config = args[:desired_resource_usage_export_config] if args.key?(:desired_resource_usage_export_config)
  @desired_service_external_ips_config = args[:desired_service_external_ips_config] if args.key?(:desired_service_external_ips_config)
  @desired_shielded_nodes = args[:desired_shielded_nodes] if args.key?(:desired_shielded_nodes)
  @desired_tpu_config = args[:desired_tpu_config] if args.key?(:desired_tpu_config)
  @desired_vertical_pod_autoscaling = args[:desired_vertical_pod_autoscaling] if args.key?(:desired_vertical_pod_autoscaling)
  @desired_workload_alts_config = args[:desired_workload_alts_config] if args.key?(:desired_workload_alts_config)
  @desired_workload_certificates = args[:desired_workload_certificates] if args.key?(:desired_workload_certificates)
  @desired_workload_identity_config = args[:desired_workload_identity_config] if args.key?(:desired_workload_identity_config)
end