/
capability.go
507 lines (475 loc) · 15.9 KB
/
capability.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
/*
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 common
import (
"context"
"encoding/json"
"errors"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"strings"
"github.com/oam-dev/kubevela/pkg/utils/common"
corev1 "k8s.io/api/core/v1"
"github.com/ghodss/yaml"
apierrors "k8s.io/apimachinery/pkg/api/errors"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"github.com/oam-dev/kubevela/apis/core.oam.dev/v1beta1"
"github.com/oam-dev/kubevela/apis/types"
"github.com/oam-dev/kubevela/pkg/oam/discoverymapper"
"github.com/oam-dev/kubevela/pkg/oam/util"
"github.com/oam-dev/kubevela/pkg/utils/helm"
"github.com/oam-dev/kubevela/pkg/utils/system"
cmdutil "github.com/oam-dev/kubevela/pkg/utils/util"
"github.com/oam-dev/kubevela/references/apiserver/apis"
"github.com/oam-dev/kubevela/references/plugins"
)
// AddCapabilityCenter will add a cap center
func AddCapabilityCenter(capName, capURL, capToken string) error {
repos, err := plugins.LoadRepos()
if err != nil {
return err
}
config := &plugins.CapCenterConfig{
Name: capName,
Address: capURL,
Token: capToken,
}
var updated bool
for idx, r := range repos {
if r.Name == config.Name {
repos[idx] = *config
updated = true
break
}
}
if !updated {
repos = append(repos, *config)
}
if err = plugins.StoreRepos(repos); err != nil {
return err
}
return SyncCapabilityFromCenter(capName, capURL, capToken)
}
// SyncCapabilityFromCenter will sync all capabilities from center
func SyncCapabilityFromCenter(capName, capURL, capToken string) error {
client, err := plugins.NewCenterClient(context.Background(), capName, capURL, capToken)
if err != nil {
return err
}
return client.SyncCapabilityFromCenter()
}
// AddCapabilityIntoCluster will add a capability into K8s cluster, it is equal to apply a definition yaml and run `vela workloads/traits`
func AddCapabilityIntoCluster(c client.Client, mapper discoverymapper.DiscoveryMapper, capability string) (string, error) {
ss := strings.Split(capability, "/")
if len(ss) < 2 {
return "", errors.New("invalid format for " + capability + ", please follow format <center>/<name>")
}
repoName := ss[0]
name := ss[1]
ioStreams := cmdutil.IOStreams{In: os.Stdin, Out: os.Stdout, ErrOut: os.Stderr}
if err := InstallCapability(c, mapper, repoName, name, ioStreams); err != nil {
return "", err
}
return fmt.Sprintf("Successfully installed capability %s from %s", name, repoName), nil
}
// InstallCapability will add a cap into K8s cluster and install it's controller(helm charts)
func InstallCapability(client client.Client, mapper discoverymapper.DiscoveryMapper, centerName, capabilityName string, ioStreams cmdutil.IOStreams) error {
dir, _ := system.GetCapCenterDir()
repoDir := filepath.Join(dir, centerName)
tp, err := GetCapabilityFromCenter(mapper, centerName, capabilityName)
if err != nil {
return err
}
defDir, _ := system.GetCapabilityDir()
fileContent, err := ioutil.ReadFile(filepath.Clean(filepath.Join(repoDir, tp.Name+".yaml")))
if err != nil {
return err
}
switch tp.Type {
case types.TypeComponentDefinition:
err = InstallComponentDefinition(client, fileContent, ioStreams, &tp)
if err != nil {
return err
}
case types.TypeTrait:
err = InstallTraitDefinition(client, mapper, fileContent, ioStreams, &tp)
if err != nil {
return err
}
case types.TypeScope:
// TODO(wonderflow): support install scope here
case types.TypeWorkload:
return fmt.Errorf("unsupported capability type %v", types.TypeWorkload)
default:
return fmt.Errorf("unsupported type: %v", tp.Type)
}
success := plugins.SinkTemp2Local([]types.Capability{tp}, defDir)
if success == 1 {
ioStreams.Infof("Successfully installed capability %s from %s\n", capabilityName, centerName)
}
return nil
}
// InstallComponentDefinition will add a component into K8s cluster and install it's controller
func InstallComponentDefinition(client client.Client, workloadData []byte, ioStreams cmdutil.IOStreams, tp *types.Capability) error {
var cd v1beta1.ComponentDefinition
var err error
if err = yaml.Unmarshal(workloadData, &cd); err != nil {
return err
}
cd.Namespace = types.DefaultKubeVelaNS
ioStreams.Info("Installing component capability " + cd.Name)
if tp.Install != nil {
tp.Source.ChartName = tp.Install.Helm.Name
if err = helm.InstallHelmChart(ioStreams, tp.Install.Helm); err != nil {
return err
}
err = addSourceIntoExtension(cd.Spec.Extension, tp.Source)
if err != nil {
return err
}
}
if cd.Spec.Workload.Type == "" {
tp.CrdInfo = &types.CRDInfo{
APIVersion: cd.Spec.Workload.Definition.APIVersion,
Kind: cd.Spec.Workload.Definition.Kind,
}
}
if err = client.Create(context.Background(), &cd); err != nil && !apierrors.IsAlreadyExists(err) {
return err
}
return nil
}
// InstallTraitDefinition will add a trait into K8s cluster and install it's controller
func InstallTraitDefinition(client client.Client, mapper discoverymapper.DiscoveryMapper, traitdata []byte, ioStreams cmdutil.IOStreams, tp *types.Capability) error {
var td v1beta1.TraitDefinition
var err error
if err = yaml.Unmarshal(traitdata, &td); err != nil {
return err
}
td.Namespace = types.DefaultKubeVelaNS
ioStreams.Info("Installing trait capability " + td.Name)
if tp.Install != nil {
tp.Source.ChartName = tp.Install.Helm.Name
if err = helm.InstallHelmChart(ioStreams, tp.Install.Helm); err != nil {
return err
}
err = addSourceIntoExtension(td.Spec.Extension, tp.Source)
if err != nil {
return err
}
}
if err = HackForStandardTrait(*tp, client); err != nil {
return err
}
gvk, err := util.GetGVKFromDefinition(mapper, td.Spec.Reference)
if err != nil {
return err
}
tp.CrdInfo = &types.CRDInfo{
APIVersion: gvk.GroupVersion().String(),
Kind: gvk.Kind,
}
if err = client.Create(context.Background(), &td); err != nil && !apierrors.IsAlreadyExists(err) {
return err
}
return nil
}
// HackForStandardTrait will do some hack install for standard capability
func HackForStandardTrait(tp types.Capability, client client.Client) error {
switch tp.Name {
case "metrics":
// metrics trait will rely on a Prometheus instance to be installed
// make sure the chart is a prometheus operator
if tp.Install == nil {
break
}
if tp.Install.Helm.Namespace == "monitoring" && tp.Install.Helm.Name == "kube-prometheus-stack" {
if err := InstallPrometheusInstance(client); err != nil {
return err
}
}
default:
}
return nil
}
// GetCapabilityFromCenter will list all synced capabilities from cap center and return the specified one
func GetCapabilityFromCenter(mapper discoverymapper.DiscoveryMapper, repoName, addonName string) (types.Capability, error) {
dir, _ := system.GetCapCenterDir()
repoDir := filepath.Join(dir, repoName)
templates, err := plugins.LoadCapabilityFromSyncedCenter(mapper, repoDir)
if err != nil {
return types.Capability{}, err
}
for _, t := range templates {
if t.Name == addonName {
t.Source = &types.Source{RepoName: repoName}
return t, nil
}
}
return types.Capability{}, fmt.Errorf("%s/%s not exist, try 'vela cap center sync %s' to sync from remote", repoName, addonName, repoName)
}
// ListCapabilityCenters will list all capabilities from center
func ListCapabilityCenters() ([]apis.CapabilityCenterMeta, error) {
var capabilityCenterList []apis.CapabilityCenterMeta
centers, err := plugins.LoadRepos()
if err != nil {
return capabilityCenterList, err
}
for _, c := range centers {
capabilityCenterList = append(capabilityCenterList, apis.CapabilityCenterMeta{
Name: c.Name,
URL: c.Address,
})
}
return capabilityCenterList, nil
}
// SyncCapabilityCenter will sync capabilities from center to local
func SyncCapabilityCenter(capabilityCenterName string) error {
repos, err := plugins.LoadRepos()
if err != nil {
return err
}
if len(repos) == 0 {
return fmt.Errorf("no capability center configured")
}
find := false
if capabilityCenterName != "" {
for idx, r := range repos {
if r.Name == capabilityCenterName {
repos = []plugins.CapCenterConfig{repos[idx]}
find = true
break
}
}
if !find {
return fmt.Errorf("%s center not exist", capabilityCenterName)
}
}
ctx := context.Background()
for _, d := range repos {
client, err := plugins.NewCenterClient(ctx, d.Name, d.Address, d.Token)
if err != nil {
return err
}
err = client.SyncCapabilityFromCenter()
if err != nil {
return err
}
}
return nil
}
// RemoveCapabilityFromCluster will remove a capability from cluster.
// 1. remove definition 2. uninstall chart 3. remove local files
func RemoveCapabilityFromCluster(userNamespace string, c common.Args, client client.Client, capabilityName string) (string, error) {
ioStreams := cmdutil.IOStreams{In: os.Stdin, Out: os.Stdout, ErrOut: os.Stderr}
if err := RemoveCapability(userNamespace, c, client, capabilityName, ioStreams); err != nil {
return "", err
}
msg := fmt.Sprintf("%s removed successfully", capabilityName)
return msg, nil
}
// RemoveCapability will remove a capability from cluster.
// 1. remove definition 2. uninstall chart 3. remove local files
func RemoveCapability(userNamespace string, c common.Args, client client.Client, capabilityName string, ioStreams cmdutil.IOStreams) error {
// TODO(wonderflow): make sure no apps is using this capability
caps, err := plugins.LoadAllInstalledCapability(userNamespace, c)
if err != nil {
return err
}
for _, w := range caps {
if w.Name == capabilityName {
return uninstallCap(client, w, ioStreams)
}
}
return errors.New(capabilityName + " not exist")
}
func uninstallCap(client client.Client, cap types.Capability, ioStreams cmdutil.IOStreams) error {
// 1. Remove WorkloadDefinition or TraitDefinition
ctx := context.Background()
var obj runtime.Object
switch cap.Type {
case types.TypeTrait:
obj = &v1beta1.TraitDefinition{ObjectMeta: v1.ObjectMeta{Name: cap.Name, Namespace: types.DefaultKubeVelaNS}}
case types.TypeWorkload:
obj = &v1beta1.WorkloadDefinition{ObjectMeta: v1.ObjectMeta{Name: cap.Name, Namespace: types.DefaultKubeVelaNS}}
case types.TypeScope:
return fmt.Errorf("uninstall scope capability was not supported yet")
case types.TypeComponentDefinition:
obj = &v1beta1.ComponentDefinition{ObjectMeta: v1.ObjectMeta{Name: cap.Name, Namespace: types.DefaultKubeVelaNS}}
default:
return fmt.Errorf("unsupported type: %v", cap.Type)
}
if err := client.Delete(ctx, obj); err != nil {
return err
}
if cap.Install != nil && cap.Install.Helm.Name != "" {
// 2. Remove Helm chart if there is
if cap.Install.Helm.Namespace == "" {
cap.Install.Helm.Namespace = types.DefaultKubeVelaNS
}
if err := helm.Uninstall(ioStreams, cap.Install.Helm.Name, cap.Install.Helm.Namespace, cap.Name); err != nil {
return err
}
}
// 3. Remove local capability file
capdir, _ := system.GetCapabilityDir()
switch cap.Type {
case types.TypeTrait:
if err := os.Remove(filepath.Join(capdir, "traits", cap.Name)); err != nil {
return err
}
case types.TypeWorkload:
if err := os.Remove(filepath.Join(capdir, "workloads", cap.Name)); err != nil {
return err
}
case types.TypeScope:
// TODO(wonderflow): add scope remove here.
case types.TypeComponentDefinition:
if err := os.Remove(filepath.Join(capdir, "components", cap.Name)); err != nil {
return err
}
default:
return fmt.Errorf("unsupported type: %v", cap.Type)
}
ioStreams.Infof("Successfully uninstalled capability %s", cap.Name)
return nil
}
// ListCapabilities will list all caps from specified center
func ListCapabilities(userNamespace string, c common.Args, capabilityCenterName string) ([]types.Capability, error) {
var capabilityList []types.Capability
dir, err := system.GetCapCenterDir()
if err != nil {
return capabilityList, err
}
if capabilityCenterName != "" {
return listCenterCapabilities(userNamespace, c, filepath.Join(dir, capabilityCenterName))
}
dirs, err := ioutil.ReadDir(dir)
if err != nil {
return capabilityList, err
}
for _, dd := range dirs {
if !dd.IsDir() {
continue
}
caps, err := listCenterCapabilities(userNamespace, c, filepath.Join(dir, dd.Name()))
if err != nil {
return capabilityList, err
}
capabilityList = append(capabilityList, caps...)
}
return capabilityList, nil
}
func listCenterCapabilities(userNamespace string, c common.Args, repoDir string) ([]types.Capability, error) {
dm, err := c.GetDiscoveryMapper()
if err != nil {
return nil, err
}
templates, err := plugins.LoadCapabilityFromSyncedCenter(dm, repoDir)
if err != nil {
return templates, err
}
if len(templates) < 1 {
return templates, nil
}
baseDir := filepath.Base(repoDir)
workloads := gatherComponents(userNamespace, c, templates)
for i, p := range templates {
status := checkInstallStatus(userNamespace, c, baseDir, p)
convertedApplyTo := ConvertApplyTo(p.AppliesTo, workloads)
templates[i].Center = baseDir
templates[i].Status = status
templates[i].AppliesTo = convertedApplyTo
}
return templates, nil
}
// RemoveCapabilityCenter will remove a cap center from local
func RemoveCapabilityCenter(centerName string) (string, error) {
var message string
var err error
dir, _ := system.GetCapCenterDir()
repoDir := filepath.Join(dir, centerName)
// 1.remove capability center dir
if _, err := os.Stat(repoDir); err != nil {
if os.IsNotExist(err) {
err = fmt.Errorf("%s capability center has not successfully synced", centerName)
return message, err
}
}
if err = os.RemoveAll(repoDir); err != nil {
return message, err
}
// 2.remove center from capability center config
repos, err := plugins.LoadRepos()
if err != nil {
return message, err
}
for idx, r := range repos {
if r.Name == centerName {
repos = append(repos[:idx], repos[idx+1:]...)
break
}
}
if err = plugins.StoreRepos(repos); err != nil {
return message, err
}
message = fmt.Sprintf("%s capability center removed successfully", centerName)
return message, err
}
func gatherComponents(userNamespace string, c common.Args, templates []types.Capability) []types.Capability {
workloads, err := plugins.LoadInstalledCapabilityWithType(userNamespace, c, types.TypeComponentDefinition)
if err != nil {
workloads = make([]types.Capability, 0)
}
for _, t := range templates {
if t.Type == types.TypeComponentDefinition {
workloads = append(workloads, t)
}
}
return workloads
}
func checkInstallStatus(userNamespace string, c common.Args, repoName string, tmp types.Capability) string {
var status = "uninstalled"
installed, _ := plugins.LoadInstalledCapabilityWithType(userNamespace, c, tmp.Type)
for _, i := range installed {
if i.Source != nil && i.Source.RepoName == repoName && i.Name == tmp.Name && i.CrdName == tmp.CrdName {
return "installed"
}
}
return status
}
func addSourceIntoExtension(in *runtime.RawExtension, source *types.Source) error {
var extension map[string]interface{}
err := json.Unmarshal(in.Raw, &extension)
if err != nil {
return err
}
extension["source"] = source
data, err := json.Marshal(extension)
if err != nil {
return err
}
in.Raw = data
return nil
}
// GetCapabilityConfigMap gets the ConfigMap which stores the information of a capability
func GetCapabilityConfigMap(kubeClient client.Client, capabilityName string) (corev1.ConfigMap, error) {
cmName := fmt.Sprintf("%s%s", types.CapabilityConfigMapNamePrefix, capabilityName)
var cm corev1.ConfigMap
err := kubeClient.Get(context.Background(), client.ObjectKey{Namespace: types.DefaultKubeVelaNS, Name: cmName}, &cm)
return cm, err
}