-
Notifications
You must be signed in to change notification settings - Fork 9
/
op_ensuredeployment.go
354 lines (294 loc) · 12.4 KB
/
op_ensuredeployment.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
// Copyright 2022 Namespace Labs Inc; All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
package kubeops
import (
"context"
"encoding/json"
"fmt"
"reflect"
"google.golang.org/protobuf/encoding/protojson"
appsv1 "k8s.io/api/apps/v1"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"namespacelabs.dev/foundation/framework/kubernetes/kubedef"
"namespacelabs.dev/foundation/framework/resources"
"namespacelabs.dev/foundation/framework/rpcerrors/multierr"
"namespacelabs.dev/foundation/internal/fnerrors"
"namespacelabs.dev/foundation/internal/runtime"
"namespacelabs.dev/foundation/internal/runtime/kubernetes/kubeobserver"
fnschema "namespacelabs.dev/foundation/schema"
orchpb "namespacelabs.dev/foundation/schema/orchestration"
runtimepb "namespacelabs.dev/foundation/schema/runtime"
"namespacelabs.dev/foundation/std/execution"
"namespacelabs.dev/foundation/std/tasks"
)
func registerEnsureDeployment() {
execution.RegisterVFuncs(execution.VFuncs[*kubedef.OpEnsureDeployment, *parsedEnsureDeployment]{
Parse: func(ctx context.Context, def *fnschema.SerializedInvocation, ensure *kubedef.OpEnsureDeployment) (*parsedEnsureDeployment, error) {
if ensure.SerializedResource == "" {
return nil, fnerrors.InternalError("EnsureDeployment.SerializedResource is required")
}
var parsed unstructured.Unstructured
if err := json.Unmarshal([]byte(ensure.SerializedResource), &parsed); err != nil {
return nil, fnerrors.BadInputError("kubernetes.ensuredeployment: failed to parse resource: %w", err)
}
return &parsedEnsureDeployment{obj: &parsed, spec: ensure}, nil
},
EmitStart: func(ctx context.Context, d *fnschema.SerializedInvocation, parsed *parsedEnsureDeployment, ch chan *orchpb.Event) {
if parsed.spec.InhibitEvents {
return
}
ev := kubeobserver.PrepareEvent(parsed.obj.GroupVersionKind(), parsed.obj.GetNamespace(), parsed.obj.GetName(), d.Description, parsed.spec.Deployable)
ev.Stage = orchpb.Event_WAITING
ch <- ev
},
HandleWithEvents: func(ctx context.Context, d *fnschema.SerializedInvocation, parsed *parsedEnsureDeployment, ch chan *orchpb.Event) (*execution.HandleResult, error) {
return tasks.Return(ctx, tasks.Action("kubernetes.ensure-deployment").Scope(parsed.spec.Deployable.GetPackageRef().AsPackageName()),
func(ctx context.Context) (*execution.HandleResult, error) {
if parsed.spec.ConfigurationVolumeName == "" && len(parsed.spec.SetContainerField) == 0 {
return apply(ctx, d.Description, fnschema.PackageNames(d.Scope...), parsed.obj, &kubedef.OpApply{
BodyJson: parsed.spec.SerializedResource,
InhibitEvents: parsed.spec.InhibitEvents,
}, ch)
}
inputs, err := execution.Get(ctx, execution.InputsInjection)
if err != nil {
return nil, err
}
outputMsg, ok := inputs[kubedef.RuntimeConfigOutput(parsed.spec.Deployable)]
if !ok {
return nil, fnerrors.InternalError("%s: input missing", kubedef.RuntimeConfigOutput(parsed.spec.Deployable))
}
output := outputMsg.Message.(*kubedef.EnsureRuntimeConfigOutput)
renewed, err := patchObject(parsed.obj, parsed.spec, output, parsed.spec.SetContainerField)
if err != nil {
return nil, err
}
serializedRenewed, err := json.Marshal(renewed)
if err != nil {
return nil, fnerrors.InternalError("failed to serialize deployment: %w", err)
}
var reparsed unstructured.Unstructured
if err := json.Unmarshal(serializedRenewed, &reparsed); err != nil {
return nil, fnerrors.InternalError("failed to reparse deployment: %w", err)
}
return apply(ctx, d.Description, fnschema.PackageNames(d.Scope...), &reparsed, &kubedef.OpApply{
BodyJson: string(serializedRenewed),
InhibitEvents: parsed.spec.InhibitEvents,
Deployable: parsed.spec.Deployable,
}, ch)
})
},
PlanOrder: func(ctx context.Context, ensure *parsedEnsureDeployment) (*fnschema.ScheduleOrder, error) {
return kubedef.PlanOrder(ensure.obj.GroupVersionKind(), ensure.obj.GetNamespace(), ensure.obj.GetName()), nil
},
})
}
func patchObject(obj kubedef.Object, spec *kubedef.OpEnsureDeployment, output *kubedef.EnsureRuntimeConfigOutput, setFields []*runtimepb.SetContainerField) (any, error) {
switch {
case kubedef.IsDeployment(obj):
var d specOnlyDeployment
if err := json.Unmarshal([]byte(spec.SerializedResource), &d); err != nil {
return nil, err
}
patchConfigID(&d.ObjectMeta, &d.Spec.Template.Spec, output.ConfigId, spec.ConfigurationVolumeName)
if err := patchSetFields(&d.ObjectMeta, &d.Spec.Template.Spec, setFields, output); err != nil {
return nil, err
}
return &d, nil
case kubedef.IsStatefulSet(obj):
var d specOnlyStatefulSet
if err := json.Unmarshal([]byte(spec.SerializedResource), &d); err != nil {
return nil, err
}
patchConfigID(&d.ObjectMeta, &d.Spec.Template.Spec, output.ConfigId, spec.ConfigurationVolumeName)
if err := patchSetFields(&d.ObjectMeta, &d.Spec.Template.Spec, setFields, output); err != nil {
return nil, err
}
return &d, nil
case kubedef.IsDaemonSet(obj):
var d specOnlyDaemonSet
if err := json.Unmarshal([]byte(spec.SerializedResource), &d); err != nil {
return nil, err
}
patchConfigID(&d.ObjectMeta, &d.Spec.Template.Spec, output.ConfigId, spec.ConfigurationVolumeName)
if err := patchSetFields(&d.ObjectMeta, &d.Spec.Template.Spec, setFields, output); err != nil {
return nil, err
}
return &d, nil
case kubedef.IsPod(obj):
var d specOnlyPod
if err := json.Unmarshal([]byte(spec.SerializedResource), &d); err != nil {
return nil, err
}
patchConfigID(&d.ObjectMeta, &d.Spec, output.ConfigId, spec.ConfigurationVolumeName)
if err := patchSetFields(&d.ObjectMeta, &d.Spec, setFields, output); err != nil {
return nil, err
}
return &d, nil
default:
return nil, fnerrors.InternalError("unsupported deployment kind")
}
}
type specOnlyDeployment struct {
metav1.TypeMeta `json:",inline"`
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Specification of the desired behavior of the Deployment.
// +optional
Spec appsv1.DeploymentSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}
type specOnlyStatefulSet struct {
metav1.TypeMeta `json:",inline"`
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of pods in this set.
// +optional
Spec appsv1.StatefulSetSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}
type specOnlyDaemonSet struct {
metav1.TypeMeta `json:",inline"`
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of pods in this set.
// +optional
Spec appsv1.DaemonSetSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}
type specOnlyPod struct {
metav1.TypeMeta `json:",inline"`
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Specification of the desired behavior of the pod.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional
Spec v1.PodSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}
func patchConfigID(metadata *metav1.ObjectMeta, spec *v1.PodSpec, configID, configVolumeName string) {
if configID == "" {
return
}
// We do manual cleanup of unused configs. In the future they'll be owned by a deployment intent.
metadata.Annotations[kubedef.K8sRuntimeConfig] = configID
spec.Volumes = append(spec.Volumes, v1.Volume{
Name: configVolumeName,
VolumeSource: v1.VolumeSource{
ConfigMap: &v1.ConfigMapVolumeSource{
LocalObjectReference: v1.LocalObjectReference{Name: configID},
},
},
})
}
func patchSetFields(metadata *metav1.ObjectMeta, spec *v1.PodSpec, setFields []*runtimepb.SetContainerField, output *kubedef.EnsureRuntimeConfigOutput) error {
var errs []error
for _, setField := range setFields {
for _, setArg := range setField.GetSetArg() {
value, err := selectValue(output, setArg)
if err != nil {
errs = append(errs, err)
} else {
if value.From != nil {
errs = append(errs, fnerrors.BadInputError("%s: can't set an argument from an env source", setArg.Key))
} else {
errs = append(errs, updateContainers(spec, setArg.ContainerName, func(container *v1.Container) {
container.Args = append(container.Args, setArg.Key+"="+value.Inline)
}))
}
}
}
for _, setEnv := range setField.GetSetEnv() {
value, err := selectValue(output, setEnv)
if err != nil {
errs = append(errs, err)
} else {
errs = append(errs, updateContainers(spec, setEnv.ContainerName, func(container *v1.Container) {
container.Env = append(container.Env, v1.EnvVar{Name: setEnv.Key, Value: value.Inline, ValueFrom: value.From})
}))
}
}
}
return multierr.New(errs...)
}
type value struct {
Inline string
From *v1.EnvVarSource
}
func selectValue(output *kubedef.EnsureRuntimeConfigOutput, set *runtimepb.SetContainerField_SetValue) (*value, error) {
switch set.Value {
case runtimepb.SetContainerField_RUNTIME_CONFIG:
return &value{Inline: output.SerializedRuntimeJson}, nil
case runtimepb.SetContainerField_RESOURCE_CONFIG:
return &value{Inline: output.SerializedResourceJson}, nil
case runtimepb.SetContainerField_RUNTIME_CONFIG_SERVICE_ENDPOINT:
endpoint, err := selectServiceValue(set.ServiceRef, output.SerializedRuntimeJson, runtime.SelectServiceEndpoint)
if err != nil {
return nil, err
}
// Returns a hostname:port pair.
return &value{Inline: endpoint}, nil
case runtimepb.SetContainerField_RUNTIME_CONFIG_SERVICE_INGRESS_BASE_URL:
ingressUrl, err := selectServiceValue(set.ServiceRef, output.SerializedRuntimeJson, runtime.SelectServiceIngress)
if err != nil {
return nil, err
}
return &value{Inline: ingressUrl}, nil
case runtimepb.SetContainerField_RESOURCE_CONFIG_FIELD_SELECTOR:
if set.ResourceConfigFieldSelector == nil {
return nil, fnerrors.BadInputError("missing required field selector")
}
resources, err := resources.ParseResourceData([]byte(output.SerializedResourceJson))
if err != nil {
return nil, fnerrors.InternalError("failed to unmarshal resource configuration: %w", err)
}
v, err := resources.SelectField(set.ResourceConfigFieldSelector.GetResource().Canonical(), set.ResourceConfigFieldSelector.GetFieldSelector())
if err != nil {
return nil, fnerrors.InternalError("failed to select resource value: %w", err)
}
switch x := v.(type) {
case string:
return &value{Inline: x}, nil
case int32, int64, uint32, uint64, int:
return &value{Inline: fmt.Sprintf("%d", x)}, nil
default:
return nil, fnerrors.BadInputError("unsupported resource field value %q", reflect.TypeOf(v).String())
}
}
return nil, fnerrors.BadInputError("%s: don't know this value", set.Value)
}
func selectServiceValue(ref *fnschema.ServiceRef, serializedResourceJson string, selector func(*runtimepb.Server_Service) (string, error)) (string, error) {
rt := &runtimepb.RuntimeConfig{}
// XXX unmarshal once.
if err := protojson.Unmarshal([]byte(serializedResourceJson), rt); err != nil {
return "", fnerrors.InternalError("failed to unmarshal runtime configuration: %w", err)
}
return runtime.SelectServiceValue(rt, ref, selector)
}
func updateContainers(spec *v1.PodSpec, name string, update func(container *v1.Container)) error {
count := 0
for k, container := range spec.Containers {
if name != "" && container.Name != name {
continue
}
c := container
update(&c)
spec.Containers[k] = c
count++
}
if name != "" && count == 0 {
return fnerrors.BadInputError("no container matched name %q", name)
}
return nil
}
type parsedEnsureDeployment struct {
obj *unstructured.Unstructured
spec *kubedef.OpEnsureDeployment
}