Class: Google::Apis::GkeonpremV1::BareMetalCluster

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 bare metal user cluster.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BareMetalCluster

Returns a new instance of BareMetalCluster.



1245
1246
1247
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1245

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

Instance Attribute Details

#admin_cluster_membership ⇒ String

Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. Corresponds to the JSON property adminClusterMembership

Returns:

  • (String) 


1058
1059
1060
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1058

def admin_cluster_membership
  @admin_cluster_membership
end

#admin_cluster_name ⇒ String

Output only. The resource name of the bare metal admin cluster managing this user cluster. Corresponds to the JSON property adminClusterName

Returns:

  • (String) 


1064
1065
1066
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1064

def admin_cluster_name
  @admin_cluster_name
end

#annotations ⇒ Hash<String,String>

Annotations on the bare metal 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>) 


1074
1075
1076
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1074

def annotations
  @annotations
end

#bare_metal_version ⇒ String

Required. The Anthos clusters on bare metal version for your user cluster. Corresponds to the JSON property bareMetalVersion

Returns:

  • (String) 


1079
1080
1081
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1079

def bare_metal_version
  @bare_metal_version
end

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

Configuration for Binary Authorization. Corresponds to the JSON property binaryAuthorization

Returns:



1084
1085
1086
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1084

def binary_authorization
  @binary_authorization
end

#cluster_operations ⇒ Google::Apis::GkeonpremV1::BareMetalClusterOperationsConfig

Specifies the bare metal user cluster's observability infrastructure. Corresponds to the JSON property clusterOperations

Returns:



1089
1090
1091
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1089

def cluster_operations
  @cluster_operations
end

#control_plane ⇒ Google::Apis::GkeonpremV1::BareMetalControlPlaneConfig

Specifies the control plane configuration. Corresponds to the JSON property controlPlane

Returns:



1094
1095
1096
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1094

def control_plane
  @control_plane
end

#create_time ⇒ String

Output only. The time when the bare metal user cluster was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1099
1100
1101
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1099

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty Corresponds to the JSON property deleteTime

Returns:

  • (String) 


1105
1106
1107
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1105

def delete_time
  @delete_time
end

#description ⇒ String

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

Returns:

  • (String) 


1110
1111
1112
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1110

def description
  @description
end

#endpoint ⇒ String

Output only. The IP address of the bare metal user cluster's API server. Corresponds to the JSON property endpoint

Returns:

  • (String) 


1115
1116
1117
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1115

def endpoint
  @endpoint
end

#etag ⇒ String

Output only. 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) 


1123
1124
1125
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1123

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:



1132
1133
1134
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1132

def fleet
  @fleet
end

#load_balancer ⇒ Google::Apis::GkeonpremV1::BareMetalLoadBalancerConfig

Specifies the load balancer configuration. Corresponds to the JSON property loadBalancer

Returns:



1137
1138
1139
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1137

def load_balancer
  @load_balancer
end

#local_name ⇒ String

Output only. The object name of the bare metal user cluster 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 name 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. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl. Corresponds to the JSON property localName

Returns:

  • (String) 


1150
1151
1152
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1150

def local_name
  @local_name
end

#local_namespace ⇒ String

Output only. The namespace of the cluster. Corresponds to the JSON property localNamespace

Returns:

  • (String) 


1155
1156
1157
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1155

def local_namespace
  @local_namespace
end

#maintenance_config ⇒ Google::Apis::GkeonpremV1::BareMetalMaintenanceConfig

Specifies configurations to put bare metal nodes in and out of maintenance. Corresponds to the JSON property maintenanceConfig

Returns:



1160
1161
1162
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1160

def maintenance_config
  @maintenance_config
end

#maintenance_status ⇒ Google::Apis::GkeonpremV1::BareMetalMaintenanceStatus

Represents the maintenance status of the bare metal user cluster. Corresponds to the JSON property maintenanceStatus

Returns:



1165
1166
1167
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1165

def maintenance_status
  @maintenance_status
