-
Notifications
You must be signed in to change notification settings - Fork 215
/
alloydb_v1beta1_alloydbcluster.yaml
1483 lines (1474 loc) · 69.1 KB
/
alloydb_v1beta1_alloydbcluster.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
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# 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: alloydbclusters.alloydb.cnrm.cloud.google.com
spec:
group: alloydb.cnrm.cloud.google.com
names:
categories:
- gcp
kind: AlloyDBCluster
plural: alloydbclusters
shortNames:
- gcpalloydbcluster
- gcpalloydbclusters
singular: alloydbcluster
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:
properties:
automatedBackupPolicy:
description: The automated backup policy for this cluster. AutomatedBackupPolicy
is disabled by default.
properties:
backupWindow:
description: |-
The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.
The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour.
A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
type: string
enabled:
description: Whether automated backups are enabled.
type: boolean
encryptionConfig:
description: EncryptionConfig describes the encryption config
of a cluster or a backup that is encrypted with a CMEK (customer-managed
encryption key).
properties:
kmsKeyNameRef:
description: '(Optional) The fully-qualified resource name
of the KMS key. Each Cloud KMS key is regionalized and has
the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].'
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `selfLink` field of a
`KMSCryptoKey` 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
type: object
labels:
additionalProperties:
type: string
description: Labels to apply to backups created using this configuration.
type: object
location:
description: The location where the backup will be stored. Currently,
the only supported option is to store the backup in the same
region as the cluster.
type: string
quantityBasedRetention:
description: Quantity-based Backup retention policy to retain
recent backups. Conflicts with 'time_based_retention', both
can't be set together.
properties:
count:
description: The number of backups to retain.
type: integer
type: object
timeBasedRetention:
description: Time-based Backup retention policy. Conflicts with
'quantity_based_retention', both can't be set together.
properties:
retentionPeriod:
description: |-
The retention period.
A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
type: string
type: object
weeklySchedule:
description: Weekly schedule for the Backup.
properties:
daysOfWeek:
description: 'The days of the week to perform a backup. At
least one day of the week must be provided. Possible values:
["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY",
"SATURDAY", "SUNDAY"].'
items:
type: string
type: array
startTimes:
description: The times during the day to start a backup. At
least one start time must be provided. The start times are
assumed to be in UTC and to be an exact hour (e.g., 04:00:00).
items:
properties:
hours:
description: Hours of day in 24 hour format. Should
be from 0 to 23. An API may choose to allow the value
"24:00:00" for scenarios like business closing time.
type: integer
minutes:
description: Minutes of hour of day. Currently, only
the value 0 is supported.
type: integer
nanos:
description: Fractions of seconds in nanoseconds. Currently,
only the value 0 is supported.
type: integer
seconds:
description: Seconds of minutes of the time. Currently,
only the value 0 is supported.
type: integer
type: object
type: array
required:
- startTimes
type: object
type: object
clusterType:
description: 'The type of cluster. If not set, defaults to PRIMARY.
Default value: "PRIMARY" Possible values: ["PRIMARY", "SECONDARY"].'
type: string
continuousBackupConfig:
description: |-
The continuous backup config for this cluster.
If no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days.
properties:
enabled:
description: Whether continuous backup recovery is enabled. If
not set, defaults to true.
type: boolean
encryptionConfig:
description: EncryptionConfig describes the encryption config
of a cluster or a backup that is encrypted with a CMEK (customer-managed
encryption key).
properties:
kmsKeyNameRef:
description: '(Optional) The fully-qualified resource name
of the KMS key. Each Cloud KMS key is regionalized and has
the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].'
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `selfLink` field of a
`KMSCryptoKey` 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
type: object
recoveryWindowDays:
description: |-
The numbers of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window.
If not set, defaults to 14 days.
type: integer
type: object
deletionPolicy:
description: |-
Policy to determine if the cluster should be deleted forcefully.
Deleting a cluster forcefully, deletes the cluster and all its associated instances within the cluster.
Deleting a Secondary cluster with a secondary instance REQUIRES setting deletion_policy = "FORCE" otherwise an error is returned. This is needed as there is no support to delete just the secondary instance, and the only way to delete secondary instance is to delete the associated secondary cluster forcefully which also deletes the secondary instance.
type: string
displayName:
description: User-settable and human-readable display name for the
Cluster.
type: string
encryptionConfig:
description: EncryptionConfig describes the encryption config of a
cluster or a backup that is encrypted with a CMEK (customer-managed
encryption key).
properties:
kmsKeyNameRef:
description: '(Optional) The fully-qualified resource name of
the KMS key. Each Cloud KMS key is regionalized and has the
following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].'
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `selfLink` field of a `KMSCryptoKey`
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
type: object
initialUser:
description: Initial user to setup during cluster creation.
properties:
password:
description: The initial password for the user.
oneOf:
- not:
required:
- valueFrom
required:
- value
- not:
required:
- value
required:
- valueFrom
properties:
value:
description: Value of the field. Cannot be used if 'valueFrom'
is specified.
type: string
valueFrom:
description: Source for the field's value. Cannot be used
if 'value' is specified.
properties:
secretKeyRef:
description: Reference to a value with the given key in
the given Secret in the resource's namespace.
properties:
key:
description: Key that identifies the value to be extracted.
type: string
name:
description: Name of the Secret to extract a value
from.
type: string
required:
- name
- key
type: object
type: object
type: object
user:
description: The database username.
type: string
required:
- password
type: object
location:
description: Immutable. The location where the alloydb cluster should
reside.
type: string
maintenanceUpdatePolicy:
description: MaintenanceUpdatePolicy defines the policy for system
updates.
properties:
maintenanceWindows:
description: Preferred windows to perform maintenance. Currently
limited to 1.
items:
properties:
day:
description: 'Preferred day of the week for maintenance,
e.g. MONDAY, TUESDAY, etc. Possible values: ["MONDAY",
"TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY",
"SUNDAY"].'
type: string
startTime:
description: Preferred time to start the maintenance operation
on the specified day. Maintenance will start within 1
hour of this time.
properties:
hours:
description: Hours of day in 24 hour format. Should
be from 0 to 23.
type: integer
minutes:
description: Minutes of hour of day. Currently, only
the value 0 is supported.
type: integer
nanos:
description: Fractions of seconds in nanoseconds. Currently,
only the value 0 is supported.
type: integer
seconds:
description: Seconds of minutes of the time. Currently,
only the value 0 is supported.
type: integer
required:
- hours
type: object
required:
- day
- startTime
type: object
type: array
type: object
networkConfig:
description: Metadata related to network configuration.
properties:
allocatedIpRange:
description: |-
The name of the allocated IP range for the private IP AlloyDB cluster. For example: "google-managed-services-default".
If set, the instance IPs for this cluster will be created in the allocated range.
type: string
networkRef:
description: |-
(Required) The relative resource name of the VPC network on which
the instance can be accessed. It is specified in the following form:
projects/{project}/global/networks/{network_id}.
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: string of the format `projects/{{project}}/global/networks/{{value}}`,
where {{value}} is the `name` field of a `ComputeNetwork`
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
type: object
networkRef:
description: |-
(Required) The relative resource name of the VPC network on which
the instance can be accessed. It is specified in the following form:
projects/{project}/global/networks/{network_id}.
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: string of the format `projects/{{project}}/global/networks/{{value}}`,
where {{value}} is the `name` field of a `ComputeNetwork` 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
projectRef:
description: The project that this resource belongs to.
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `name` field of a `Project` 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
resourceID:
description: Immutable. Optional. The clusterId of the resource. Used
for creation and acquisition. When unset, the value of `metadata.name`
is used as the default.
type: string
restoreBackupSource:
description: Immutable. The source when restoring from a backup. Conflicts
with 'restore_continuous_backup_source', both can't be set together.
properties:
backupNameRef:
description: (Required) The name of the backup that this cluster
is restored from.
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `name` field of an `AlloyDBBackup`
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
required:
- backupNameRef
type: object
restoreContinuousBackupSource:
description: Immutable. The source when restoring via point in time
recovery (PITR). Conflicts with 'restore_backup_source', both can't
be set together.
properties:
clusterRef:
description: (Required) The name of the source cluster that this
cluster is restored from.
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
pointInTime:
description: Immutable. The point in time that this cluster is
restored to, in RFC 3339 format.
type: string
required:
- clusterRef
- pointInTime
type: object
secondaryConfig:
description: Configuration of the secondary cluster for Cross Region
Replication. This should be set if and only if the cluster is of
type SECONDARY.
properties:
primaryClusterNameRef:
description: |-
Name of the primary cluster must be in the format
'projects/{project}/locations/{location}/clusters/{cluster_id}'
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
required:
- primaryClusterNameRef
type: object
required:
- location
- projectRef
type: object
status:
properties:
backupSource:
description: Cluster created from backup.
items:
properties:
backupName:
description: The name of the backup resource.
type: string
type: object
type: array
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
continuousBackupInfo:
description: ContinuousBackupInfo describes the continuous backup
properties of a cluster.
items:
properties:
earliestRestorableTime:
description: The earliest restorable time that can be restored
to. Output only field.
type: string
enabledTime:
description: When ContinuousBackup was most recently enabled.
Set to null if ContinuousBackup is not enabled.
type: string
encryptionInfo:
description: Output only. The encryption information for the
WALs and backups required for ContinuousBackup.
items:
properties:
encryptionType:
description: Output only. Type of encryption.
type: string
kmsKeyVersions:
description: Output only. Cloud KMS key versions that
are being used to protect the database or the backup.
items:
type: string
type: array
type: object
type: array
schedule:
description: Days of the week on which a continuous backup is
taken. Output only field. Ignored if passed into the request.
items:
type: string
type: array
type: object
type: array
databaseVersion:
description: The database engine major version. This is an output-only
field and it's populated at the Cluster creation time. This field
cannot be changed after cluster creation.
type: string
encryptionInfo:
description: EncryptionInfo describes the encryption information of
a cluster or a backup.
items:
properties:
encryptionType:
description: Output only. Type of encryption.
type: string
kmsKeyVersions:
description: Output only. Cloud KMS key versions that are being
used to protect the database or the backup.
items:
type: string
type: array
type: object
type: array
migrationSource:
description: Cluster created via DMS migration.
items:
properties:
hostPort:
description: The host and port of the on-premises instance in
host:port format.
type: string
referenceId:
description: Place holder for the external source identifier(e.g
DMS job name) that created the cluster.
type: string
sourceType:
description: Type of migration source.
type: string
type: object
type: array
name:
description: The name of the cluster 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
observedState:
description: The observed state of the underlying GCP resource.
properties:
clusterType:
description: 'The type of cluster. If not set, defaults to PRIMARY.
Default value: "PRIMARY" Possible values: ["PRIMARY", "SECONDARY"].'
type: string
type: object
uid:
description: The system-generated UID of the resource.
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:
properties:
automatedBackupPolicy:
description: The automated backup policy for this cluster. AutomatedBackupPolicy
is disabled by default.
properties:
backupWindow:
description: |-
The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.
The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour.
A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
type: string
enabled:
description: Whether automated backups are enabled.
type: boolean
encryptionConfig:
description: EncryptionConfig describes the encryption config
of a cluster or a backup that is encrypted with a CMEK (customer-managed
encryption key).
properties:
kmsKeyNameRef:
description: '(Optional) The fully-qualified resource name
of the KMS key. Each Cloud KMS key is regionalized and has
the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].'
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `selfLink` field of a
`KMSCryptoKey` 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
type: object
labels:
additionalProperties:
type: string
description: Labels to apply to backups created using this configuration.
type: object
location:
description: The location where the backup will be stored. Currently,
the only supported option is to store the backup in the same
region as the cluster.
type: string
quantityBasedRetention:
description: Quantity-based Backup retention policy to retain
recent backups. Conflicts with 'time_based_retention', both
can't be set together.
properties:
count:
description: The number of backups to retain.
type: integer
type: object
timeBasedRetention:
description: Time-based Backup retention policy. Conflicts with
'quantity_based_retention', both can't be set together.
properties:
retentionPeriod:
description: |-
The retention period.
A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
type: string
type: object
weeklySchedule:
description: Weekly schedule for the Backup.
properties:
daysOfWeek:
description: 'The days of the week to perform a backup. At
least one day of the week must be provided. Possible values:
["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY",
"SATURDAY", "SUNDAY"].'
items:
type: string
type: array
startTimes:
description: The times during the day to start a backup. At
least one start time must be provided. The start times are
assumed to be in UTC and to be an exact hour (e.g., 04:00:00).
items:
properties:
hours:
description: Hours of day in 24 hour format. Should
be from 0 to 23. An API may choose to allow the value
"24:00:00" for scenarios like business closing time.
type: integer
minutes:
description: Minutes of hour of day. Currently, only
the value 0 is supported.
type: integer
nanos:
description: Fractions of seconds in nanoseconds. Currently,
only the value 0 is supported.
type: integer
seconds:
description: Seconds of minutes of the time. Currently,
only the value 0 is supported.
type: integer
type: object
type: array
required:
- startTimes
type: object
type: object
clusterType:
description: 'The type of cluster. If not set, defaults to PRIMARY.
Default value: "PRIMARY" Possible values: ["PRIMARY", "SECONDARY"].'
type: string
continuousBackupConfig:
description: |-
The continuous backup config for this cluster.
If no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days.
properties:
enabled:
description: Whether continuous backup recovery is enabled. If
not set, defaults to true.
type: boolean
encryptionConfig:
description: EncryptionConfig describes the encryption config
of a cluster or a backup that is encrypted with a CMEK (customer-managed
encryption key).
properties:
kmsKeyNameRef:
description: '(Optional) The fully-qualified resource name
of the KMS key. Each Cloud KMS key is regionalized and has
the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].'
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The `selfLink` field of a
`KMSCryptoKey` 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
type: object
recoveryWindowDays:
description: |-
The numbers of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window.
If not set, defaults to 14 days.
type: integer
type: object
deletionPolicy:
description: |-
Policy to determine if the cluster should be deleted forcefully.
Deleting a cluster forcefully, deletes the cluster and all its associated instances within the cluster.
Deleting a Secondary cluster with a secondary instance REQUIRES setting deletion_policy = "FORCE" otherwise an error is returned. This is needed as there is no support to delete just the secondary instance, and the only way to delete secondary instance is to delete the associated secondary cluster forcefully which also deletes the secondary instance.
type: string
displayName:
description: User-settable and human-readable display name for the
Cluster.
type: string
encryptionConfig:
description: EncryptionConfig describes the encryption config of a
cluster or a backup that is encrypted with a CMEK (customer-managed
encryption key).
properties:
kmsKeyNameRef:
description: '(Optional) The fully-qualified resource name of
the KMS key. Each Cloud KMS key is regionalized and has the
following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].'
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace