appfile

Documentation

Index

• Constants
• Variables
• type AppFile
  • func Load() (*AppFile, error)
  • func LoadFromFile(filename string) (*AppFile, error)
  • func NewAppFile() *AppFile
  • func (app *AppFile) BuildOAM(ns string, io cmdutil.IOStreams, tm template.Manager) ([]*v1alpha2.Component, *v1alpha2.ApplicationConfiguration, error)
  • func (af *AppFile) GetServices() map[string]Service
  • func (app *AppFile) RenderOAM(ns string, io cmdutil.IOStreams, tm template.Manager) ([]*v1alpha2.Component, *v1alpha2.ApplicationConfiguration, error)
• type Build
  • func (b *Build) BuildImage(io cmdutil.IOStreams, image string) error
• type Docker
• type Push
• type Service
  • func (s Service) GetBuild() *Build
  • func (s Service) GetConfig() map[string]interface{}
  • func (s Service) GetType() string
  • func (s Service) RenderService(tm template.Manager, name, ns, image string) (*v1alpha2.ApplicationConfigurationComponent, *v1alpha2.Component, error)

Constants

const DefaultAppfilePath = "./vela.yml"

const DefaultWorkloadType = "webservice"

Variables

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

Types

type AppFile

type AppFile struct {
	Name       string             `json:"name"`
	Version    string             `json:"version"`
	CreateTime time.Time          `json:"createTime,omitempty"`
	UpdateTime time.Time          `json:"updateTime,omitempty"`
	Services   map[string]Service `json:"services"`
	Secrets    map[string]string  `json:"secrets"`
}

func Load

func Load() (*AppFile, error)

func LoadFromFile

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

func NewAppFile

func NewAppFile() *AppFile

func (*AppFile) BuildOAM

func (app *AppFile) BuildOAM(ns string, io cmdutil.IOStreams, tm template.Manager) (
	[]*v1alpha2.Component, *v1alpha2.ApplicationConfiguration, error)

BuildOAM renders Appfile into AppConfig, Components. It also builds images for services if defined.

func (*AppFile) GetServices

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

func (*AppFile) RenderOAM

func (app *AppFile) RenderOAM(ns string, io cmdutil.IOStreams, tm template.Manager) (
	[]*v1alpha2.Component, *v1alpha2.ApplicationConfiguration, error)

RenderOAM renders Appfile into AppConfig, Components.

type Build

type Build struct {
	Push   Push   `json:"push,omitempty"`
	Docker Docker `json:"docker,omitempty"`
}

func (*Build) BuildImage

func (b *Build) BuildImage(io cmdutil.IOStreams, image string) error

type Docker

type Docker struct {
	File    string `json:"file"`
	Context string `json:"context"`
}

type Push

type Push struct {
	Local    string `json:"local,omitempty"`
	Registry string `json:"registry,omitempty"`
}

type Service

type Service map[string]interface{}

func (Service) GetBuild

func (s Service) GetBuild() *Build

func (Service) GetConfig

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

func (Service) GetType

func (s Service) GetType() string

func (Service) RenderService

func (s Service) RenderService(tm template.Manager, name, ns, image string) (
	*v1alpha2.ApplicationConfigurationComponent, *v1alpha2.Component, error)

RenderService render all capabilities of a service to CUE values of a Component. It outputs a Component which will be marshaled as standalone Component and also returned AppConfig Component section.