/
addon.go
1931 lines (1744 loc) · 60.7 KB
/
addon.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
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright 2021 The KubeVela Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package addon
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"path"
"path/filepath"
"sort"
"strings"
"sync"
"time"
"github.com/Masterminds/semver/v3"
"github.com/google/go-github/v32/github"
"github.com/imdario/mergo"
"github.com/kubevela/workflow/pkg/cue/model/value"
"github.com/pkg/errors"
"github.com/xanzy/go-gitlab"
"go.uber.org/multierr"
"golang.org/x/oauth2"
"helm.sh/helm/v3/pkg/chart/loader"
"helm.sh/helm/v3/pkg/chartutil"
appsv1 "k8s.io/api/apps/v1"
v1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
k8syaml "k8s.io/apimachinery/pkg/runtime/serializer/yaml"
types2 "k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/client-go/discovery"
"k8s.io/client-go/rest"
"k8s.io/client-go/util/retry"
"k8s.io/klog/v2"
stringslices "k8s.io/utils/strings/slices"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/yaml"
common2 "github.com/oam-dev/kubevela/apis/core.oam.dev/common"
"github.com/oam-dev/kubevela/apis/core.oam.dev/v1beta1"
"github.com/oam-dev/kubevela/apis/types"
"github.com/oam-dev/kubevela/pkg/config"
"github.com/oam-dev/kubevela/pkg/cue/script"
"github.com/oam-dev/kubevela/pkg/definition"
"github.com/oam-dev/kubevela/pkg/multicluster"
"github.com/oam-dev/kubevela/pkg/oam"
"github.com/oam-dev/kubevela/pkg/oam/util"
"github.com/oam-dev/kubevela/pkg/utils"
addonutil "github.com/oam-dev/kubevela/pkg/utils/addon"
"github.com/oam-dev/kubevela/pkg/utils/apply"
"github.com/oam-dev/kubevela/pkg/utils/common"
"github.com/oam-dev/kubevela/pkg/velaql"
version2 "github.com/oam-dev/kubevela/version"
)
const (
// ReadmeFileName is the addon readme file name
ReadmeFileName string = "README.md"
// LegacyReadmeFileName is the addon readme lower case file name
LegacyReadmeFileName string = "readme.md"
// MetadataFileName is the addon meatadata.yaml file name
MetadataFileName string = "metadata.yaml"
// TemplateFileName is the addon template.yaml file name
TemplateFileName string = "template.yaml"
// AppTemplateCueFileName is the addon application template.cue file name
AppTemplateCueFileName string = "template.cue"
// NotesCUEFileName is the addon notes print to end users when installed
NotesCUEFileName string = "NOTES.cue"
// KeyWordNotes is the keyword in NOTES.cue which will render the notes message out.
KeyWordNotes string = "notes"
// GlobalParameterFileName is the addon global parameter.cue file name
GlobalParameterFileName string = "parameter.cue"
// ResourcesDirName is the addon resources/ dir name
ResourcesDirName string = "resources"
// DefinitionsDirName is the addon definitions/ dir name
DefinitionsDirName string = "definitions"
// ConfigTemplateDirName is the addon config-templates/ dir name
ConfigTemplateDirName string = "config-templates"
// DefSchemaName is the addon definition schemas dir name
DefSchemaName string = "schemas"
// ViewDirName is the addon views dir name
ViewDirName string = "views"
// AddonParameterDataKey is the key of parameter in addon args secrets
AddonParameterDataKey string = "addonParameterDataKey"
// DefaultGiteeURL is the addon repository of gitee api
DefaultGiteeURL string = "https://gitee.com/api/v5/"
// InstallerRuntimeOption inject install runtime info into addon options
InstallerRuntimeOption string = "installerRuntimeOption"
// CUEExtension with the expected extension for CUE files
CUEExtension = ".cue"
)
// ParameterFileName is the addon resources/parameter.cue file name
var ParameterFileName = strings.Join([]string{"resources", "parameter.cue"}, "/")
// ListOptions contains flags mark what files should be read in an addon directory
type ListOptions struct {
GetDetail bool
GetDefinition bool
GetConfigTemplate bool
GetResource bool
GetParameter bool
GetTemplate bool
GetDefSchema bool
}
var (
// UIMetaOptions get Addon metadata for UI display
UIMetaOptions = ListOptions{GetDetail: true, GetDefinition: true, GetParameter: true, GetConfigTemplate: true}
// CLIMetaOptions get Addon metadata for CLI display
CLIMetaOptions = ListOptions{}
// UnInstallOptions used for addon uninstalling
UnInstallOptions = ListOptions{GetDefinition: true}
)
const (
// LocalAddonRegistryName is the addon-registry name for those installed by local dir
LocalAddonRegistryName = "local"
// ClusterLabelSelector define the key of topology cluster label selector
ClusterLabelSelector = "clusterLabelSelector"
)
// Pattern indicates the addon framework file pattern, all files should match at least one of the pattern.
type Pattern struct {
IsDir bool
Value string
}
// Patterns is the file pattern that the addon should be in
var Patterns = []Pattern{
// config-templates pattern
{IsDir: true, Value: ConfigTemplateDirName},
// single file reader pattern
{Value: ReadmeFileName}, {Value: MetadataFileName}, {Value: TemplateFileName},
// parameter in resource directory
{Value: ParameterFileName},
// directory files
{IsDir: true, Value: ResourcesDirName}, {IsDir: true, Value: DefinitionsDirName}, {IsDir: true, Value: DefSchemaName}, {IsDir: true, Value: ViewDirName},
// CUE app template, parameter and notes
{Value: AppTemplateCueFileName}, {Value: GlobalParameterFileName}, {Value: NotesCUEFileName},
{Value: LegacyReadmeFileName}}
// GetPatternFromItem will check if the file path has a valid pattern, return empty string if it's invalid.
// AsyncReader is needed to calculate relative path
func GetPatternFromItem(it Item, r AsyncReader, rootPath string) string {
relativePath := r.RelativePath(it)
for _, p := range Patterns {
if strings.HasPrefix(relativePath, strings.Join([]string{rootPath, p.Value}, "/")) {
return p.Value
}
if strings.HasPrefix(relativePath, filepath.Join(rootPath, p.Value)) {
// for enable addon by load dir, compatible with linux or windows os
return p.Value
}
}
return ""
}
// ListAddonUIDataFromReader list addons from AsyncReader
func ListAddonUIDataFromReader(r AsyncReader, registryMeta map[string]SourceMeta, registryName string, opt ListOptions) ([]*UIData, error) {
var addons []*UIData
var err error
var wg sync.WaitGroup
var errs []error
errCh := make(chan error)
waitCh := make(chan struct{})
var l sync.Mutex
for _, subItem := range registryMeta {
wg.Add(1)
go func(addonMeta SourceMeta) {
defer wg.Done()
addonRes, err := GetUIDataFromReader(r, &addonMeta, opt)
if err != nil {
errCh <- err
return
}
addonRes.RegistryName = registryName
l.Lock()
addons = append(addons, addonRes)
l.Unlock()
}(subItem)
}
// in another goroutine for wait group to finish
go func() {
wg.Wait()
close(waitCh)
}()
forLoop:
for {
select {
case <-waitCh:
break forLoop
case err = <-errCh:
errs = append(errs, err)
}
}
if len(errs) != 0 {
return addons, compactErrors("error(s) happen when reading from registry: ", errs)
}
return addons, nil
}
func compactErrors(message string, errs []error) error {
errForPrint := make([]string, 0)
for _, e := range errs {
errForPrint = append(errForPrint, e.Error())
}
return errors.New(message + strings.Join(errForPrint, ","))
}
// GetUIDataFromReader read ui metadata of addon from Reader, used to be displayed in UI
func GetUIDataFromReader(r AsyncReader, meta *SourceMeta, opt ListOptions) (*UIData, error) {
addonContentsReader := map[string]struct {
skip bool
read func(a *UIData, reader AsyncReader, readPath string) error
}{
ReadmeFileName: {!opt.GetDetail, readReadme},
LegacyReadmeFileName: {!opt.GetDetail, readReadme},
MetadataFileName: {false, readMetadata},
DefinitionsDirName: {!opt.GetDefinition, readDefFile},
ConfigTemplateDirName: {!opt.GetConfigTemplate, readConfigTemplateFile},
ParameterFileName: {!opt.GetParameter, readParamFile},
GlobalParameterFileName: {!opt.GetParameter, readGlobalParamFile},
}
ptItems := ClassifyItemByPattern(meta, r)
var addon = &UIData{}
for contentType, method := range addonContentsReader {
if method.skip {
continue
}
items := ptItems[contentType]
for _, it := range items {
err := method.read(addon, r, r.RelativePath(it))
if err != nil {
return nil, fmt.Errorf("fail to read addon %s file %s: %w", meta.Name, r.RelativePath(it), err)
}
}
}
if opt.GetParameter && (len(addon.Parameters) != 0 || len(addon.GlobalParameters) != 0) {
if addon.GlobalParameters != "" {
if addon.Parameters != "" {
klog.Warning("both legacy parameter and global parameter are provided, but only global parameter will be used. Consider removing the legacy parameters.")
}
addon.Parameters = addon.GlobalParameters
}
err := genAddonAPISchema(addon)
if err != nil {
return nil, fmt.Errorf("fail to generate openAPIschema for addon %s : %w (parameter: %s)", meta.Name, err, addon.Parameters)
}
}
addon.AvailableVersions = []string{addon.Version}
return addon, nil
}
// GetInstallPackageFromReader get install package of addon from Reader, this is used to enable an addon
func GetInstallPackageFromReader(r AsyncReader, meta *SourceMeta, uiData *UIData) (*InstallPackage, error) {
addonContentsReader := map[string]func(a *InstallPackage, reader AsyncReader, readPath string) error{
TemplateFileName: readTemplate,
ResourcesDirName: readResFile,
DefSchemaName: readDefSchemaFile,
ViewDirName: readViewFile,
AppTemplateCueFileName: readAppCueTemplate,
NotesCUEFileName: readNotesFile,
}
ptItems := ClassifyItemByPattern(meta, r)
// Read the installed data from UI metadata object to reduce network payload
var addon = &InstallPackage{
Meta: uiData.Meta,
Definitions: uiData.Definitions,
CUEDefinitions: uiData.CUEDefinitions,
Parameters: uiData.Parameters,
ConfigTemplates: uiData.ConfigTemplates,
}
for contentType, method := range addonContentsReader {
items := ptItems[contentType]
for _, it := range items {
err := method(addon, r, r.RelativePath(it))
if err != nil {
return nil, fmt.Errorf("fail to read addon %s file %s: %w", meta.Name, r.RelativePath(it), err)
}
}
}
return addon, nil
}
func readTemplate(a *InstallPackage, reader AsyncReader, readPath string) error {
data, err := reader.ReadFile(readPath)
if err != nil {
return err
}
dec := k8syaml.NewDecodingSerializer(unstructured.UnstructuredJSONScheme)
a.AppTemplate = &v1beta1.Application{}
// try to check it's a valid app template
_, _, err = dec.Decode([]byte(data), nil, a.AppTemplate)
if err != nil {
return err
}
return nil
}
func readAppCueTemplate(a *InstallPackage, reader AsyncReader, readPath string) error {
data, err := reader.ReadFile(readPath)
if err != nil {
return err
}
a.AppCueTemplate = ElementFile{Data: data, Name: filepath.Base(readPath)}
return nil
}
// readParamFile read single resource/parameter.cue file
func readParamFile(a *UIData, reader AsyncReader, readPath string) error {
b, err := reader.ReadFile(readPath)
if err != nil {
return err
}
a.Parameters = b
return nil
}
// readNotesFile read single NOTES.cue file
func readNotesFile(a *InstallPackage, reader AsyncReader, readPath string) error {
data, err := reader.ReadFile(readPath)
if err != nil {
return err
}
a.Notes = ElementFile{Data: data, Name: filepath.Base(readPath)}
return nil
}
// readGlobalParamFile read global parameter file.
func readGlobalParamFile(a *UIData, reader AsyncReader, readPath string) error {
b, err := reader.ReadFile(readPath)
if err != nil {
return err
}
a.GlobalParameters = b
return nil
}
// readResFile read single resource file
func readResFile(a *InstallPackage, reader AsyncReader, readPath string) error {
filename := path.Base(readPath)
b, err := reader.ReadFile(readPath)
if err != nil {
return err
}
if filename == "parameter.cue" {
return nil
}
file := ElementFile{Data: b, Name: filepath.Base(readPath)}
switch filepath.Ext(filename) {
case CUEExtension:
a.CUETemplates = append(a.CUETemplates, file)
case ".yaml", ".yml":
a.YAMLTemplates = append(a.YAMLTemplates, file)
default:
// skip other file formats
}
return nil
}
// readDefSchemaFile read single file of definition schema
func readDefSchemaFile(a *InstallPackage, reader AsyncReader, readPath string) error {
b, err := reader.ReadFile(readPath)
if err != nil {
return err
}
a.DefSchemas = append(a.DefSchemas, ElementFile{Data: b, Name: filepath.Base(readPath)})
return nil
}
// readDefFile read single definition file
func readDefFile(a *UIData, reader AsyncReader, readPath string) error {
b, err := reader.ReadFile(readPath)
if err != nil {
return err
}
filename := path.Base(readPath)
file := ElementFile{Data: b, Name: filepath.Base(readPath)}
switch filepath.Ext(filename) {
case CUEExtension:
a.CUEDefinitions = append(a.CUEDefinitions, file)
case ".yaml", ".yml":
a.Definitions = append(a.Definitions, file)
default:
// skip other file formats
}
return nil
}
// readConfigTemplateFile read single template file of the config
func readConfigTemplateFile(a *UIData, reader AsyncReader, readPath string) error {
b, err := reader.ReadFile(readPath)
if err != nil {
return err
}
filename := path.Base(readPath)
if filepath.Ext(filename) != CUEExtension {
return nil
}
file := ElementFile{Data: b, Name: filepath.Base(readPath)}
a.ConfigTemplates = append(a.ConfigTemplates, file)
return nil
}
// readViewFile read single view file
func readViewFile(a *InstallPackage, reader AsyncReader, readPath string) error {
b, err := reader.ReadFile(readPath)
if err != nil {
return err
}
filename := path.Base(readPath)
switch filepath.Ext(filename) {
case CUEExtension:
a.CUEViews = append(a.CUEViews, ElementFile{Data: b, Name: filepath.Base(readPath)})
case ".yaml", ".yml":
a.YAMLViews = append(a.YAMLViews, ElementFile{Data: b, Name: filepath.Base(readPath)})
default:
// skip other file formats
}
return nil
}
func readMetadata(a *UIData, reader AsyncReader, readPath string) error {
b, err := reader.ReadFile(readPath)
if err != nil {
return err
}
err = yaml.Unmarshal([]byte(b), &a.Meta)
if err != nil {
return err
}
return nil
}
func readReadme(a *UIData, reader AsyncReader, readPath string) error {
// the detail will contain readme.md or README.md, if the content already is filled, don't read another.
if len(a.Detail) != 0 {
return nil
}
content, err := reader.ReadFile(readPath)
if err != nil {
return err
}
a.Detail = content
return nil
}
func createGitHelper(content *utils.Content, token string) *gitHelper {
var ts oauth2.TokenSource
if token != "" {
ts = oauth2.StaticTokenSource(&oauth2.Token{AccessToken: token})
}
tc := oauth2.NewClient(context.Background(), ts)
tc.Timeout = time.Second * 20
cli := github.NewClient(tc)
return &gitHelper{
Client: cli,
Meta: content,
}
}
func createGiteeHelper(content *utils.Content, token string) *giteeHelper {
var ts oauth2.TokenSource
if token != "" {
ts = oauth2.StaticTokenSource(&oauth2.Token{AccessToken: token})
}
tc := oauth2.NewClient(context.Background(), ts)
tc.Timeout = time.Second * 20
cli := NewGiteeClient(tc, nil)
return &giteeHelper{
Client: cli,
Meta: content,
}
}
func createGitlabHelper(content *utils.Content, token string) (*gitlabHelper, error) {
newClient, err := gitlab.NewClient(token, gitlab.WithBaseURL(content.GitlabContent.Host))
return &gitlabHelper{
Client: newClient,
Meta: content,
}, err
}
// readRepo will read relative path (relative to Meta.Path)
func (h *gitHelper) readRepo(relativePath string) (*github.RepositoryContent, []*github.RepositoryContent, error) {
file, items, _, err := h.Client.Repositories.GetContents(context.Background(), h.Meta.GithubContent.Owner, h.Meta.GithubContent.Repo, path.Join(h.Meta.GithubContent.Path, relativePath), nil)
if err != nil {
return nil, nil, WrapErrRateLimit(err)
}
return file, items, nil
}
// readRepo will read relative path (relative to Meta.Path)
func (h *giteeHelper) readRepo(relativePath string) (*github.RepositoryContent, []*github.RepositoryContent, error) {
file, items, err := h.Client.GetGiteeContents(context.Background(), h.Meta.GiteeContent.Owner, h.Meta.GiteeContent.Repo, path.Join(h.Meta.GiteeContent.Path, relativePath), h.Meta.GiteeContent.Ref)
if err != nil {
return nil, nil, WrapErrRateLimit(err)
}
return file, items, nil
}
// GetGiteeContents can return either the metadata and content of a single file
func (c *Client) GetGiteeContents(ctx context.Context, owner, repo, path, ref string) (fileContent *github.RepositoryContent, directoryContent []*github.RepositoryContent, err error) {
escapedPath := (&url.URL{Path: path}).String()
u := fmt.Sprintf(c.BaseURL.String()+"repos/%s/%s/contents/%s", owner, repo, escapedPath)
if ref != "" {
u = fmt.Sprintf(u+"?ref=%s", ref)
}
req, err := http.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}
response, err := c.Client.Do(req.WithContext(ctx))
if err != nil {
return nil, nil, err
}
//nolint:errcheck
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil {
return nil, nil, err
}
return unmarshalToContent(body)
}
func unmarshalToContent(content []byte) (fileContent *github.RepositoryContent, directoryContent []*github.RepositoryContent, err error) {
fileUnmarshalError := json.Unmarshal(content, &fileContent)
if fileUnmarshalError == nil {
return fileContent, nil, nil
}
directoryUnmarshalError := json.Unmarshal(content, &directoryContent)
if directoryUnmarshalError == nil {
return nil, directoryContent, nil
}
return nil, nil, fmt.Errorf("unmarshalling failed for both file and directory content: %s and %w", fileUnmarshalError.Error(), directoryUnmarshalError)
}
func genAddonAPISchema(addonRes *UIData) error {
cueScript := script.CUE(addonRes.Parameters)
schema, err := cueScript.ParsePropertiesToSchema()
if err != nil {
return err
}
addonRes.APISchema = schema
return nil
}
func getClusters(args map[string]interface{}) []string {
ccr, ok := args[types.ClustersArg]
if !ok {
return nil
}
cc, ok := ccr.([]string)
if ok {
return cc
}
ccrslice, ok := ccr.([]interface{})
if !ok {
return nil
}
var ccstring []string
for _, c := range ccrslice {
if cstring, ok := c.(string); ok {
ccstring = append(ccstring, cstring)
}
}
return ccstring
}
// renderNeededNamespaceAsComps will convert namespace as app components to create namespace for managed clusters
func renderNeededNamespaceAsComps(addon *InstallPackage) []common2.ApplicationComponent {
var nscomps []common2.ApplicationComponent
// create namespace for managed clusters
for _, namespace := range addon.NeedNamespace {
// vela-system must exist before rendering vela addon
if namespace == types.DefaultKubeVelaNS {
continue
}
comp := common2.ApplicationComponent{
Type: "raw",
Name: fmt.Sprintf("%s-namespace", namespace),
Properties: util.Object2RawExtension(renderNamespace(namespace)),
}
nscomps = append(nscomps, comp)
}
return nscomps
}
func checkDeployClusters(ctx context.Context, k8sClient client.Client, args map[string]interface{}) ([]string, error) {
deployClusters := getClusters(args)
if len(deployClusters) == 0 || k8sClient == nil {
return nil, nil
}
clusters, err := multicluster.NewClusterClient(k8sClient).List(ctx)
if err != nil {
return nil, errors.Wrap(err, "fail to get registered cluster")
}
clusterNames := sets.Set[string]{}
if len(clusters.Items) != 0 {
for _, cluster := range clusters.Items {
clusterNames.Insert(cluster.Name)
}
}
var res []string
for _, c := range deployClusters {
c = strings.TrimSpace(c)
if c == "" {
continue
}
if !clusterNames.Has(c) {
return nil, errors.Errorf("cluster %s not exist", c)
}
res = append(res, c)
}
return res, nil
}
// RenderDefinitions render definition objects if needed
func RenderDefinitions(addon *InstallPackage, config *rest.Config) ([]*unstructured.Unstructured, error) {
defObjs := make([]*unstructured.Unstructured, 0)
// No matter runtime mode or control mode, definition only needs to control plane k8s.
for _, def := range addon.Definitions {
obj, err := renderObject(def)
if err != nil {
return nil, errors.Wrapf(err, "render definition file %s", def.Name)
}
// we should ignore the namespace defined in definition yaml, override the filed by DefaultKubeVelaNS
obj.SetNamespace(types.DefaultKubeVelaNS)
defObjs = append(defObjs, obj)
}
for _, cueDef := range addon.CUEDefinitions {
def := definition.Definition{Unstructured: unstructured.Unstructured{}}
err := def.FromCUEString(cueDef.Data, config)
if err != nil {
return nil, errors.Wrapf(err, "fail to render definition: %s in cue's format", cueDef.Name)
}
// we should ignore the namespace defined in definition yaml, override the filed by DefaultKubeVelaNS
def.SetNamespace(types.DefaultKubeVelaNS)
defObjs = append(defObjs, &def.Unstructured)
}
return defObjs, nil
}
// RenderConfigTemplates render the config template
func RenderConfigTemplates(addon *InstallPackage, cli client.Client) ([]*unstructured.Unstructured, error) {
templates := make([]*unstructured.Unstructured, 0)
factory := config.NewConfigFactory(cli)
for _, templateFile := range addon.ConfigTemplates {
t, err := factory.ParseTemplate("", []byte(templateFile.Data))
if err != nil {
return nil, err
}
t.ConfigMap.Namespace = types.DefaultKubeVelaNS
obj, err := util.Object2Unstructured(t.ConfigMap)
if err != nil {
return nil, err
}
obj.SetKind("ConfigMap")
obj.SetAPIVersion("v1")
templates = append(templates, obj)
}
return templates, nil
}
// RenderDefinitionSchema will render definitions' schema in addons.
func RenderDefinitionSchema(addon *InstallPackage) ([]*unstructured.Unstructured, error) {
schemaConfigmaps := make([]*unstructured.Unstructured, 0)
// No matter runtime mode or control mode , definition schemas only needs to control plane k8s.
for _, teml := range addon.DefSchemas {
u, err := renderSchemaConfigmap(teml)
if err != nil {
return nil, errors.Wrapf(err, "render uiSchema file %s", teml.Name)
}
schemaConfigmaps = append(schemaConfigmaps, u)
}
return schemaConfigmaps, nil
}
// RenderViews will render views in addons.
func RenderViews(addon *InstallPackage) ([]*unstructured.Unstructured, error) {
views := make([]*unstructured.Unstructured, 0)
for _, view := range addon.YAMLViews {
obj, err := renderObject(view)
if err != nil {
return nil, errors.Wrapf(err, "render velaQL view file %s", view.Name)
}
views = append(views, obj)
}
for _, view := range addon.CUEViews {
obj, err := renderCUEView(view)
if err != nil {
return nil, errors.Wrapf(err, "render velaQL view file %s", view.Name)
}
views = append(views, obj)
}
return views, nil
}
func renderObject(elem ElementFile) (*unstructured.Unstructured, error) {
obj := &unstructured.Unstructured{}
dec := k8syaml.NewDecodingSerializer(unstructured.UnstructuredJSONScheme)
_, _, err := dec.Decode([]byte(elem.Data), nil, obj)
if err != nil {
return nil, err
}
return obj, nil
}
func renderNamespace(namespace string) *unstructured.Unstructured {
u := &unstructured.Unstructured{}
u.SetAPIVersion("v1")
u.SetKind("Namespace")
u.SetName(namespace)
return u
}
func renderK8sObjectsComponent(elems []ElementFile, addonName string) (*common2.ApplicationComponent, error) {
var objects []*unstructured.Unstructured
for _, elem := range elems {
obj, err := renderObject(elem)
if err != nil {
return nil, errors.Wrapf(err, "render resource file %s", elem.Name)
}
objects = append(objects, obj)
}
properties := map[string]interface{}{"objects": objects}
propJSON, err := json.Marshal(properties)
if err != nil {
return nil, err
}
baseRawComponent := common2.ApplicationComponent{
Type: "k8s-objects",
Name: addonName + "-resources",
Properties: &runtime.RawExtension{Raw: propJSON},
}
return &baseRawComponent, nil
}
func renderSchemaConfigmap(elem ElementFile) (*unstructured.Unstructured, error) {
jsonData, err := yaml.YAMLToJSON([]byte(elem.Data))
if err != nil {
return nil, err
}
cm := v1.ConfigMap{
TypeMeta: metav1.TypeMeta{APIVersion: "v1", Kind: "ConfigMap"},
ObjectMeta: metav1.ObjectMeta{Namespace: types.DefaultKubeVelaNS, Name: strings.Split(elem.Name, ".")[0]},
Data: map[string]string{
types.UISchema: string(jsonData),
}}
return util.Object2Unstructured(cm)
}
func renderCUEView(elem ElementFile) (*unstructured.Unstructured, error) {
name, err := utils.GetFilenameFromLocalOrRemote(elem.Name)
if err != nil {
return nil, err
}
cm, err := velaql.ParseViewIntoConfigMap(elem.Data, name)
if err != nil {
return nil, err
}
return util.Object2Unstructured(*cm)
}
// RenderArgsSecret render addon enable argument to secret to remember when restart or upgrade
func RenderArgsSecret(addon *InstallPackage, args map[string]interface{}) *unstructured.Unstructured {
argsByte, err := json.Marshal(args)
if err != nil {
return nil
}
sec := v1.Secret{
TypeMeta: metav1.TypeMeta{APIVersion: "v1", Kind: "Secret"},
ObjectMeta: metav1.ObjectMeta{
Name: addonutil.Addon2SecName(addon.Name),
Namespace: types.DefaultKubeVelaNS,
},
Data: map[string][]byte{
AddonParameterDataKey: argsByte,
},
Type: v1.SecretTypeOpaque,
}
u, err := util.Object2Unstructured(sec)
if err != nil {
return nil
}
return u
}
// deleteArgsSecret delete the addon's args secret file
func deleteArgsSecret(ctx context.Context, k8sClient client.Client, addonName string) error {
var sec v1.Secret
if err := k8sClient.Get(ctx, client.ObjectKey{Namespace: types.DefaultKubeVelaNS, Name: addonutil.Addon2SecName(addonName)}, &sec); err == nil {
// Handle successful get operation
if deleteErr := k8sClient.Delete(ctx, &sec); deleteErr != nil {
return deleteErr
}
return nil
} else if !apierrors.IsNotFound(err) {
return err
}
return nil
}
// FetchArgsFromSecret fetch addon args from secrets
func FetchArgsFromSecret(sec *v1.Secret) (map[string]interface{}, error) {
res := map[string]interface{}{}
if args, ok := sec.Data[AddonParameterDataKey]; ok {
err := json.Unmarshal(args, &res)
if err != nil {
return nil, err
}
return res, nil
}
// this is backward compatibility code for old way to storage parameter
res = make(map[string]interface{}, len(sec.Data))
for k, v := range sec.Data {
res[k] = string(v)
}
return res, nil
}
// Installer helps addon enable, dependency-check, dispatch resources
type Installer struct {
ctx context.Context
config *rest.Config
addon *InstallPackage
cli client.Client
apply apply.Applicator
r *Registry
registryMeta map[string]SourceMeta
args map[string]interface{}
cache *Cache
dc *discovery.DiscoveryClient
skipVersionValidate bool
overrideDefs bool
dryRun bool
dryRunBuff *bytes.Buffer
installerRuntime map[string]interface{}
registries []Registry
}
// NewAddonInstaller will create an installer for addon
func NewAddonInstaller(ctx context.Context, cli client.Client, discoveryClient *discovery.DiscoveryClient, apply apply.Applicator, config *rest.Config, r *Registry, args map[string]interface{}, cache *Cache, registries []Registry, opts ...InstallOption) Installer {
if args == nil {
args = map[string]interface{}{}
}
i := Installer{
ctx: ctx,
config: config,
cli: cli,
apply: apply,
r: r,
args: args,
cache: cache,
dc: discoveryClient,
dryRunBuff: &bytes.Buffer{},
registries: registries,
}
ir := args[InstallerRuntimeOption]
if irr, ok := ir.(map[string]interface{}); ok {
i.installerRuntime = irr
} else {
i.installerRuntime = map[string]interface{}{}
}
// clean injected data from runtime option
delete(args, InstallerRuntimeOption)
for _, opt := range opts {
opt(&i)
}
return i
}
func (h *Installer) enableAddon(addon *InstallPackage) (string, error) {
var err error
h.addon = addon
if !h.skipVersionValidate {
err = checkAddonVersionMeetRequired(h.ctx, addon.SystemRequirements, h.cli, h.dc)
if err != nil {
version := h.getAddonVersionMeetSystemRequirement(addon.Name)
return "", VersionUnMatchError{addonName: addon.Name, err: err, userSelectedAddonVersion: addon.Version, availableVersion: version}
}
}
if err = h.installDependency(addon); err != nil {
return "", err
}
if err = h.dispatchAddonResource(addon); err != nil {
return "", err
}
// we shouldn't put continue func into dispatchAddonResource, because the re-apply app maybe already update app and
// the suspend will set with false automatically
if err := h.continueOrRestartWorkflow(); err != nil {
return "", err
}
additionalInfo, err := h.renderNotes(addon)
if err != nil {
klog.Warningf("fail to render notes for addon %s: %v\n", addon.Name, err)
// notes don't affect the installation, so just print warn logs instead of abort with errors
return "", nil
}
return additionalInfo, nil
}
func (h *Installer) loadInstallPackage(name, version string) (*InstallPackage, error) {
var installPackage *InstallPackage
var err error
if !IsVersionRegistry(*h.r) {
metas, err := h.getAddonMeta()
if err != nil {
return nil, errors.Wrap(err, "fail to get addon meta")
}
meta, ok := metas[name]
if !ok {
return nil, ErrNotExist
}
var uiData *UIData
uiData, err = h.cache.GetUIData(*h.r, name, version)
if err != nil {
return nil, err
}
// enable this addon if it's invisible
installPackage, err = h.r.GetInstallPackage(&meta, uiData)
if err != nil {
return nil, errors.Wrap(err, "fail to find dependent addon in source repository")
}
} else {
versionedRegistry := BuildVersionedRegistry(h.r.Name, h.r.Helm.URL, &common.HTTPOption{
Username: h.r.Helm.Username,
Password: h.r.Helm.Password,
InsecureSkipTLS: h.r.Helm.InsecureSkipTLS,
})