-
Notifications
You must be signed in to change notification settings - Fork 29
/
sidecar_spec.go
235 lines (198 loc) · 7.32 KB
/
sidecar_spec.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
/*
Copyright 2018 The Kubernetes Authors.
Copyright 2022 Google LLC
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
https://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 webhook
import (
corev1 "k8s.io/api/core/v1"
"k8s.io/klog/v2"
"k8s.io/utils/ptr"
)
const (
SidecarContainerName = "gke-gcsfuse-sidecar"
SidecarContainerTmpVolumeName = "gke-gcsfuse-tmp"
SidecarContainerTmpVolumeMountPath = "/gcsfuse-tmp"
SidecarContainerBufferVolumeName = "gke-gcsfuse-buffer"
SidecarContainerBufferVolumeMountPath = "/gcsfuse-buffer"
SidecarContainerCacheVolumeName = "gke-gcsfuse-cache"
SidecarContainerCacheVolumeMountPath = "/gcsfuse-cache"
// See the nonroot user discussion: https://github.com/GoogleContainerTools/distroless/issues/443
NobodyUID = 65534
NobodyGID = 65534
)
var (
tmpVolume = corev1.Volume{
Name: SidecarContainerTmpVolumeName,
VolumeSource: corev1.VolumeSource{
EmptyDir: &corev1.EmptyDirVolumeSource{},
},
}
buffVolume = corev1.Volume{
Name: SidecarContainerBufferVolumeName,
VolumeSource: corev1.VolumeSource{
EmptyDir: &corev1.EmptyDirVolumeSource{},
},
}
cacheVolume = corev1.Volume{
Name: SidecarContainerCacheVolumeName,
VolumeSource: corev1.VolumeSource{
EmptyDir: &corev1.EmptyDirVolumeSource{},
},
}
TmpVolumeMount = corev1.VolumeMount{
Name: SidecarContainerTmpVolumeName,
MountPath: SidecarContainerTmpVolumeMountPath,
}
buffVolumeMount = corev1.VolumeMount{
Name: SidecarContainerBufferVolumeName,
MountPath: SidecarContainerBufferVolumeMountPath,
}
cacheVolumeMount = corev1.VolumeMount{
Name: SidecarContainerCacheVolumeName,
MountPath: SidecarContainerCacheVolumeMountPath,
}
)
func GetNativeSidecarContainerSpec(c *Config) corev1.Container {
container := GetSidecarContainerSpec(c)
container.Env = append(container.Env, corev1.EnvVar{Name: "NATIVE_SIDECAR", Value: "TRUE"})
container.RestartPolicy = ptr.To(corev1.ContainerRestartPolicyAlways)
return container
}
func GetSidecarContainerSpec(c *Config) corev1.Container {
limits, requests := prepareResourceList(c)
// The sidecar container follows Restricted Pod Security Standard,
// see https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted
container := corev1.Container{
Name: SidecarContainerName,
Image: c.ContainerImage,
ImagePullPolicy: corev1.PullPolicy(c.ImagePullPolicy),
SecurityContext: &corev1.SecurityContext{
AllowPrivilegeEscalation: ptr.To(false),
ReadOnlyRootFilesystem: ptr.To(true),
Capabilities: &corev1.Capabilities{
Drop: []corev1.Capability{
corev1.Capability("ALL"),
},
},
SeccompProfile: &corev1.SeccompProfile{Type: corev1.SeccompProfileTypeRuntimeDefault},
RunAsNonRoot: ptr.To(true),
RunAsUser: ptr.To(int64(NobodyUID)),
RunAsGroup: ptr.To(int64(NobodyGID)),
},
Args: []string{
"--v=5",
},
Resources: corev1.ResourceRequirements{
Limits: limits,
Requests: requests,
},
VolumeMounts: []corev1.VolumeMount{TmpVolumeMount, buffVolumeMount, cacheVolumeMount},
}
return container
}
// GetSidecarContainerVolumeSpec returns volumes required by the sidecar container,
// skipping the existing custom volumes.
func GetSidecarContainerVolumeSpec(existingVolumes ...corev1.Volume) []corev1.Volume {
volumes := []corev1.Volume{tmpVolume}
var bufferVolumeExists, cacheVolumeExists bool
for _, v := range existingVolumes {
switch v.Name {
case SidecarContainerBufferVolumeName:
bufferVolumeExists = true
case SidecarContainerCacheVolumeName:
cacheVolumeExists = true
}
}
if !bufferVolumeExists {
volumes = append(volumes, buffVolume)
}
if !cacheVolumeExists {
volumes = append(volumes, cacheVolume)
}
return volumes
}
// ValidatePodHasSidecarContainerInjected validates the following:
// 1. One of the container or init container name matches the sidecar container name.
// 2. The container uses NobodyUID and NobodyGID.
// 3. The container uses the temp volume.
// 4. The temp volume have correct volume mount paths.
// 5. The Pod has the temp volume and the volume is an emptyDir volumes.
//
// Returns two booleans:
// 1. True when either native or regular sidecar is present.
// 2. True iff the sidecar present is a native sidecar container.
func ValidatePodHasSidecarContainerInjected(pod *corev1.Pod) (bool, bool) {
return validatePodHasSidecarContainerInjected(SidecarContainerName, pod, []corev1.Volume{tmpVolume}, []corev1.VolumeMount{TmpVolumeMount})
}
func sidecarContainerPresent(containerName string, containers []corev1.Container, volumeMounts []corev1.VolumeMount) bool {
containerInjected := false
volumeMountMap := map[string]string{}
for _, vm := range volumeMounts {
volumeMountMap[vm.Name] = vm.MountPath
}
for _, c := range containers {
if c.Name == containerName {
if c.SecurityContext != nil &&
c.SecurityContext.RunAsUser != nil &&
c.SecurityContext.RunAsGroup != nil &&
*c.SecurityContext.RunAsUser == NobodyUID &&
*c.SecurityContext.RunAsGroup == NobodyGID {
containerInjected = true
}
// Delete volumeMounts present from map.
for _, vm := range c.VolumeMounts {
if mountPath, exists := volumeMountMap[vm.Name]; exists {
if vm.MountPath == mountPath {
delete(volumeMountMap, vm.Name)
}
}
}
break
}
}
if containerInjected && len(volumeMountMap) == 0 {
return true
}
return false
}
func validatePodHasSidecarContainerInjected(containerName string, pod *corev1.Pod, volumes []corev1.Volume, volumeMounts []corev1.VolumeMount) (bool, bool) {
// Checks that the default emptyDir volumes are present in pod, skipping the custom volumes.
volumesInjected := func(pod *corev1.Pod) bool {
volumeMap := map[string]corev1.EmptyDirVolumeSource{}
for _, v := range volumes {
volumeMap[v.Name] = *v.EmptyDir
}
// volumeMap/volumes represents all of the volumes that should be present in the pod.
for _, v := range pod.Spec.Volumes {
if _, exists := volumeMap[v.Name]; exists {
if v.EmptyDir != nil {
delete(volumeMap, v.Name)
}
}
}
return len(volumeMap) == 0
}
// Check the sidecar container is present in regular or init container list.
containerAndVolumeMountPresentInContainers := sidecarContainerPresent(containerName, pod.Spec.Containers, volumeMounts)
containerAndVolumeMountPresentInInitContainers := sidecarContainerPresent(containerName, pod.Spec.InitContainers, volumeMounts)
if containerAndVolumeMountPresentInContainers && containerAndVolumeMountPresentInInitContainers {
klog.Errorf("sidecar present in containers and init containers... make sure only one sidecar is present.")
}
if !containerAndVolumeMountPresentInContainers && !containerAndVolumeMountPresentInInitContainers {
return false, false
}
// We continue validation if all sidecar volumes are present in the pod.
if !volumesInjected(pod) {
return false, false
}
return true, containerAndVolumeMountPresentInInitContainers
}