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

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.



4153
4154
4155
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4153

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) 


3982
3983
3984
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 3982

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) 


3988
3989
3990
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 3988

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


3998
3999
4000
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 3998

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:



4003
4004
4005
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4003

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:



4009
4010
4011
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4009

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:



4015
4016
4017
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4015

def auto_repair_config
  @auto_repair_config
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:



4020
4021
4022
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4020

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) 


4025
4026
4027
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4025

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:



4032
4033
4034
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4032

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) 


4037
4038
4039
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4037

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) 


4042
4043
4044
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4042

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


4047
4048
4049
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4047

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) 


4053
4054
4055
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4053

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) 


4061
4062
4063
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4061

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:



4070
4071
4072
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4070

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:



4075
4076
4077
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4075

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) 


4087
4088
4089
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4087

def local_name
  @local_name
end

#name ⇒ String

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

Returns:

  • (String) 


4092
4093
4094
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4092

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:



4097
4098
4099
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4097

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) 


4102
4103
4104
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4102

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) 


4108
4109
4110
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4108

def reconciling
  @reconciling
end

#state ⇒ String

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

Returns:

  • (String) 


4114
4115
4116
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4114

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:



4120
4121
4122
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4120

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:



4125
4126
4127
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4125

def storage
  @storage
end

#uid ⇒ String

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

Returns:

  • (String) 


4130
4131
4132
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4130

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) 


4135
4136
4137
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4135

def update_time
  @update_time
end

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

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

Returns:



4140
4141
4142
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4140

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:



4145
4146
4147
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4145

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) 


4150
4151
4152
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4150

def vm_tracking_enabled
  @vm_tracking_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 4158

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