/* 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 api import ( "encoding/json" "errors" "io/ioutil" "os" "path/filepath" "strings" "time" "github.com/ghodss/yaml" corev1 "k8s.io/api/core/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "github.com/oam-dev/kubevela/apis/core.oam.dev/common" "github.com/oam-dev/kubevela/apis/core.oam.dev/v1alpha2" "github.com/oam-dev/kubevela/apis/core.oam.dev/v1beta1" "github.com/oam-dev/kubevela/apis/types" "github.com/oam-dev/kubevela/pkg/appfile/config" "github.com/oam-dev/kubevela/pkg/builtin" "github.com/oam-dev/kubevela/pkg/oam" cmdutil "github.com/oam-dev/kubevela/pkg/utils/util" "github.com/oam-dev/kubevela/references/appfile/template" ) // error msg used in Appfile var ( ErrImageNotDefined = errors.New("image not defined") ) // DefaultAppfilePath defines the default file path that used by `vela up` command const ( DefaultJSONAppfilePath = "./vela.json" DefaultAppfilePath = "./vela.yaml" DefaultUnknowFormatAppfilePath = "./Appfile" ) const ( // DefaultHealthScopeKey is the key in application for default health scope DefaultHealthScopeKey = "healthscopes.core.oam.dev" ) // AppFile defines the spec of KubeVela Appfile type AppFile struct { Name string `json:"name"` CreateTime time.Time `json:"createTime,omitempty"` UpdateTime time.Time `json:"updateTime,omitempty"` Services map[string]Service `json:"services"` Secrets map[string]string `json:"secrets,omitempty"` configGetter config.Store initialized bool } // NewAppFile init an empty AppFile struct func NewAppFile() *AppFile { return &AppFile{ Services: make(map[string]Service), Secrets: make(map[string]string), configGetter: &config.Local{}, } } // Load will load appfile from default path func Load() (*AppFile, error) { if _, err := os.Stat(DefaultAppfilePath); err == nil { return LoadFromFile(DefaultAppfilePath) } if _, err := os.Stat(DefaultJSONAppfilePath); err == nil { return LoadFromFile(DefaultJSONAppfilePath) } return LoadFromFile(DefaultUnknowFormatAppfilePath) } // JSONToYaml will convert JSON format appfile to yaml and load the AppFile struct func JSONToYaml(data []byte, appFile *AppFile) (*AppFile, error) { j, e := yaml.JSONToYAML(data) if e != nil { return nil, e } err := yaml.Unmarshal(j, appFile) if err != nil { return nil, err } return appFile, nil } // LoadFromFile will read the file and load the AppFile struct func LoadFromFile(filename string) (*AppFile, error) { b, err := ioutil.ReadFile(filepath.Clean(filename)) if err != nil { return nil, err } af := NewAppFile() // Add JSON format appfile support ext := filepath.Ext(filename) switch ext { case ".yaml", ".yml": err = yaml.Unmarshal(b, af) case ".json": af, err = JSONToYaml(b, af) default: if json.Valid(b) { af, err = JSONToYaml(b, af) } else { err = yaml.Unmarshal(b, af) } } if err != nil { return nil, err } return af, nil } // ExecuteAppfileTasks will execute built-in tasks(such as image builder, etc.) and generate locally executed application func (app *AppFile) ExecuteAppfileTasks(io cmdutil.IOStreams) error { if app.initialized { return nil } for name, svc := range app.Services { newSvc, err := builtin.RunBuildInTasks(svc, io) if err != nil { return err } app.Services[name] = newSvc } app.initialized = true return nil } // BuildOAMApplication renders Appfile into Application, Scopes and other K8s Resources. func (app *AppFile) BuildOAMApplication(env *types.EnvMeta, io cmdutil.IOStreams, tm template.Manager, silence bool) (*v1beta1.Application, []oam.Object, error) { if err := app.ExecuteAppfileTasks(io); err != nil { if strings.Contains(err.Error(), "'image' : not found") { return nil, nil, ErrImageNotDefined } return nil, nil, err } // auxiliaryObjects currently include OAM Scope Custom Resources and ConfigMaps var auxiliaryObjects []oam.Object servApp := new(v1beta1.Application) servApp.SetNamespace(env.Namespace) servApp.SetName(app.Name) servApp.Spec.Components = []common.ApplicationComponent{} for serviceName, svc := range app.GetServices() { if !silence { io.Infof("\nRendering configs for service (%s)...\n", serviceName) } configname := svc.GetUserConfigName() if configname != "" { configData, err := app.configGetter.GetConfigData(configname, env.Name) if err != nil { return nil, nil, err } decodedData, err := config.DecodeConfigFormat(configData) if err != nil { return nil, nil, err } cm, err := config.ToConfigMap(app.configGetter, config.GenConfigMapName(app.Name, serviceName, configname), env.Name, decodedData) if err != nil { return nil, nil, err } auxiliaryObjects = append(auxiliaryObjects, cm) } comp, err := svc.RenderServiceToApplicationComponent(tm, serviceName) if err != nil { return nil, nil, err } servApp.Spec.Components = append(servApp.Spec.Components, comp) } servApp.SetGroupVersionKind(v1beta1.SchemeGroupVersion.WithKind("Application")) auxiliaryObjects = append(auxiliaryObjects, addDefaultHealthScopeToApplication(servApp)) return servApp, auxiliaryObjects, nil } func addDefaultHealthScopeToApplication(app *v1beta1.Application) *v1alpha2.HealthScope { health := &v1alpha2.HealthScope{ TypeMeta: metav1.TypeMeta{ APIVersion: v1alpha2.HealthScopeGroupVersionKind.GroupVersion().String(), Kind: v1alpha2.HealthScopeKind, }, } health.Name = FormatDefaultHealthScopeName(app.Name) health.Namespace = app.Namespace health.Spec.WorkloadReferences = make([]corev1.ObjectReference, 0) for i := range app.Spec.Components { // FIXME(wonderflow): the hardcode health scope should be fixed. app.Spec.Components[i].Scopes = map[string]string{DefaultHealthScopeKey: health.Name} } return health } // FormatDefaultHealthScopeName will create a default health scope name. func FormatDefaultHealthScopeName(appName string) string { return appName + "-default-health" }