/
generic.go
272 lines (230 loc) · 9.3 KB
/
generic.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
package options
import (
"bytes"
"errors"
"fmt"
"io/ioutil"
"path/filepath"
"text/template"
"github.com/ghodss/yaml"
configv1 "github.com/openshift/api/config/v1"
"github.com/openshift/library-go/pkg/assets"
"github.com/openshift/library-go/pkg/operator/configobserver/featuregates"
"github.com/openshift/library-go/pkg/operator/resource/resourcemerge"
"github.com/spf13/pflag"
"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/runtime/schema"
)
// GenericOptions contains the generic render command options.
type GenericOptions struct {
DefaultFile string
BootstrapOverrideFile string
AdditionalConfigOverrideFiles []string
RenderedManifestInputFilenames []string
ConfigOutputFile string
TemplatesDir string
AssetInputDir string
AssetOutputDir string
PayloadVersion string
}
type Template struct {
FileName string
Content []byte
}
// NewGenericOptions returns a default set of generic options.
func NewGenericOptions() *GenericOptions {
return &GenericOptions{
TemplatesDir: "/usr/share/bootkube/manifests",
}
}
// AddFlags adds the generic flags to the flagset.
func (o *GenericOptions) AddFlags(fs *pflag.FlagSet, configGVK schema.GroupVersionKind) {
fs.StringVar(&o.AssetOutputDir, "asset-output-dir", o.AssetOutputDir, "Output path for rendered manifests.")
fs.StringVar(&o.AssetInputDir, "asset-input-dir", o.AssetInputDir, "A path to directory with certificates and secrets.")
fs.StringVar(&o.TemplatesDir, "templates-input-dir", o.TemplatesDir, "A path to a directory with manifest templates.")
fs.StringSliceVar(&o.AdditionalConfigOverrideFiles, "config-override-files", o.AdditionalConfigOverrideFiles,
fmt.Sprintf("Additional sparse %s files for customiziation through the installer, merged into the default config in the given order.", gvkOutput{configGVK}))
fs.StringVar(&o.ConfigOutputFile, "config-output-file", o.ConfigOutputFile, fmt.Sprintf("Output path for the %s yaml file.", gvkOutput{configGVK}))
fs.StringSliceVar(&o.RenderedManifestInputFilenames, "rendered-manifest-files", o.RenderedManifestInputFilenames,
"files or directories containing yaml or json manifests that will be created via cluster-bootstrapping.")
fs.StringVar(&o.PayloadVersion, "payload-version", o.PayloadVersion, "Version that will eventually be placed into ClusterOperator.status. This normally comes from the CVO set via env var: OPERATOR_IMAGE_VERSION.")
}
type gvkOutput struct {
schema.GroupVersionKind
}
func (gvk gvkOutput) String() string {
return fmt.Sprintf("%s.%s/%s", gvk.GroupVersionKind.Kind, gvk.GroupVersionKind.Group, gvk.GroupVersionKind.Version)
}
// Complete fills in missing values before execution.
func (o *GenericOptions) Complete() error {
return nil
}
// Validate verifies the inputs.
func (o *GenericOptions) Validate() error {
if len(o.AssetInputDir) == 0 {
return errors.New("missing required flag: --asset-input-dir")
}
if len(o.AssetOutputDir) == 0 {
return errors.New("missing required flag: --asset-output-dir")
}
if len(o.TemplatesDir) == 0 {
return errors.New("missing required flag: --templates-dir")
}
if len(o.ConfigOutputFile) == 0 {
return errors.New("missing required flag: --config-output-file")
}
if renderedManifests, err := o.ReadInputManifests(); err != nil {
return fmt.Errorf("--rendered-manifest-files, could not be read: %v", err)
} else {
if err := renderedManifests.ValidateManifestPredictability(); err != nil {
return fmt.Errorf("--rendered-manifest-files, are not consistent so results would be unpredictable depending on apply order: %v", err)
}
}
return nil
}
func (o *GenericOptions) ReadInputManifests() (RenderedManifests, error) {
ret := RenderedManifests{}
for _, filename := range o.RenderedManifestInputFilenames {
manifestContent, err := assets.LoadFilesRecursively(filename)
if err != nil {
return nil, fmt.Errorf("failed loading rendered manifest inputs from %q: %w", filename, err)
}
for manifestFile, content := range manifestContent {
ret = append(ret, RenderedManifest{
OriginalFilename: filepath.Join(filename, manifestFile),
Content: content,
})
}
}
return ret, nil
}
func (o *GenericOptions) FeatureGates() (featuregates.FeatureGateAccess, error) {
if len(o.PayloadVersion) == 0 {
return nil, fmt.Errorf("cannot return FeatureGate without payload version")
}
if len(o.RenderedManifestInputFilenames) == 0 {
return nil, fmt.Errorf("cannot return FeatureGate without rendered manifests")
}
manifests, err := o.FeatureGateManifests()
if err != nil {
return nil, fmt.Errorf("error reading input manifests: %w", err)
}
// they're all the same, so just get the first
featureGate, err := manifests[0].GetDecodedObj()
if err != nil {
return nil, fmt.Errorf("error decoding FeatureGates: %w", err)
}
ret, err := featuregates.NewHardcodedFeatureGateAccessFromFeatureGate(featureGate.(*configv1.FeatureGate), o.PayloadVersion)
if err != nil {
return nil, fmt.Errorf("error creating feature accessor: %w", err)
}
return ret, nil
}
// FeatureGateManifests is exposed for usage in getting FeatureGateAccess and for convenient by cluster-config-operator
func (o *GenericOptions) FeatureGateManifests() (RenderedManifests, error) {
if len(o.RenderedManifestInputFilenames) == 0 {
return nil, nil
}
inputManifest, err := o.ReadInputManifests()
if err != nil {
return nil, fmt.Errorf("error reading input manifests: %w", err)
}
featureGates := inputManifest.ListManifestOfType(configv1.GroupVersion.WithKind("FeatureGate"))
if len(featureGates) == 0 {
return nil, fmt.Errorf("no FeatureGates found in manfest dir: %v", o.RenderedManifestInputFilenames)
}
ret := RenderedManifests{}
var prev *RenderedManifest
var featureGate *configv1.FeatureGate
for i := range featureGates {
curr := featureGates[i]
ret = append(ret, curr)
decodedObj, err := curr.GetDecodedObj()
if err != nil {
return nil, fmt.Errorf("decoding failure for %q: %w", curr.OriginalFilename, err)
}
currFeatureGate, ok := decodedObj.(*configv1.FeatureGate)
if !ok {
return nil, fmt.Errorf("wrong obj type for %q: %T: %v", curr.OriginalFilename, decodedObj, curr.Content)
}
if featureGate == nil {
prev = &curr
featureGate = currFeatureGate
continue
}
if !equality.Semantic.DeepEqual(featureGate, currFeatureGate) {
return nil, fmt.Errorf("FeatureGate manifests disagree: %q and %q, with \n%v\n%v ", prev.OriginalFilename, curr.OriginalFilename, prev.Content, curr.Content)
}
}
return ret, nil
}
func (o *GenericOptions) FeatureSetName() (configv1.FeatureSet, error) {
if len(o.RenderedManifestInputFilenames) == 0 {
return configv1.Default, nil
}
manifests, err := o.FeatureGateManifests()
if err != nil {
return "MISSING", fmt.Errorf("error reading input manifests: %w", err)
}
// they're all the same, so just get the first
featureGate, err := manifests[0].GetDecodedObj()
if err != nil {
return "MISSING", fmt.Errorf("error decoding FeatureGates: %w", err)
}
return featureGate.(*configv1.FeatureGate).Spec.FeatureSet, nil
}
// ApplyTo applies the options to the given config struct using the provided text/template data.
func (o *GenericOptions) ApplyTo(cfg *FileConfig, defaultConfig, bootstrapOverrides Template, templateData interface{}, specialCases map[string]resourcemerge.MergeFunc) error {
var err error
cfg.BootstrapConfig, err = o.configFromDefaultsPlusOverride(defaultConfig, bootstrapOverrides, templateData, specialCases)
if err != nil {
return fmt.Errorf("failed to generate bootstrap config (phase 1): %v", err)
}
// load and render templates
if cfg.Assets, err = assets.LoadFilesRecursively(o.AssetInputDir); err != nil {
return fmt.Errorf("failed loading assets from %q: %v", o.AssetInputDir, err)
}
return nil
}
func (o *GenericOptions) configFromDefaultsPlusOverride(defaultConfig, overrides Template, templateData interface{}, specialCases map[string]resourcemerge.MergeFunc) ([]byte, error) {
defaultConfigContent, err := renderTemplate(defaultConfig, templateData)
if err != nil {
return nil, fmt.Errorf("failed to render default config file %q as text/template: %v", defaultConfig.FileName, err)
}
overridesContent, err := renderTemplate(overrides, templateData)
if err != nil {
return nil, fmt.Errorf("failed to render config override file %q as text/template: %v", overrides.FileName, err)
}
configs := [][]byte{defaultConfigContent, overridesContent}
for _, fname := range o.AdditionalConfigOverrideFiles {
bs, err := ioutil.ReadFile(fname)
if err != nil {
return nil, fmt.Errorf("failed to load config overrides at %q: %v", fname, err)
}
overrides, err := renderTemplate(Template{fname, bs}, templateData)
if err != nil {
return nil, fmt.Errorf("failed to render config overrides file %q as text/template: %v", fname, err)
}
configs = append(configs, overrides)
}
mergedConfig, err := resourcemerge.MergeProcessConfig(specialCases, configs...)
if err != nil {
return nil, fmt.Errorf("failed to merge configs: %v", err)
}
yml, err := yaml.JSONToYAML(mergedConfig)
if err != nil {
return nil, err
}
return yml, nil
}
func renderTemplate(tpl Template, data interface{}) ([]byte, error) {
tmpl, err := template.New(tpl.FileName).Parse(string(tpl.Content))
if err != nil {
return nil, err
}
var buf bytes.Buffer
if err := tmpl.Execute(&buf, data); err != nil {
return nil, err
}
return buf.Bytes(), nil
}