-
Notifications
You must be signed in to change notification settings - Fork 215
/
alloydb_v1beta1_alloydbinstance.yaml
579 lines (578 loc) · 26.6 KB
/
alloydb_v1beta1_alloydbinstance.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
cnrm.cloud.google.com/version: 1.122.0
creationTimestamp: null
labels:
cnrm.cloud.google.com/managed-by-kcc: "true"
cnrm.cloud.google.com/stability-level: stable
cnrm.cloud.google.com/system: "true"
cnrm.cloud.google.com/tf2crd: "true"
name: alloydbinstances.alloydb.cnrm.cloud.google.com
spec:
group: alloydb.cnrm.cloud.google.com
names:
categories:
- gcp
kind: AlloyDBInstance
plural: alloydbinstances
shortNames:
- gcpalloydbinstance
- gcpalloydbinstances
singular: alloydbinstance
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
- description: When 'True', the most recent reconcile of the resource succeeded
jsonPath: .status.conditions[?(@.type=='Ready')].status
name: Ready
type: string
- description: The reason for the value in 'Ready'
jsonPath: .status.conditions[?(@.type=='Ready')].reason
name: Status
type: string
- description: The last transition time for the value in 'Status'
jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
name: Status Age
type: date
name: v1beta1
schema:
openAPIV3Schema:
properties:
apiVersion:
description: 'apiVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
type: string
kind:
description: 'kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
oneOf:
- required:
- instanceType
- required:
- instanceTypeRef
properties:
annotations:
additionalProperties:
type: string
description: Annotations to allow client tools to store small amount
of arbitrary data. This is distinct from labels.
type: object
availabilityType:
description: |-
'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.
Note that primary and read instances can have different availability types.
Only READ_POOL instance supports ZONAL type. Users can't specify the zone for READ_POOL instance.
Zone is automatically chosen from the list of zones in the region specified.
Read pool of size 1 can only have zonal availability. Read pools with node count of 2 or more
can have regional availability (nodes are present in 2 or more zones in a region).' Possible values: ["AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL"].
type: string
clusterRef:
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `name` field of an `AlloyDBCluster`
resource.'
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
databaseFlags:
additionalProperties:
type: string
description: Database flags. Set at instance level. * They are copied
from primary instance on read instance creation. * Read instances
can set new or override existing flags that are relevant for reads,
e.g. for enabling columnar cache on a read instance. Flags set on
read instance may or may not be present on primary.
type: object
displayName:
description: User-settable and human-readable display name for the
Instance.
type: string
gceZone:
description: The Compute Engine zone that the instance should serve
from, per https://cloud.google.com/compute/docs/regions-zones This
can ONLY be specified for ZONAL instances. If present for a REGIONAL
instance, an error will be thrown. If this is absent for a ZONAL
instance, instance is created in a random zone with available capacity.
type: string
instanceType:
description: |-
We recommend that you use `instanceTypeRef` instead.
The type of the instance. Possible values: [PRIMARY, READ_POOL, SECONDARY]
type: string
instanceTypeRef:
description: |-
The type of instance.
Possible values: ["PRIMARY", "READ_POOL", "SECONDARY"]
For PRIMARY and SECONDARY instances, set the value to refer to the name of the associated cluster.
This is recommended because the instance type of primary and secondary instances is tied to the cluster type of the associated cluster.
If the secondary cluster is promoted to primary cluster, then the associated secondary instance also becomes primary instance.
Example:
instanceTypeRef:
name: clusterName
For instances of type READ_POOL, set the value using external keyword.
Example:
instanceTypeRef:
external: READ_POOL
If the instance type is SECONDARY, the delete instance operation does not delete the secondary instance but abandons it instead.
Use deletionPolicy = "FORCE" in the associated secondary cluster and delete the cluster forcefully to delete the secondary cluster as well its associated secondary instance.
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `clusterType` field of an `AlloyDBCluster`
resource.'
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
machineConfig:
description: Configurations for the machines that host the underlying
database engine.
properties:
cpuCount:
description: The number of CPU's in the VM instance.
type: integer
type: object
networkConfig:
description: Instance level network configuration.
properties:
authorizedExternalNetworks:
description: A list of external networks authorized to access
this instance. This field is only allowed to be set when 'enable_public_ip'
is set to true.
items:
properties:
cidrRange:
description: CIDR range for one authorized network of the
instance.
type: string
type: object
type: array
enablePublicIp:
description: Enabling public ip for the instance. If a user wishes
to disable this, please also clear the list of the authorized
external networks set on the same instance.
type: boolean
type: object
readPoolConfig:
description: Read pool specific config. If the instance type is READ_POOL,
this configuration must be provided.
properties:
nodeCount:
description: Read capacity, i.e. number of nodes in a read pool
instance.
type: integer
type: object
resourceID:
description: Immutable. Optional. The instanceId of the resource.
Used for creation and acquisition. When unset, the value of `metadata.name`
is used as the default.
type: string
required:
- clusterRef
type: object
status:
properties:
conditions:
description: Conditions represent the latest available observation
of the resource's current state.
items:
properties:
lastTransitionTime:
description: Last time the condition transitioned from one status
to another.
type: string
message:
description: Human-readable message indicating details about
last transition.
type: string
reason:
description: Unique, one-word, CamelCase reason for the condition's
last transition.
type: string
status:
description: Status is the status of the condition. Can be True,
False, Unknown.
type: string
type:
description: Type is the type of the condition.
type: string
type: object
type: array
createTime:
description: Time the Instance was created in UTC.
type: string
ipAddress:
description: The IP address for the Instance. This is the connection
endpoint for an end-user application.
type: string
name:
description: The name of the instance resource.
type: string
observedGeneration:
description: ObservedGeneration is the generation of the resource
that was most recently observed by the Config Connector controller.
If this is equal to metadata.generation, then that means that the
current reported status reflects the most recent desired state of
the resource.
type: integer
publicIpAddress:
description: The public IP addresses for the Instance. This is available
ONLY when networkConfig.enablePublicIp is set to true. This is the
connection endpoint for an end-user application.
type: string
reconciling:
description: Set to true if the current state of Instance does not
match the user's intended state, and the service is actively updating
the resource to reconcile them. This can happen due to user-triggered
updates or system actions like failover or maintenance.
type: boolean
state:
description: The current state of the alloydb instance.
type: string
uid:
description: The system-generated UID of the resource.
type: string
updateTime:
description: Time the Instance was updated in UTC.
type: string
type: object
required:
- spec
type: object
served: true
storage: false
subresources:
status: {}
- additionalPrinterColumns:
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
- description: When 'True', the most recent reconcile of the resource succeeded
jsonPath: .status.conditions[?(@.type=='Ready')].status
name: Ready
type: string
- description: The reason for the value in 'Ready'
jsonPath: .status.conditions[?(@.type=='Ready')].reason
name: Status
type: string
- description: The last transition time for the value in 'Status'
jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
name: Status Age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
properties:
apiVersion:
description: 'apiVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
type: string
kind:
description: 'kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
oneOf:
- required:
- instanceType
- required:
- instanceTypeRef
properties:
annotations:
additionalProperties:
type: string
description: Annotations to allow client tools to store small amount
of arbitrary data. This is distinct from labels.
type: object
availabilityType:
description: |-
'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.
Note that primary and read instances can have different availability types.
Only READ_POOL instance supports ZONAL type. Users can't specify the zone for READ_POOL instance.
Zone is automatically chosen from the list of zones in the region specified.
Read pool of size 1 can only have zonal availability. Read pools with node count of 2 or more
can have regional availability (nodes are present in 2 or more zones in a region).' Possible values: ["AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL"].
type: string
clusterRef:
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `name` field of an `AlloyDBCluster`
resource.'
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
databaseFlags:
additionalProperties:
type: string
description: Database flags. Set at instance level. * They are copied
from primary instance on read instance creation. * Read instances
can set new or override existing flags that are relevant for reads,
e.g. for enabling columnar cache on a read instance. Flags set on
read instance may or may not be present on primary.
type: object
displayName:
description: User-settable and human-readable display name for the
Instance.
type: string
gceZone:
description: The Compute Engine zone that the instance should serve
from, per https://cloud.google.com/compute/docs/regions-zones This
can ONLY be specified for ZONAL instances. If present for a REGIONAL
instance, an error will be thrown. If this is absent for a ZONAL
instance, instance is created in a random zone with available capacity.
type: string
instanceType:
description: |-
We recommend that you use `instanceTypeRef` instead.
The type of the instance. Possible values: [PRIMARY, READ_POOL, SECONDARY]
type: string
instanceTypeRef:
description: |-
The type of instance.
Possible values: ["PRIMARY", "READ_POOL", "SECONDARY"]
For PRIMARY and SECONDARY instances, set the value to refer to the name of the associated cluster.
This is recommended because the instance type of primary and secondary instances is tied to the cluster type of the associated cluster.
If the secondary cluster is promoted to primary cluster, then the associated secondary instance also becomes primary instance.
Example:
instanceTypeRef:
name: clusterName
For instances of type READ_POOL, set the value using external keyword.
Example:
instanceTypeRef:
external: READ_POOL
If the instance type is SECONDARY, the delete instance operation does not delete the secondary instance but abandons it instead.
Use deletionPolicy = "FORCE" in the associated secondary cluster and delete the cluster forcefully to delete the secondary cluster as well its associated secondary instance.
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `clusterType` field of an `AlloyDBCluster`
resource.'
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
machineConfig:
description: Configurations for the machines that host the underlying
database engine.
properties:
cpuCount:
description: The number of CPU's in the VM instance.
type: integer
type: object
networkConfig:
description: Instance level network configuration.
properties:
authorizedExternalNetworks:
description: A list of external networks authorized to access
this instance. This field is only allowed to be set when 'enable_public_ip'
is set to true.
items:
properties:
cidrRange:
description: CIDR range for one authorized network of the
instance.
type: string
type: object
type: array
enablePublicIp:
description: Enabling public ip for the instance. If a user wishes
to disable this, please also clear the list of the authorized
external networks set on the same instance.
type: boolean
type: object
readPoolConfig:
description: Read pool specific config. If the instance type is READ_POOL,
this configuration must be provided.
properties:
nodeCount:
description: Read capacity, i.e. number of nodes in a read pool
instance.
type: integer
type: object
resourceID:
description: Immutable. Optional. The instanceId of the resource.
Used for creation and acquisition. When unset, the value of `metadata.name`
is used as the default.
type: string
required:
- clusterRef
type: object
status:
properties:
conditions:
description: Conditions represent the latest available observation
of the resource's current state.
items:
properties:
lastTransitionTime:
description: Last time the condition transitioned from one status
to another.
type: string
message:
description: Human-readable message indicating details about
last transition.
type: string
reason:
description: Unique, one-word, CamelCase reason for the condition's
last transition.
type: string
status:
description: Status is the status of the condition. Can be True,
False, Unknown.
type: string
type:
description: Type is the type of the condition.
type: string
type: object
type: array
createTime:
description: Time the Instance was created in UTC.
type: string
ipAddress:
description: The IP address for the Instance. This is the connection
endpoint for an end-user application.
type: string
name:
description: The name of the instance resource.
type: string
observedGeneration:
description: ObservedGeneration is the generation of the resource
that was most recently observed by the Config Connector controller.
If this is equal to metadata.generation, then that means that the
current reported status reflects the most recent desired state of
the resource.
type: integer
publicIpAddress:
description: The public IP addresses for the Instance. This is available
ONLY when networkConfig.enablePublicIp is set to true. This is the
connection endpoint for an end-user application.
type: string
reconciling:
description: Set to true if the current state of Instance does not
match the user's intended state, and the service is actively updating
the resource to reconcile them. This can happen due to user-triggered
updates or system actions like failover or maintenance.
type: boolean
state:
description: The current state of the alloydb instance.
type: string
uid:
description: The system-generated UID of the resource.
type: string
updateTime:
description: Time the Instance was updated in UTC.
type: string
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []