component

Documentation

Overview

Package component defines all component-specific actions, which get generated by the policy diff when component changes occur for specific component instances. Component-specific action is supposed to handle a certain change for a given component instance (e.g. create, update, delete, attach claim, remove claim, etc).

Index

• Variables
• type AttachClaimAction
  • func NewAttachClaimAction(componentKey string, claimKey string, depth int) *AttachClaimAction
  • func (a *AttachClaimAction) Apply(context *action.Context) (errResult error)
  • func (a *AttachClaimAction) DescribeChanges() util.NestedParameterMap
• type CreateAction
  • func NewCreateAction(componentKey string, params util.NestedParameterMap) *CreateAction
  • func (a *CreateAction) Apply(context *action.Context) (errResult error)
  • func (a *CreateAction) DescribeChanges() util.NestedParameterMap
• type DeleteAction
  • func NewDeleteAction(componentKey string, params util.NestedParameterMap) *DeleteAction
  • func (a *DeleteAction) Apply(context *action.Context) (errResult error)
  • func (a *DeleteAction) DescribeChanges() util.NestedParameterMap
• type DetachClaimAction
  • func NewDetachClaimAction(componentKey string, claimKey string) *DetachClaimAction
  • func (a *DetachClaimAction) Apply(context *action.Context) (errResult error)
  • func (a *DetachClaimAction) DescribeChanges() util.NestedParameterMap
• type EndpointsAction
  • func NewEndpointsAction(componentKey string) *EndpointsAction
  • func (a *EndpointsAction) Apply(context *action.Context) (errResult error)
  • func (a *EndpointsAction) DescribeChanges() util.NestedParameterMap
• type UpdateAction
  • func NewUpdateAction(componentKey string, paramsBefore util.NestedParameterMap, ...) *UpdateAction
  • func (a *UpdateAction) Apply(context *action.Context) (errResult error)
  • func (a *UpdateAction) DescribeChanges() util.NestedParameterMap

Variables

var AttachClaimActionObject = &runtime.Info{
	Kind:        "action-component-claim-attach",
	Constructor: func() runtime.Object { return &AttachClaimAction{} },
}

AttachClaimActionObject is an informational data structure with Kind and Constructor for the action

var CreateActionObject = &runtime.Info{
	Kind:        "action-component-create",
	Constructor: func() runtime.Object { return &CreateAction{} },
}

CreateActionObject is an informational data structure with Kind and Constructor for the action

var DeleteActionObject = &runtime.Info{
	Kind:        "action-component-delete",
	Constructor: func() runtime.Object { return &DeleteAction{} },
}

DeleteActionObject is an informational data structure with Kind and Constructor for the action

var DetachClaimActionObject = &runtime.Info{
	Kind:        "action-component-claim-detach",
	Constructor: func() runtime.Object { return &DetachClaimAction{} },
}

DetachClaimActionObject is an informational data structure with Kind and Constructor for the action

var EndpointsActionObject = &runtime.Info{
	Kind:        "action-component-endpoints",
	Constructor: func() runtime.Object { return &EndpointsAction{} },
}

EndpointsActionObject is an informational data structure with Kind and Constructor for the action

var UpdateActionObject = &runtime.Info{
	Kind:        "action-component-update",
	Constructor: func() runtime.Object { return &DeleteAction{} },
}

UpdateActionObject is an informational data structure with Kind and Constructor for the action

Types

type AttachClaimAction

type AttachClaimAction struct {
	runtime.TypeKind `yaml:",inline"`
	*action.Metadata
	ComponentKey string
	ClaimKey     string
	Depth        int
}

AttachClaimAction is a action which gets called when a consumer is added to an existing component

func NewAttachClaimAction

func NewAttachClaimAction(componentKey string, claimKey string, depth int) *AttachClaimAction

NewAttachClaimAction creates new AttachClaimAction

func (*AttachClaimAction) Apply

func (a *AttachClaimAction) Apply(context *action.Context) (errResult error)

Apply applies the action

func (*AttachClaimAction) DescribeChanges

