-
Notifications
You must be signed in to change notification settings - Fork 90
/
preflight.go
588 lines (506 loc) · 19.3 KB
/
preflight.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
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
package preflight
import (
"bytes"
"context"
"encoding/json"
"fmt"
"os"
"path/filepath"
"time"
"github.com/pkg/errors"
apptypes "github.com/replicatedhq/kots/pkg/app/types"
"github.com/replicatedhq/kots/pkg/installers"
"github.com/replicatedhq/kots/pkg/k8sutil"
kotstypes "github.com/replicatedhq/kots/pkg/kotsadm/types"
"github.com/replicatedhq/kots/pkg/kotsutil"
"github.com/replicatedhq/kots/pkg/logger"
"github.com/replicatedhq/kots/pkg/preflight/types"
"github.com/replicatedhq/kots/pkg/registry"
registrytypes "github.com/replicatedhq/kots/pkg/registry/types"
"github.com/replicatedhq/kots/pkg/render"
"github.com/replicatedhq/kots/pkg/render/helper"
rendertypes "github.com/replicatedhq/kots/pkg/render/types"
"github.com/replicatedhq/kots/pkg/reporting"
"github.com/replicatedhq/kots/pkg/store"
storetypes "github.com/replicatedhq/kots/pkg/store/types"
"github.com/replicatedhq/kots/pkg/util"
"github.com/replicatedhq/kots/pkg/version"
"github.com/replicatedhq/kotskinds/client/kotsclientset/scheme"
kurlv1beta1 "github.com/replicatedhq/kurlkinds/pkg/apis/cluster/v1beta1"
troubleshootanalyze "github.com/replicatedhq/troubleshoot/pkg/analyze"
troubleshootv1beta2 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta2"
troubleshootcollect "github.com/replicatedhq/troubleshoot/pkg/collect"
troubleshootpreflight "github.com/replicatedhq/troubleshoot/pkg/preflight"
"go.uber.org/zap"
"gopkg.in/yaml.v2"
corev1 "k8s.io/api/core/v1"
kuberneteserrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
serializer "k8s.io/apimachinery/pkg/runtime/serializer/json"
)
const (
SpecDataKey = "preflight-spec"
)
func Run(appID string, appSlug string, sequence int64, isAirgap bool, ignoreNonStrict bool, archiveDir string) error {
kotsKinds, err := kotsutil.LoadKotsKinds(archiveDir)
if err != nil {
return errors.Wrap(err, "failed to load rendered kots kinds")
}
status, err := store.GetStore().GetDownstreamVersionStatus(appID, sequence)
if err != nil {
return errors.Wrapf(err, "failed to check downstream version %d status", sequence)
}
// preflights should not run until config is finished
if status == storetypes.VersionPendingConfig {
logger.Debug("not running preflights for app that is pending required configuration",
zap.String("appID", appID),
zap.Int64("sequence", sequence))
return nil
}
var ignoreRBAC bool
var registrySettings registrytypes.RegistrySettings
var preflight *troubleshootv1beta2.Preflight
ignoreRBAC, err = store.GetStore().GetIgnoreRBACErrors(appID, sequence)
if err != nil {
return errors.Wrap(err, "failed to get ignore rbac flag")
}
registrySettings, err = store.GetStore().GetRegistryDetailsForApp(appID)
if err != nil {
return errors.Wrap(err, "failed to get registry settings for app")
}
tsKinds, err := kotsutil.LoadTSKindsFromPath(filepath.Join(archiveDir, "rendered"))
if err != nil {
return errors.Wrap(err, fmt.Sprintf("failed to load troubleshoot kinds from path: %s", filepath.Join(archiveDir, "rendered")))
}
runPreflights := false
if tsKinds.PreflightsV1Beta2 != nil {
for _, v := range tsKinds.PreflightsV1Beta2 {
preflight = troubleshootpreflight.ConcatPreflightSpec(preflight, &v)
}
InjectDefaultPreflights(preflight, kotsKinds, registrySettings)
numAnalyzers := 0
for _, analyzer := range preflight.Spec.Analyzers {
exclude := troubleshootanalyze.GetExcludeFlag(analyzer).BoolOrDefaultFalse()
if !exclude {
numAnalyzers += 1
}
}
runPreflights = numAnalyzers > 0
} else if kotsKinds.Preflight != nil {
// render the preflight file
// we need to convert to bytes first, so that we can reuse the renderfile function
renderedMarshalledPreflights, err := kotsKinds.Marshal("troubleshoot.replicated.com", "v1beta1", "Preflight")
if err != nil {
return errors.Wrap(err, "failed to marshal rendered preflight")
}
renderedPreflight, err := render.RenderFile(rendertypes.RenderFileOptions{
KotsKinds: kotsKinds,
RegistrySettings: registrySettings,
AppSlug: appSlug,
Sequence: sequence,
IsAirgap: isAirgap,
Namespace: util.PodNamespace,
InputContent: []byte(renderedMarshalledPreflights),
})
if err != nil {
return errors.Wrap(err, "failed to render preflights")
}
preflight, err = kotsutil.LoadPreflightFromContents(renderedPreflight)
if err != nil {
return errors.Wrap(err, "failed to load rendered preflight")
}
InjectDefaultPreflights(preflight, kotsKinds, registrySettings)
numAnalyzers := 0
for _, analyzer := range preflight.Spec.Analyzers {
exclude := troubleshootanalyze.GetExcludeFlag(analyzer).BoolOrDefaultFalse()
if !exclude {
numAnalyzers += 1
}
}
runPreflights = numAnalyzers > 0
}
if runPreflights {
var preflightErr error
defer func() {
if preflightErr != nil {
preflightResults := &types.PreflightResults{
Errors: []*types.PreflightError{
&types.PreflightError{
Error: preflightErr.Error(),
IsRBAC: false,
},
},
}
if err := setPreflightResults(appID, sequence, preflightResults); err != nil {
logger.Error(errors.Wrap(err, "failed to set preflight results"))
return
}
}
}()
status, err := store.GetStore().GetDownstreamVersionStatus(appID, sequence)
if err != nil {
preflightErr = errors.Wrap(err, "failed to get version status")
return preflightErr
}
if status != storetypes.VersionDeployed && status != storetypes.VersionDeploying {
if err := store.GetStore().SetDownstreamVersionStatus(appID, sequence, storetypes.VersionPendingPreflight, ""); err != nil {
preflightErr = errors.Wrapf(err, "failed to set downstream version %d pending preflight", sequence)
return preflightErr
}
}
collectors, err := registry.UpdateCollectorSpecsWithRegistryData(preflight.Spec.Collectors, registrySettings, kotsKinds.Installation, kotsKinds.License, &kotsKinds.KotsApplication)
if err != nil {
preflightErr = errors.Wrap(err, "failed to rewrite images in preflight")
return preflightErr
}
preflight.Spec.Collectors = collectors
go func() {
logger.Info("preflight checks beginning",
zap.String("appID", appID),
zap.Int64("sequence", sequence))
setProgress := func(progress map[string]interface{}) error {
return setPreflightProgress(appID, sequence, progress)
}
setResults := func(results *types.PreflightResults) error {
return setPreflightResults(appID, sequence, results)
}
uploadPreflightResults, err := Execute(preflight, ignoreRBAC, setProgress, setResults)
if err != nil {
logger.Error(errors.Wrap(err, "failed to run preflight checks"))
return
}
logger.Info("preflight checks completed")
go func() {
err := reporting.GetReporter().SubmitAppInfo(appID) // send app and preflight info when preflights finish
if err != nil {
logger.Debugf("failed to submit app info: %v", err)
}
}()
// status could've changed while preflights were running
status, err := store.GetStore().GetDownstreamVersionStatus(appID, sequence)
if err != nil {
logger.Error(errors.Wrapf(err, "failed to check downstream version %d status", sequence))
return
}
if status == storetypes.VersionDeployed || status == storetypes.VersionDeploying || status == storetypes.VersionFailed {
return
}
isDeployed, err := maybeDeployFirstVersion(appID, sequence, uploadPreflightResults, ignoreNonStrict)
if err != nil {
logger.Error(errors.Wrap(err, "failed to deploy first version"))
return
}
// preflight reporting
if isDeployed {
if err := reporting.WaitAndReportPreflightChecks(appID, sequence, false, false); err != nil {
logger.Debugf("failed to send preflights data to replicated app: %v", err)
return
}
}
}()
} else if status != storetypes.VersionDeployed && status != storetypes.VersionFailed {
if sequence == 0 {
_, err := maybeDeployFirstVersion(appID, sequence, &types.PreflightResults{}, ignoreNonStrict)
if err != nil {
return errors.Wrap(err, "failed to deploy first version")
}
} else {
err := store.GetStore().SetDownstreamVersionStatus(appID, sequence, storetypes.VersionPending, "")
if err != nil {
return errors.Wrap(err, "failed to set downstream version status to pending")
}
}
}
return nil
}
func setPreflightProgress(appID string, sequence int64, progress map[string]interface{}) error {
b, err := json.Marshal(progress)
if err != nil {
return errors.Wrap(err, "failed to marshal preflight progress")
}
if err := store.GetStore().SetPreflightProgress(appID, sequence, string(b)); err != nil {
return errors.Wrap(err, "failed to set preflight progress")
}
return nil
}
func setPreflightResults(appID string, sequence int64, preflightResults *types.PreflightResults) error {
b, err := json.Marshal(preflightResults)
if err != nil {
return errors.Wrap(err, "failed to marshal preflight results")
}
if err := store.GetStore().SetPreflightResults(appID, sequence, b); err != nil {
return errors.Wrap(err, "failed to set preflight results")
}
return nil
}
// GetPreflightCheckState returns the state of a single preflight check result
func GetPreflightCheckState(p *troubleshootpreflight.UploadPreflightResult) string {
if p == nil {
return "unknown"
}
if p.IsFail {
return "fail"
}
if p.IsWarn {
return "warn"
}
if p.IsPass {
return "pass"
}
return "unknown"
}
// maybeDeployFirstVersion will deploy the first version if preflight checks pass
func maybeDeployFirstVersion(appID string, sequence int64, preflightResults *types.PreflightResults, ignoreNonStrictPreflights bool) (bool, error) {
if sequence != 0 {
return false, nil
}
app, err := store.GetStore().GetApp(appID)
if err != nil {
return false, errors.Wrap(err, "failed to get app")
}
// do not revert to first version
if app.CurrentSequence != 0 {
return false, nil
}
preflightState := GetPreflightState(preflightResults, ignoreNonStrictPreflights)
if preflightState != "pass" {
// log the preflight results if there are any warnings or errors as this is useful for debugging
logger.Warnf("Preflight checks completed with warnings or errors. The application will not get deployed")
for _, result := range preflightResults.Results {
if result == nil {
continue
}
logger.Infof("preflight state=%s title=%q message=%q", GetPreflightCheckState(result), result.Title, result.Message)
}
return false, nil
}
logger.Debug("automatically deploying first app version")
err = version.DeployVersion(appID, sequence)
if err != nil {
return false, errors.Wrap(err, "failed to deploy version")
}
// this ensures the version status is updated before returning
time.Sleep(time.Second)
return true, nil
}
// GetPreflightState returns a single state based on checking all
// preflight checks results. If there are any errors, the state is fail.
// If there are no errors and any warnings, the state is warn.
// Otherwise, the state is pass.
func GetPreflightState(preflightResults *types.PreflightResults, ignoreNonStrict bool) string {
if len(preflightResults.Errors) > 0 {
return "fail"
}
if len(preflightResults.Results) == 0 {
return "pass"
}
state := "pass"
for _, result := range preflightResults.Results {
if ignoreNonStrict && !result.Strict {
continue
}
if result.IsFail {
return "fail"
} else if result.IsWarn {
state = "warn"
}
}
return state
}
func GetSpecSecretName(appSlug string) string {
return fmt.Sprintf("kotsadm-%s-preflight", appSlug)
}
func GetSpecURI(appSlug string) string {
return fmt.Sprintf("secret/%s/%s", util.PodNamespace, GetSpecSecretName(appSlug))
}
func GetPreflightCommand(appSlug string) []string {
comamnd := []string{
"curl https://krew.sh/preflight | bash",
fmt.Sprintf("kubectl preflight %s\n", GetSpecURI(appSlug)),
}
return comamnd
}
func CreateRenderedSpec(app *apptypes.App, sequence int64, origin string, inCluster bool, kotsKinds *kotsutil.KotsKinds, archiveDir string) error {
var builtPreflight *troubleshootv1beta2.Preflight
tsKinds, err := kotsutil.LoadTSKindsFromPath(filepath.Join(archiveDir, "rendered"))
if err != nil {
return errors.Wrap(err, fmt.Sprintf("failed to load troubleshoot kinds from path: %s", filepath.Join(archiveDir, "rendered")))
}
if tsKinds.PreflightsV1Beta2 != nil {
for _, v := range tsKinds.PreflightsV1Beta2 {
builtPreflight = troubleshootpreflight.ConcatPreflightSpec(builtPreflight, &v)
}
} else {
builtPreflight = kotsKinds.Preflight.DeepCopy()
}
if builtPreflight == nil {
builtPreflight = &troubleshootv1beta2.Preflight{
TypeMeta: v1.TypeMeta{
Kind: "Preflight",
APIVersion: "troubleshoot.sh/v1beta2",
},
ObjectMeta: v1.ObjectMeta{
Name: "default-preflight",
},
}
}
builtPreflight.Spec.Collectors = troubleshootcollect.DedupCollectors(builtPreflight.Spec.Collectors)
builtPreflight.Spec.Analyzers = troubleshootanalyze.DedupAnalyzers(builtPreflight.Spec.Analyzers)
registrySettings, err := store.GetStore().GetRegistryDetailsForApp(app.ID)
if err != nil {
return errors.Wrap(err, "failed to get registry settings for app")
}
InjectDefaultPreflights(builtPreflight, kotsKinds, registrySettings)
collectors, err := registry.UpdateCollectorSpecsWithRegistryData(builtPreflight.Spec.Collectors, registrySettings, kotsKinds.Installation, kotsKinds.License, &kotsKinds.KotsApplication)
if err != nil {
return errors.Wrap(err, "failed to rewrite images in preflight")
}
builtPreflight.Spec.Collectors = collectors
baseURL := os.Getenv("API_ADVERTISE_ENDPOINT")
if inCluster {
baseURL = os.Getenv("API_ENDPOINT")
} else if origin != "" {
baseURL = origin
}
builtPreflight.Spec.UploadResultsTo = fmt.Sprintf("%s/api/v1/preflight/app/%s/sequence/%d", baseURL, app.Slug, sequence)
s := serializer.NewYAMLSerializer(serializer.DefaultMetaFactory, scheme.Scheme, scheme.Scheme)
var b bytes.Buffer
if err := s.Encode(builtPreflight, &b); err != nil {
return errors.Wrap(err, "failed to encode preflight")
}
templatedSpec := b.Bytes()
renderedSpec, err := helper.RenderAppFile(app, &sequence, templatedSpec, kotsKinds, util.PodNamespace)
if err != nil {
return errors.Wrap(err, "failed render preflight spec")
}
clientset, err := k8sutil.GetClientset()
if err != nil {
return errors.Wrap(err, "failed to get k8s clientset")
}
secretName := GetSpecSecretName(app.Slug)
existingSecret, err := clientset.CoreV1().Secrets(util.PodNamespace).Get(context.TODO(), secretName, metav1.GetOptions{})
if err != nil && !kuberneteserrors.IsNotFound(err) {
return errors.Wrap(err, "failed to read preflight secret")
} else if kuberneteserrors.IsNotFound(err) {
secret := &corev1.Secret{
TypeMeta: metav1.TypeMeta{
APIVersion: "v1",
Kind: "Secret",
},
ObjectMeta: metav1.ObjectMeta{
Name: secretName,
Namespace: util.PodNamespace,
Labels: kotstypes.GetKotsadmLabels(),
},
Data: map[string][]byte{
SpecDataKey: renderedSpec,
},
}
_, err = clientset.CoreV1().Secrets(util.PodNamespace).Create(context.TODO(), secret, metav1.CreateOptions{})
if err != nil {
return errors.Wrap(err, "failed to create preflight secret")
}
return nil
}
if existingSecret.Data == nil {
existingSecret.Data = map[string][]byte{}
}
existingSecret.Data[SpecDataKey] = renderedSpec
existingSecret.ObjectMeta.Labels = kotstypes.GetKotsadmLabels()
_, err = clientset.CoreV1().Secrets(util.PodNamespace).Update(context.TODO(), existingSecret, metav1.UpdateOptions{})
if err != nil {
return errors.Wrap(err, "failed to update preflight secret")
}
return nil
}
func InjectDefaultPreflights(preflight *troubleshootv1beta2.Preflight, kotskinds *kotsutil.KotsKinds, registrySettings registrytypes.RegistrySettings) {
if registrySettings.IsValid() && registrySettings.IsReadOnly {
// Get images from Installation.KnownImages, see UpdateCollectorSpecsWithRegistryData
images := []string{}
for _, image := range kotskinds.Installation.Spec.KnownImages {
images = append(images, image.Image)
}
preflight.Spec.Collectors = append(preflight.Spec.Collectors, &troubleshootv1beta2.Collect{
RegistryImages: &troubleshootv1beta2.RegistryImages{
Images: images,
},
})
preflight.Spec.Analyzers = append(preflight.Spec.Analyzers, &troubleshootv1beta2.Analyze{
RegistryImages: &troubleshootv1beta2.RegistryImagesAnalyze{
AnalyzeMeta: troubleshootv1beta2.AnalyzeMeta{
CheckName: "Private Registry Images Available",
},
Outcomes: []*troubleshootv1beta2.Outcome{
{
Fail: &troubleshootv1beta2.SingleOutcome{
When: "missing > 0",
Message: "Application uses images that cannot be found in the private registry",
},
},
{
Warn: &troubleshootv1beta2.SingleOutcome{
When: "errors > 0",
Message: "Availability of application images in the private registry could not be verified.",
},
},
{
Pass: &troubleshootv1beta2.SingleOutcome{
Message: "All images used by the application are present in the private registry",
},
},
},
},
})
}
if kotskinds.Installer != nil {
if deployedInstaller, err := installers.GetDeployedInstaller(); err == nil {
injectInstallerPreflightIfPresent(preflight, deployedInstaller, kotskinds.Installer)
} else {
logger.Error(errors.Wrap(err, "failed to get deployed installer"))
}
}
}
func injectInstallerPreflightIfPresent(preflight *troubleshootv1beta2.Preflight, deployedInstaller *kurlv1beta1.Installer, releaseInstaller *kurlv1beta1.Installer) {
for _, analyzer := range preflight.Spec.Analyzers {
if analyzer.YamlCompare != nil && analyzer.YamlCompare.Annotations["kots.io/installer"] != "" {
err := injectInstallerPreflight(preflight, analyzer, deployedInstaller, releaseInstaller)
if err != nil {
logger.Error(errors.Wrap(err, "failed to inject installer preflight"))
}
}
}
}
func injectInstallerPreflight(preflight *troubleshootv1beta2.Preflight, analyzer *troubleshootv1beta2.Analyze, deployedInstaller *kurlv1beta1.Installer, releaseInstaller *kurlv1beta1.Installer) error {
if releaseInstaller.Spec.Kurl != nil {
if releaseInstaller.Spec.Kurl.AdditionalNoProxyAddresses == nil {
// if this is nil, it will be set to an empty string slice by kurl, so lets do so before comparing
releaseInstaller.Spec.Kurl.AdditionalNoProxyAddresses = []string{}
}
}
if releaseInstaller.Spec.Kotsadm != nil {
if releaseInstaller.Spec.Kotsadm.ApplicationSlug == "" {
// application slug may be injected into the deployed installer, so remove it if not specified in release installer
deployedInstaller.Spec.Kotsadm.ApplicationSlug = ""
}
}
// Inject deployed installer spec as collected data
deployedInstallerSpecYaml, err := yaml.Marshal(deployedInstaller.Spec)
if err != nil {
return errors.Wrap(err, "failed to marshal deployed installer")
}
preflight.Spec.Collectors = append(preflight.Spec.Collectors, &troubleshootv1beta2.Collect{
Data: &troubleshootv1beta2.Data{
Name: "kurl/installer.yaml",
Data: string(deployedInstallerSpecYaml),
},
})
// Inject release installer spec as analyzer value
releaseInstallerSpecYaml, err := yaml.Marshal(releaseInstaller.Spec)
if err != nil {
return errors.Wrap(err, "failed to marshal release installer")
}
analyzer.YamlCompare.FileName = "kurl/installer.yaml"
analyzer.YamlCompare.Value = string(releaseInstallerSpecYaml)
return nil
}