/
kubernetes.go
513 lines (462 loc) · 13.5 KB
/
kubernetes.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
/*
Copyright AppsCode Inc. and Contributors
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 v1
import (
"sort"
"kmodules.xyz/client-go/meta"
jsoniter "github.com/json-iterator/go"
"gomodules.xyz/mergo"
core "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
)
var json = jsoniter.ConfigFastest
func AddFinalizer(m metav1.ObjectMeta, finalizer string) metav1.ObjectMeta {
for _, name := range m.Finalizers {
if name == finalizer {
return m
}
}
m.Finalizers = append(m.Finalizers, finalizer)
return m
}
func HasFinalizer(m metav1.ObjectMeta, finalizer string) bool {
for _, name := range m.Finalizers {
if name == finalizer {
return true
}
}
return false
}
func RemoveFinalizer(m metav1.ObjectMeta, finalizer string) metav1.ObjectMeta {
// https://github.com/golang/go/wiki/SliceTricks#filtering-without-allocating
r := m.Finalizers[:0]
for _, name := range m.Finalizers {
if name != finalizer {
r = append(r, name)
}
}
m.Finalizers = r
return m
}
func EnsureContainerDeleted(containers []core.Container, name string) []core.Container {
for i, c := range containers {
if c.Name == name {
return append(containers[:i], containers[i+1:]...)
}
}
return containers
}
func GetContainerByName(containers []core.Container, name string) *core.Container {
for i := range containers {
if containers[i].Name == name {
return &containers[i]
}
}
return nil
}
func UpsertContainer(containers []core.Container, upsert core.Container) []core.Container {
for i, container := range containers {
if container.Name == upsert.Name {
err := mergo.Merge(&container, upsert, mergo.WithOverride)
if err != nil {
panic(err)
}
// mergo does not overwrite "dst (container)" using empty "src (upsert)" values.
// This causes problem we want to remove args or commands (eg, disable TLS).
// TODO: should this be done for all the []string type fields (eg, EnvFrom etc.)?
container.Command = upsert.Command
container.Args = upsert.Args
for i, env := range upsert.Env {
if env.ValueFrom != nil &&
env.ValueFrom.FieldRef != nil &&
env.ValueFrom.FieldRef.APIVersion == "" {
env.ValueFrom.FieldRef.APIVersion = "v1"
}
upsert.Env[i] = env
}
container.Env = upsert.Env
container.VolumeMounts = upsert.VolumeMounts
container.VolumeDevices = upsert.VolumeDevices
container.Resources = upsert.Resources
containers[i] = container
return containers
}
}
return append(containers, upsert)
}
func MergeContainer(container core.Container, containerTemplate core.Container) core.Container {
if len(containerTemplate.Command) > 0 {
container.Command = containerTemplate.Command
}
container.Args = meta.UpsertArgumentList(container.Args, containerTemplate.Args)
container.WorkingDir = containerTemplate.WorkingDir
container.EnvFrom = containerTemplate.EnvFrom
container.Env = UpsertEnvVars(container.Env, containerTemplate.Env...)
container.Ports = UpsertContainerPorts(container.Ports, containerTemplate.Ports...)
container.Resources = containerTemplate.Resources
container.ResizePolicy = containerTemplate.ResizePolicy
container.RestartPolicy = containerTemplate.RestartPolicy
container.VolumeMounts = UpsertVolumeMount(container.VolumeMounts, containerTemplate.VolumeMounts...)
container.VolumeDevices = containerTemplate.VolumeDevices
container.LivenessProbe = containerTemplate.LivenessProbe
container.ReadinessProbe = containerTemplate.ReadinessProbe
container.StartupProbe = containerTemplate.StartupProbe
container.Lifecycle = containerTemplate.Lifecycle
container.TerminationMessagePath = containerTemplate.TerminationMessagePath
container.TerminationMessagePolicy = containerTemplate.TerminationMessagePolicy
container.ImagePullPolicy = containerTemplate.ImagePullPolicy
container.SecurityContext = containerTemplate.SecurityContext
container.StdinOnce = containerTemplate.StdinOnce
container.TTY = containerTemplate.TTY
return container
}
func UpsertContainers(containers []core.Container, addons []core.Container) []core.Container {
out := containers
for _, c := range addons {
out = UpsertContainer(out, c)
}
return out
}
func DeleteContainer(containers []core.Container, name string) []core.Container {
for i, v := range containers {
if v.Name == name {
return append(containers[:i], containers[i+1:]...)
}
}
return containers
}
func GetVolumeByName(volumes []core.Volume, name string) *core.Volume {
for i := range volumes {
if volumes[i].Name == name {
return &volumes[i]
}
}
return nil
}
func UpsertVolume(volumes []core.Volume, nv ...core.Volume) []core.Volume {
upsert := func(v core.Volume) {
for i, vol := range volumes {
if vol.Name == v.Name {
err := mergo.Merge(&volumes[i], v, mergo.WithOverride)
if err != nil {
panic(err)
}
return
}
}
volumes = append(volumes, v)
}
for _, volume := range nv {
upsert(volume)
}
return volumes
}
func ReplaceVolumes(existing []core.Volume, desired ...core.Volume) ([]core.Volume, error) {
merge := func(cur core.Volume) error {
for i, v := range desired {
if v.Name == cur.Name {
if err := mergo.Merge(&cur, v, mergo.WithOverride); err != nil {
return err
}
desired[i] = cur
break
}
}
return nil
}
for _, cur := range existing {
if err := merge(cur); err != nil {
return nil, err
}
}
sort.Slice(desired, func(i, j int) bool {
return desired[i].Name < desired[j].Name
})
return desired, nil
}
func MustReplaceVolumes(existing []core.Volume, desired ...core.Volume) []core.Volume {
result, err := ReplaceVolumes(existing, desired...)
if err != nil {
panic(err)
}
return result
}
func UpsertVolumeClaim(volumeClaims []core.PersistentVolumeClaim, upsert core.PersistentVolumeClaim) []core.PersistentVolumeClaim {
for i, vc := range volumeClaims {
if vc.Name == upsert.Name {
volumeClaims[i].Labels = upsert.Labels
volumeClaims[i].Annotations = upsert.Annotations
if err := mergo.Merge(&volumeClaims[i].Spec, upsert.Spec, mergo.WithOverride); err != nil {
panic(err)
}
return volumeClaims
}
}
return append(volumeClaims, upsert)
}
func EnsureVolumeDeleted(volumes []core.Volume, name string) []core.Volume {
for i, v := range volumes {
if v.Name == name {
return append(volumes[:i], volumes[i+1:]...)
}
}
return volumes
}
func GetVolumeMountByName(volumeMounts []core.VolumeMount, name string) *core.VolumeMount {
for i := range volumeMounts {
if volumeMounts[i].Name == name {
return &volumeMounts[i]
}
}
return nil
}
func UpsertVolumeMount(mounts []core.VolumeMount, nv ...core.VolumeMount) []core.VolumeMount {
upsert := func(m core.VolumeMount) {
for i, vol := range mounts {
if vol.Name == m.Name {
mounts[i] = m
return
}
}
mounts = append(mounts, m)
}
for _, mount := range nv {
upsert(mount)
}
return mounts
}
func EnsureVolumeMountDeleted(mounts []core.VolumeMount, name string) []core.VolumeMount {
for i, v := range mounts {
if v.Name == name {
return append(mounts[:i], mounts[i+1:]...)
}
}
return mounts
}
func UpsertVolumeMountByPath(mounts []core.VolumeMount, nv core.VolumeMount) []core.VolumeMount {
for i, vol := range mounts {
if vol.MountPath == nv.MountPath {
mounts[i] = nv
return mounts
}
}
return append(mounts, nv)
}
func EnsureVolumeMountDeletedByPath(mounts []core.VolumeMount, mountPath string) []core.VolumeMount {
for i, v := range mounts {
if v.MountPath == mountPath {
return append(mounts[:i], mounts[i+1:]...)
}
}
return mounts
}
func UpsertContainerPorts(ports []core.ContainerPort, np ...core.ContainerPort) []core.ContainerPort {
upsert := func(p core.ContainerPort) {
for i, port := range ports {
if port.Name == p.Name {
err := mergo.Merge(&ports[i], p, mergo.WithOverride)
if err != nil {
panic(err)
}
return
}
}
ports = append(ports, p)
}
for _, port := range np {
upsert(port)
}
return ports
}
func GetEnvByName(envs []core.EnvVar, name string) *core.EnvVar {
for i := range envs {
if envs[i].Name == name {
return &envs[i]
}
}
return nil
}
func UpsertEnvVars(vars []core.EnvVar, nv ...core.EnvVar) []core.EnvVar {
upsert := func(env core.EnvVar) {
if env.ValueFrom != nil &&
env.ValueFrom.FieldRef != nil &&
env.ValueFrom.FieldRef.APIVersion == "" {
env.ValueFrom.FieldRef.APIVersion = "v1"
}
for i, v := range vars {
if v.Name == env.Name {
vars[i] = env
return
}
}
vars = append(vars, env)
}
for _, env := range nv {
upsert(env)
}
return vars
}
func EnsureEnvVarDeleted(vars []core.EnvVar, name string) []core.EnvVar {
for i, v := range vars {
if v.Name == name {
return append(vars[:i], vars[i+1:]...)
}
}
return vars
}
func MergeLocalObjectReferences(l1, l2 []core.LocalObjectReference) []core.LocalObjectReference {
result := make([]core.LocalObjectReference, 0, len(l1)+len(l2))
m := make(map[string]core.LocalObjectReference)
for _, ref := range l1 {
m[ref.Name] = ref
result = append(result, ref)
}
for _, ref := range l2 {
if _, found := m[ref.Name]; !found {
result = append(result, ref)
}
}
sort.Slice(result, func(i, j int) bool { return result[i].Name < result[j].Name })
return result
}
// NewOwnerRef creates an OwnerReference pointing to the given owner.
func NewOwnerRef(owner metav1.Object, gvk schema.GroupVersionKind) *metav1.OwnerReference {
blockOwnerDeletion := false
isController := false
return &metav1.OwnerReference{
APIVersion: gvk.GroupVersion().String(),
Kind: gvk.Kind,
Name: owner.GetName(),
UID: owner.GetUID(),
BlockOwnerDeletion: &blockOwnerDeletion,
Controller: &isController,
}
}
// EnsureOwnerReference adds owner if absent or syncs owner if already present.
//
// If you are writing a controller or an operator, use the following code snippet for dependent objects.
// Here, `controller = true` and `blockOwnerDeletion = true`
//
// owner := metav1.NewControllerRef(foo, samplev1alpha1.SchemeGroupVersion.WithKind("Foo"))
// EnsureOwnerReference(dependent, owner)
//
// If our CRD is not a controller but just want to be a owner, use the following code snippet.
// Here, `controller = false` and `blockOwnerDeletion = false`
//
// owner := NewOwnerRef(foo, samplev1alpha1.SchemeGroupVersion.WithKind("Foo"))
// EnsureOwnerReference(dependent, owner)
//
// To understand the impact of `blockOwnerDeletion`, read:
// - https://kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/#foreground-cascading-deletion
// - https://github.com/kubernetes/apimachinery/blob/v0.17.0/pkg/apis/meta/v1/types.go#L297-L323
func EnsureOwnerReference(dependent metav1.Object, owner *metav1.OwnerReference) {
if owner == nil {
return
}
refs := dependent.GetOwnerReferences()
fi := -1
for i := range refs {
if refs[i].UID == owner.UID {
fi = i
break
}
}
if fi == -1 {
refs = append(refs, *owner)
} else {
refs[fi] = *owner
}
dependent.SetOwnerReferences(refs)
}
func RemoveOwnerReference(dependent metav1.Object, owner metav1.Object) {
refs := dependent.GetOwnerReferences()
for i := range refs {
if refs[i].UID == owner.GetUID() {
refs = append(refs[:i], refs[i+1:]...)
break
}
}
dependent.SetOwnerReferences(refs)
}
// IsOwnedBy checks if the dependent has a owner reference to the given owner
func IsOwnedBy(dependent metav1.Object, owner metav1.Object) (owned bool, controller bool) {
refs := dependent.GetOwnerReferences()
for i := range refs {
if refs[i].UID == owner.GetUID() {
return true, refs[i].Controller != nil && *refs[i].Controller
}
}
return false, false
}
func IsOwnerOfGroup(ctrl *metav1.OwnerReference, group string) (bool, string, error) {
if ctrl == nil {
return false, "", nil
}
gv, err := schema.ParseGroupVersion(ctrl.APIVersion)
if err != nil {
return false, "", err
}
if gv.Group != group {
return false, "", nil
}
return true, ctrl.Kind, nil
}
func IsOwnerOfGroupKind(ctrl *metav1.OwnerReference, group, kind string) (bool, error) {
if ctrl == nil {
return false, nil
}
gv, err := schema.ParseGroupVersion(ctrl.APIVersion)
if err != nil {
return false, err
}
if gv.Group != group {
return false, nil
}
if ctrl.Kind != kind {
return false, nil
}
return true, nil
}
func UpsertToleration(tolerations []core.Toleration, upsert core.Toleration) []core.Toleration {
for i, toleration := range tolerations {
if toleration.Key == upsert.Key {
tolerations[i] = upsert
return tolerations
}
}
return append(tolerations, upsert)
}
func RemoveToleration(tolerations []core.Toleration, key string) []core.Toleration {
for i, toleration := range tolerations {
if toleration.Key == key {
return append(tolerations[:i], tolerations[i+1:]...)
}
}
return tolerations
}
func UpsertImagePullSecrets(refs []core.LocalObjectReference, upsert ...core.LocalObjectReference) []core.LocalObjectReference {
for i := range upsert {
var found bool
for j := range refs {
if refs[j].Name == upsert[i].Name {
found = true
break
}
}
if !found {
refs = append(refs, upsert[i])
}
}
return refs
}