func (a *AttachClaimAction) DescribeChanges() util.NestedParameterMap

DescribeChanges returns text-based description of changes that will be applied

type CreateAction

type CreateAction struct {
	runtime.TypeKind `yaml:",inline"`
	*action.Metadata
	ComponentKey string
	Params       util.NestedParameterMap
}

CreateAction is a action which gets called when a new component needs to be instantiated (i.e. new instance of code to be deployed to the cloud)

func NewCreateAction

func NewCreateAction(componentKey string, params util.NestedParameterMap) *CreateAction

NewCreateAction creates new CreateAction

func (*CreateAction) Apply

func (a *CreateAction) Apply(context *action.Context) (errResult error)

Apply applies the action

func (*CreateAction) DescribeChanges

func (a *CreateAction) DescribeChanges() util.NestedParameterMap

DescribeChanges returns text-based description of changes that will be applied

type DeleteAction

type DeleteAction struct {
	runtime.TypeKind `yaml:",inline"`
	*action.Metadata
	ComponentKey string
	Params       util.NestedParameterMap
}

DeleteAction is a action which gets called when an existing component needs to be destroyed (i.e. existing instance of code needs to be terminated in the cloud)

func NewDeleteAction

func NewDeleteAction(componentKey string, params util.NestedParameterMap) *DeleteAction

NewDeleteAction creates new DeleteAction

func (*DeleteAction) Apply

func (a *DeleteAction) Apply(context *action.Context) (errResult error)

Apply applies the action

func (*DeleteAction) DescribeChanges

func (a *DeleteAction) DescribeChanges() util.NestedParameterMap

DescribeChanges returns text-based description of changes that will be applied

type DetachClaimAction

type DetachClaimAction struct {
	runtime.TypeKind `yaml:",inline"`
	*action.Metadata
	ComponentKey string
	ClaimKey     string
}

DetachClaimAction is a action which gets called when a consumer is removed from an existing component

func NewDetachClaimAction

func NewDetachClaimAction(componentKey string, claimKey string) *DetachClaimAction

NewDetachClaimAction creates new DetachClaimAction

func (*DetachClaimAction) Apply

func (a *DetachClaimAction) Apply(context *action.Context) (errResult error)

Apply applies the action

func (*DetachClaimAction) DescribeChanges

func (a *DetachClaimAction) DescribeChanges() util.NestedParameterMap

DescribeChanges returns text-based description of changes that will be applied

type EndpointsAction

type EndpointsAction struct {
	runtime.TypeKind `yaml:",inline"`
	*action.Metadata
	ComponentKey string
}

EndpointsAction is a action which gets called when a new component changed (created or updated) and endpoints should be updated

func NewEndpointsAction

func NewEndpointsAction(componentKey string) *EndpointsAction

NewEndpointsAction creates new EndpointsAction

func (*EndpointsAction) Apply

func (a *EndpointsAction) Apply(context *action.Context) (errResult error)

Apply applies the action

func (*EndpointsAction) DescribeChanges

func (a *EndpointsAction) DescribeChanges() util.NestedParameterMap

DescribeChanges returns text-based description of changes that will be applied

type UpdateAction

type UpdateAction struct {
	runtime.TypeKind `yaml:",inline"`
	*action.Metadata
	ComponentKey string
	ParamsBefore util.NestedParameterMap
	Params       util.NestedParameterMap
}

UpdateAction is a action which gets called when an existing component needs to be updated (i.e. parameters of a running code instance need to be changed in the cloud)

func NewUpdateAction

func NewUpdateAction(componentKey string, paramsBefore util.NestedParameterMap, params util.NestedParameterMap) *UpdateAction

NewUpdateAction creates new UpdateAction

func (*UpdateAction) Apply

func (a *UpdateAction) Apply(context *action.Context) (errResult error)

Apply applies the action

func (*UpdateAction) DescribeChanges

func (a *UpdateAction) DescribeChanges() util.NestedParameterMap

DescribeChanges returns text-based description of changes that will be applied