Class: Google::Apis::GkeonpremV1::VmwareCluster

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

Overview

Resource that represents a VMware user cluster. ##

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VmwareCluster

Returns a new instance of VmwareCluster.

[View source]

4682
4683
4684
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4682

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

Instance Attribute Details

#admin_cluster_membership ⇒ String

Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources. Corresponds to the JSON property adminClusterMembership

Returns:

  • (String) 

4495
4496
4497
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4495

def admin_cluster_membership
  @admin_cluster_membership
end

#admin_cluster_name ⇒ String

Output only. The resource name of the VMware admin cluster hosting this user cluster. Corresponds to the JSON property adminClusterName

Returns:

  • (String) 

4501
4502
4503
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4501

def admin_cluster_name
  @admin_cluster_name
end

#annotations ⇒ Hash<String,String>

Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required) , separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 

4511
4512
4513
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4511

def annotations
  @annotations
end

#anti_affinity_groups ⇒ Google::Apis::GkeonpremV1::VmwareAagConfig

Specifies anti affinity group config for the VMware user cluster. Corresponds to the JSON property antiAffinityGroups

Returns:


4516
4517
4518
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4516

def anti_affinity_groups
  @anti_affinity_groups
end

#authorization ⇒ Google::Apis::GkeonpremV1::Authorization

Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. Corresponds to the JSON property authorization

Returns:


4522
4523
4524
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4522

def authorization
  @authorization
end

#auto_repair_config ⇒ Google::Apis::GkeonpremV1::VmwareAutoRepairConfig

Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. Corresponds to the JSON property autoRepairConfig

Returns:


4528
4529
4530
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4528

def auto_repair_config
  @auto_repair_config
end

#binary_authorization ⇒ Google::Apis::GkeonpremV1::BinaryAuthorization

Configuration for Binary Authorization. Corresponds to the JSON property binaryAuthorization

Returns:


4533
4534
4535
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4533

def binary_authorization
  @binary_authorization
end

#control_plane_node ⇒ Google::Apis::GkeonpremV1::VmwareControlPlaneNodeConfig

Specifies control plane node config for the VMware user cluster. Corresponds to the JSON property controlPlaneNode

Returns:


4538
4539
4540
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4538

def control_plane_node
  @control_plane_node
end

#create_time ⇒ String

Output only. The time at which VMware user cluster was created. Corresponds to the JSON property createTime

Returns:

  • (String) 

4543
4544
4545
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4543

def create_time
  @create_time
end

#dataplane_v2 ⇒ Google::Apis::GkeonpremV1::VmwareDataplaneV2Config

Contains configurations for Dataplane V2, which is optimized dataplane for Kubernetes networking. For more information, see: https://cloud.google.com/ kubernetes-engine/docs/concepts/dataplane-v2 Corresponds to the JSON property dataplaneV2

Returns:


4550
4551
4552
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4550

def dataplane_v2
  @dataplane_v2
end

#delete_time ⇒ String

Output only. The time at which VMware user cluster was deleted. Corresponds to the JSON property deleteTime

Returns:

  • (String) 

4555
4556
4557
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4555

def delete_time
  @delete_time
end

#description ⇒ String

A human readable description of this VMware user cluster. Corresponds to the JSON property description

Returns:

  • (String) 

4560
4561
4562
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4560

def description
  @description
end

#disable_bundled_ingress ⇒ Boolean Also known as: disable_bundled_ingress?

Disable bundled ingress. Corresponds to the JSON property disableBundledIngress

Returns:

  • (Boolean) 

4565
4566
4567
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4565

def disable_bundled_ingress
  @disable_bundled_ingress
end

#enable_control_plane_v2 ⇒ Boolean Also known as: enable_control_plane_v2?

Enable control plane V2. Default to false. Corresponds to the JSON property enableControlPlaneV2

Returns:

  • (Boolean) 

4571
4572
4573
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4571

def enable_control_plane_v2
  @enable_control_plane_v2
end

#endpoint ⇒ String

Output only. The DNS name of VMware user cluster's API server. Corresponds to the JSON property endpoint

Returns:

  • (String) 

4577
4578
4579
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4577

def endpoint
  @endpoint
end

#etag ⇒ String

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up- to-date value before proceeding. Allows clients to perform consistent read- modify-writes through optimistic concurrency control. Corresponds to the JSON property etag

Returns:

  • (String) 

4585
4586
4587
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4585

def etag
  @etag
end

#fleet ⇒ Google::Apis::GkeonpremV1::Fleet

Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See Anthos Fleets for more details on Anthos multi-cluster capabilities using Fleets. ## Corresponds to the JSON property fleet

Returns:


4594
4595
4596
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4594

def fleet
  @fleet
end

#load_balancer ⇒ Google::Apis::GkeonpremV1::VmwareLoadBalancerConfig

Specifies the locad balancer config for the VMware user cluster. Corresponds to the JSON property loadBalancer

Returns:


4599
4600
4601
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4599

def load_balancer
  @load_balancer
end

#local_name ⇒ String

Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs. Corresponds to the JSON property localName

Returns:

  • (String) 

4611
4612
4613
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4611

def local_name
  @local_name
end

#name ⇒ String

