-
Notifications
You must be signed in to change notification settings - Fork 3
/
vitess-operator.yaml
5799 lines (5799 loc) · 328 KB
/
vitess-operator.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
# Version: 20200423: 99eb9b939b4166caa38276874ce96cf289da8317
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
name: etcdlockservers.planetscale.com
namespace: voip
spec:
group: planetscale.com
names:
kind: EtcdLockserver
listKind: EtcdLockserverList
plural: etcdlockservers
shortNames:
- etcdls
singular: etcdlockserver
scope: Namespaced
subresources:
status: {}
validation:
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:
advertisePeerURLs:
description: 'AdvertisePeerURLs can optionally be used to override the
URLs that etcd members use to find each other for peer-to-peer connections. If
specified, the list must contain exactly 3 entries, one for each etcd
member index (1,2,3) respectively. Default: Build peer URLs automatically
based on Kubernetes built-in DNS.'
items:
type: string
maxItems: 3
minItems: 3
type: array
affinity:
description: 'Affinity allows you to set rules that constrain the scheduling
of your Etcd pods. WARNING: These affinity rules will override all
default affinities that we set; in turn, we can''t guarantee optimal
scheduling of your pods if you choose to set this field.'
type: object
annotations:
additionalProperties:
type: string
description: Annotations can optionally be used to attach custom annotations
to Pods created for this component.
type: object
createClientService:
description: 'CreateClientService sets whether to create a Service for
the client port of etcd member Pods. Note: Disabling this will NOT
delete a Service that was previously created. Default: true'
type: boolean
createPDB:
description: 'CreatePDB sets whether to create a PodDisruptionBudget
(PDB) for etcd member Pods. Note: Disabling this will NOT delete
a PDB that was previously created. Default: true'
type: boolean
createPeerService:
description: 'CreatePeerService sets whether to create a Service for
the peer port of etcd member Pods. Note: Disabling this will NOT
delete a Service that was previously created. Default: true'
type: boolean
dataVolumeClaimTemplate:
description: 'DataVolumeClaimTemplate configures the PersistentVolumeClaims
that will be created for each etcd instance to store its data files.
This field is required. IMPORTANT: For a cell-local lockserver, you
must set a storageClassName here for a StorageClass that''s configured
to only provision volumes in the Availability Zone that corresponds
to the Vitess cell. Default: Let the operator choose.'
type: object
extraEnv:
description: ExtraEnv can optionally be used to override default environment
variables set by the operator, or pass additional environment variables.
items:
type: object
type: array
extraFlags:
additionalProperties:
type: string
description: 'ExtraFlags can optionally be used to override default
flags set by the operator, or pass additional flags to etcd. All entries
must be key-value string pairs of the form "flag": "value". The flag
name should not have any prefix (just "flag", not "-flag"). To set
a boolean flag, set the string value to either "true" or "false".'
type: object
extraLabels:
additionalProperties:
type: string
description: ExtraLabels can optionally be used to attach custom labels
to Pods created for this component.
type: object
extraVolumeMounts:
description: ExtraVolumeMounts can optionally be used to override default
Pod volumeMounts defined by the operator, or specify additional mounts.
Typically, these are used to mount volumes defined through extraVolumes.
items:
type: object
type: array
extraVolumes:
description: ExtraVolumes can optionally be used to override default
Pod volumes defined by the operator, or provide additional volumes
to the Pod. Note that when adding a new volume, you should usually
also add a volumeMount to specify where in each container's filesystem
the volume should be mounted.
items:
type: object
type: array
image:
description: 'Image is the etcd server image (including version tag)
to deploy. Default: Let the operator choose.'
type: string
imagePullPolicy:
description: ImagePullPolicy specifies if/when to pull a container image.
type: string
initContainers:
description: InitContainers can optionally be used to supply extra init
containers that will be run to completion one after another before
any app containers are started.
items:
type: object
type: array
localMemberIndex:
description: 'LocalMemberIndex can optionally be used to specify that
only one etcd member should actually be deployed. This can be used
to spread members across multiple Kubernetes clusters by configuring
the EtcdLockserver CRD in each cluster to deploy a different member
index. If specified, the index must be 1, 2, or 3. Default: Deploy
all etcd members locally.'
format: int32
maximum: 3
minimum: 1
type: integer
resources:
description: 'Resources specify the compute resources to allocate for
each etcd member. Default: Let the operator choose.'
type: object
sidecarContainers:
description: SidecarContainers can optionally be used to supply extra
containers that run alongside the main containers.
items:
type: object
type: array
zone:
description: Zone is the name of the Availability Zone that this lockserver
should run in. This value should match the value of the "failure-domain.beta.kubernetes.io/zone"
label on the Kubernetes Nodes in that AZ. If the Kubernetes Nodes
don't have such a label, leave this empty.
type: string
type: object
status:
properties:
available:
description: Available is a condition that indicates whether the cluster
is able to serve queries.
type: string
clientServiceName:
description: ClientServiceName is the name of the Service for etcd client
connections.
type: string
observedGeneration:
description: The generation observed by the controller.
format: int64
type: integer
type: object
version: v2
versions:
- name: v2
served: true
storage: true
---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
name: vitessbackups.planetscale.com
namespace: voip
spec:
group: planetscale.com
names:
kind: VitessBackup
listKind: VitessBackupList
plural: vitessbackups
shortNames:
- vtb
singular: vitessbackup
scope: Namespaced
validation:
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:
type: object
status:
properties:
complete:
description: Complete indicates whether the backup ever completed.
type: boolean
engine:
description: Engine is the Vitess backup engine implementation that
was used.
type: string
finishedTime:
description: FinishedTime is the time when the backup finished.
format: date-time
type: string
position:
description: Position is the replication position of the snapshot that
was backed up. The position is expressed in the native, GTID-based
format of the MySQL flavor that took the backup. This is only available
after the backup is complete.
type: string
startTime:
description: StartTime is the time when the backup started.
format: date-time
type: string
storageDirectory:
description: StorageDirectory is the name of the parent directory in
storage that contains this backup.
type: string
storageName:
description: StorageName is the name of the backup in storage. This
is different from the name of the VitessBackup object created to represent
metadata about the actual backup in storage.
type: string
type: object
version: v2
versions:
- name: v2
served: true
storage: true
---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
name: vitessbackupstorages.planetscale.com
namespace: voip
spec:
group: planetscale.com
names:
kind: VitessBackupStorage
listKind: VitessBackupStorageList
plural: vitessbackupstorages
shortNames:
- vtbs
singular: vitessbackupstorage
scope: Namespaced
subresources:
status: {}
validation:
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:
location:
description: Location specifies the Vitess parameters for connecting
to the backup storage location.
properties:
azblob:
description: Azblob specifies a backup location in Azure Blob Storage.
properties:
account:
description: Account is the name of the Azure storage account
to use.
minLength: 1
type: string
authSecret:
description: AuthSecret is a reference to the Secret to use
for Azure authentication.
properties:
key:
description: Key is the name of the item within the data
source to use as the value. For a Kubernetes Secret object
(specified with the 'name' field), this is the key within
the 'data' map. When 'volumeName' is used, this specifies
the name of the file to load within that Volume.
type: string
name:
description: Name is the name of a Kubernetes Secret object
to use as the data source. The Secret must be in the same
namespace as the VitessCluster. The 'key' field defines
the item to pick from the Secret object's 'data' map. If
a Secret name is not specified, the data source must be
defined with the 'volumeName' field instead.
type: string
volumeName:
description: VolumeName directly specifies the name of a
Volume in each Pod that should be mounted. You must ensure
a Volume by that name exists in all relevant Pods, such
as by using the appropriate ExtraVolumes fields. If specified,
this takes precedence over the 'name' field. The 'key'
field defines the name of the file to load within this
Volume.
type: string
required:
- key
type: object
container:
description: Container is the name of the Azure storage account
container to use.
minLength: 1
type: string
keyPrefix:
description: KeyPrefix is an optional prefix added to all object
keys created by Vitess. This is only needed if the same container
is also used for something other than backups for VitessClusters.
Backups from different clusters, keyspaces, or shards will
automatically avoid colliding with each other within a container,
regardless of this setting.
maxLength: 256
pattern: ^[^\r\n]*$
type: string
required:
- account
- container
- authSecret
type: object
gcs:
description: GCS specifies a backup location in Google Cloud Storage.
properties:
authSecret:
description: 'AuthSecret is a reference to the Secret to use
for GCS authentication. If set, this must point to a file
in the format expected for the GOOGLE_APPLICATION_CREDENTIALS
environment variable. Default: Use the default credentials
of the Node.'
properties:
key:
description: Key is the name of the item within the data
source to use as the value. For a Kubernetes Secret object
(specified with the 'name' field), this is the key within
the 'data' map. When 'volumeName' is used, this specifies
the name of the file to load within that Volume.
type: string
name:
description: Name is the name of a Kubernetes Secret object
to use as the data source. The Secret must be in the same
namespace as the VitessCluster. The 'key' field defines
the item to pick from the Secret object's 'data' map. If
a Secret name is not specified, the data source must be
defined with the 'volumeName' field instead.
type: string
volumeName:
description: VolumeName directly specifies the name of a
Volume in each Pod that should be mounted. You must ensure
a Volume by that name exists in all relevant Pods, such
as by using the appropriate ExtraVolumes fields. If specified,
this takes precedence over the 'name' field. The 'key'
field defines the name of the file to load within this
Volume.
type: string
required:
- key
type: object
bucket:
description: Bucket is the name of the GCS bucket to use.
minLength: 1
type: string
keyPrefix:
description: KeyPrefix is an optional prefix added to all object
keys created by Vitess. This is only needed if the same bucket
is also used for something other than backups for VitessClusters.
Backups from different clusters, keyspaces, or shards will
automatically avoid colliding with each other within a bucket,
regardless of this setting.
maxLength: 256
pattern: ^[^\r\n]*$
type: string
required:
- bucket
type: object
name:
description: Name is used to refer to this backup location from
other parts of a VitessCluster object, such as in tablet pool
definitions. This name must be unique among all backup locations
defined in a given cluster. A backup location with an empty name
defines the default location used when a tablet pool does not
specify a backup location name.
maxLength: 25
pattern: ^[a-z0-9]([a-z0-9]*[a-z0-9])?$
type: string
s3:
description: S3 specifies a backup location in Amazon S3.
properties:
authSecret:
description: 'AuthSecret is a reference to the Secret to use
for S3 authentication. If set, this must point to a file in
the format expected for the `~/.aws/credentials` file. Default:
Use the default credentials of the Node.'
properties:
key:
description: Key is the name of the item within the data
source to use as the value. For a Kubernetes Secret object
(specified with the 'name' field), this is the key within
the 'data' map. When 'volumeName' is used, this specifies
the name of the file to load within that Volume.
type: string
name:
description: Name is the name of a Kubernetes Secret object
to use as the data source. The Secret must be in the same
namespace as the VitessCluster. The 'key' field defines
the item to pick from the Secret object's 'data' map. If
a Secret name is not specified, the data source must be
defined with the 'volumeName' field instead.
type: string
volumeName:
description: VolumeName directly specifies the name of a
Volume in each Pod that should be mounted. You must ensure
a Volume by that name exists in all relevant Pods, such
as by using the appropriate ExtraVolumes fields. If specified,
this takes precedence over the 'name' field. The 'key'
field defines the name of the file to load within this
Volume.
type: string
required:
- key
type: object
bucket:
description: Bucket is the name of the S3 bucket to use.
minLength: 1
type: string
endpoint:
description: 'Endpoint is the `host:port` (port is required)
for the S3 backend. Default: Use the endpoint associated with
`region` by the driver.'
type: string
keyPrefix:
description: KeyPrefix is an optional prefix added to all object
keys created by Vitess. This is only needed if the same bucket
is also used for something other than backups for VitessClusters.
Backups from different clusters, keyspaces, or shards will
automatically avoid colliding with each other within a bucket,
regardless of this setting.
maxLength: 256
pattern: ^[^\r\n]*$
type: string
region:
description: Region is the AWS region in which the bucket is
located.
minLength: 1
type: string
required:
- region
- bucket
type: object
volume:
description: Volume specifies a backup location as a Kubernetes
Volume Source to mount. This can be used, for example, to store
backups on an NFS mount, or on a shared host path for local testing.
type: object
type: object
required:
- location
type: object
status:
properties:
observedGeneration:
description: The generation observed by the controller.
format: int64
type: integer
totalBackupCount:
description: TotalBackupCount is the total number of backups found in
this storage location, across all keyspaces and shards.
format: int32
type: integer
type: object
version: v2
versions:
- name: v2
served: true
storage: true
---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
name: vitesscells.planetscale.com
namespace: voip
spec:
group: planetscale.com
names:
kind: VitessCell
listKind: VitessCellList
plural: vitesscells
shortNames:
- vtc
singular: vitesscell
scope: Namespaced
subresources:
status: {}
validation:
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:
allCells:
description: AllCells is a list of all cells in the Vitess cluster.
items:
type: string
type: array
extraVitessFlags:
additionalProperties:
type: string
description: ExtraVitessFlags is inherited from the parent's VitessClusterSpec.
type: object
gateway:
description: Gateway configures the Vitess Gateway deployment in this
cell.
properties:
affinity:
description: 'Affinity allows you to set rules that constrain the
scheduling of your vtgate pods. WARNING: These affinity rules
will override all default affinities that we set; in turn, we
can''t guarantee optimal scheduling of your pods if you choose
to set this field.'
type: object
annotations:
additionalProperties:
type: string
description: Annotations can optionally be used to attach custom
annotations to Pods created for this component. These will be
attached to the underlying Pods that the vtgate Deployment creates.
type: object
authentication:
description: Authentication configures how Vitess Gateway authenticates
MySQL client connections.
properties:
static:
description: Static configures vtgate to use a static file containing
usernames and passwords.
properties:
secret:
description: Secret configures vtgate to load the static
auth file from a given key in a given Secret.
properties:
key:
description: Key is the name of the item within the
data source to use as the value. For a Kubernetes
Secret object (specified with the 'name' field), this
is the key within the 'data' map. When 'volumeName'
is used, this specifies the name of the file to load
within that Volume.
type: string
name:
description: Name is the name of a Kubernetes Secret
object to use as the data source. The Secret must
be in the same namespace as the VitessCluster. The
'key' field defines the item to pick from the Secret
object's 'data' map. If a Secret name is not specified,
the data source must be defined with the 'volumeName'
field instead.
type: string
volumeName:
description: VolumeName directly specifies the name
of a Volume in each Pod that should be mounted. You
must ensure a Volume by that name exists in all relevant
Pods, such as by using the appropriate ExtraVolumes
fields. If specified, this takes precedence over the
'name' field. The 'key' field defines the name of
the file to load within this Volume.
type: string
required:
- key
type: object
type: object
type: object
extraEnv:
description: ExtraEnv can optionally be used to override default
environment variables set by the operator, or pass additional
environment variables.
items:
type: object
type: array
extraFlags:
additionalProperties:
type: string
description: 'ExtraFlags can optionally be used to override default
flags set by the operator, or pass additional flags to vtgate.
All entries must be key-value string pairs of the form "flag":
"value". The flag name should not have any prefix (just "flag",
not "-flag"). To set a boolean flag, set the string value to either
"true" or "false".'
type: object
extraLabels:
additionalProperties:
type: string
description: ExtraLabels can optionally be used to attach custom
labels to Pods created for this component. These will be attached
to the underlying Pods that the vtgate Deployment creates.
type: object
extraVolumeMounts:
description: ExtraVolumeMounts can optionally be used to override
default Pod volumeMounts defined by the operator, or specify additional
mounts. Typically, these are used to mount volumes defined through
extraVolumes.
items:
type: object
type: array
extraVolumes:
description: ExtraVolumes can optionally be used to override default
Pod volumes defined by the operator, or provide additional volumes
to the Pod. Note that when adding a new volume, you should usually
also add a volumeMount to specify where in each container's filesystem
the volume should be mounted.
items:
type: object
type: array
initContainers:
description: InitContainers can optionally be used to supply extra
init containers that will be run to completion one after another
before any app containers are started.
items:
type: object
type: array
replicas:
description: Replicas is the number of vtgate instances to deploy
in this cell.
format: int32
minimum: 0
type: integer
resources:
description: Resources determines the compute resources reserved
for each vtgate replica.
type: object
secureTransport:
description: SecureTransport configures secure transport connections
for vtgate.
properties:
required:
description: Required configures vtgate to reject non-secure
transport connections. Applies only to MySQL protocol connections.
All GRPC transport is required to be encrypted when certs
are set.
type: boolean
tls:
description: TLS configures vtgate to use TLS encrypted transport.
properties:
certSecret:
description: CertSecret configures vtgate to load the TLS
cert PEM file from a given key in a given Secret.
properties:
key:
description: Key is the name of the item within the
data source to use as the value. For a Kubernetes
Secret object (specified with the 'name' field), this
is the key within the 'data' map. When 'volumeName'
is used, this specifies the name of the file to load
within that Volume.
type: string
name:
description: Name is the name of a Kubernetes Secret
object to use as the data source. The Secret must
be in the same namespace as the VitessCluster. The
'key' field defines the item to pick from the Secret
object's 'data' map. If a Secret name is not specified,
the data source must be defined with the 'volumeName'
field instead.
type: string
volumeName:
description: VolumeName directly specifies the name
of a Volume in each Pod that should be mounted. You
must ensure a Volume by that name exists in all relevant
Pods, such as by using the appropriate ExtraVolumes
fields. If specified, this takes precedence over the
'name' field. The 'key' field defines the name of
the file to load within this Volume.
type: string
required:
- key
type: object
clientCACertSecret:
description: ClientCACertSecret configures vtgate to load
the TLS certificate authority PEM file from a given key
in a given Secret. If specified, checks client certificates
are signed by this CA certificate. Optional.
properties:
key:
description: Key is the name of the item within the
data source to use as the value. For a Kubernetes
Secret object (specified with the 'name' field), this
is the key within the 'data' map. When 'volumeName'
is used, this specifies the name of the file to load
within that Volume.
type: string
name:
description: Name is the name of a Kubernetes Secret
object to use as the data source. The Secret must
be in the same namespace as the VitessCluster. The
'key' field defines the item to pick from the Secret
object's 'data' map. If a Secret name is not specified,
the data source must be defined with the 'volumeName'
field instead.
type: string
volumeName:
description: VolumeName directly specifies the name
of a Volume in each Pod that should be mounted. You
must ensure a Volume by that name exists in all relevant
Pods, such as by using the appropriate ExtraVolumes
fields. If specified, this takes precedence over the
'name' field. The 'key' field defines the name of
the file to load within this Volume.
type: string
required:
- key
type: object
keySecret:
description: KeySecret configures vtgate to load the TLS
key PEM file from a given key in a given Secret.
properties:
key:
description: Key is the name of the item within the
data source to use as the value. For a Kubernetes
Secret object (specified with the 'name' field), this
is the key within the 'data' map. When 'volumeName'
is used, this specifies the name of the file to load
within that Volume.
type: string
name:
description: Name is the name of a Kubernetes Secret
object to use as the data source. The Secret must
be in the same namespace as the VitessCluster. The
'key' field defines the item to pick from the Secret
object's 'data' map. If a Secret name is not specified,
the data source must be defined with the 'volumeName'
field instead.
type: string
volumeName:
description: VolumeName directly specifies the name
of a Volume in each Pod that should be mounted. You
must ensure a Volume by that name exists in all relevant
Pods, such as by using the appropriate ExtraVolumes
fields. If specified, this takes precedence over the
'name' field. The 'key' field defines the name of
the file to load within this Volume.
type: string
required:
- key
type: object
type: object
type: object
sidecarContainers:
description: SidecarContainers can optionally be used to supply
extra containers that run alongside the main containers.
items:
type: object
type: array
type: object
globalLockserver:
description: GlobalLockserver are the params to connect to the global
lockserver.
properties:
address:
description: Address is the host:port of the lockserver client endpoint.
type: string
implementation:
description: Implementation specifies which Vitess "topo" plugin
to use.
type: string
rootPath:
description: RootPath is a path prefix for all lockserver data belonging
to a given Vitess cluster. Multiple Vitess clusters can share
a lockserver as long as they have unique root paths.
type: string
required:
- implementation
- address
- rootPath
type: object
imagePullPolicies:
description: ImagePullPolicies are inherited from the VitessCluster
spec.
properties:
mysqld:
description: Mysqld is the container image pull policy to use for
mysqld.
type: string
mysqldExporter:
description: MysqldExporter is the container image pull policy to
use for mysqld-exporter.
type: string
vtbackup:
description: Vtbackup is the container image pull policy to use
for Vitess Backup jobs.
type: string
vtctld:
description: Vtctld is the container image pull policy to use for
Vitess Dashboard instances.
type: string
vtgate:
description: Vtgate is the container image pull policy to use for
Vitess Gateway instances.
type: string
vttablet:
description: Vttablet is the container image pull policy to use
for Vitess Tablet instances.
type: string
type: object
images:
description: Images are not customizable by users at the cell level
because version skew across the cluster is discouraged except during
rolling updates, in which case this field is automatically managed
by the VitessCluster controller that owns this VitessCell.
properties:
vtgate:
description: Vtgate is the container image (including version tag)
to use for Vitess Gateway instances.
type: string
type: object
lockserver:
description: 'Lockserver specifies either a deployed or external lockserver
to be used as the Vitess cell-local topology store. Default: Put this
cell''s topology data in the global lockserver instead of its own
lockserver.'
properties:
etcd:
description: Etcd deploys our own etcd cluster as a lockserver.
properties:
advertisePeerURLs:
description: 'AdvertisePeerURLs can optionally be used to override
the URLs that etcd members use to find each other for peer-to-peer
connections. If specified, the list must contain exactly
3 entries, one for each etcd member index (1,2,3) respectively. Default:
Build peer URLs automatically based on Kubernetes built-in
DNS.'
items:
type: string
maxItems: 3
minItems: 3
type: array
affinity:
description: 'Affinity allows you to set rules that constrain
the scheduling of your Etcd pods. WARNING: These affinity
rules will override all default affinities that we set; in
turn, we can''t guarantee optimal scheduling of your pods
if you choose to set this field.'
type: object
annotations:
additionalProperties:
type: string
description: Annotations can optionally be used to attach custom
annotations to Pods created for this component.
type: object
createClientService:
description: 'CreateClientService sets whether to create a Service
for the client port of etcd member Pods. Note: Disabling
this will NOT delete a Service that was previously created. Default:
true'
type: boolean
createPDB:
description: 'CreatePDB sets whether to create a PodDisruptionBudget
(PDB) for etcd member Pods. Note: Disabling this will NOT
delete a PDB that was previously created. Default: true'
type: boolean
createPeerService:
description: 'CreatePeerService sets whether to create a Service
for the peer port of etcd member Pods. Note: Disabling this
will NOT delete a Service that was previously created. Default:
true'
type: boolean
dataVolumeClaimTemplate:
description: 'DataVolumeClaimTemplate configures the PersistentVolumeClaims
that will be created for each etcd instance to store its data
files. This field is required. IMPORTANT: For a cell-local
lockserver, you must set a storageClassName here for a StorageClass
that''s configured to only provision volumes in the Availability
Zone that corresponds to the Vitess cell. Default: Let the
operator choose.'
type: object
extraEnv:
description: ExtraEnv can optionally be used to override default
environment variables set by the operator, or pass additional
environment variables.
items:
type: object
type: array
extraFlags:
additionalProperties:
type: string
description: 'ExtraFlags can optionally be used to override
default flags set by the operator, or pass additional flags
to etcd. All entries must be key-value string pairs of the
form "flag": "value". The flag name should not have any prefix
(just "flag", not "-flag"). To set a boolean flag, set the
string value to either "true" or "false".'
type: object
extraLabels:
additionalProperties:
type: string
description: ExtraLabels can optionally be used to attach custom
labels to Pods created for this component.
type: object
extraVolumeMounts:
description: ExtraVolumeMounts can optionally be used to override
default Pod volumeMounts defined by the operator, or specify
additional mounts. Typically, these are used to mount volumes
defined through extraVolumes.
items:
type: object
type: array
extraVolumes:
description: ExtraVolumes can optionally be used to override
default Pod volumes defined by the operator, or provide additional
volumes to the Pod. Note that when adding a new volume, you
should usually also add a volumeMount to specify where in
each container's filesystem the volume should be mounted.
items:
type: object
type: array
image:
description: 'Image is the etcd server image (including version
tag) to deploy. Default: Let the operator choose.'
type: string
imagePullPolicy:
description: ImagePullPolicy specifies if/when to pull a container
image.
type: string
initContainers:
description: InitContainers can optionally be used to supply
extra init containers that will be run to completion one after
another before any app containers are started.
items:
type: object
type: array
localMemberIndex:
description: 'LocalMemberIndex can optionally be used to specify
that only one etcd member should actually be deployed. This
can be used to spread members across multiple Kubernetes clusters
by configuring the EtcdLockserver CRD in each cluster to deploy
a different member index. If specified, the index must be
1, 2, or 3. Default: Deploy all etcd members locally.'
format: int32
maximum: 3
minimum: 1
type: integer
resources:
description: 'Resources specify the compute resources to allocate
for each etcd member. Default: Let the operator choose.'
type: object
sidecarContainers:
description: SidecarContainers can optionally be used to supply
extra containers that run alongside the main containers.
items:
type: object
type: array
type: object
external:
description: External specifies that we should connect to an existing
lockserver, instead of deploying our own. If this is set, all
other Lockserver fields are ignored.
properties:
address:
description: Address is the host:port of the lockserver client
endpoint.
type: string
implementation:
description: Implementation specifies which Vitess "topo" plugin
to use.