end

#name ⇒ String

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

Returns:

  • (String) 


1170
1171
1172
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1170

def name
  @name
end

#network_config ⇒ Google::Apis::GkeonpremV1::BareMetalNetworkConfig

Specifies the cluster network configuration. Corresponds to the JSON property networkConfig

Returns:



1175
1176
1177
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1175

def network_config
  @network_config
end

#node_access_config ⇒ Google::Apis::GkeonpremV1::BareMetalNodeAccessConfig

Specifies the node access related settings for the bare metal user cluster. Corresponds to the JSON property nodeAccessConfig

Returns:



1180
1181
1182
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1180

def node_access_config
  @node_access_config
end

#node_config ⇒ Google::Apis::GkeonpremV1::BareMetalWorkloadNodeConfig

Specifies the workload node configurations. Corresponds to the JSON property nodeConfig

Returns:



1185
1186
1187
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1185

def node_config
  @node_config
end

#os_environment_config ⇒ Google::Apis::GkeonpremV1::BareMetalOsEnvironmentConfig

Specifies operating system settings for cluster provisioning. Corresponds to the JSON property osEnvironmentConfig

Returns:



1190
1191
1192
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1190

def os_environment_config
  @os_environment_config
end

#proxy ⇒ Google::Apis::GkeonpremV1::BareMetalProxyConfig

Specifies the cluster proxy configuration. Corresponds to the JSON property proxy

Returns:



1195
1196
1197
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1195

def proxy
  @proxy
end

#reconciling ⇒ Boolean Also known as: reconciling?

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

Returns:

  • (Boolean) 


1201
1202
1203
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1201

def reconciling
  @reconciling
end

#security_config ⇒ Google::Apis::GkeonpremV1::BareMetalSecurityConfig

Specifies the security related settings for the bare metal user cluster. Corresponds to the JSON property securityConfig

Returns:



1207
1208
1209
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1207

def security_config
  @security_config
end

#state ⇒ String

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

Returns:

  • (String) 


1212
1213
1214
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1212

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:



1218
1219
1220
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1218

def status
  @status
end

#storage ⇒ Google::Apis::GkeonpremV1::BareMetalStorageConfig

BareMetalStorageConfig specifies the cluster storage configuration. Corresponds to the JSON property storage

Returns:



1223
1224
1225
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1223

def storage
  @storage
end

#uid ⇒ String

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

Returns:

  • (String) 


1228
1229
1230
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1228

def uid
  @uid
end

#update_time ⇒ String

Output only. The time when the bare metal user cluster was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1233
1234
1235
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1233

def update_time
  @update_time
end

#upgrade_policy ⇒ Google::Apis::GkeonpremV1::BareMetalClusterUpgradePolicy

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

Returns:



1238
1239
1240
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1238

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:



1243
1244
1245
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1243

def validation_check
  @validation_check
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1250

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)
  @bare_metal_version = args[:bare_metal_version] if args.key?(:bare_metal_version)
  @binary_authorization = args[:binary_authorization] if args.key?(:binary_authorization)
  @cluster_operations = args[:cluster_operations] if args.key?(:cluster_operations)
  @control_plane = args[:control_plane] if args.key?(:control_plane)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @description = args[:description] if args.key?(:description)
  @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)
  @local_namespace = args[:local_namespace] if args.key?(:local_namespace)
  @maintenance_config = args[:maintenance_config] if args.key?(:maintenance_config)
  @maintenance_status = args[:maintenance_status] if args.key?(:maintenance_status)
  @name = args[:name] if args.key?(:name)
  @network_config = args[:network_config] if args.key?(:network_config)
  @node_access_config = args[:node_access_config] if args.key?(:node_access_config)
  @node_config = args[:node_config] if args.key?(:node_config)
  @os_environment_config = args[:os_environment_config] if args.key?(:os_environment_config)
  @proxy = args[:proxy] if args.key?(:proxy)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @security_config = args[:security_config] if args.key?(:security_config)
  @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)
end