api

Documentation

Index

• Constants
• Variables
• func FormatDefaultHealthScopeName(appName string) string
• type AppFile
  • func JSONToYaml(data []byte, appFile *AppFile) (*AppFile, error)
  • func Load() (*AppFile, error)
  • func LoadFromFile(filename string) (*AppFile, error)
  • func NewAppFile() *AppFile
  • func (app *AppFile) BuildOAMApplication(env *types.EnvMeta, io cmdutil.IOStreams, tm template.Manager, silence bool) (*v1alpha2.Application, []oam.Object, error)
  • func (app *AppFile) ExecuteAppfileTasks(io cmdutil.IOStreams) error
  • func (af *AppFile) GetServices() map[string]Service
• type Application
• type Driver
• type Service
  • func (s Service) GetApplicationConfig() map[string]interface{}
  • func (s Service) GetType() string
  • func (s Service) GetUserConfigName() string
  • func (s Service) RenderServiceToApplicationComponent(tm template.Manager, serviceName string) (v1alpha2.ApplicationComponent, error)

Constants

const (
	DefaultJSONAppfilePath         = "./vela.json"
	DefaultAppfilePath             = "./vela.yaml"
	DefaultUnknowFormatAppfilePath = "./Appfile"
)

DefaultAppfilePath defines the default file path that used by `vela up` command

const (
	// DefaultHealthScopeKey is the key in application for default health scope
	DefaultHealthScopeKey = "healthscopes.core.oam.dev"
)

const DefaultWorkloadType = "webservice"

DefaultWorkloadType defines the default service type if no type specified in Appfile

Variables

var (
	ErrImageNotDefined = errors.New("image not defined")
)

error msg used in Appfile

Functions

func FormatDefaultHealthScopeName

func FormatDefaultHealthScopeName(appName string) string

FormatDefaultHealthScopeName will create a default health scope name.

Types

type 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"`
	// contains filtered or unexported fields
}

AppFile defines the spec of KubeVela Appfile

func JSONToYaml

func JSONToYaml(data []byte, appFile *AppFile) (*AppFile, error)

JSONToYaml will convert JSON format appfile to yaml and load the AppFile struct

func Load

func Load() (*AppFile, error)

Load will load appfile from default path

func LoadFromFile

func LoadFromFile(filename string) (*AppFile, error)

LoadFromFile will read the file and load the AppFile struct

func NewAppFile

func NewAppFile() *AppFile

NewAppFile init an empty AppFile struct

func (*AppFile) BuildOAMApplication

func (app *AppFile) BuildOAMApplication(env *types.EnvMeta, io cmdutil.IOStreams, tm template.Manager, silence bool) (*v1alpha2.Application, []oam.Object, error)

BuildOAMApplication renders Appfile into Application, Scopes and other K8s Resources.

func (*AppFile) ExecuteAppfileTasks

func (app *AppFile) ExecuteAppfileTasks(io cmdutil.IOStreams) error

ExecuteAppfileTasks will execute built-in tasks(such as image builder, etc.) and generate locally executed application

func (*AppFile) GetServices

func (af *AppFile) GetServices() map[string]Service

GetServices will get all services defined in AppFile

type Application

type Application struct {
	*AppFile `json:",inline"`
	Tm       template.Manager
}

Application is an implementation level object for Appfile, all vela commands will access AppFile from Appliction struct here.

type Driver

type Driver interface {
	// List applications
	List(envName string) ([]*Application, error)
	// Save application
	Save(app *Application, envName string) error
	// Delete application
	Delete(envName, appName string) error
	// Get application
	Get(envName, appName string) (*Application, error)
	// Name of storage driver
	Name() string
}

Driver is mutli implement interface

type Service

type Service map[string]interface{}

Service defines the service spec for AppFile, it will contain all related information including OAM component, traits, source to image, etc...

func (Service) GetApplicationConfig

func (s Service) GetApplicationConfig() map[string]interface{}

GetApplicationConfig will get OAM workload and trait information exclude inner section('build','type' and 'config')

func (Service) GetType

func (s Service) GetType() string

GetType get type from AppFile

func (Service) GetUserConfigName

func (s Service) GetUserConfigName() string

GetUserConfigName get user config from AppFile, it will contain config file in it.

func (Service) RenderServiceToApplicationComponent

func (s Service) RenderServiceToApplicationComponent(tm template.Manager, serviceName string) (v1alpha2.ApplicationComponent, error)

RenderServiceToApplicationComponent render all capabilities of a service to CUE values to KubeVela Application.