-
Notifications
You must be signed in to change notification settings - Fork 458
/
bootstrap.go
1251 lines (1210 loc) · 55 KB
/
bootstrap.go
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 (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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.
package etcd
import (
"context"
"fmt"
"strconv"
"time"
v1beta1constants "github.com/gardener/gardener/pkg/apis/core/v1beta1/constants"
"github.com/gardener/gardener/pkg/client/kubernetes"
"github.com/gardener/gardener/pkg/gardenlet/apis/config"
"github.com/gardener/gardener/pkg/operation/botanist/component"
gutil "github.com/gardener/gardener/pkg/utils/gardener"
"github.com/gardener/gardener/pkg/utils/imagevector"
kutil "github.com/gardener/gardener/pkg/utils/kubernetes"
"github.com/gardener/gardener/pkg/utils/managedresources"
druidv1alpha1 "github.com/gardener/etcd-druid/api/v1alpha1"
"github.com/gardener/gardener/pkg/resourcemanager/controller/garbagecollector/references"
appsv1 "k8s.io/api/apps/v1"
autoscalingv1 "k8s.io/api/autoscaling/v1"
batchv1 "k8s.io/api/batch/v1"
batchv1beta1 "k8s.io/api/batch/v1beta1"
coordinationv1 "k8s.io/api/coordination/v1"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
autoscalingv1beta2 "k8s.io/autoscaler/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1beta2"
"k8s.io/utils/pointer"
"sigs.k8s.io/controller-runtime/pkg/client"
)
const (
// Druid is a constant for the name of the etcd-druid.
Druid = "etcd-druid"
druidRBACName = "gardener.cloud:system:" + Druid
druidServiceAccountName = Druid
druidVPAName = Druid + "-vpa"
druidConfigMapImageVectorOverwriteNamePrefix = Druid + "-imagevector-overwrite"
druidDeploymentName = Druid
managedResourceControlName = Druid
druidConfigMapImageVectorOverwriteDataKey = "images_overwrite.yaml"
druidDeploymentVolumeMountPathImageVectorOverwrite = "/charts_overwrite"
druidDeploymentVolumeNameImageVectorOverwrite = "imagevector-overwrite"
)
// NewBootstrapper creates a new instance of DeployWaiter for the etcd bootstrapper.
func NewBootstrapper(c client.Client, namespace string, config *config.GardenletConfiguration, image string, imageVectorOverwrite *string) component.DeployWaiter {
return &bootstrapper{
client: c,
namespace: namespace,
config: config,
image: image,
imageVectorOverwrite: imageVectorOverwrite,
}
}
type bootstrapper struct {
client client.Client
namespace string
config *config.GardenletConfiguration
image string
imageVectorOverwrite *string
}
func (b *bootstrapper) Deploy(ctx context.Context) error {
var (
registry = managedresources.NewRegistry(kubernetes.SeedScheme, kubernetes.SeedCodec, kubernetes.SeedSerializer)
labels = func() map[string]string { return map[string]string{v1beta1constants.GardenRole: Druid} }
serviceAccount = &corev1.ServiceAccount{
ObjectMeta: metav1.ObjectMeta{
Name: druidServiceAccountName,
Namespace: b.namespace,
Labels: labels(),
},
AutomountServiceAccountToken: pointer.Bool(false),
}
clusterRole = &rbacv1.ClusterRole{
ObjectMeta: metav1.ObjectMeta{
Name: druidRBACName,
Labels: labels(),
},
Rules: []rbacv1.PolicyRule{
{
APIGroups: []string{corev1.GroupName},
Resources: []string{"pods"},
Verbs: []string{"list", "watch", "delete"},
},
{
APIGroups: []string{corev1.GroupName},
Resources: []string{"secrets", "endpoints"},
Verbs: []string{"get", "list", "patch", "update", "watch"},
},
{
APIGroups: []string{corev1.GroupName},
Resources: []string{"events"},
Verbs: []string{"create", "get", "list", "watch", "patch", "update"},
},
{
APIGroups: []string{corev1.GroupName},
Resources: []string{"serviceaccounts"},
Verbs: []string{"get", "list", "watch", "create", "update", "patch", "delete"},
},
{
APIGroups: []string{rbacv1.GroupName},
Resources: []string{"roles", "rolebindings"},
Verbs: []string{"get", "list", "watch", "create", "update", "patch", "delete"},
},
{
APIGroups: []string{corev1.GroupName, appsv1.GroupName},
Resources: []string{"services", "configmaps", "statefulsets"},
Verbs: []string{"get", "list", "patch", "update", "watch", "create", "delete"},
},
{
APIGroups: []string{batchv1.GroupName},
Resources: []string{"jobs"},
Verbs: []string{"get", "list", "watch", "create", "update", "patch", "delete"},
},
{
APIGroups: []string{batchv1beta1.GroupName},
Resources: []string{"cronjobs"},
Verbs: []string{"get", "list", "watch", "delete"},
},
{
APIGroups: []string{druidv1alpha1.GroupVersion.Group},
Resources: []string{"etcds", "etcdcopybackupstasks"},
Verbs: []string{"get", "list", "watch", "create", "update", "patch", "delete"},
},
{
APIGroups: []string{druidv1alpha1.GroupVersion.Group},
Resources: []string{"etcds/status", "etcds/finalizers", "etcdcopybackupstasks/status", "etcdcopybackupstasks/finalizers"},
Verbs: []string{"get", "update", "patch", "create"},
},
{
APIGroups: []string{coordinationv1.GroupName},
Resources: []string{"leases"},
Verbs: []string{"get", "list", "watch", "create", "update", "patch", "delete"},
},
{
APIGroups: []string{corev1.GroupName},
Resources: []string{"persistentvolumeclaims"},
Verbs: []string{"get", "list", "watch"},
},
},
}
clusterRoleBinding = &rbacv1.ClusterRoleBinding{
ObjectMeta: metav1.ObjectMeta{
Name: druidRBACName,
Labels: labels(),
},
RoleRef: rbacv1.RoleRef{
APIGroup: rbacv1.GroupName,
Kind: "ClusterRole",
Name: druidRBACName,
},
Subjects: []rbacv1.Subject{
{
Kind: rbacv1.ServiceAccountKind,
Name: druidServiceAccountName,
Namespace: b.namespace,
},
},
}
configMapImageVectorOverwrite = &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: druidConfigMapImageVectorOverwriteNamePrefix,
Namespace: b.namespace,
Labels: labels(),
},
}
vpaUpdateMode = autoscalingv1beta2.UpdateModeAuto
vpa = &autoscalingv1beta2.VerticalPodAutoscaler{
ObjectMeta: metav1.ObjectMeta{
Name: druidVPAName,
Namespace: b.namespace,
Labels: labels(),
},
Spec: autoscalingv1beta2.VerticalPodAutoscalerSpec{
TargetRef: &autoscalingv1.CrossVersionObjectReference{
APIVersion: appsv1.SchemeGroupVersion.String(),
Kind: "Deployment",
Name: druidDeploymentName,
},
UpdatePolicy: &autoscalingv1beta2.PodUpdatePolicy{
UpdateMode: &vpaUpdateMode,
},
ResourcePolicy: &autoscalingv1beta2.PodResourcePolicy{
ContainerPolicies: []autoscalingv1beta2.ContainerResourcePolicy{{
ContainerName: autoscalingv1beta2.DefaultContainerResourcePolicy,
MinAllowed: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("50m"),
corev1.ResourceMemory: resource.MustParse("100M"),
},
}},
},
},
}
deployment = &appsv1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name: druidDeploymentName,
Namespace: b.namespace,
Labels: labels(),
},
Spec: appsv1.DeploymentSpec{
Replicas: pointer.Int32(1),
RevisionHistoryLimit: pointer.Int32(1),
Selector: &metav1.LabelSelector{
MatchLabels: labels(),
},
Template: corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{
// TODO(rfranzke): Remove in a future release.
"security.gardener.cloud/trigger": "rollout",
},
Labels: labels(),
},
Spec: corev1.PodSpec{
ServiceAccountName: druidServiceAccountName,
Containers: []corev1.Container{
{
Name: Druid,
Image: b.image,
ImagePullPolicy: corev1.PullIfNotPresent,
Command: getDruidDeployCommands(b.config),
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("50m"),
corev1.ResourceMemory: resource.MustParse("128Mi"),
},
Limits: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("300m"),
corev1.ResourceMemory: resource.MustParse("512Mi"),
},
},
Ports: []corev1.ContainerPort{{
ContainerPort: 9569,
}},
},
},
},
},
},
}
resourcesToAdd = []client.Object{
serviceAccount,
clusterRole,
clusterRoleBinding,
vpa,
}
)
if b.imageVectorOverwrite != nil {
configMapImageVectorOverwrite.Data = map[string]string{druidConfigMapImageVectorOverwriteDataKey: *b.imageVectorOverwrite}
utilruntime.Must(kutil.MakeUnique(configMapImageVectorOverwrite))
resourcesToAdd = append(resourcesToAdd, configMapImageVectorOverwrite)
deployment.Spec.Template.Spec.Volumes = append(deployment.Spec.Template.Spec.Volumes, corev1.Volume{
Name: druidDeploymentVolumeNameImageVectorOverwrite,
VolumeSource: corev1.VolumeSource{
ConfigMap: &corev1.ConfigMapVolumeSource{
LocalObjectReference: corev1.LocalObjectReference{
Name: configMapImageVectorOverwrite.Name,
},
},
},
})
deployment.Spec.Template.Spec.Containers[0].VolumeMounts = append(deployment.Spec.Template.Spec.Containers[0].VolumeMounts, corev1.VolumeMount{
Name: druidDeploymentVolumeNameImageVectorOverwrite,
MountPath: druidDeploymentVolumeMountPathImageVectorOverwrite,
ReadOnly: true,
})
deployment.Spec.Template.Spec.Containers[0].Env = append(deployment.Spec.Template.Spec.Containers[0].Env, corev1.EnvVar{
Name: imagevector.OverrideEnv,
Value: druidDeploymentVolumeMountPathImageVectorOverwrite + "/" + druidConfigMapImageVectorOverwriteDataKey,
})
utilruntime.Must(references.InjectAnnotations(deployment))
}
resources, err := registry.AddAllAndSerialize(append(resourcesToAdd, deployment)...)
if err != nil {
return err
}
resources["crd.yaml"] = []byte(CrdYAML)
resources["crdEtcdCopyBackupsTask.yaml"] = []byte(etcdCopyBackupsTaskCRDYaml)
return managedresources.CreateForSeed(ctx, b.client, b.namespace, managedResourceControlName, false, resources)
}
func getDruidDeployCommands(gardenletConf *config.GardenletConfiguration) []string {
command := []string{"" + "/bin/etcd-druid"}
command = append(command, "--enable-leader-election=true")
command = append(command, "--ignore-operation-annotation=false")
if gardenletConf == nil {
// TODO(abdasgupta): Following line to add 50 workers is only for backward compatibility. Please, remove.
command = append(command, "--workers=50")
return command
}
config := gardenletConf.ETCDConfig
if config == nil {
// TODO(abdasgupta): Following line to add 50 workers is only for backward compatibility. Please, remove.
command = append(command, "--workers=50")
return command
}
if config.ETCDController != nil {
command = append(command, "--workers="+strconv.FormatInt(pointer.Int64Deref(config.ETCDController.Workers, 50), 10))
}
if config.CustodianController != nil {
command = append(command, "--custodian-workers="+strconv.FormatInt(pointer.Int64Deref(config.CustodianController.Workers, 10), 10))
}
if config.BackupCompactionController != nil {
command = append(command, "--compaction-workers="+strconv.FormatInt(pointer.Int64Deref(config.BackupCompactionController.Workers, 3), 10))
command = append(command, "--enable-backup-compaction="+strconv.FormatBool(pointer.BoolDeref(config.BackupCompactionController.EnableBackupCompaction, false)))
command = append(command, "--etcd-events-threshold="+strconv.FormatInt(pointer.Int64Deref(config.BackupCompactionController.EventsThreshold, 1000000), 10))
if config.BackupCompactionController.ActiveDeadlineDuration != nil {
command = append(command, "--active-deadline-duration="+config.BackupCompactionController.ActiveDeadlineDuration.Duration.String())
}
}
return command
}
func (b *bootstrapper) Destroy(ctx context.Context) error {
etcdList := &druidv1alpha1.EtcdList{}
// Need to check for both error types. The DynamicRestMapper can hold a stale cache returning a path to a non-existing api-resource leading to a NotFound error.
if err := b.client.List(ctx, etcdList); err != nil && !meta.IsNoMatchError(err) && !apierrors.IsNotFound(err) {
return err
}
if len(etcdList.Items) > 0 {
return fmt.Errorf("cannot debootstrap etcd-druid because there are still druidv1alpha1.Etcd resources left in the cluster")
}
if err := gutil.ConfirmDeletion(ctx, b.client, &apiextensionsv1.CustomResourceDefinition{ObjectMeta: metav1.ObjectMeta{Name: crdName}}); client.IgnoreNotFound(err) != nil {
return err
}
etcdCopyBackupsTaskList := &druidv1alpha1.EtcdCopyBackupsTaskList{}
if err := b.client.List(ctx, etcdCopyBackupsTaskList); err != nil && !meta.IsNoMatchError(err) && !apierrors.IsNotFound(err) {
return err
}
if len(etcdCopyBackupsTaskList.Items) > 0 {
return fmt.Errorf("cannot debootstrap etcd-druid because there are still druidv1alpha1.EtcdCopyBackupsTask resources left in the cluster")
}
if err := gutil.ConfirmDeletion(ctx, b.client, &apiextensionsv1.CustomResourceDefinition{ObjectMeta: metav1.ObjectMeta{Name: etcdCopyBackupsTaskCRDName}}); client.IgnoreNotFound(err) != nil {
return err
}
return managedresources.DeleteForSeed(ctx, b.client, b.namespace, managedResourceControlName)
}
// TimeoutWaitForManagedResource is the timeout used while waiting for the ManagedResources to become healthy
// or deleted.
var TimeoutWaitForManagedResource = 2 * time.Minute
func (b *bootstrapper) Wait(ctx context.Context) error {
timeoutCtx, cancel := context.WithTimeout(ctx, TimeoutWaitForManagedResource)
defer cancel()
return managedresources.WaitUntilHealthy(timeoutCtx, b.client, b.namespace, managedResourceControlName)
}
func (b *bootstrapper) WaitCleanup(ctx context.Context) error {
timeoutCtx, cancel := context.WithTimeout(ctx, TimeoutWaitForManagedResource)
defer cancel()
return managedresources.WaitUntilDeleted(timeoutCtx, b.client, b.namespace, managedResourceControlName)
}
const (
crdName = "etcds.druid.gardener.cloud"
// CrdYAML is yaml representation of the custom resource of the ETCD.
CrdYAML = `apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: ` + crdName + `
annotations:
controller-gen.kubebuilder.io/version: v0.4.1
labels:
` + gutil.DeletionProtected + `: "true"
spec:
group: druid.gardener.cloud
names:
kind: Etcd
listKind: EtcdList
plural: etcds
singular: etcd
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.ready
name: Ready
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
description: Etcd is the Schema for the etcds API
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: EtcdSpec defines the desired state of Etcd
properties:
annotations:
additionalProperties:
type: string
type: object
backup:
description: BackupSpec defines parametes associated with the full
and delta snapshots of etcd
properties:
compactionResources:
description: 'CompactionResources defines the compute Resources required by compaction job. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
compression:
description: SnapshotCompression defines the specification for
compression of Snapshots.
properties:
enabled:
type: boolean
policy:
description: CompressionPolicy defines the type of policy
for compression of snapshots.
enum:
- gzip
- lzw
- zlib
type: string
type: object
deltaSnapshotMemoryLimit:
anyOf:
- type: integer
- type: string
description: DeltaSnapshotMemoryLimit defines the memory limit
after which delta snapshots will be taken
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
deltaSnapshotPeriod:
description: DeltaSnapshotPeriod defines the period after which
delta snapshots will be taken
type: string
enableProfiling:
description: EnableProfiling defines if profiling should be enabled
for the etcd-backup-restore-sidecar
type: boolean
etcdSnapshotTimeout:
description: EtcdSnapshotTimeout defines the timeout duration
for etcd FullSnapshot operation
type: string
fullSnapshotSchedule:
description: FullSnapshotSchedule defines the cron standard schedule
for full snapshots.
type: string
enableProfiling:
description: EnableProfiling defines if profiling should be enabled for the etcd-backup-restore-sidecar
type: boolean
etcdSnapshotTimeout:
description: EtcdSnapshotTimeout defines the timeout duration for etcd FullSnapshot operation
type: string
garbageCollectionPeriod:
description: GarbageCollectionPeriod defines the period for garbage
collecting old backups
type: string
garbageCollectionPolicy:
description: GarbageCollectionPolicy defines the policy for garbage
collecting old backups
enum:
- Exponential
- LimitBased
type: string
image:
description: Image defines the etcd container image and tag
type: string
ownerCheck:
description: OwnerCheck defines parameters related to checking if the cluster owner, as specified in the owner DNS record, is the expected one.
properties:
dnsCacheTTL:
description: DNSCacheTTL is the DNS cache TTL for owner checks.
type: string
id:
description: ID is the owner id value that is expected to be found in the owner DNS record.
type: string
interval:
description: Interval is the time interval between owner checks.
type: string
name:
description: Name is the domain name of the owner DNS record.
type: string
timeout:
description: Timeout is the timeout for owner checks.
type: string
required:
- id
- name
type: object
port:
description: Port define the port on which etcd-backup-restore
server will exposed.
format: int32
type: integer
resources:
description: 'Resources defines the compute Resources required
by backup-restore container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount of compute
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Requests describes the minimum amount of compute
resources required. If Requests is omitted for a container,
it defaults to Limits if that is explicitly specified, otherwise
to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
store:
description: Store defines the specification of object store provider
for storing backups.
properties:
container:
description: Container is the name of the container the backup is stored at.
type: string
prefix:
description: Prefix is the prefix used for the store.
type: string
provider:
description: Provider is the name of the backup provider.
type: string
secretRef:
description: SecretRef is the reference to the secret which used to connect to the backup store.
properties:
name:
description: Name is unique within a namespace to reference
a secret resource.
type: string
namespace:
description: Namespace defines the space within which
the secret name must be unique.
type: string
type: object
required:
- prefix
type: object
tls:
description: TLSConfig hold the TLS configuration details.
properties:
clientTLSSecretRef:
description: SecretReference represents a Secret Reference.
It has enough information to retrieve secret in any namespace
properties:
name:
description: Name is unique within a namespace to reference
a secret resource.
type: string
namespace:
description: Namespace defines the space within which
the secret name must be unique.
type: string
type: object
serverTLSSecretRef:
description: SecretReference represents a Secret Reference.
It has enough information to retrieve secret in any namespace
properties:
name:
description: Name is unique within a namespace to reference
a secret resource.
type: string
namespace:
description: Namespace defines the space within which
the secret name must be unique.
type: string
type: object
tlsCASecretRef:
description: SecretReference represents a Secret Reference.
It has enough information to retrieve secret in any namespace
properties:
name:
description: Name is unique within a namespace to reference
a secret resource.
type: string
namespace:
description: Namespace defines the space within which
the secret name must be unique.
type: string
type: object
required:
- clientTLSSecretRef
- serverTLSSecretRef
- tlsCASecretRef
type: object
type: object
etcd:
description: EtcdConfig defines parameters associated etcd deployed
properties:
authSecretRef:
description: SecretReference represents a Secret Reference. It
has enough information to retrieve secret in any namespace
properties:
name:
description: Name is unique within a namespace to reference
a secret resource.
type: string
namespace:
description: Namespace defines the space within which the
secret name must be unique.
type: string
type: object
clientPort:
format: int32
type: integer
etcdDefragTimeout:
description: EtcdDefragTimeout defines the timeout duration for etcd defrag call
type: string
image:
description: Image defines the etcd container image and tag
type: string
metrics:
description: Metrics defines the level of detail for exported
metrics of etcd, specify 'extensive' to include histogram metrics.
enum:
- basic
- extensive
type: string
quota:
anyOf:
- type: integer
- type: string
description: Quota defines the etcd DB quota.
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resources:
description: 'Resources defines the compute Resources required
by etcd container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount of compute
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Requests describes the minimum amount of compute
resources required. If Requests is omitted for a container,
it defaults to Limits if that is explicitly specified, otherwise
to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
serverPort:
format: int32
type: integer
tls:
description: TLSConfig hold the TLS configuration details.
properties:
clientTLSSecretRef:
description: SecretReference represents a Secret Reference.
It has enough information to retrieve secret in any namespace
properties:
name:
description: Name is unique within a namespace to reference
a secret resource.
type: string
namespace:
description: Namespace defines the space within which
the secret name must be unique.
type: string
type: object
serverTLSSecretRef:
description: SecretReference represents a Secret Reference.
It has enough information to retrieve secret in any namespace
properties:
name:
description: Name is unique within a namespace to reference
a secret resource.
type: string
namespace:
description: Namespace defines the space within which
the secret name must be unique.
type: string
type: object
tlsCASecretRef:
description: SecretReference represents a Secret Reference.
It has enough information to retrieve secret in any namespace
properties:
name:
description: Name is unique within a namespace to reference
a secret resource.
type: string
namespace:
description: Namespace defines the space within which
the secret name must be unique.
type: string
type: object
required:
- clientTLSSecretRef
- serverTLSSecretRef
- tlsCASecretRef
type: object
type: object
labels:
additionalProperties:
type: string
type: object
priorityClassName:
description: PriorityClassName is the name of a priority class that
shall be used for the etcd pods.
type: string
replicas:
type: integer
selector:
description: 'selector is a label query over pods that should match
the replica count. It must match the pod template''s labels. More
info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors'
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: A label selector requirement is a selector that
contains values, a key, and an operator that relates the key
and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: operator represents a key's relationship to
a set of values. Valid operators are In, NotIn, Exists
and DoesNotExist.
type: string
values:
description: values is an array of string values. If the
operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values
array must be empty. This array is replaced during a strategic
merge patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: matchLabels is a map of {key,value} pairs. A single
{key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator
is "In", and the values array contains only "value". The requirements
are ANDed.
type: object
type: object
sharedConfig:
description: SharedConfig defines parameters shared and used by Etcd
as well as backup-restore sidecar.
properties:
autoCompactionMode:
description: AutoCompactionMode defines the auto-compaction-mode:'periodic'
mode or 'revision' mode for etcd and embedded-Etcd of backup-restore
sidecar.
enum:
- periodic
- revision
type: string
autoCompactionRetention:
description: AutoCompactionRetention defines the auto-compaction-retention
length for etcd as well as for embedded-Etcd of backup-restore
sidecar.
type: string
type: object
storageCapacity:
anyOf:
- type: integer
- type: string
description: StorageCapacity defines the size of persistent volume.
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
storageClass:
description: 'StorageClass defines the name of the StorageClass required
by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeClaimTemplate:
description: VolumeClaimTemplate defines the volume claim template
to be created
type: string
required:
- backup
- etcd
- labels
- replicas
- selector
type: object
status:
description: EtcdStatus defines the observed state of Etcd.
properties:
clusterSize:
description: Cluster size is the size of the etcd cluster.
format: int32
type: integer
conditions:
description: Conditions represents the latest available observations of an etcd's current state.
items:
description: Condition holds the information about the state of
a resource.
properties:
lastTransitionTime:
description: Last time the condition transitioned from one status
to another.
format: date-time
type: string
lastUpdateTime:
description: Last time the condition was updated.
format: date-time
type: string
message:
description: A human readable message indicating details about
the transition.
type: string
reason:
description: The reason for the condition's last transition.
type: string
status:
description: Status of the condition, one of True, False, Unknown.
type: string
type:
description: Type of the Etcd condition.
type: string
required:
- lastTransitionTime
- lastUpdateTime
- message
- reason
- status
- type
type: object
type: array
currentReplicas:
description: CurrentReplicas is the current replica count for the etcd cluster.
format: int32
type: integer
etcd:
description: CrossVersionObjectReference contains enough information
to let you identify the referred resource.
properties:
apiVersion:
description: API version of the referent
type: string
kind:
description: Kind of the referent
type: string
name:
description: Name of the referent
type: string
type: object
labelSelector:
description: LabelSelector is a label query over pods that should match the replica count. It must match the pod template's labels.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: A label selector requirement is a selector that
contains values, a key, and an operator that relates the key
and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: operator represents a key's relationship to
a set of values. Valid operators are In, NotIn, Exists
and DoesNotExist.
type: string
values:
description: values is an array of string values. If the
operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values
array must be empty. This array is replaced during a strategic
merge patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: matchLabels is a map of {key,value} pairs. A single
{key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator
is "In", and the values array contains only "value". The requirements
are ANDed.
type: object
type: object
lastError:
description: LastError represents the last occurred error.
type: string
members:
description: Members represents the members of the etcd cluster
items:
description: EtcdMemberStatus holds information about a etcd cluster membership.
properties:
id:
description: ID is the ID of the etcd member.
type: string