Class: Google::Apis::ContainerV1::AutoprovisioningNodePoolDefaults

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

Overview

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AutoprovisioningNodePoolDefaults

Returns a new instance of AutoprovisioningNodePoolDefaults.



337
338
339
 
# File 'lib/google/apis/container_v1/classes.rb', line 337

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

Instance Attribute Details

#boot_disk_kms_key ⇒ String

The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[ KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME] . For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption Corresponds to the JSON property bootDiskKmsKey

Returns:

  • (String) 


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

def boot_disk_kms_key
  @boot_disk_kms_key
end

#disk_size_gb ⇒ Fixnum

Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


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

def disk_size_gb
  @disk_size_gb
end

#disk_type ⇒ String

Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd- balanced') If unspecified, the default disk type is 'pd-standard' Corresponds to the JSON property diskType

Returns:

  • (String) 


261
262
263
 
# File 'lib/google/apis/container_v1/classes.rb', line 261

def disk_type
  @disk_type
end

#image_type ⇒ String

The image type to use for NAP created node. Corresponds to the JSON property imageType

Returns:

  • (String) 


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

def image_type
  @image_type
end

#management ⇒ Google::Apis::ContainerV1::NodeManagement

NodeManagement defines the set of node management services turned on for the node pool. Corresponds to the JSON property management

Returns:



272
273
274
 
# File 'lib/google/apis/container_v1/classes.rb', line 272

def management
  @management
end

#min_cpu_platform ⇒ String

Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read how to specify min CPU platform. This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. Corresponds to the JSON property minCpuPlatform

Returns:

  • (String) 


285
286
287
 
# File 'lib/google/apis/container_v1/classes.rb', line 285

def min_cpu_platform
  @min_cpu_platform
end

#oauth_scopes ⇒ Array<String>

Scopes that are used by NAP when creating node pools. Corresponds to the JSON property oauthScopes

Returns:

  • (Array<String>) 


290
291
292
 
# File 'lib/google/apis/container_v1/classes.rb', line 290

def oauth_scopes
  @oauth_scopes
end

#service_account ⇒ String

The Google Cloud Platform Service Account to be used by the node VMs. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


295
296
297
 
# File 'lib/google/apis/container_v1/classes.rb', line 295

def 
  @service_account
end

#shielded_instance_config ⇒ Google::Apis::ContainerV1::ShieldedInstanceConfig

A set of Shielded Instance options. Corresponds to the JSON property shieldedInstanceConfig

Returns:



300
301
302
 
# File 'lib/google/apis/container_v1/classes.rb', line 300

def shielded_instance_config
  @shielded_instance_config
end

#upgrade_settings ⇒ Google::Apis::ContainerV1::UpgradeSettings

These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional ( upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue- green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. Corresponds to the JSON property upgradeSettings

Returns:



335
336
337
 
# File 'lib/google/apis/container_v1/classes.rb', line 335

def upgrade_settings
  @upgrade_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/google/apis/container_v1/classes.rb', line 342

def update!(**args)
  @boot_disk_kms_key = args[:boot_disk_kms_key] if args.key?(:boot_disk_kms_key)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @disk_type = args[:disk_type] if args.key?(:disk_type)
  @image_type = args[:image_type] if args.key?(:image_type)
  @management = args[:management] if args.key?(:management)
  @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform)
  @oauth_scopes = args[:oauth_scopes] if args.key?(:oauth_scopes)
  @service_account = args[:service_account] if args.key?(:service_account)
  @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
  @upgrade_settings = args[:upgrade_settings] if args.key?(:upgrade_settings)
end