-
Notifications
You must be signed in to change notification settings - Fork 567
/
assets.go
1507 lines (1422 loc) · 45.8 KB
/
assets.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
package assets
import (
"fmt"
"io/ioutil"
"path"
"path/filepath"
"strconv"
"strings"
"github.com/pachyderm/pachyderm/src/client"
"github.com/pachyderm/pachyderm/src/client/pkg/grpcutil"
auth "github.com/pachyderm/pachyderm/src/server/auth/server"
pfs "github.com/pachyderm/pachyderm/src/server/pfs/server"
"github.com/pachyderm/pachyderm/src/server/pps/server/githook"
apps "k8s.io/api/apps/v1beta1"
"k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/intstr"
)
var (
suite = "pachyderm"
pachdImage = "pachyderm/pachd"
// Using our own etcd image for now because there's a fix we need
// that hasn't been released, and which has been manually applied
// to the official v3.2.7 release.
etcdImage = "quay.io/coreos/etcd:v3.3.5"
grpcProxyImage = "pachyderm/grpc-proxy:0.4.2"
dashName = "dash"
workerImage = "pachyderm/worker"
pauseImage = "gcr.io/google_containers/pause-amd64:3.0"
dashImage = "pachyderm/dash"
// ServiceAccountName is the name of Pachyderm's service account.
// It's public because it's needed by pps.APIServer to create the RCs for
// workers.
ServiceAccountName = "pachyderm"
etcdHeadlessServiceName = "etcd-headless"
etcdName = "etcd"
etcdVolumeName = "etcd-volume"
etcdVolumeClaimName = "etcd-storage"
// The storage class name to use when creating a new StorageClass for etcd.
defaultEtcdStorageClassName = "etcd-storage-class"
grpcProxyName = "grpc-proxy"
pachdName = "pachd"
// PrometheusPort hosts the prometheus stats for scraping
PrometheusPort = 9091
// Role & binding names, used for Roles or ClusterRoles and their associated
// bindings.
roleName = "pachyderm"
roleBindingName = "pachyderm"
// Policy rules to use for Pachyderm's Role or ClusterRole.
rolePolicyRules = []rbacv1.PolicyRule{{
APIGroups: []string{""},
Verbs: []string{"get", "list", "watch"},
Resources: []string{"nodes", "pods", "pods/log", "endpoints"},
}, {
APIGroups: []string{""},
Verbs: []string{"get", "list", "watch", "create", "update", "delete"},
Resources: []string{"replicationcontrollers", "services"},
}, {
APIGroups: []string{""},
Verbs: []string{"get", "list", "watch", "create", "update", "delete"},
Resources: []string{"secrets"},
ResourceNames: []string{client.StorageSecretName},
}}
// The name of the local volume (mounted kubernetes secret) where pachd
// should read a TLS cert and private key for authenticating with clients
tlsVolumeName = "pachd-tls-cert"
// The name of the kubernetes secret mount in the TLS volume (see
// tlsVolumeName)
tlsSecretName = "pachd-tls-cert"
)
type backend int
const (
localBackend backend = iota
amazonBackend
googleBackend
microsoftBackend
minioBackend
s3CustomArgs = 6
)
// TLSOpts indicates the cert and key file that Pachd should use to
// authenticate with clients
type TLSOpts struct {
ServerCert string
ServerKey string
}
// AssetOpts are options that are applicable to all the asset types.
type AssetOpts struct {
PachdShards uint64
Version string
LogLevel string
Metrics bool
Dynamic bool
EtcdNodes int
EtcdVolume string
DashOnly bool
NoDash bool
DashImage string
Registry string
EtcdPrefix string
// NoGuaranteed will not generate assets that have both resource limits and
// resource requests set which causes kubernetes to give the pods
// guaranteed QoS. Guaranteed QoS generally leads to more stable clusters
// but on smaller test clusters such as those run on minikube it doesn't
// help much and may cause more instability than it prevents.
NoGuaranteed bool
// DisableAuthentication stops Pachyderm's authentication service
// from talking to GitHub, for testing. Instead users can authenticate
// simply by providing a username.
DisableAuthentication bool
// BlockCacheSize is the amount of memory each PachD node allocates towards
// its cache of PFS blocks. If empty, assets.go will choose a default size.
BlockCacheSize string
// PachdCPURequest is the amount of CPU we request for each pachd node. If
// empty, assets.go will choose a default size.
PachdCPURequest string
// PachdNonCacheMemRequest is the amount of memory we request for each
// pachd node in addition to BlockCacheSize. If empty, assets.go will choose
// a default size.
PachdNonCacheMemRequest string
// EtcdCPURequest is the amount of CPU (in cores) we request for each etcd
// node. If empty, assets.go will choose a default size.
EtcdCPURequest string
// EtcdMemRequest is the amount of memory we request for each etcd node. If
// empty, assets.go will choose a default size.
EtcdMemRequest string
// EtcdStorageClassName is the name of an existing StorageClass to use when
// creating a StatefulSet for dynamic etcd storage. If unset, a new
// StorageClass will be created for the StatefulSet.
EtcdStorageClassName string
// IAM role that the Pachyderm deployment should assume when talking to AWS
// services (if using kube2iam + metadata service + IAM role to delegate
// permissions to pachd via its instance).
// This is in AssetOpts rather than AmazonCreds because it must be passed
// as an annotation on the pachd pod rather than as a k8s secret
IAMRole string
// ImagePullSecret specifies an image pull secret that gets attached to the
// various deployments so that their images can be pulled from a private
// registry.
ImagePullSecret string
// NoRBAC, if true, will disable creation of RBAC assets.
NoRBAC bool
// LocalRoles, if true, uses Role and RoleBinding instead of ClusterRole and
// ClusterRoleBinding.
LocalRoles bool
// Namespace is the kubernetes namespace to deploy to.
Namespace string
// NoExposeDockerSocket if true prevents pipelines from accessing the docker socket.
NoExposeDockerSocket bool
// ExposeObjectAPI, if set, causes pachd to serve Object/Block API requests on
// its public port. This should generally be false in production (it breaks
// auth) but is needed by tests
ExposeObjectAPI bool
// If set, the files indictated by 'TLS.ServerCert' and 'TLS.ServerKey' are
// placed into a Kubernetes secret and used by pachd nodes to authenticate
// during TLS
TLS *TLSOpts
}
// Encoder is the interface for writing out assets. This is assumed to wrap an output writer.
type Encoder interface {
// Encodes the given struct to the wrapped output stream. This also will write out a separator
// value, suitable for differentiating multiple objects in the stream.
Encode(interface{}) (err error)
}
// replicas lets us create a pointer to a non-zero int32 in-line. This is
// helpful because the Replicas field of many specs expectes an *int32
func replicas(r int32) *int32 {
return &r
}
// fillDefaultResourceRequests sets any of:
// opts.BlockCacheSize
// opts.PachdNonCacheMemRequest
// opts.PachdCPURequest
// opts.EtcdCPURequest
// opts.EtcdMemRequest
// that are unset in 'opts' to the appropriate default ('persistentDiskBackend'
// just used to determine if this is a local deployment, and if so, make the
// resource requests smaller)
func fillDefaultResourceRequests(opts *AssetOpts, persistentDiskBackend backend) {
if persistentDiskBackend == localBackend {
// For local deployments, we set the resource requirements and cache sizes
// low so that pachyderm clusters will fit inside e.g. minikube or travis
if opts.BlockCacheSize == "" {
opts.BlockCacheSize = "256M"
}
if opts.PachdNonCacheMemRequest == "" {
opts.PachdNonCacheMemRequest = "256M"
}
if opts.PachdCPURequest == "" {
opts.PachdCPURequest = "0.25"
}
if opts.EtcdMemRequest == "" {
opts.EtcdMemRequest = "256M"
}
if opts.EtcdCPURequest == "" {
opts.EtcdCPURequest = "0.25"
}
} else {
// For non-local deployments, we set the resource requirements and cache
// sizes higher, so that the cluster is stable and performant
if opts.BlockCacheSize == "" {
opts.BlockCacheSize = "1G"
}
if opts.PachdNonCacheMemRequest == "" {
opts.PachdNonCacheMemRequest = "2G"
}
if opts.PachdCPURequest == "" {
opts.PachdCPURequest = "1"
}
if opts.EtcdMemRequest == "" {
opts.EtcdMemRequest = "2G"
}
if opts.EtcdCPURequest == "" {
opts.EtcdCPURequest = "1"
}
}
}
// ServiceAccount returns a kubernetes service account for use with Pachyderm.
func ServiceAccount(opts *AssetOpts) *v1.ServiceAccount {
return &v1.ServiceAccount{
TypeMeta: metav1.TypeMeta{
Kind: "ServiceAccount",
APIVersion: "v1",
},
ObjectMeta: objectMeta(ServiceAccountName, labels(""), nil, opts.Namespace),
}
}
// ClusterRole returns a ClusterRole that should be bound to the Pachyderm service account.
func ClusterRole(opts *AssetOpts) *rbacv1.ClusterRole {
return &rbacv1.ClusterRole{
TypeMeta: metav1.TypeMeta{
Kind: "ClusterRole",
APIVersion: "rbac.authorization.k8s.io/v1",
},
ObjectMeta: objectMeta(roleName, labels(""), nil, opts.Namespace),
Rules: rolePolicyRules,
}
}
// ClusterRoleBinding returns a ClusterRoleBinding that binds Pachyderm's
// ClusterRole to its ServiceAccount.
func ClusterRoleBinding(opts *AssetOpts) *rbacv1.ClusterRoleBinding {
return &rbacv1.ClusterRoleBinding{
TypeMeta: metav1.TypeMeta{
Kind: "ClusterRoleBinding",
APIVersion: "rbac.authorization.k8s.io/v1",
},
ObjectMeta: objectMeta(roleBindingName, labels(""), nil, opts.Namespace),
Subjects: []rbacv1.Subject{{
Kind: "ServiceAccount",
Name: ServiceAccountName,
Namespace: opts.Namespace,
}},
RoleRef: rbacv1.RoleRef{
Kind: "ClusterRole",
Name: roleName,
},
}
}
// Role returns a Role that should be bound to the Pachyderm service account.
func Role(opts *AssetOpts) *rbacv1.Role {
return &rbacv1.Role{
TypeMeta: metav1.TypeMeta{
Kind: "Role",
APIVersion: "rbac.authorization.k8s.io/v1",
},
ObjectMeta: objectMeta(roleName, labels(""), nil, opts.Namespace),
Rules: rolePolicyRules,
}
}
// RoleBinding returns a RoleBinding that binds Pachyderm's Role to its
// ServiceAccount.
func RoleBinding(opts *AssetOpts) *rbacv1.RoleBinding {
return &rbacv1.RoleBinding{
TypeMeta: metav1.TypeMeta{
Kind: "RoleBinding",
APIVersion: "rbac.authorization.k8s.io/v1",
},
ObjectMeta: objectMeta(roleBindingName, labels(""), nil, opts.Namespace),
Subjects: []rbacv1.Subject{{
Kind: "ServiceAccount",
Name: ServiceAccountName,
Namespace: opts.Namespace,
}},
RoleRef: rbacv1.RoleRef{
Kind: "Role",
Name: roleName,
},
}
}
// GetBackendSecretVolumeAndMount returns a properly configured Volume and
// VolumeMount object given a backend. The backend needs to be one of the
// constants defined in pfs/server.
func GetBackendSecretVolumeAndMount(backend string) (v1.Volume, v1.VolumeMount) {
return v1.Volume{
Name: client.StorageSecretName,
VolumeSource: v1.VolumeSource{
Secret: &v1.SecretVolumeSource{
SecretName: client.StorageSecretName,
},
},
}, v1.VolumeMount{
Name: client.StorageSecretName,
MountPath: "/" + client.StorageSecretName,
}
}
func versionedPachdImage(opts *AssetOpts) string {
if opts.Version != "" {
return fmt.Sprintf("%s:%s", pachdImage, opts.Version)
}
return pachdImage
}
func versionedWorkerImage(opts *AssetOpts) string {
if opts.Version != "" {
return fmt.Sprintf("%s:%s", workerImage, opts.Version)
}
return workerImage
}
func imagePullSecrets(opts *AssetOpts) []v1.LocalObjectReference {
var result []v1.LocalObjectReference
if opts.ImagePullSecret != "" {
result = append(result, v1.LocalObjectReference{Name: opts.ImagePullSecret})
}
return result
}
// PachdDeployment returns a pachd k8s Deployment.
func PachdDeployment(opts *AssetOpts, objectStoreBackend backend, hostPath string) *apps.Deployment {
mem := resource.MustParse(opts.BlockCacheSize)
mem.Add(resource.MustParse(opts.PachdNonCacheMemRequest))
cpu := resource.MustParse(opts.PachdCPURequest)
image := AddRegistry(opts.Registry, versionedPachdImage(opts))
volumes := []v1.Volume{
{
Name: "pach-disk",
},
}
volumeMounts := []v1.VolumeMount{
{
Name: "pach-disk",
MountPath: "/pach",
},
}
// Set up storage options
var backendEnvVar string
var storageHostPath string
switch objectStoreBackend {
case localBackend:
storageHostPath = filepath.Join(hostPath, "pachd")
volumes[0].HostPath = &v1.HostPathVolumeSource{
Path: storageHostPath,
}
backendEnvVar = pfs.LocalBackendEnvVar
case minioBackend:
backendEnvVar = pfs.MinioBackendEnvVar
case amazonBackend:
backendEnvVar = pfs.AmazonBackendEnvVar
case googleBackend:
backendEnvVar = pfs.GoogleBackendEnvVar
case microsoftBackend:
backendEnvVar = pfs.MicrosoftBackendEnvVar
}
volume, mount := GetBackendSecretVolumeAndMount(backendEnvVar)
volumes = append(volumes, volume)
volumeMounts = append(volumeMounts, mount)
if opts.TLS != nil {
volumes = append(volumes, v1.Volume{
Name: tlsVolumeName,
VolumeSource: v1.VolumeSource{
Secret: &v1.SecretVolumeSource{
SecretName: tlsSecretName,
},
},
})
volumeMounts = append(volumeMounts, v1.VolumeMount{
Name: tlsVolumeName,
MountPath: grpcutil.TLSVolumePath,
})
}
resourceRequirements := v1.ResourceRequirements{
Requests: v1.ResourceList{
v1.ResourceCPU: cpu,
v1.ResourceMemory: mem,
},
}
if !opts.NoGuaranteed {
resourceRequirements.Limits = v1.ResourceList{
v1.ResourceCPU: cpu,
v1.ResourceMemory: mem,
}
}
return &apps.Deployment{
TypeMeta: metav1.TypeMeta{
Kind: "Deployment",
APIVersion: "apps/v1beta1",
},
ObjectMeta: objectMeta(pachdName, labels(pachdName), nil, opts.Namespace),
Spec: apps.DeploymentSpec{
Replicas: replicas(1),
Selector: &metav1.LabelSelector{
MatchLabels: labels(pachdName),
},
Template: v1.PodTemplateSpec{
ObjectMeta: objectMeta(pachdName, labels(pachdName),
map[string]string{"iam.amazonaws.com/role": opts.IAMRole}, opts.Namespace),
Spec: v1.PodSpec{
Containers: []v1.Container{
{
Name: pachdName,
Image: image,
Env: []v1.EnvVar{
{Name: "PACH_ROOT", Value: "/pach"},
{Name: "ETCD_PREFIX", Value: opts.EtcdPrefix},
{Name: "NUM_SHARDS", Value: fmt.Sprintf("%d", opts.PachdShards)},
{Name: "STORAGE_BACKEND", Value: backendEnvVar},
{Name: "STORAGE_HOST_PATH", Value: storageHostPath},
{Name: "WORKER_IMAGE", Value: AddRegistry(opts.Registry, versionedWorkerImage(opts))},
{Name: "IMAGE_PULL_SECRET", Value: opts.ImagePullSecret},
{Name: "WORKER_SIDECAR_IMAGE", Value: image},
{Name: "WORKER_IMAGE_PULL_POLICY", Value: "IfNotPresent"},
{Name: "PACHD_VERSION", Value: opts.Version},
{Name: "METRICS", Value: strconv.FormatBool(opts.Metrics)},
{Name: "LOG_LEVEL", Value: opts.LogLevel},
{Name: "BLOCK_CACHE_BYTES", Value: opts.BlockCacheSize},
{Name: "IAM_ROLE", Value: opts.IAMRole},
{Name: "NO_EXPOSE_DOCKER_SOCKET", Value: strconv.FormatBool(opts.NoExposeDockerSocket)},
{Name: auth.DisableAuthenticationEnvVar, Value: strconv.FormatBool(opts.DisableAuthentication)},
{
Name: "PACHD_POD_NAMESPACE",
ValueFrom: &v1.EnvVarSource{
FieldRef: &v1.ObjectFieldSelector{
APIVersion: "v1",
FieldPath: "metadata.namespace",
},
},
},
{Name: "EXPOSE_OBJECT_API", Value: strconv.FormatBool(opts.ExposeObjectAPI)},
},
Ports: []v1.ContainerPort{
{
ContainerPort: 650, // also set in cmd/pachd/main.go
Protocol: "TCP",
Name: "api-grpc-port",
},
{
ContainerPort: 651, // also set in cmd/pachd/main.go
Name: "trace-port",
},
{
ContainerPort: 652, // also set in cmd/pachd/main.go
Protocol: "TCP",
Name: "api-http-port",
},
{
ContainerPort: 653, // also set in cmd/pachd/main.go
Protocol: "TCP",
Name: "peer-port",
},
{
ContainerPort: githook.GitHookPort,
Protocol: "TCP",
Name: "api-git-port",
},
},
VolumeMounts: volumeMounts,
ImagePullPolicy: "IfNotPresent",
Resources: resourceRequirements,
ReadinessProbe: &v1.Probe{
Handler: v1.Handler{
Exec: &v1.ExecAction{
Command: []string{"/pachd", "--readiness"},
},
},
},
},
},
ServiceAccountName: ServiceAccountName,
Volumes: volumes,
ImagePullSecrets: imagePullSecrets(opts),
},
},
},
}
}
// PachdService returns a pachd service.
func PachdService(opts *AssetOpts) *v1.Service {
prometheusAnnotations := map[string]string{
"prometheus.io/scrape": "true",
"prometheus.io/port": strconv.Itoa(PrometheusPort),
}
return &v1.Service{
TypeMeta: metav1.TypeMeta{
Kind: "Service",
APIVersion: "v1",
},
ObjectMeta: objectMeta(pachdName, labels(pachdName), prometheusAnnotations, opts.Namespace),
Spec: v1.ServiceSpec{
Type: v1.ServiceTypeNodePort,
Selector: map[string]string{
"app": pachdName,
},
Ports: []v1.ServicePort{
{
Port: 650, // also set in cmd/pachd/main.go
Name: "api-grpc-port",
NodePort: 30650,
},
{
Port: 651, // also set in cmd/pachd/main.go
Name: "trace-port",
NodePort: 30651,
},
{
Port: 652, // also set in cmd/pachd/main.go
Name: "api-http-port",
NodePort: 30652,
},
{
Port: githook.GitHookPort,
Name: "api-git-port",
NodePort: githook.NodePort(),
},
},
},
}
}
// GithookService returns a k8s service that exposes a public IP
func GithookService(namespace string) *v1.Service {
name := "githook"
return &v1.Service{
TypeMeta: metav1.TypeMeta{
Kind: "Service",
APIVersion: "v1",
},
ObjectMeta: objectMeta(name, labels(name), nil, namespace),
Spec: v1.ServiceSpec{
Type: v1.ServiceTypeLoadBalancer,
Selector: map[string]string{
"app": pachdName,
},
Ports: []v1.ServicePort{
{
TargetPort: intstr.FromInt(githook.GitHookPort),
Name: "api-git-port",
Port: githook.ExternalPort(),
},
},
},
}
}
// EtcdDeployment returns an etcd k8s Deployment.
func EtcdDeployment(opts *AssetOpts, hostPath string) *apps.Deployment {
cpu := resource.MustParse(opts.EtcdCPURequest)
mem := resource.MustParse(opts.EtcdMemRequest)
var volumes []v1.Volume
if hostPath == "" {
volumes = []v1.Volume{
{
Name: "etcd-storage",
VolumeSource: v1.VolumeSource{
PersistentVolumeClaim: &v1.PersistentVolumeClaimVolumeSource{
ClaimName: etcdVolumeClaimName,
},
},
},
}
} else {
volumes = []v1.Volume{
{
Name: "etcd-storage",
VolumeSource: v1.VolumeSource{
HostPath: &v1.HostPathVolumeSource{
Path: filepath.Join(hostPath, "etcd"),
},
},
},
}
}
resourceRequirements := v1.ResourceRequirements{
Requests: v1.ResourceList{
v1.ResourceCPU: cpu,
v1.ResourceMemory: mem,
},
}
if !opts.NoGuaranteed {
resourceRequirements.Limits = v1.ResourceList{
v1.ResourceCPU: cpu,
v1.ResourceMemory: mem,
}
}
// Don't want to strip the registry out of etcdImage since it's from quay
// not docker hub.
image := etcdImage
if opts.Registry != "" {
image = AddRegistry(opts.Registry, etcdImage)
}
return &apps.Deployment{
TypeMeta: metav1.TypeMeta{
Kind: "Deployment",
APIVersion: "apps/v1beta1",
},
ObjectMeta: objectMeta(etcdName, labels(etcdName), nil, opts.Namespace),
Spec: apps.DeploymentSpec{
Replicas: replicas(1),
Selector: &metav1.LabelSelector{
MatchLabels: labels(etcdName),
},
Template: v1.PodTemplateSpec{
ObjectMeta: objectMeta(etcdName, labels(etcdName), nil, opts.Namespace),
Spec: v1.PodSpec{
Containers: []v1.Container{
{
Name: etcdName,
Image: image,
//TODO figure out how to get a cluster of these to talk to each other
Command: []string{
"/usr/local/bin/etcd",
"--listen-client-urls=http://0.0.0.0:2379",
"--advertise-client-urls=http://0.0.0.0:2379",
"--data-dir=/var/data/etcd",
"--auto-compaction-retention=1",
"--max-txn-ops=5000",
},
Ports: []v1.ContainerPort{
{
ContainerPort: 2379,
Name: "client-port",
},
{
ContainerPort: 2380,
Name: "peer-port",
},
},
VolumeMounts: []v1.VolumeMount{
{
Name: "etcd-storage",
MountPath: "/var/data/etcd",
},
},
ImagePullPolicy: "IfNotPresent",
Resources: resourceRequirements,
},
},
Volumes: volumes,
ImagePullSecrets: imagePullSecrets(opts),
},
},
},
}
}
// EtcdStorageClass creates a storage class used for dynamic volume
// provisioning. Currently dynamic volume provisioning only works
// on AWS and GCE.
func EtcdStorageClass(opts *AssetOpts, backend backend) (interface{}, error) {
sc := map[string]interface{}{
"apiVersion": "storage.k8s.io/v1beta1",
"kind": "StorageClass",
"metadata": map[string]interface{}{
"name": defaultEtcdStorageClassName,
"labels": labels(etcdName),
"namespace": opts.Namespace,
},
}
switch backend {
case googleBackend:
sc["provisioner"] = "kubernetes.io/gce-pd"
sc["parameters"] = map[string]string{
"type": "pd-ssd",
}
case amazonBackend:
sc["provisioner"] = "kubernetes.io/aws-ebs"
sc["parameters"] = map[string]string{
"type": "gp2",
}
default:
return nil, nil
}
return sc, nil
}
// EtcdVolume creates a persistent volume backed by a volume with name "name"
func EtcdVolume(persistentDiskBackend backend, opts *AssetOpts,
hostPath string, name string, size int) (*v1.PersistentVolume, error) {
spec := &v1.PersistentVolume{
TypeMeta: metav1.TypeMeta{
Kind: "PersistentVolume",
APIVersion: "v1",
},
ObjectMeta: objectMeta(etcdVolumeName, labels(etcdName), nil, opts.Namespace),
Spec: v1.PersistentVolumeSpec{
Capacity: map[v1.ResourceName]resource.Quantity{
"storage": resource.MustParse(fmt.Sprintf("%vGi", size)),
},
AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce},
PersistentVolumeReclaimPolicy: v1.PersistentVolumeReclaimRetain,
},
}
switch persistentDiskBackend {
case amazonBackend:
spec.Spec.PersistentVolumeSource = v1.PersistentVolumeSource{
AWSElasticBlockStore: &v1.AWSElasticBlockStoreVolumeSource{
FSType: "ext4",
VolumeID: name,
},
}
case googleBackend:
spec.Spec.PersistentVolumeSource = v1.PersistentVolumeSource{
GCEPersistentDisk: &v1.GCEPersistentDiskVolumeSource{
FSType: "ext4",
PDName: name,
},
}
case microsoftBackend:
dataDiskURI := name
split := strings.Split(name, "/")
diskName := split[len(split)-1]
spec.Spec.PersistentVolumeSource = v1.PersistentVolumeSource{
AzureDisk: &v1.AzureDiskVolumeSource{
DiskName: diskName,
DataDiskURI: dataDiskURI,
},
}
case minioBackend:
fallthrough
case localBackend:
spec.Spec.PersistentVolumeSource = v1.PersistentVolumeSource{
HostPath: &v1.HostPathVolumeSource{
Path: filepath.Join(hostPath, "etcd"),
},
}
default:
return nil, fmt.Errorf("cannot generate volume spec for unknown backend \"%v\"", persistentDiskBackend)
}
return spec, nil
}
// EtcdVolumeClaim creates a persistent volume claim of 'size' GB.
//
// Note that if you're controlling Etcd with a Stateful Set, this is
// unnecessary (the stateful set controller will create PVCs automatically).
func EtcdVolumeClaim(size int, opts *AssetOpts) *v1.PersistentVolumeClaim {
return &v1.PersistentVolumeClaim{
TypeMeta: metav1.TypeMeta{
Kind: "PersistentVolumeClaim",
APIVersion: "v1",
},
ObjectMeta: objectMeta(etcdVolumeClaimName, labels(etcdName), nil, opts.Namespace),
Spec: v1.PersistentVolumeClaimSpec{
Resources: v1.ResourceRequirements{
Requests: map[v1.ResourceName]resource.Quantity{
"storage": resource.MustParse(fmt.Sprintf("%vGi", size)),
},
},
AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce},
VolumeName: etcdVolumeName,
},
}
}
// EtcdNodePortService returns a NodePort etcd service. This will let non-etcd
// pods talk to etcd
func EtcdNodePortService(local bool, opts *AssetOpts) *v1.Service {
var clientNodePort int32
if local {
clientNodePort = 32379
}
return &v1.Service{
TypeMeta: metav1.TypeMeta{
Kind: "Service",
APIVersion: "v1",
},
ObjectMeta: objectMeta(etcdName, labels(etcdName), nil, opts.Namespace),
Spec: v1.ServiceSpec{
Type: v1.ServiceTypeNodePort,
Selector: map[string]string{
"app": etcdName,
},
Ports: []v1.ServicePort{
{
Port: 2379,
Name: "client-port",
NodePort: clientNodePort,
},
},
},
}
}
// EtcdHeadlessService returns a headless etcd service, which is only for DNS
// resolution.
func EtcdHeadlessService(opts *AssetOpts) *v1.Service {
return &v1.Service{
TypeMeta: metav1.TypeMeta{
Kind: "Service",
APIVersion: "v1",
},
ObjectMeta: objectMeta(etcdHeadlessServiceName, labels(etcdName), nil, opts.Namespace),
Spec: v1.ServiceSpec{
Selector: map[string]string{
"app": etcdName,
},
ClusterIP: "None",
Ports: []v1.ServicePort{
{
Name: "peer-port",
Port: 2380,
},
},
},
}
}
// EtcdStatefulSet returns a stateful set that manages an etcd cluster
func EtcdStatefulSet(opts *AssetOpts, backend backend, diskSpace int) interface{} {
mem := resource.MustParse(opts.EtcdMemRequest)
cpu := resource.MustParse(opts.EtcdCPURequest)
initialCluster := make([]string, 0, opts.EtcdNodes)
for i := 0; i < opts.EtcdNodes; i++ {
url := fmt.Sprintf("http://etcd-%d.etcd-headless.${NAMESPACE}.svc.cluster.local:2380", i)
initialCluster = append(initialCluster, fmt.Sprintf("etcd-%d=%s", i, url))
}
// Because we need to refer to some environment variables set the by the
// k8s downward API, we define the command for running etcd here, and then
// actually run it below via '/bin/sh -c ${CMD}'
etcdCmd := []string{
"/usr/local/bin/etcd",
"--listen-client-urls=http://0.0.0.0:2379",
"--advertise-client-urls=http://0.0.0.0:2379",
"--listen-peer-urls=http://0.0.0.0:2380",
"--data-dir=/var/data/etcd",
"--initial-cluster-token=pach-cluster", // unique ID
"--initial-advertise-peer-urls=http://${ETCD_NAME}.etcd-headless.${NAMESPACE}.svc.cluster.local:2380",
"--initial-cluster=" + strings.Join(initialCluster, ","),
"--auto-compaction-retention=1",
"--max-txn-ops=5000",
}
for i, str := range etcdCmd {
etcdCmd[i] = fmt.Sprintf("\"%s\"", str) // quote all arguments, for shell
}
var pvcTemplates []interface{}
switch backend {
case googleBackend, amazonBackend:
storageClassName := opts.EtcdStorageClassName
if storageClassName == "" {
storageClassName = defaultEtcdStorageClassName
}
pvcTemplates = []interface{}{
map[string]interface{}{
"metadata": map[string]interface{}{
"name": etcdVolumeClaimName,
"labels": labels(etcdName),
"annotations": map[string]string{
"volume.beta.kubernetes.io/storage-class": storageClassName,
},
"namespace": opts.Namespace,
},
"spec": map[string]interface{}{
"resources": map[string]interface{}{
"requests": map[string]interface{}{
"storage": resource.MustParse(fmt.Sprintf("%vGi", diskSpace)),
},
},
"accessModes": []string{"ReadWriteOnce"},
},
},
}
default:
pvcTemplates = []interface{}{
map[string]interface{}{
"metadata": map[string]interface{}{
"name": etcdVolumeClaimName,
"labels": labels(etcdName),
"namespace": opts.Namespace,
},
"spec": map[string]interface{}{
"resources": map[string]interface{}{
"requests": map[string]interface{}{
"storage": resource.MustParse(fmt.Sprintf("%vGi", diskSpace)),
},
},
"accessModes": []string{"ReadWriteOnce"},
},
},
}
}
var imagePullSecrets []map[string]string
if opts.ImagePullSecret != "" {
imagePullSecrets = append(imagePullSecrets, map[string]string{"name": opts.ImagePullSecret})
}
// As of March 17, 2017, the Kubernetes client does not include structs for
// Stateful Set, so we generate the kubernetes manifest using raw json.
// TODO(msteffen): we're now upgrading our kubernetes client, so we should be
// abe to rewrite this spec using k8s client structs
image := etcdImage
if opts.Registry != "" {
image = AddRegistry(opts.Registry, etcdImage)
}
return map[string]interface{}{
"apiVersion": "apps/v1beta1",
"kind": "StatefulSet",
"metadata": map[string]interface{}{
"name": etcdName,
"labels": labels(etcdName),
"namespace": opts.Namespace,
},
"spec": map[string]interface{}{
// Effectively configures a RC
"serviceName": etcdHeadlessServiceName,
"replicas": int(opts.EtcdNodes),
"selector": map[string]interface{}{
"matchLabels": labels(etcdName),
},
// pod template
"template": map[string]interface{}{
"metadata": map[string]interface{}{
"name": etcdName,
"labels": labels(etcdName),
"namespace": opts.Namespace,
},
"spec": map[string]interface{}{
"imagePullSecrets": imagePullSecrets,
"containers": []interface{}{
map[string]interface{}{
"name": etcdName,
"image": image,
"command": []string{"/bin/sh", "-c"},
"args": []string{strings.Join(etcdCmd, " ")},
// Use the downward API to pass the pod name to etcd. This sets
// the etcd-internal name of each node to its pod name.
"env": []map[string]interface{}{{
"name": "ETCD_NAME",
"valueFrom": map[string]interface{}{
"fieldRef": map[string]interface{}{
"apiVersion": "v1",
"fieldPath": "metadata.name",
},
},
}, {
"name": "NAMESPACE",
"valueFrom": map[string]interface{}{
"fieldRef": map[string]interface{}{
"apiVersion": "v1",
"fieldPath": "metadata.namespace",
},
},
}},
"ports": []interface{}{
map[string]interface{}{
"containerPort": 2379,
"name": "client-port",