/
expose.go
545 lines (472 loc) · 16.2 KB
/
expose.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
package expose
import (
"strconv"
"github.com/khulnasoft/meshplay/meshkit/logger"
appsv1 "k8s.io/api/apps/v1"
appsv1beta1 "k8s.io/api/apps/v1beta1"
appsv1beta2 "k8s.io/api/apps/v1beta2"
corev1 "k8s.io/api/core/v1"
v1 "k8s.io/api/core/v1"
extensionsv1beta1 "k8s.io/api/extensions/v1beta1"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/apimachinery/pkg/util/validation"
"k8s.io/cli-runtime/pkg/resource"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
"k8s.io/client-go/restmapper"
)
// SessionAffinity is the type for Kubernetes resources' SessionAffinity
type SessionAffinity string
const (
// None is the "None" type SessionAffinity
None SessionAffinity = "None"
// ClientIP is the "ClientIP" type SessionAffinity
ClientIP SessionAffinity = "ClientIP"
)
// ServiceType us the type for Kubernetes resources' Type
type ServiceType string
// Supported service type
const (
ClusterIP ServiceType = "ClusterIP"
NodePort ServiceType = "NodePort"
LoadBalancer ServiceType = "LoadBalancer"
)
// Config is a the struct for Expose configuration
type Config struct {
// Type is the type of the service
// could be either ClusterIP, NodePort
// or LoadBalancer. If an empty is string
// is provided then "ClusterIP" type service
// is created
Type ServiceType
// LoadBalancerIP is the IP address that would
// be used if the service type is "loadBalancer"
// based. This IP address should be a valid
// IP address which can be provisioned by
// the service provider
LoadBalancerIP string
// ClusterIP is the IP address that would be
// used if the service type is "ClusterIP" or
// an empty string. This IP address should be
// a valid clusterIP.
ClusterIP string
// Namespace where the service should be created
// ideally this should be the same as the service
// that needs to be exposed
//
// It defaults to the namespace of the target resource
Namespace string
// SessionAffinity of the service
// could be "None" or "ClientIP"
SessionAffinity SessionAffinity
// Name of the service
Name string
// Annotations will be used to annotate the generated service
//
// It will not effect the target resource
Annotations map[string]string
// Log is the logger that would be used for logging
Log logger.Handler
}
// serviceConfig extends the Config and is meant to be
// used internally within the expose package.
//
// It used to configure the service generator
type serviceConfig struct {
selectorsMap map[string]string
labelsMap map[string]string
protocolsMap map[string]string
portsSlice []string
Config
}
// Expose exposes the given kubernetes resource
func Expose(
clientSet *kubernetes.Clientset,
restConfig rest.Config,
config Config,
resources []Resource,
) ([]*v1.Service, error) {
// continueOnError controls if the traversal should continue even after errors
continueOnError := true
tr := Traverser{
Client: clientSet,
Resources: resources,
Logger: config.Log,
}
createdSvc, err := tr.Visit(func(info Object, err error) (*v1.Service, error) {
if config.Namespace == "" {
config.Namespace = info.GetNamespace()
}
if err != nil {
return nil, nil
}
// Check if the resource can be exposed or not
gk := info.GetObjectKind().GroupVersionKind().GroupKind()
if err = canBeExposed(gk); err != nil {
return nil, ErrResourceCannotBeExposed(err, gk.Kind)
}
if len(config.Name) > validation.DNS1035LabelMaxLength {
config.Name = config.Name[:validation.DNS1035LabelMaxLength]
}
// Map for selectors of the current object
selectorsMap, err := mapBasedSelectorForObject(info)
if err != nil {
return nil, ErrSelectorBasedMap(err)
}
isHeadlessService := config.ClusterIP == "None"
// protocolsMap stores the protocols for the current object
protocolsMap, err := protocolsForObject(info)
if err != nil {
return nil, ErrProtocolBasedMap(err)
}
// labelsMap stores the lables for the current object
labelsMap, err := meta.NewAccessor().Labels(info)
if err != nil {
return nil, ErrLabelBasedMap(err)
}
ports, err := portsForObject(info)
if err != nil {
return nil, ErrPortParsing(err)
}
if len(ports) == 0 && !isHeadlessService {
return nil, ErrPortParsing(ErrNoPortsFoundForHeadlessResource)
}
service, err := generateService(serviceConfig{
selectorsMap: selectorsMap,
protocolsMap: protocolsMap,
labelsMap: labelsMap,
portsSlice: ports,
Config: config,
})
if err != nil {
return nil, ErrGenerateService(err)
}
config.Log.Debug("Generated service object", service.Name, "in namespace", service.Namespace)
helper, err := constructObject(clientSet, restConfig, service)
if err != nil {
return nil, ErrConstructingRestHelper(err)
}
_, err = helper.Create(config.Namespace, false, service)
config.Log.Debug("Service deployed")
if err != nil {
return nil, ErrCreatingService(err)
}
return service, nil
}, continueOnError)
return createdSvc, err
}
func generateService(serviceConfig serviceConfig) (*corev1.Service, error) {
ports := []corev1.ServicePort{}
for i, port := range serviceConfig.portsSlice {
// We can expect the port to be a valid UNIX port and hence
// should not cause integer overflow. Hence,
// #nosec
portInt, err := strconv.Atoi(port)
if err != nil {
return nil, err
}
portName := ""
if len(serviceConfig.portsSlice) > 1 {
portName = "port-" + strconv.Itoa(i+1)
}
protocol := "TCP" // Default protocol is "TCP"
if exposeProtocol, ok := serviceConfig.protocolsMap[port]; ok {
protocol = exposeProtocol
}
ports = append(ports, corev1.ServicePort{
Name: portName,
Port: int32(portInt),
Protocol: corev1.Protocol(protocol),
})
}
service := corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: serviceConfig.Name,
Labels: serviceConfig.labelsMap,
Namespace: serviceConfig.Namespace,
Annotations: serviceConfig.Annotations,
},
Spec: corev1.ServiceSpec{
Selector: serviceConfig.selectorsMap,
Ports: ports,
},
TypeMeta: metav1.TypeMeta{
APIVersion: "v1",
Kind: "Service",
},
}
// Setup target ports
for i := range service.Spec.Ports {
port := service.Spec.Ports[i].Port
service.Spec.Ports[i].TargetPort = intstr.FromInt(int(port))
}
// Setup service type
if len(serviceConfig.Type) != 0 {
service.Spec.Type = corev1.ServiceType(serviceConfig.Type)
}
// Setup load balancer ip if the type is load balancer
if service.Spec.Type == corev1.ServiceTypeLoadBalancer {
service.Spec.LoadBalancerIP = serviceConfig.LoadBalancerIP
}
// Setup session affinity
if len(serviceConfig.SessionAffinity) != 0 {
switch corev1.ServiceAffinity(serviceConfig.SessionAffinity) {
case corev1.ServiceAffinityNone:
service.Spec.SessionAffinity = corev1.ServiceAffinityNone
case corev1.ServiceAffinityClientIP:
service.Spec.SessionAffinity = corev1.ServiceAffinityClientIP
default:
return nil, ErrUnknownSessionAffinityErr(serviceConfig.SessionAffinity)
}
}
// Setup cluster IP
if len(serviceConfig.ClusterIP) != 0 {
if serviceConfig.ClusterIP == "None" {
service.Spec.ClusterIP = corev1.ClusterIPNone
} else {
service.Spec.ClusterIP = serviceConfig.ClusterIP
}
}
return &service, nil
}
// canBeExposed checks whether the kind of resources could be exposed
func canBeExposed(kind schema.GroupKind) error {
switch kind {
case
corev1.SchemeGroupVersion.WithKind("ReplicationController").GroupKind(),
corev1.SchemeGroupVersion.WithKind("Service").GroupKind(),
corev1.SchemeGroupVersion.WithKind("Pod").GroupKind(),
appsv1.SchemeGroupVersion.WithKind("Deployment").GroupKind(),
appsv1.SchemeGroupVersion.WithKind("ReplicaSet").GroupKind(),
extensionsv1beta1.SchemeGroupVersion.WithKind("Deployment").GroupKind(),
extensionsv1beta1.SchemeGroupVersion.WithKind("ReplicaSet").GroupKind():
default:
return ErrCannotExposeObjectErr(kind)
}
return nil
}
// mapBasedSelectorForObject returns the map-based selector associated with the provided object. If a
// new set-based selector is provided, an error is returned if the selector cannot be converted to a
// map-based selector
func mapBasedSelectorForObject(object runtime.Object) (map[string]string, error) {
switch t := object.(type) {
case *corev1.ReplicationController:
return t.Spec.Selector, nil
case *corev1.Pod:
if len(t.Labels) == 0 {
return map[string]string{}, ErrPodHasNoLabels
}
return t.Labels, nil
case *corev1.Service:
if t.Spec.Selector == nil {
return map[string]string{}, ErrServiceHasNoSelectors
}
return t.Spec.Selector, nil
case *extensionsv1beta1.Deployment:
// "extensions" deployments use pod template labels if selector is not set.
var labels map[string]string
if t.Spec.Selector != nil {
if len(t.Spec.Selector.MatchExpressions) > 0 {
return map[string]string{}, ErrMatchExpressionsConvertionErr(t.Spec.Selector.MatchExpressions)
}
labels = t.Spec.Selector.MatchLabels
} else {
labels = t.Spec.Template.Labels
}
if len(labels) == 0 {
return map[string]string{}, ErrInvalidDeploymentNoSelectorsLabels
}
return labels, nil
case *appsv1.Deployment:
// "apps" deployments must have the selector set.
if t.Spec.Selector == nil || len(t.Spec.Selector.MatchLabels) == 0 {
return map[string]string{}, ErrInvalidDeploymentNoSelectors
}
if len(t.Spec.Selector.MatchExpressions) > 0 {
return map[string]string{}, ErrMatchExpressionsConvertionErr(t.Spec.Selector.MatchExpressions)
}
return t.Spec.Selector.MatchLabels, nil
case *appsv1beta2.Deployment:
// "apps" deployments must have the selector set.
if t.Spec.Selector == nil || len(t.Spec.Selector.MatchLabels) == 0 {
return map[string]string{}, ErrInvalidDeploymentNoSelectors
}
if len(t.Spec.Selector.MatchExpressions) > 0 {
return map[string]string{}, ErrMatchExpressionsConvertionErr(t.Spec.Selector.MatchExpressions)
}
return t.Spec.Selector.MatchLabels, nil
case *appsv1beta1.Deployment:
// "apps" deployments must have the selector set.
if t.Spec.Selector == nil || len(t.Spec.Selector.MatchLabels) == 0 {
return map[string]string{}, ErrInvalidDeploymentNoSelectors
}
if len(t.Spec.Selector.MatchExpressions) > 0 {
return map[string]string{}, ErrMatchExpressionsConvertionErr(t.Spec.Selector.MatchExpressions)
}
return t.Spec.Selector.MatchLabels, nil
case *extensionsv1beta1.ReplicaSet:
// "extensions" replicasets use pod template labels if selector is not set.
var labels map[string]string
if t.Spec.Selector != nil {
if len(t.Spec.Selector.MatchExpressions) > 0 {
return map[string]string{}, ErrMatchExpressionsConvertionErr(t.Spec.Selector.MatchExpressions)
}
labels = t.Spec.Selector.MatchLabels
} else {
labels = t.Spec.Template.Labels
}
if len(labels) == 0 {
return map[string]string{}, ErrInvalidReplicaNoSelectorsLabels
}
return labels, nil
case *appsv1.ReplicaSet:
// "apps" replicasets must have the selector set.
if t.Spec.Selector == nil || len(t.Spec.Selector.MatchLabels) == 0 {
return map[string]string{}, ErrInvalidReplicaSetNoSelectors
}
if len(t.Spec.Selector.MatchExpressions) > 0 {
return map[string]string{}, ErrMatchExpressionsConvertionErr(t.Spec.Selector.MatchExpressions)
}
return t.Spec.Selector.MatchLabels, nil
case *appsv1beta2.ReplicaSet:
// "apps" replicasets must have the selector set.
if t.Spec.Selector == nil || len(t.Spec.Selector.MatchLabels) == 0 {
return map[string]string{}, ErrInvalidReplicaSetNoSelectors
}
if len(t.Spec.Selector.MatchExpressions) > 0 {
return map[string]string{}, ErrMatchExpressionsConvertionErr(t.Spec.Selector.MatchExpressions)
}
return t.Spec.Selector.MatchLabels, nil
default:
return map[string]string{}, ErrFailedToExtractPodSelectorErr(object)
}
}
func protocolsForObject(object runtime.Object) (map[string]string, error) {
switch t := object.(type) {
case *corev1.ReplicationController:
return getProtocols(t.Spec.Template.Spec), nil
case *corev1.Pod:
return getProtocols(t.Spec), nil
case *corev1.Service:
return getServiceProtocols(t.Spec), nil
case *extensionsv1beta1.Deployment:
return getProtocols(t.Spec.Template.Spec), nil
case *appsv1.Deployment:
return getProtocols(t.Spec.Template.Spec), nil
case *appsv1beta2.Deployment:
return getProtocols(t.Spec.Template.Spec), nil
case *appsv1beta1.Deployment:
return getProtocols(t.Spec.Template.Spec), nil
case *extensionsv1beta1.ReplicaSet:
return getProtocols(t.Spec.Template.Spec), nil
case *appsv1.ReplicaSet:
return getProtocols(t.Spec.Template.Spec), nil
case *appsv1beta2.ReplicaSet:
return getProtocols(t.Spec.Template.Spec), nil
default:
return nil, ErrFailedToExtractProtocolsErr(object)
}
}
func getProtocols(spec corev1.PodSpec) map[string]string {
result := make(map[string]string)
for _, container := range spec.Containers {
for _, port := range container.Ports {
// Empty protocol must be defaulted (TCP)
if len(port.Protocol) == 0 {
port.Protocol = corev1.ProtocolTCP
}
result[strconv.Itoa(int(port.ContainerPort))] = string(port.Protocol)
}
}
return result
}
// Extracts the protocols exposed by a service from the given service spec.
func getServiceProtocols(spec corev1.ServiceSpec) map[string]string {
result := make(map[string]string)
for _, servicePort := range spec.Ports {
// Empty protocol must be defaulted (TCP)
if len(servicePort.Protocol) == 0 {
servicePort.Protocol = corev1.ProtocolTCP
}
result[strconv.Itoa(int(servicePort.Port))] = string(servicePort.Protocol)
}
return result
}
func portsForObject(object runtime.Object) ([]string, error) {
switch t := object.(type) {
case *corev1.ReplicationController:
return getPorts(t.Spec.Template.Spec), nil
case *corev1.Pod:
return getPorts(t.Spec), nil
case *corev1.Service:
return getServicePorts(t.Spec), nil
case *extensionsv1beta1.Deployment:
return getPorts(t.Spec.Template.Spec), nil
case *appsv1.Deployment:
return getPorts(t.Spec.Template.Spec), nil
case *appsv1beta2.Deployment:
return getPorts(t.Spec.Template.Spec), nil
case *appsv1beta1.Deployment:
return getPorts(t.Spec.Template.Spec), nil
case *extensionsv1beta1.ReplicaSet:
return getPorts(t.Spec.Template.Spec), nil
case *appsv1.ReplicaSet:
return getPorts(t.Spec.Template.Spec), nil
case *appsv1beta2.ReplicaSet:
return getPorts(t.Spec.Template.Spec), nil
default:
return nil, ErrFailedToExtractPorts(object)
}
}
func getPorts(spec corev1.PodSpec) []string {
result := []string{}
for _, container := range spec.Containers {
for _, port := range container.Ports {
result = append(result, strconv.Itoa(int(port.ContainerPort)))
}
}
return result
}
func getServicePorts(spec corev1.ServiceSpec) []string {
result := []string{}
for _, servicePort := range spec.Ports {
result = append(result, strconv.Itoa(int(servicePort.Port)))
}
return result
}
func constructObject(kubeClientset kubernetes.Interface, restConfig rest.Config, obj runtime.Object) (*resource.Helper, error) {
// Create a REST mapper that tracks information about the available resources in the cluster.
groupResources, err := restmapper.GetAPIGroupResources(kubeClientset.Discovery())
if err != nil {
return nil, ErrConstructingRestHelper(err)
}
rm := restmapper.NewDiscoveryRESTMapper(groupResources)
// Get some metadata needed to make the REST request.
gvk := obj.GetObjectKind().GroupVersionKind()
gk := schema.GroupKind{Group: gvk.Group, Kind: gvk.Kind}
mapping, err := rm.RESTMapping(gk, gvk.Version)
if err != nil {
return nil, ErrConstructingRestHelper(err)
}
// Create a client specifically for creating the object.
restClient, err := newRestClient(restConfig, mapping.GroupVersionKind.GroupVersion())
if err != nil {
return nil, ErrConstructingRestHelper(err)
}
// Use the REST helper to create the object in the "default" namespace.
return resource.NewHelper(restClient, mapping), nil
}
func newRestClient(restConfig rest.Config, gv schema.GroupVersion) (rest.Interface, error) {
restConfig.ContentConfig = resource.UnstructuredPlusDefaultContentConfig()
restConfig.GroupVersion = &gv
if len(gv.Group) == 0 {
restConfig.APIPath = "/api"
} else {
restConfig.APIPath = "/apis"
}
return rest.RESTClientFor(&restConfig)
}