-
Notifications
You must be signed in to change notification settings - Fork 132
/
tf_controller_runner.go
394 lines (355 loc) · 11.3 KB
/
tf_controller_runner.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
package controllers
import (
"context"
"fmt"
"os"
"time"
errors2 "github.com/pkg/errors"
"github.com/weaveworks/tf-controller/api/v1alpha1"
"github.com/weaveworks/tf-controller/mtls"
"github.com/weaveworks/tf-controller/runner"
"google.golang.org/grpc"
"k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
v12 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/wait"
"sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
)
func getRunnerPodObjectKey(terraform v1alpha1.Terraform) types.NamespacedName {
return types.NamespacedName{Namespace: terraform.Namespace, Name: fmt.Sprintf("%s-tf-runner", terraform.Name)}
}
func getRunnerPodImage(image string) string {
runnerPodImage := image
if runnerPodImage == "" {
runnerPodImage = os.Getenv("RUNNER_POD_IMAGE")
}
if runnerPodImage == "" {
runnerPodImage = "ghcr.io/weaveworks/tf-runner:latest"
}
return runnerPodImage
}
func runnerPodTemplate(terraform v1alpha1.Terraform, secretName string) v1.Pod {
podNamespace := terraform.Namespace
podName := fmt.Sprintf("%s-tf-runner", terraform.Name)
runnerPodTemplate := v1.Pod{
ObjectMeta: v12.ObjectMeta{
Namespace: podNamespace,
Name: podName,
Labels: map[string]string{
"app.kubernetes.io/created-by": "tf-controller",
"app.kubernetes.io/name": "tf-runner",
"app.kubernetes.io/instance": podName,
v1alpha1.RunnerLabel: terraform.Namespace,
"tf.weave.works/tls-secret-name": secretName,
},
Annotations: terraform.Spec.RunnerPodTemplate.Metadata.Annotations,
},
}
// add runner pod custom labels
if len(terraform.Spec.RunnerPodTemplate.Metadata.Labels) != 0 {
for k, v := range terraform.Spec.RunnerPodTemplate.Metadata.Labels {
runnerPodTemplate.Labels[k] = v
}
}
return runnerPodTemplate
}
func (r *TerraformReconciler) LookupOrCreateRunner(ctx context.Context, terraform v1alpha1.Terraform) (runner.RunnerClient, func() error, error) {
// we have to make sure that the secret is valid before we can create the runner.
secret, err := r.reconcileRunnerSecret(ctx, &terraform)
if err != nil {
return nil, nil, err
}
var hostname string
if os.Getenv("INSECURE_LOCAL_RUNNER") == "1" {
hostname = "localhost"
} else {
podIP, err := r.reconcileRunnerPod(ctx, terraform, secret)
if err != nil {
return nil, nil, err
}
hostname = terraform.GetRunnerHostname(podIP)
}
dialCtx, dialCancel := context.WithTimeout(ctx, 30*time.Second)
defer dialCancel()
conn, err := r.getRunnerConnection(dialCtx, secret, hostname, r.RunnerGRPCPort)
if err != nil {
return nil, nil, err
}
connClose := func() error { return conn.Close() }
runnerClient := runner.NewRunnerClient(conn)
return runnerClient, connClose, nil
}
func (r *TerraformReconciler) getRunnerConnection(ctx context.Context, tlsSecret *v1.Secret, hostname string, port int) (*grpc.ClientConn, error) {
addr := fmt.Sprintf("%s:%d", hostname, port)
credentials, err := mtls.GetGRPCClientCredentials(tlsSecret)
if err != nil {
return nil, err
}
const retryPolicy = `{
"methodConfig": [{
"name": [{"service": "runner.Runner"}],
"waitForReady": true,
"retryPolicy": {
"MaxAttempts": 4,
"InitialBackoff": ".01s",
"MaxBackoff": ".01s",
"BackoffMultiplier": 1.0,
"RetryableStatusCodes": [ "UNAVAILABLE" ]
}
}]}`
return grpc.DialContext(ctx, addr,
grpc.WithTransportCredentials(credentials),
grpc.WithBlock(),
grpc.WithDefaultServiceConfig(retryPolicy),
)
}
func (r *TerraformReconciler) runnerPodSpec(terraform v1alpha1.Terraform, tlsSecretName string) v1.PodSpec {
serviceAccountName := terraform.Spec.ServiceAccountName
if serviceAccountName == "" {
serviceAccountName = "tf-runner"
}
gracefulTermPeriod := terraform.Spec.RunnerTerminationGracePeriodSeconds
envvars := []v1.EnvVar{}
envvarsMap := map[string]v1.EnvVar{
"POD_NAME": {
Name: "POD_NAME",
ValueFrom: &v1.EnvVarSource{
FieldRef: &v1.ObjectFieldSelector{
FieldPath: "metadata.name",
},
},
},
"POD_NAMESPACE": {
Name: "POD_NAMESPACE",
ValueFrom: &v1.EnvVarSource{
FieldRef: &v1.ObjectFieldSelector{
FieldPath: "metadata.namespace",
},
},
},
}
for _, envName := range []string{"HTTP_PROXY", "HTTPS_PROXY", "NO_PROXY"} {
if envValue := os.Getenv(envName); envValue != "" {
envvarsMap[envName] = v1.EnvVar{
Name: envName,
Value: envValue,
}
}
}
for _, env := range terraform.Spec.RunnerPodTemplate.Spec.Env {
envvarsMap[env.Name] = env
}
for _, env := range envvarsMap {
envvars = append(envvars, env)
}
vFalse := false
vTrue := true
vUser := int64(65532)
podVolumes := []v1.Volume{
{
Name: "temp",
VolumeSource: v1.VolumeSource{
EmptyDir: &v1.EmptyDirVolumeSource{},
},
},
{
Name: "home",
VolumeSource: v1.VolumeSource{
EmptyDir: &v1.EmptyDirVolumeSource{},
},
},
}
if len(terraform.Spec.RunnerPodTemplate.Spec.Volumes) != 0 {
podVolumes = append(podVolumes, terraform.Spec.RunnerPodTemplate.Spec.Volumes...)
}
podVolumeMounts := []v1.VolumeMount{
{
Name: "temp",
MountPath: "/tmp",
},
{
Name: "home",
MountPath: "/home/runner",
},
}
if len(terraform.Spec.RunnerPodTemplate.Spec.VolumeMounts) != 0 {
podVolumeMounts = append(podVolumeMounts, terraform.Spec.RunnerPodTemplate.Spec.VolumeMounts...)
}
return v1.PodSpec{
TerminationGracePeriodSeconds: gracefulTermPeriod,
Containers: []v1.Container{
{
Name: "tf-runner",
Args: []string{
"--grpc-port", fmt.Sprintf("%d", r.RunnerGRPCPort),
"--tls-secret-name", tlsSecretName,
"--grpc-max-message-size", fmt.Sprintf("%d", r.RunnerGRPCMaxMessageSize),
},
Image: getRunnerPodImage(terraform.Spec.RunnerPodTemplate.Spec.Image),
ImagePullPolicy: v1.PullIfNotPresent,
Ports: []v1.ContainerPort{
{
Name: "grpc",
ContainerPort: int32(r.RunnerGRPCPort),
},
},
Env: envvars,
EnvFrom: terraform.Spec.RunnerPodTemplate.Spec.EnvFrom,
// TODO: this security context might break OpenShift because of SCC. We need verification.
// TODO how to support it via Spec or Helm Chart
SecurityContext: &v1.SecurityContext{
Capabilities: &v1.Capabilities{
Drop: []v1.Capability{"ALL"},
},
AllowPrivilegeEscalation: &vFalse,
RunAsNonRoot: &vTrue,
RunAsUser: &vUser,
SeccompProfile: &v1.SeccompProfile{
Type: v1.SeccompProfileTypeRuntimeDefault,
},
ReadOnlyRootFilesystem: &vTrue,
},
VolumeMounts: podVolumeMounts,
},
},
Volumes: podVolumes,
ServiceAccountName: serviceAccountName,
NodeSelector: terraform.Spec.RunnerPodTemplate.Spec.NodeSelector,
Affinity: terraform.Spec.RunnerPodTemplate.Spec.Affinity,
Tolerations: terraform.Spec.RunnerPodTemplate.Spec.Tolerations,
}
}
func (r *TerraformReconciler) reconcileRunnerPod(ctx context.Context, terraform v1alpha1.Terraform, tlsSecret *v1.Secret) (string, error) {
log := controllerruntime.LoggerFrom(ctx)
type state string
const (
stateUnknown state = "unknown"
stateRunning state = "running"
stateNotFound state = "not-found"
stateMustBeDeleted state = "must-be-deleted"
stateTerminating state = "terminating"
)
const interval = time.Second * 15
timeout := r.RunnerCreationTimeout // default is 120 seconds
tlsSecretName := tlsSecret.Name
createNewPod := func() error {
runnerPodTemplate := runnerPodTemplate(terraform, tlsSecretName)
newRunnerPod := *runnerPodTemplate.DeepCopy()
newRunnerPod.Spec = r.runnerPodSpec(terraform, tlsSecretName)
if err := r.Create(ctx, &newRunnerPod); err != nil {
return err
}
return nil
}
waitForPodToBeTerminated := func() error {
runnerPodTemplate := runnerPodTemplate(terraform, tlsSecretName)
runnerPod := *runnerPodTemplate.DeepCopy()
runnerPodKey := client.ObjectKeyFromObject(&runnerPod)
err := wait.PollImmediate(interval, timeout, func() (bool, error) {
err := r.Get(ctx, runnerPodKey, &runnerPod)
if err != nil && errors.IsNotFound(err) {
return true, nil
}
return false, nil
})
if err != nil {
return err
}
return nil
}
podState := stateUnknown
runnerPodTemplate := runnerPodTemplate(terraform, tlsSecretName)
runnerPod := *runnerPodTemplate.DeepCopy()
runnerPodKey := client.ObjectKeyFromObject(&runnerPod)
err := r.Get(ctx, runnerPodKey, &runnerPod)
if err != nil && errors.IsNotFound(err) {
podState = stateNotFound
} else if err == nil {
label, found := runnerPod.Labels["tf.weave.works/tls-secret-name"]
if !found || label != tlsSecretName {
podState = stateMustBeDeleted
} else if runnerPod.DeletionTimestamp != nil {
podState = stateTerminating
} else if runnerPod.Status.Phase == v1.PodRunning {
podState = stateRunning
}
}
log.Info("show runner pod state: ", "name", terraform.Name, "state", podState)
switch podState {
case stateNotFound:
// create new pod
err := createNewPod()
if err != nil {
return "", err
}
case stateMustBeDeleted:
// delete old pod
if err := r.Delete(ctx, &runnerPod,
client.GracePeriodSeconds(1), // force kill = 1 second
client.PropagationPolicy(v12.DeletePropagationForeground),
); err != nil {
return "", err
}
// wait for pod to be terminated
if err := waitForPodToBeTerminated(); err != nil {
return "", fmt.Errorf("failed to wait for the old pod termination: %v", err)
}
// create new pod
if err := createNewPod(); err != nil {
return "", err
}
case stateTerminating:
// wait for pod to be terminated
if err := waitForPodToBeTerminated(); err != nil {
return "", fmt.Errorf("failed to wait for the old pod termination: %v", err)
}
// create new pod
err := createNewPod()
if err != nil {
return "", err
}
case stateRunning:
// do nothing
}
// wait for pod ip
if wait.Poll(interval, timeout, func() (bool, error) {
if err := r.Get(ctx, runnerPodKey, &runnerPod); err != nil {
return false, fmt.Errorf("failed to get runner pod: %w", err)
}
if runnerPod.Status.PodIP != "" {
return true, nil
}
return false, nil
}) != nil {
if err := r.Delete(ctx, &runnerPod,
client.GracePeriodSeconds(1), // force kill = 1 second
client.PropagationPolicy(v12.DeletePropagationForeground),
); err != nil {
return "", fmt.Errorf("failed to obtain pod ip and delete runner pod: %w", err)
}
return "", fmt.Errorf("failed to create and obtain pod ip")
}
return runnerPod.Status.PodIP, nil
}
// reconcileRunnerSecret reconciles the runner secret used for mTLS
//
// It should create the secret if it doesn't exist and then verify that the cert is valid
// if the cert is not present in the secret or is invalid, it will generate a new cert and
// write it to the secret. One secret per namespace is created in order to sidestep the need
// for specifying a pod ip in the certificate SAN field.
func (r *TerraformReconciler) reconcileRunnerSecret(ctx context.Context, terraform *v1alpha1.Terraform) (*v1.Secret, error) {
log := controllerruntime.LoggerFrom(ctx)
log.Info("trigger namespace tls secret generation")
trigger := mtls.Trigger{
Namespace: terraform.Namespace,
Ready: make(chan *mtls.TriggerResult),
}
r.CertRotator.TriggerNamespaceTLSGeneration <- trigger
result := <-trigger.Ready
if result.Err != nil {
return nil, errors2.Wrap(result.Err, "failed to get tls generation result")
}
return result.Secret, nil
}