Immutable. The VMware user cluster resource name. Corresponds to the JSON property name

Returns:

  • (String) 

4616
4617
4618
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4616

def name
  @name
end

#network_config ⇒ Google::Apis::GkeonpremV1::VmwareNetworkConfig

Specifies network config for the VMware user cluster. Corresponds to the JSON property networkConfig

Returns:


4621
4622
4623
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4621

def network_config
  @network_config
end

#on_prem_version ⇒ String

Required. The Anthos clusters on the VMware version for your user cluster. Corresponds to the JSON property onPremVersion

Returns:

  • (String) 

4626
4627
4628
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4626

def on_prem_version
  @on_prem_version
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. If set, there are currently changes in flight to the VMware user cluster. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 

4632
4633
4634
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4632

def reconciling
  @reconciling
end

#state ⇒ String

Output only. The current state of VMware user cluster. Corresponds to the JSON property state

Returns:

  • (String) 

4638
4639
4640
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4638

def state
  @state
end

#status ⇒ Google::Apis::GkeonpremV1::ResourceStatus

ResourceStatus describes why a cluster or node pool has a certain status. (e.g. , ERROR or DEGRADED). Corresponds to the JSON property status

Returns:


4644
4645
4646
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4644

def status
  @status
end

#storage ⇒ Google::Apis::GkeonpremV1::VmwareStorageConfig

Specifies vSphere CSI components deployment config in the VMware user cluster. Corresponds to the JSON property storage

Returns:


4649
4650
4651
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4649

def storage
  @storage
end

#uid ⇒ String

Output only. The unique identifier of the VMware user cluster. Corresponds to the JSON property uid

Returns:

  • (String) 

4654
4655
4656
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4654

def uid
  @uid
end

#update_time ⇒ String

Output only. The time at which VMware user cluster was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 

4659
4660
4661
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4659

def update_time
  @update_time
end

#upgrade_policy ⇒ Google::Apis::GkeonpremV1::VmwareClusterUpgradePolicy

VmwareClusterUpgradePolicy defines the cluster upgrade policy. Corresponds to the JSON property upgradePolicy

Returns:


4664
4665
4666
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4664

def upgrade_policy
  @upgrade_policy
end

#validation_check ⇒ Google::Apis::GkeonpremV1::ValidationCheck

ValidationCheck represents the result of preflight check. Corresponds to the JSON property validationCheck

Returns:


4669
4670
4671
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4669

def validation_check
  @validation_check
end

#vcenter ⇒ Google::Apis::GkeonpremV1::VmwareVCenterConfig

Represents configuration for the VMware VCenter for the user cluster. Corresponds to the JSON property vcenter

Returns:


4674
4675
4676
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4674

def vcenter
  @vcenter
end

#vm_tracking_enabled ⇒ Boolean Also known as: vm_tracking_enabled?

Enable VM tracking. Corresponds to the JSON property vmTrackingEnabled

Returns:

  • (Boolean) 

4679
4680
4681
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4679

def vm_tracking_enabled
  @vm_tracking_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4687

def update!(**args)
  @admin_cluster_membership = args[:admin_cluster_membership] if args.key?(:admin_cluster_membership)
  @admin_cluster_name = args[:admin_cluster_name] if args.key?(:admin_cluster_name)
  @annotations = args[:annotations] if args.key?(:annotations)
  @anti_affinity_groups = args[:anti_affinity_groups] if args.key?(:anti_affinity_groups)
  @authorization = args[:authorization] if args.key?(:authorization)
  @auto_repair_config = args[:auto_repair_config] if args.key?(:auto_repair_config)
  @binary_authorization = args[:binary_authorization] if args.key?(:binary_authorization)
  @control_plane_node = args[:control_plane_node] if args.key?(:control_plane_node)
  @create_time = args[:create_time] if args.key?(:create_time)
  @dataplane_v2 = args[:dataplane_v2] if args.key?(:dataplane_v2)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @description = args[:description] if args.key?(:description)
  @disable_bundled_ingress = args[:disable_bundled_ingress] if args.key?(:disable_bundled_ingress)
  @enable_control_plane_v2 = args[:enable_control_plane_v2] if args.key?(:enable_control_plane_v2)
  @endpoint = args[:endpoint] if args.key?(:endpoint)
  @etag = args[:etag] if args.key?(:etag)
  @fleet = args[:fleet] if args.key?(:fleet)
  @load_balancer = args[:load_balancer] if args.key?(:load_balancer)
  @local_name = args[:local_name] if args.key?(:local_name)
  @name = args[:name] if args.key?(:name)
  @network_config = args[:network_config] if args.key?(:network_config)
  @on_prem_version = args[:on_prem_version] if args.key?(:on_prem_version)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @state = args[:state] if args.key?(:state)
  @status = args[:status] if args.key?(:status)
  @storage = args[:storage] if args.key?(:storage)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @upgrade_policy = args[:upgrade_policy] if args.key?(:upgrade_policy)
  @validation_check = args[:validation_check] if args.key?(:validation_check)
  @vcenter = args[:vcenter] if args.key?(:vcenter)
  @vm_tracking_enabled = args[:vm_tracking_enabled] if args.key?(:vm_tracking_enabled)
end