summaryrefslogtreecommitdiff
path: root/cloud/pkg/controllermanager/edgeapplication/overridemanager/envoverrider.go
blob: c91476457f0bb54a94af72f8ce0e0bd8726b4217 (about) (plain)
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
/*
Copyright 2024 The KubeEdge Authors.

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 overridemanager

import (
	"fmt"
	"strings"

	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"k8s.io/apimachinery/pkg/util/sets"
	"k8s.io/klog/v2"

	"github.com/kubeedge/kubeedge/pkg/apis/apps/v1alpha1"
)

type EnvOverrider struct{}

func (o *EnvOverrider) ApplyOverrides(rawObj *unstructured.Unstructured, overriders OverriderInfo) error {
	envOverriders := overriders.Overriders.EnvOverrides
	for index := range envOverriders {
		patches, err := buildEnvPatches(rawObj, &envOverriders[index])
		if err != nil {
			return err
		}

		klog.V(4).Infof("Parsed JSON patches by EnvOverrider(%+v): %+v", envOverriders[index], patches)
		if err = applyJSONPatch(rawObj, patches); err != nil {
			return err
		}
	}

	return nil
}

// buildEnvPatches build JSON patches for the resource object according to EnvOverrider declaration.
func buildEnvPatches(rawObj *unstructured.Unstructured, envOverrider *v1alpha1.EnvOverrider) ([]overrideOption, error) {
	switch rawObj.GetKind() {
	case PodKind:
		return buildEnvPatchesWithPath("spec/containers", rawObj, envOverrider)
	case ReplicaSetKind:
		fallthrough
	case DeploymentKind:
		fallthrough
	case DaemonSetKind:
		fallthrough
	case JobKind:
		fallthrough
	case StatefulSetKind:
		return buildEnvPatchesWithPath("spec/template/spec/containers", rawObj, envOverrider)
	}
	return nil, nil
}

func buildEnvPatchesWithPath(specContainersPath string, rawObj *unstructured.Unstructured, envOverrider *v1alpha1.EnvOverrider) ([]overrideOption, error) {
	patches := make([]overrideOption, 0)
	containers, ok, err := unstructured.NestedSlice(rawObj.Object, strings.Split(specContainersPath, pathSplit)...)
	if err != nil {
		return nil, fmt.Errorf("failed to retrieve path(%s) from rawObj, error: %v", specContainersPath, err)
	}
	if !ok || len(containers) == 0 {
		return nil, nil
	}
	klog.V(4).Infof("buildEnvPatchesWithPath containers info (%+v)", containers)
	for index, container := range containers {
		if container.(map[string]interface{})["name"] == envOverrider.ContainerName {
			envPath := fmt.Sprintf("/%s/%d/env", specContainersPath, index)
			envValue := make([]corev1.EnvVar, 0)
			var patch overrideOption
			// if env is nil, to add new [env]
			if container.(map[string]interface{})["env"] == nil {
				patch, _ = acquireAddEnvOverrideOption(envPath, envOverrider)
			} else {
				env, ok := container.(map[string]interface{})["env"].([]interface{})
				if !ok {
					return nil, fmt.Errorf("failed to retrieve env from container")
				}
				for _, val := range env {
					envVar, err := convertToEnvVar(val)
					if err != nil {
						return nil, err
					}
					envValue = append(envValue, *envVar)
				}
				patch, _ = acquireReplaceEnvOverrideOption(envPath, envValue, envOverrider)
			}

			klog.V(4).Infof("[buildEnvPatchesWithPath] containers patch info (%+v)", patch)
			patches = append(patches, patch)
		}
	}
	return patches, nil
}

func acquireAddEnvOverrideOption(envPath string, envOverrider *v1alpha1.EnvOverrider) (overrideOption, error) {
	if !strings.HasPrefix(envPath, pathSplit) {
		return overrideOption{}, fmt.Errorf("internal error: [acquireAddEnvOverrideOption] envPath should start with / character")
	}
	newEnv, err := overrideEnv([]corev1.EnvVar{}, envOverrider)
	if err != nil {
		return overrideOption{}, err
	}
	return overrideOption{
		Op:    string(v1alpha1.OverriderOpAdd),
		Path:  envPath,
		Value: newEnv,
	}, nil
}

func acquireReplaceEnvOverrideOption(envPath string, envValue []corev1.EnvVar, envOverrider *v1alpha1.EnvOverrider) (overrideOption, error) {
	if !strings.HasPrefix(envPath, pathSplit) {
		return overrideOption{}, fmt.Errorf("internal error: [acquireReplaceEnvOverrideOption] envPath should start with / character")
	}

	newEnv, err := overrideEnv(envValue, envOverrider)
	if err != nil {
		return overrideOption{}, err
	}

	return overrideOption{
		Op:    string(v1alpha1.OverriderOpReplace),
		Path:  envPath,
		Value: newEnv,
	}, nil
}

func overrideEnv(curEnv []corev1.EnvVar, envOverrider *v1alpha1.EnvOverrider) ([]corev1.EnvVar, error) {
	var newEnv []corev1.EnvVar
	switch envOverrider.Operator {
	case v1alpha1.OverriderOpAdd:
		newEnv = append(curEnv, envOverrider.Value...)
	case v1alpha1.OverriderOpRemove:
		newEnv = envRemove(curEnv, envOverrider.Value)
	case v1alpha1.OverriderOpReplace:
		newEnv = replaceEnv(curEnv, envOverrider.Value)
	default:
		newEnv = curEnv
		klog.V(4).Infof("[overrideEnv], op: %s , op not supported, ignored.", envOverrider.Operator)
	}
	return newEnv, nil
}

func replaceEnv(curEnv []corev1.EnvVar, replaceValues []corev1.EnvVar) []corev1.EnvVar {
	newEnv := make([]corev1.EnvVar, 0, len(curEnv))
	currentMap := make(map[string]corev1.EnvVar)

	// Populate current map with existing environment variables
	for _, envVar := range curEnv {
		currentMap[envVar.Name] = envVar
	}

	// Replace or add new environment variables
	for _, replaceVar := range replaceValues {
		currentMap[replaceVar.Name] = replaceVar
	}

	// Convert map back to slice
	for _, envVar := range currentMap {
		newEnv = append(newEnv, envVar)
	}

	return newEnv
}

func envRemove(curEnv []corev1.EnvVar, removeValues []corev1.EnvVar) []corev1.EnvVar {
	newEnv := make([]corev1.EnvVar, 0, len(curEnv))
	currentSet := sets.NewString()
	for _, val := range removeValues {
		currentSet.Insert(val.Name)
	}
	for _, envVar := range curEnv {
		if !currentSet.Has(envVar.Name) {
			newEnv = append(newEnv, envVar)
		}
	}
	return newEnv
}

func convertToEnvVar(value interface{}) (*corev1.EnvVar, error) {
	envMap, ok := value.(map[string]interface{})
	if !ok {
		return nil, fmt.Errorf("failed to convert env value to map[string]interface{}")
	}
	name, ok := envMap["name"].(string)
	if !ok {
		return nil, fmt.Errorf("failed to convert env value name to string")
	}
	var env corev1.EnvVar
	env.Name = name
	if value, ok := envMap["value"].(string); ok {
		env.Value = value
	}
	if value, ok := envMap["valueFrom"].(map[string]interface{}); ok {
		valueFrom, err := convertToEnvVarSource(value)
		if err != nil {
			return nil, err
		}
		env.ValueFrom = &valueFrom
	}
	return &env, nil
}

func convertToEnvVarSource(value map[string]interface{}) (corev1.EnvVarSource, error) {
	var envVarSource corev1.EnvVarSource
	fieldRef, ok := value["fieldRef"].(map[string]interface{})
	if !ok {
		return envVarSource, fmt.Errorf("failed to convert env valueFrom fieldRef to map[string]interface{}")
	}
	fieldPath, ok := fieldRef["fieldPath"].(string)
	if !ok {
		return envVarSource, fmt.Errorf("failed to convert env valueFrom fieldPath to string")
	}
	envVarSource.FieldRef = &corev1.ObjectFieldSelector{FieldPath: fieldPath}
	return envVarSource, nil
}