appfile

Documentation

Index

• Constants
• func PrepareProcessContext(k8sClient client.Client, wl *Workload, applicationName, revision string, ...) (process.Context, error)
• type Appfile
  • func (af *Appfile) TemplateValidate() error
• type Parser
  • func NewApplicationParser(cli client.Client, dm discoverymapper.DiscoveryMapper) *Parser
  • func (p *Parser) GenerateAppFile(ctx context.Context, name string, app *v1alpha2.Application) (*Appfile, error)
  • func (p *Parser) GenerateApplicationConfiguration(app *Appfile, ns string) (*v1alpha2.ApplicationConfiguration, []*v1alpha2.Component, error)
• type Scope
• type Trait
  • func (trait *Trait) EvalContext(ctx process.Context) error
  • func (trait *Trait) EvalHealth(ctx process.Context, client client.Client, namespace string) (bool, error)
  • func (trait *Trait) EvalStatus(ctx process.Context, cli client.Client, ns string) (string, error)
• type Workload
  • func (wl *Workload) EvalContext(ctx process.Context) error
  • func (wl *Workload) EvalHealth(ctx process.Context, client client.Client, namespace string) (bool, error)
  • func (wl *Workload) EvalStatus(ctx process.Context, cli client.Client, ns string) (string, error)
  • func (wl *Workload) GetUserConfigName() string

Constants

const (
	// AppfileBuiltinConfig defines the built-in config variable
	AppfileBuiltinConfig = "config"
)

Functions

func PrepareProcessContext

func PrepareProcessContext(k8sClient client.Client, wl *Workload, applicationName, revision string, namespace string) (process.Context, error)

PrepareProcessContext prepares a DSL process Context

Types

type Appfile

type Appfile struct {
	Name         string
	RevisionName string
	Workloads    []*Workload
}

Appfile describes application

func (*Appfile) TemplateValidate

func (af *Appfile) TemplateValidate() error

TemplateValidate validate Template format

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

Parser is an application parser

func NewApplicationParser

func NewApplicationParser(cli client.Client, dm discoverymapper.DiscoveryMapper) *Parser

NewApplicationParser create appfile parser

func (*Parser) GenerateAppFile

func (p *Parser) GenerateAppFile(ctx context.Context, name string, app *v1alpha2.Application) (*Appfile, error)

GenerateAppFile converts an application to an Appfile

func (*Parser) GenerateApplicationConfiguration

func (p *Parser) GenerateApplicationConfiguration(app *Appfile, ns string) (*v1alpha2.ApplicationConfiguration,
	[]*v1alpha2.Component, error)

GenerateApplicationConfiguration converts an appFile to applicationConfig & Components

type Scope

type Scope struct {
	Name string
	GVK  schema.GroupVersionKind
}

Scope defines the scope of workload

type Trait

type Trait struct {
	// The Name is name of TraitDefinition, actually it's a type of the trait instance
	Name               string
	CapabilityCategory types.CapabilityCategory
	Params             map[string]interface{}

	Template           string
	HealthCheckPolicy  string
	CustomStatusFormat string

	FullTemplate *util.Template
}

Trait is ComponentTrait

func (*Trait) EvalContext

func (trait *Trait) EvalContext(ctx process.Context) error

EvalContext eval trait template and set result to context

func (*Trait) EvalHealth

func (trait *Trait) EvalHealth(ctx process.Context, client client.Client, namespace string) (bool, error)

EvalHealth eval trait health check

func (*Trait) EvalStatus

func (trait *Trait) EvalStatus(ctx process.Context, cli client.Client, ns string) (string, error)

EvalStatus eval trait status

type Workload

type Workload struct {
	Name               string
	Type               string
	CapabilityCategory types.CapabilityCategory
	Params             map[string]interface{}
	Traits             []*Trait
	Scopes             []Scope

	Template           string
	HealthCheckPolicy  string
	CustomStatusFormat string

	Helm                *v1alpha2.Helm
	DefinitionReference v1alpha2.WorkloadGVK
	// TODO: remove all the duplicate fields above as workload now contains the whole template
	FullTemplate *util.Template
}

Workload is component

func (*Workload) EvalContext

func (wl *Workload) EvalContext(ctx process.Context) error

EvalContext eval workload template and set result to context

func (*Workload) EvalHealth

func (wl *Workload) EvalHealth(ctx process.Context, client client.Client, namespace string) (bool, error)

EvalHealth eval workload health check

func (*Workload) EvalStatus

func (wl *Workload) EvalStatus(ctx process.Context, cli client.Client, ns string) (string, error)

EvalStatus eval workload status

func (*Workload) GetUserConfigName

func (wl *Workload) GetUserConfigName() string

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