-
Notifications
You must be signed in to change notification settings - Fork 8
/
manifests_renderer.go
554 lines (479 loc) · 16.9 KB
/
manifests_renderer.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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
package render
import (
"encoding/json"
"fmt"
"regexp"
"strings"
"github.com/Masterminds/semver"
"github.com/solo-io/skv2/codegen/proto/schemagen"
"github.com/solo-io/skv2/codegen/util"
"github.com/solo-io/skv2/pkg/crdutils"
protoutil "github.com/solo-io/skv2/codegen/proto"
"github.com/rotisserie/eris"
"github.com/solo-io/anyvendor/anyvendor"
"github.com/solo-io/cue/cue"
"github.com/solo-io/cue/encoding/openapi"
"github.com/solo-io/cue/encoding/protobuf"
"github.com/solo-io/go-utils/stringutils"
"github.com/solo-io/skv2/codegen/kuberesource"
"github.com/solo-io/skv2/codegen/model"
apiextv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"sigs.k8s.io/yaml"
)
// creates a k8s resource for a group
// this gets turned into a k8s manifest file
type MakeResourceFunc func(groups []*Group) ([]metav1.Object, error)
// renders kubernetes from templates
type ManifestsRenderer struct {
templateRenderer
AppName string // used for labeling
ResourceFuncs map[OutFile]MakeResourceFunc
ManifestDir string
ProtoDir string
// the name of the flag to pass the list of enabled alpha-level crds
// used in codegen/templates/manifests/crd.yamltmpl
EnabledAlphaApiFlagName string
// Optional: If true, skip rendering the CRD manifest
skipCrdsManifest bool
}
type templateArgs struct {
Crds []kuberesource.GlooCustomResourceDefinition
ShouldSkip map[string]bool
EnabledAlphaApiFlagName string
}
type RenderOptions struct {
AppName string
ManifestRoot string
ProtoDir string
EnabledAlphaApiFlagName string
ProtoOpts protoutil.Options
Groups []*Group
GroupOptions model.GroupOptions
SkipCrdsManifest bool
}
func RenderManifests(opts RenderOptions) ([]OutFile, error) {
defaultManifestsRenderer := ManifestsRenderer{
AppName: opts.AppName,
ManifestDir: opts.ManifestRoot,
ProtoDir: opts.ProtoDir,
EnabledAlphaApiFlagName: opts.EnabledAlphaApiFlagName,
skipCrdsManifest: opts.SkipCrdsManifest,
}
return defaultManifestsRenderer.RenderManifests(opts.Groups, opts.ProtoOpts, opts.GroupOptions)
}
func (r ManifestsRenderer) RenderManifests(grps []*Group, protoOpts protoutil.Options, groupOptions model.GroupOptions) ([]OutFile, error) {
grpsByGroupName := make(map[string][]*Group)
shouldRenderGroups := make(map[string]bool)
shouldSkipCRDManifest := make(map[string]bool)
shouldSkipTemplatedCRDManifest := make(map[string]bool)
grandfatheredGroups := make(map[string]bool)
for _, grp := range grps {
grpsByGroupName[grp.Group] = append(grpsByGroupName[grp.Group], grp)
shouldRenderGroups[grp.Group] = shouldRenderGroups[grp.Group] || grp.RenderManifests
grandfatheredGroups[grp.GroupVersion.String()] = grandfatheredGroups[grp.GroupVersion.String()] || grp.SkipConditionalCRDLoading
shouldSkipCRDManifest[grp.Group] = shouldSkipCRDManifest[grp.Group] || grp.SkipCRDManifest
shouldSkipTemplatedCRDManifest[grp.Group] = shouldSkipTemplatedCRDManifest[grp.Group] || grp.SkipTemplatedCRDManifest
}
for _, grp := range grps {
if grp.RenderValidationSchemas && shouldRenderGroups[grp.Group] {
var err error
oapiSchemas, err := generateOpenApi(*grp, r.ProtoDir, protoOpts, groupOptions)
if err != nil {
return nil, err
}
grp.OpenApiSchemas = oapiSchemas
}
}
var renderedFiles []OutFile
for groupName, selectedGrps := range grpsByGroupName {
if !shouldRenderGroups[groupName] {
continue
}
crds, err := r.createCrds(r.AppName, selectedGrps)
if err != nil {
return nil, err
}
// only render crd manifest if neither the options nor the group has the skip flag set to true
if !r.skipCrdsManifest && !shouldSkipCRDManifest[groupName] {
out, err := r.renderCRDManifest(r.AppName, groupName, crds)
if err != nil {
return nil, err
}
renderedFiles = append(renderedFiles, out)
}
if !shouldSkipTemplatedCRDManifest[groupName] {
out, err := r.renderTemplatedCRDManifest(r.AppName, groupName, crds, grandfatheredGroups)
if err != nil {
return nil, err
}
renderedFiles = append(renderedFiles, out)
}
}
return renderedFiles, nil
}
func generateOpenApi(grp model.Group, protoDir string, protoOpts protoutil.Options, groupOptions model.GroupOptions) (model.OpenApiSchemas, error) {
if groupOptions.SchemaGenerator == schemagen.ProtocGenOpenAPI {
return generateOpenApiFromProtocGen(grp, protoDir, protoOpts, groupOptions)
}
return generateOpenApiFromCue(grp, protoDir, protoOpts, groupOptions)
}
// Use protoc-gen-openapi for transpiling protobuf schemas to openapi v3 with k8s structural schema constraints.
func generateOpenApiFromProtocGen(grp model.Group, protoDir string, _ protoutil.Options, groupOptions model.GroupOptions) (model.OpenApiSchemas, error) {
// Collect all protobuf definitions including transitive dependencies.
var imports []string
for _, fileDescriptor := range grp.Descriptors {
imports = append(imports, fileDescriptor.Imports...)
}
imports = stringutils.Unique(imports)
protoFiles := make([]string, len(grp.Descriptors))
// collect the set of messsages for which validation is disabled
for i, fileDescriptor := range grp.Descriptors {
protoFiles[i] = fileDescriptor.ProtoFilePath
}
protoGen := schemagen.NewProtocGenerator(&groupOptions.SchemaValidationOpts)
gvkSchemas, err := protoGen.GetJSONSchemas(protoFiles, imports, grp.GroupVersion)
if err != nil {
return nil, err
}
oapiSchemas := make(model.OpenApiSchemas)
for gvk, schema := range gvkSchemas {
jsonSchema, err := postProcessOpenAPISchema(schema, groupOptions)
if err != nil {
return nil, err
}
// TODO: drop schemas we are not interested in
oapiSchemas[gvk.Kind] = jsonSchema
}
return oapiSchemas, nil
}
// Use cuelang as an intermediate language for transpiling protobuf schemas to openapi v3 with k8s structural schema constraints.
func generateOpenApiFromCue(grp model.Group, protoDir string, protoOpts protoutil.Options, groupOptions model.GroupOptions) (model.OpenApiSchemas, error) {
if protoDir == "" {
protoDir = anyvendor.DefaultDepDir
}
// Collect all protobuf definitions including transitive dependencies.
var imports []string
for _, fileDescriptor := range grp.Descriptors {
imports = append(imports, fileDescriptor.Imports...)
}
imports = stringutils.Unique(imports)
// Parse protobuf into cuelang
cfg := &protobuf.Config{
Root: protoDir,
Module: grp.Module,
Paths: imports,
}
ext := protobuf.NewExtractor(cfg)
// collect the set of messsages for which validation is disabled
for _, fileDescriptor := range grp.Descriptors {
if err := ext.AddFile(fileDescriptor.ProtoFilePath, nil); err != nil {
return nil, err
}
}
instances, err := ext.Instances()
if err != nil {
return nil, err
}
// Convert cuelang to openapi
unstructuredFieldsMap, err := getUnstructuredFieldsMap(grp, protoOpts)
if err != nil {
return nil, err
}
generator := &openapi.Generator{
// k8s structural schemas do not allow $refs, i.e. all references must be expanded
ExpandReferences: true,
UnstructuredFields: unstructuredFieldsMap,
}
if grp.SkipSchemaDescriptions {
// returning empty from this func results in no description field being added
generator.DescriptionFunc = func(_ cue.Value) string { return "" }
}
built := cue.Build(instances)
for _, builtInstance := range built {
// Avoid generating openapi for irrelevant proto imports.
if !strings.HasSuffix(builtInstance.ImportPath, grp.Group+"/"+grp.Version) {
continue
}
if err = builtInstance.Err; err != nil {
return nil, eris.Errorf("Cue instance failed to build for %s: %+v", grp.Group, err)
}
if err = builtInstance.Value().Validate(); err != nil {
return nil, eris.Errorf("Cue instance validation failed for %s: %+v", grp.Group, err)
}
schemas, err := generator.Schemas(builtInstance)
if err != nil {
return nil, eris.Errorf("Cue openapi generation failed for %s: %+v", grp.Group, err)
}
// Iterate openapi objects to construct mapping from proto message name to openapi schema
oapiSchemas := model.OpenApiSchemas{}
for _, kv := range schemas.Pairs() {
orderedMap := kv.Value.(*openapi.OrderedMap)
jsonSchema, err := postProcessValidationSchema(orderedMap, groupOptions)
if err != nil {
return nil, err
}
oapiSchemas[kv.Key] = jsonSchema
}
return oapiSchemas, err
}
return nil, nil
}
// returns the map of proto fields marked as unstructured, used by CUE to generate openapi schemas
func getUnstructuredFieldsMap(grp model.Group, opts protoutil.Options) (map[string][][]string, error) {
unstructuredFields := map[string][][]string{}
defaultProtoPkg := grp.Group
defaultGoPkg := util.GoPackage(grp)
for _, res := range grp.Resources {
if res.CodegenOnly {
continue
}
unstructuredSpecFields, err := opts.GetUnstructuredFields(
ifDefined(res.Spec.Type.ProtoPackage, defaultProtoPkg),
res.Spec.Type.Name,
)
if err != nil {
return nil, err
}
goPkg := ifDefined(res.Spec.Type.GoPackage, defaultGoPkg)
unstructuredFields[goPkg] = append(unstructuredFields[goPkg], unstructuredSpecFields...)
if res.Status != nil {
unstructuredStatusFields, err := opts.GetUnstructuredFields(
ifDefined(res.Status.Type.ProtoPackage, defaultProtoPkg),
res.Status.Type.Name,
)
if err != nil {
return nil, err
}
goPkg := ifDefined(res.Status.Type.GoPackage, defaultGoPkg)
if len(unstructuredStatusFields) > 0 {
unstructuredFields[goPkg] = append(unstructuredFields[goPkg], unstructuredStatusFields...)
}
}
}
return unstructuredFields, nil
}
func SetVersionForObject(obj metav1.Object, version string) {
if version == "" {
return
}
a := obj.GetAnnotations()
if a == nil {
a = make(map[string]string)
}
// we only care about major minor and patch versions.
if parsedSemVer, err := semver.NewVersion(version); err == nil {
strippedVersion, err := parsedSemVer.SetPrerelease("")
if err != nil {
return
}
strippedVersion, err = strippedVersion.SetMetadata("")
if err != nil {
return
}
a[crdutils.CRDVersionKey] = strippedVersion.String()
obj.SetAnnotations(a)
}
}
// TODO (dmitri-d): this can be removed once we migrate to use platform charts exclusively
func (r ManifestsRenderer) renderCRDManifest(appName, groupName string, objs []kuberesource.GlooCustomResourceDefinition) (OutFile, error) {
outFile := OutFile{
Path: r.ManifestDir + "/crds/" + groupName + "_" + "crds.yaml",
}
var objManifests []string
for _, obj := range objs {
manifest, err := marshalObjToYaml(appName, &obj)
if err != nil {
return OutFile{}, err
}
objManifests = append(objManifests, manifest)
}
outFile.Content = strings.Join(objManifests, "\n---\n")
return outFile, nil
}
func (r ManifestsRenderer) renderTemplatedCRDManifest(appName, groupName string,
objs []kuberesource.GlooCustomResourceDefinition,
grandfatheredGroups map[string]bool,
) (OutFile, error) {
renderer := DefaultTemplateRenderer
// when rendering helm charts, we need
// to use a custom delimiter
renderer.left = "[["
renderer.right = "]]"
defaultManifestRenderer := ChartRenderer{
templateRenderer: renderer,
}
outFile := OutFile{Path: r.ManifestDir + "/templates/" + groupName + "_" + "crds.yaml"}
templatesToRender := inputTemplates{
"manifests/crd.yamltmpl": outFile,
}
if err := r.canRenderCRDTemplate(objs, grandfatheredGroups); err != nil {
return OutFile{}, err
}
files, err := defaultManifestRenderer.renderCoreTemplates(
templatesToRender,
templateArgs{Crds: objs, ShouldSkip: grandfatheredGroups, EnabledAlphaApiFlagName: r.EnabledAlphaApiFlagName})
if err != nil {
return OutFile{}, err
}
// if we got here there's one item in []files,
// as we only rendered one template and there were no errors
return files[0], nil
}
func (r ManifestsRenderer) canRenderCRDTemplate(objs []kuberesource.GlooCustomResourceDefinition, grandfatheredGroups map[string]bool) error {
for _, obj := range objs {
for _, v := range obj.Spec.Versions {
if strings.Contains(v.Name, "alpha") && !grandfatheredGroups[obj.Spec.Group+"/"+v.Name] && r.EnabledAlphaApiFlagName == "" {
return fmt.Errorf("error rendering CRD template for kind %s: 'EnabledAlphaApiFlagName' is not defined", obj.Spec.Names.Kind)
}
}
}
return nil
}
func (r ManifestsRenderer) createCrds(appName string, groups []*Group) ([]kuberesource.GlooCustomResourceDefinition, error) {
objs, err := kuberesource.CustomResourceDefinitions(groups)
if err != nil {
return nil, err
}
for i, obj := range objs {
// find the annotation of the manifest, and add to them
SetVersionForObject(objs[i].GetObjectMeta(), groups[0].AddChartVersion)
labels := obj.GetLabels()
if labels == nil {
labels = map[string]string{}
}
labels["app"] = appName
labels["app.kubernetes.io/name"] = appName
objs[i].SetLabels(labels)
}
return objs, nil
}
func marshalObjToYaml(appName string, obj metav1.Object) (string, error) {
yam, err := yaml.Marshal(obj)
if err != nil {
return "", err
}
var v map[string]interface{}
if err := yaml.Unmarshal(yam, &v); err != nil {
return "", err
}
delete(v, "status")
// why do we have to do this? Go problem???
meta := v["metadata"].(map[string]interface{})
delete(meta, "creationTimestamp")
v["metadata"] = meta
if spec, ok := v["spec"].(map[string]interface{}); ok {
if template, ok := spec["template"].(map[string]interface{}); ok {
if meta, ok := template["metadata"].(map[string]interface{}); ok {
delete(meta, "creationTimestamp")
template["metadata"] = meta
spec["template"] = template
v["spec"] = spec
}
}
}
yam, err = yaml.Marshal(v)
return string(yam), err
}
func postProcessValidationSchema(oapi *openapi.OrderedMap, groupOptions model.GroupOptions) (*apiextv1.JSONSchemaProps, error) {
oapiJson, err := oapi.MarshalJSON()
if err != nil {
return nil, err
}
var obj map[string]interface{}
if err = json.Unmarshal(oapiJson, &obj); err != nil {
return nil, err
}
// remove 'properties' and 'required' fields to prevent validating proto.Any fields
removeProtoAnyValidation(obj)
if groupOptions.EscapeGoTemplateOperators {
// escape {{ or }} in descriptions as they will cause helm to error
escapeGoTemplateOperators(obj)
}
bytes, err := json.Marshal(obj)
if err != nil {
return nil, err
}
jsonSchema := &apiextv1.JSONSchemaProps{}
if err = json.Unmarshal(bytes, jsonSchema); err != nil {
return nil, err
}
return jsonSchema, nil
}
func postProcessOpenAPISchema(schema *apiextv1.JSONSchemaProps, groupOptions model.GroupOptions) (*apiextv1.JSONSchemaProps, error) {
oapiJson, err := json.Marshal(schema)
if err != nil {
return nil, err
}
var obj map[string]interface{}
if err = json.Unmarshal(oapiJson, &obj); err != nil {
return nil, err
}
// remove 'properties' and 'required' fields to prevent validating proto.Any fields
removeProtoAnyValidation(obj)
if groupOptions.EscapeGoTemplateOperators {
// escape {{ or }} in descriptions as they will cause helm to error
escapeGoTemplateOperators(obj)
}
bytes, err := json.Marshal(obj)
if err != nil {
return nil, err
}
jsonSchema := &apiextv1.JSONSchemaProps{}
if err = json.Unmarshal(bytes, jsonSchema); err != nil {
return nil, err
}
return jsonSchema, nil
}
// prevent k8s from validating proto.Any fields (since it's unstructured)
func removeProtoAnyValidation(d map[string]interface{}) {
for _, v := range d {
values, ok := v.(map[string]interface{})
if !ok {
continue
}
desc, ok := values["properties"]
properties, isObj := desc.(map[string]interface{})
// detect proto.Any field from presence of "@type" as field under "properties"
if !ok || !isObj || properties["@type"] == nil {
removeProtoAnyValidation(values)
continue
}
// remove "properties" value
delete(values, "properties")
// remove "required" value
delete(values, "required")
// x-kubernetes-preserve-unknown-fields allows for unknown fields from a particular node
// see https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#specifying-a-structural-schema
values["x-kubernetes-preserve-unknown-fields"] = true
}
}
// escape go template operators in descriptions, {{ or }} in description will cause helm to error
// We do not always control descriptions since we import some protos
func escapeGoTemplateOperators(d map[string]interface{}) {
for k, v := range d {
if k == "description" {
d[k] = sanitizeDescription(v)
}
values, ok := v.(map[string]interface{})
if !ok {
continue
}
escapeGoTemplateOperators(values)
}
}
// Regex to escape double brackets in go templates
func sanitizeDescription(desc interface{}) interface{} {
if description, isString := desc.(string); isString {
exp := regexp.MustCompile("{{([^}]+)}}")
description = exp.ReplaceAllString(description, `{{"{{"}}$1{{"}}"}}`)
return description
}
return desc
}
func ifDefined(val, defaultValue string) string {
if val != "" {
return val
}
return defaultValue
}