-
Notifications
You must be signed in to change notification settings - Fork 95
Expand file tree
/
Copy pathindex.html
More file actions
9127 lines (9127 loc) · 203 KB
/
index.html
File metadata and controls
9127 lines (9127 loc) · 203 KB
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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<title>Vitess Operator API Reference</title>
</head>
<body>
<nav class="navbar navbar-expand-lg navbar-dark bg-dark">
<a class="navbar-brand" href="#">Vitess Operator API Reference</a>
<ul class="navbar-nav">
<li class="nav-item">
<a class="nav-link" href="#planetscale.com/v2.VitessCluster">VitessCluster</a>
</li>
</ul>
</nav>
<div class="container">
<h1 id="planetscale.com/v2">planetscale.com/v2</h1>
<p>
<p>Package v2 contains API Schema definitions for the planetscale.com/v2 API group.</p>
</p>
<h2>Resource Types</h2>
<ul><li>
<a href="#planetscale.com/v2.EtcdLockserver">EtcdLockserver</a>
</li><li>
<a href="#planetscale.com/v2.VitessBackup">VitessBackup</a>
</li><li>
<a href="#planetscale.com/v2.VitessCluster">VitessCluster</a>
</li></ul>
<h3 id="planetscale.com/v2.EtcdLockserver">EtcdLockserver
</h3>
<p>
<p>EtcdLockserver runs an etcd cluster for use as a Vitess lockserver.
Unlike etcd-operator, it uses static bootstrapping and PVCs, treating members
as stateful rather the ephemeral. Bringing back existing members instead of
creating new ones means etcd can recover from loss of quorum without data
loss, which is important for Vitess because restoring from an etcd backup
(resetting the lockserver to a point in the past) would violate the
consistency model that Vitess expects of a lockserver.</p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>apiVersion</code><br>
string</td>
<td>
<code>
planetscale.com/v2
</code>
</td>
</tr>
<tr>
<td>
<code>kind</code><br>
string
</td>
<td><code>EtcdLockserver</code></td>
</tr>
<tr>
<td>
<code>metadata</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta">
Kubernetes meta/v1.ObjectMeta
</a>
</em>
</td>
<td>
Refer to the Kubernetes API documentation for the fields of the
<code>metadata</code> field.
</td>
</tr>
<tr>
<td>
<code>spec</code><br>
<em>
<a href="#planetscale.com/v2.EtcdLockserverSpec">
EtcdLockserverSpec
</a>
</em>
</td>
<td>
<br/>
<br/>
<table>
<tr>
<td>
<code>EtcdLockserverTemplate</code><br>
<em>
<a href="#planetscale.com/v2.EtcdLockserverTemplate">
EtcdLockserverTemplate
</a>
</em>
</td>
<td>
<p>
(Members of <code>EtcdLockserverTemplate</code> are embedded into this type.)
</p>
<p>EtcdLockserverTemplate contains the user-specified parts of EtcdLockserverSpec.
These are the parts that are configurable inside VitessCluster.
The rest of the fields below are filled in by the parent controller.</p>
</td>
</tr>
<tr>
<td>
<code>zone</code><br>
<em>
string
</em>
</td>
<td>
<p>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.</p>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<code>status</code><br>
<em>
<a href="#planetscale.com/v2.EtcdLockserverStatus">
EtcdLockserverStatus
</a>
</em>
</td>
<td>
</td>
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.VitessBackup">VitessBackup
</h3>
<p>
<p>VitessBackup is a one-way mirror of metadata for a Vitess backup.
These objects are created automatically by the VitessBackupStorage controller
to provide access to backup metadata from Kubernetes. Each backup found in
the storage location will be represented by its own VitessBackup object.</p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>apiVersion</code><br>
string</td>
<td>
<code>
planetscale.com/v2
</code>
</td>
</tr>
<tr>
<td>
<code>kind</code><br>
string
</td>
<td><code>VitessBackup</code></td>
</tr>
<tr>
<td>
<code>metadata</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta">
Kubernetes meta/v1.ObjectMeta
</a>
</em>
</td>
<td>
Refer to the Kubernetes API documentation for the fields of the
<code>metadata</code> field.
</td>
</tr>
<tr>
<td>
<code>spec</code><br>
<em>
<a href="#planetscale.com/v2.VitessBackupSpec">
VitessBackupSpec
</a>
</em>
</td>
<td>
<br/>
<br/>
<table>
</table>
</td>
</tr>
<tr>
<td>
<code>status</code><br>
<em>
<a href="#planetscale.com/v2.VitessBackupStatus">
VitessBackupStatus
</a>
</em>
</td>
<td>
</td>
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.VitessCluster">VitessCluster
</h3>
<p>
<p>VitessCluster is the top-level interface for configuring a cluster.</p>
<p>Although the VitessCluster controller creates various secondary objects
like VitessCells, all the user-accessible configuration ultimately lives here.
The other objects should be considered read-only representations of subsets of
the dynamic cluster status. For example, you can examine a specific VitessCell
object to get more details on the status of that cell than are summarized in the
VitessCluster status, but any configuration changes should only be made in
the VitessCluster object.</p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>apiVersion</code><br>
string</td>
<td>
<code>
planetscale.com/v2
</code>
</td>
</tr>
<tr>
<td>
<code>kind</code><br>
string
</td>
<td><code>VitessCluster</code></td>
</tr>
<tr>
<td>
<code>metadata</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta">
Kubernetes meta/v1.ObjectMeta
</a>
</em>
</td>
<td>
Refer to the Kubernetes API documentation for the fields of the
<code>metadata</code> field.
</td>
</tr>
<tr>
<td>
<code>spec</code><br>
<em>
<a href="#planetscale.com/v2.VitessClusterSpec">
VitessClusterSpec
</a>
</em>
</td>
<td>
<br/>
<br/>
<table>
<tr>
<td>
<code>images</code><br>
<em>
<a href="#planetscale.com/v2.VitessImages">
VitessImages
</a>
</em>
</td>
<td>
<p>Images specifies the container images (including version tag) to use
in the cluster.
Default: Let the operator choose.</p>
</td>
</tr>
<tr>
<td>
<code>imagePullPolicies</code><br>
<em>
<a href="#planetscale.com/v2.VitessImagePullPolicies">
VitessImagePullPolicies
</a>
</em>
</td>
<td>
<p>ImagePullPolicies specifies the container image pull policies to use for
images defined in the ‘images’ field.</p>
</td>
</tr>
<tr>
<td>
<code>imagePullSecrets</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<p>ImagePullSecrets specifies the image pull secrets to add to all Pods that
use the images defined in the ‘images’ field.</p>
</td>
</tr>
<tr>
<td>
<code>backup</code><br>
<em>
<a href="#planetscale.com/v2.ClusterBackupSpec">
ClusterBackupSpec
</a>
</em>
</td>
<td>
<p>Backup specifies how to take and store Vitess backups.
This is optional but strongly recommended. In addition to disaster
recovery, Vitess currently depends on backups to support provisioning
of a new tablet in a shard with existing data, as an implementation detail.</p>
</td>
</tr>
<tr>
<td>
<code>globalLockserver</code><br>
<em>
<a href="#planetscale.com/v2.LockserverSpec">
LockserverSpec
</a>
</em>
</td>
<td>
<p>GlobalLockserver specifies either a deployed or external lockserver
to be used as the Vitess global topology store.
Default: Deploy an etcd cluster as the global lockserver.</p>
</td>
</tr>
<tr>
<td>
<code>vitessDashboard</code><br>
<em>
<a href="#planetscale.com/v2.VitessDashboardSpec">
VitessDashboardSpec
</a>
</em>
</td>
<td>
<p>Dashboard deploys a set of Vitess Dashboard servers (vtctld) for the Vitess cluster.</p>
</td>
</tr>
<tr>
<td>
<code>vtadmin</code><br>
<em>
<a href="#planetscale.com/v2.VtAdminSpec">
VtAdminSpec
</a>
</em>
</td>
<td>
<p>VtAdmin deploys a set of Vitess Admin servers for the Vitess cluster.</p>
</td>
</tr>
<tr>
<td>
<code>cells</code><br>
<em>
<a href="#planetscale.com/v2.VitessCellTemplate">
[]VitessCellTemplate
</a>
</em>
</td>
<td>
<p>Cells is a list of templates for VitessCells to create for this cluster.</p>
<p>Each VitessCell represents a set of Nodes in a given failure domain,
to which VitessKeyspaces can be deployed. The VitessCell also deploys
cell-local services that any keyspaces deployed there will need.</p>
<p>This field is required, but it may be set to an empty list: [].
Before removing any cell from this list, you should first ensure
that no keyspaces are set to deploy to this cell.</p>
</td>
</tr>
<tr>
<td>
<code>keyspaces</code><br>
<em>
<a href="#planetscale.com/v2.VitessKeyspaceTemplate">
[]VitessKeyspaceTemplate
</a>
</em>
</td>
<td>
<p>Keyspaces defines the logical databases to deploy.</p>
<p>A VitessKeyspace can deploy to multiple VitessCells.</p>
<p>This field is required, but it may be set to an empty list: [].
Before removing any keyspace from this list, you should first ensure
that it is undeployed from all cells by clearing the keyspace’s list
of target cells.</p>
</td>
</tr>
<tr>
<td>
<code>extraVitessFlags</code><br>
<em>
map[string]string
</em>
</td>
<td>
<p>ExtraVitessFlags can optionally be used to pass flags to all Vitess components.
WARNING: Any flags passed here must be flags that can be accepted by vtgate, vtctld, vtorc, and vttablet.
An example use-case would be topo flags.</p>
<p>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”.</p>
</td>
</tr>
<tr>
<td>
<code>topologyReconciliation</code><br>
<em>
<a href="#planetscale.com/v2.TopoReconcileConfig">
TopoReconcileConfig
</a>
</em>
</td>
<td>
<p>TopologyReconciliation can be used to enable or disable registration or pruning of various vitess components to and from topo records.</p>
</td>
</tr>
<tr>
<td>
<code>updateStrategy</code><br>
<em>
<a href="#planetscale.com/v2.VitessClusterUpdateStrategy">
VitessClusterUpdateStrategy
</a>
</em>
</td>
<td>
<p>UpdateStrategy specifies how components in the Vitess cluster will be updated
when a revision is made to the VitessCluster spec.</p>
</td>
</tr>
<tr>
<td>
<code>gatewayService</code><br>
<em>
<a href="#planetscale.com/v2.ServiceOverrides">
ServiceOverrides
</a>
</em>
</td>
<td>
<p>GatewayService can optionally be used to customize the global vtgate Service.
Note that per-cell vtgate Services can be customized within each cell
definition.</p>
</td>
</tr>
<tr>
<td>
<code>tabletService</code><br>
<em>
<a href="#planetscale.com/v2.ServiceOverrides">
ServiceOverrides
</a>
</em>
</td>
<td>
<p>TabletService can optionally be used to customize the global, headless vttablet Service.</p>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<code>status</code><br>
<em>
<a href="#planetscale.com/v2.VitessClusterStatus">
VitessClusterStatus
</a>
</em>
</td>
<td>
</td>
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.AutoscalerSpec">AutoscalerSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.VitessCellGatewaySpec">VitessCellGatewaySpec</a>)
</p>
<p>
<p>AutoscalerSpec defines the vtgate’s pod autoscaling specification.</p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>minReplicas</code><br>
<em>
int32
</em>
</td>
<td>
<em>(Optional)</em>
<p>MinReplicas is the minimum number of instances of vtgate to run in
this cell when autoscaling is enabled.</p>
</td>
</tr>
<tr>
<td>
<code>maxReplicas</code><br>
<em>
int32
</em>
</td>
<td>
<p>MaxReplicas is the maximum number of instances of vtgate to run in
this cell when autoscaling is enabled.</p>
</td>
</tr>
<tr>
<td>
<code>metrics</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#metricspec-v2-autoscaling">
[]Kubernetes autoscaling/v2.MetricSpec
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Metrics is meant to provide a customizable way to configure HPA metrics.
currently the only supported custom metrics is type=Pod.
Use TargetCPUUtilization or TargetMemoryUtilization instead if scaling on these common resource metrics.</p>
</td>
</tr>
<tr>
<td>
<code>behavior</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#horizontalpodautoscalerbehavior-v2-autoscaling">
Kubernetes autoscaling/v2.HorizontalPodAutoscalerBehavior
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Behavior specifies the scaling behavior of the target in both Up and Down directions.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.AzblobBackupLocation">AzblobBackupLocation
</h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.VitessBackupLocation">VitessBackupLocation</a>)
</p>
<p>
<p>AzblobBackupLocation specifies a backup location in Azure Blob Storage.</p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>account</code><br>
<em>
string
</em>
</td>
<td>
<p>Account is the name of the Azure storage account to use.</p>
</td>
</tr>
<tr>
<td>
<code>container</code><br>
<em>
string
</em>
</td>
<td>
<p>Container is the name of the Azure storage account container to use.</p>
</td>
</tr>
<tr>
<td>
<code>keyPrefix</code><br>
<em>
string
</em>
</td>
<td>
<p>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.</p>
</td>
</tr>
<tr>
<td>
<code>authSecret</code><br>
<em>
<a href="#planetscale.com/v2.SecretSource">
SecretSource
</a>
</em>
</td>
<td>
<p>AuthSecret is a reference to the Secret to use for Azure authentication.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.BackupMethod">BackupMethod
(<code>string</code> alias)</p></h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.VitessBackupScheduleTemplate">VitessBackupScheduleTemplate</a>)
</p>
<p>
<p>BackupMethod defines the method used to take scheduled backups.</p>
</p>
<h3 id="planetscale.com/v2.BackupScope">BackupScope
(<code>string</code> alias)</p></h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.VitessBackupScheduleStrategy">VitessBackupScheduleStrategy</a>)
</p>
<p>
<p>BackupScope defines the scope at which a backup strategy operates.</p>
</p>
<h3 id="planetscale.com/v2.CephBackupLocation">CephBackupLocation
</h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.VitessBackupLocation">VitessBackupLocation</a>)
</p>
<p>
<p>CephBackupLocation specifies a backup location in Ceph S3.</p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>authSecret</code><br>
<em>
<a href="#planetscale.com/v2.SecretSource">
SecretSource
</a>
</em>
</td>
<td>
<p>AuthSecret is a reference to the Secret to use for Ceph S3 authentication.
If set, this must point to a file in the format expected for the
<code>https://github.com/vitessio/vitess/blob/master/examples/local/ceph_backup_config.json</code> file.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.ClusterBackupSpec">ClusterBackupSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.VitessClusterSpec">VitessClusterSpec</a>)
</p>
<p>
<p>ClusterBackupSpec configures backups for a cluster.
In addition to disaster recovery, Vitess currently depends on backups to support
provisioning of a new tablet in a shard with existing data, as an implementation detail.</p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>locations</code><br>
<em>
<a href="#planetscale.com/v2.VitessBackupLocation">
[]VitessBackupLocation
</a>
</em>
</td>
<td>
<p>Locations is a list of places where Vitess backup data for the cluster
can be stored. At least one storage location must be specified.
Within each storage location, there are multiple fields for various
location types (gcs, s3, etc.); exactly one such field must be populated.</p>
<p>Multiple storage locations may be desired if, for example, the cluster
spans multiple regions. Each storage location is independent of the others;
backups can only be restored from the same storage location in which they
were originally taken.</p>
</td>
</tr>
<tr>
<td>
<code>engine</code><br>
<em>
<a href="#planetscale.com/v2.VitessBackupEngine">
VitessBackupEngine
</a>
</em>
</td>
<td>
<p>Engine specifies the Vitess backup engine to use, either “builtin” or “xtrabackup”.
Note that if you change this after a Vitess cluster is already deployed,
you must roll the change out to all tablets and then take a new backup
from one tablet in each shard. Otherwise, new tablets trying to restore
will find that the latest backup was created with the wrong engine.
Default: builtin</p>
</td>
</tr>
<tr>
<td>
<code>subcontroller</code><br>
<em>
<a href="#planetscale.com/v2.VitessBackupSubcontrollerSpec">
VitessBackupSubcontrollerSpec
</a>
</em>
</td>
<td>
<p>Subcontroller specifies any parameters needed for launching the VitessBackupStorage subcontroller pod.</p>
</td>
</tr>
<tr>
<td>
<code>schedules</code><br>
<em>
<a href="#planetscale.com/v2.VitessBackupScheduleTemplate">
[]VitessBackupScheduleTemplate
</a>
</em>
</td>
<td>
<p>Schedules defines how often we want to perform a backup and how to perform the backup.
This is a list of VitessBackupScheduleTemplate where the “name” field has to be unique
across all the items of the list.</p>
</td>
</tr>
<tr>
<td>
<code>extraLabels</code><br>
<em>
map[string]string
</em>
</td>
<td>
<em>(Optional)</em>
<p>ExtraLabels can optionally be used to attach custom labels to pods created by backup schedules
and the VitessBackupStorage subcontroller. These labels will be applied to both the backup
schedule job pods and the subcontroller pod.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.ConcurrencyPolicy">ConcurrencyPolicy
(<code>string</code> alias)</p></h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.VitessBackupScheduleTemplate">VitessBackupScheduleTemplate</a>)
</p>
<p>
<p>ConcurrencyPolicy describes how the concurrency of new jobs created by VitessBackupSchedule
is handled, the default is set to AllowConcurrent.</p>
</p>
<h3 id="planetscale.com/v2.EtcdLockserverSpec">EtcdLockserverSpec
</h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.EtcdLockserver">EtcdLockserver</a>)
</p>
<p>
<p>EtcdLockserverSpec defines the desired state of an EtcdLockserver.</p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>EtcdLockserverTemplate</code><br>
<em>
<a href="#planetscale.com/v2.EtcdLockserverTemplate">
EtcdLockserverTemplate
</a>
</em>
</td>
<td>
<p>
(Members of <code>EtcdLockserverTemplate</code> are embedded into this type.)
</p>
<p>EtcdLockserverTemplate contains the user-specified parts of EtcdLockserverSpec.
These are the parts that are configurable inside VitessCluster.
The rest of the fields below are filled in by the parent controller.</p>
</td>
</tr>
<tr>
<td>
<code>zone</code><br>
<em>
string
</em>
</td>
<td>
<p>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.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.EtcdLockserverStatus">EtcdLockserverStatus
</h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.EtcdLockserver">EtcdLockserver</a>,
<a href="#planetscale.com/v2.LockserverStatus">LockserverStatus</a>)
</p>
<p>
<p>EtcdLockserverStatus defines the observed state of an EtcdLockserver.</p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>observedGeneration</code><br>
<em>
int64
</em>
</td>
<td>
<p>The generation observed by the controller.</p>
</td>
</tr>
<tr>
<td>
<code>available</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#conditionstatus-v1-core">
Kubernetes core/v1.ConditionStatus
</a>
</em>
</td>
<td>
<p>Available is a condition that indicates whether the cluster is able to serve queries.</p>
</td>
</tr>
<tr>
<td>
<code>clientServiceName</code><br>
<em>
string
</em>
</td>
<td>
<p>ClientServiceName is the name of the Service for etcd client connections.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.EtcdLockserverTemplate">EtcdLockserverTemplate
</h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.EtcdLockserverSpec">EtcdLockserverSpec</a>,
<a href="#planetscale.com/v2.LockserverSpec">LockserverSpec</a>)
</p>
<p>
<p>EtcdLockserverTemplate defines the user-configurable settings for an etcd
cluster that we deploy (not external), to serve as either a local or global
lockserver.</p>
</p>
<table class="table table-striped">
<thead class="thead-dark">
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>image</code><br>
<em>
string
</em>
</td>
<td>
<p>Image is the etcd server image (including version tag) to deploy.
Default: Let the operator choose.</p>
</td>
</tr>
<tr>
<td>
<code>imagePullPolicy</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#pullpolicy-v1-core">
Kubernetes core/v1.PullPolicy
</a>
</em>
</td>
<td>
<p>ImagePullPolicy specifies if/when to pull a container image.</p>
</td>
</tr>
<tr>
<td>
<code>imagePullSecrets</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
</td>
<td>
<p>ImagePullSecrets specifies the container image pull secrets to add to all
etcd Pods.</p>
</td>
</tr>
<tr>
<td>
<code>resources</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core">
Kubernetes core/v1.ResourceRequirements
</a>
</em>
</td>
<td>
<p>Resources specify the compute resources to allocate for each etcd member.
Default: Let the operator choose.</p>
</td>
</tr>
<tr>
<td>
<code>dataVolumeClaimTemplate</code><br>
<em>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#persistentvolumeclaimspec-v1-core">
Kubernetes core/v1.PersistentVolumeClaimSpec
</a>