template

Documentation

Overview

Package template provides conversion of cluster templates to Omni resources.

Index

• type SyncResult
• type Template
  • func Load(input io.Reader) (*Template, error)
  • func WithCluster(clusterName string) *Template
  • func (t *Template) ClusterName() (string, error)
  • func (t *Template) Delete(ctx context.Context, st state.State) (*SyncResult, error)
  • func (t *Template) Sync(ctx context.Context, st state.State) (*SyncResult, error)
  • func (t *Template) Translate() ([]resource.Resource, error)
  • func (t *Template) Validate() error
• type UpdateChange

Types

type SyncResult

type SyncResult struct {
	// Resources to create.
	Create []resource.Resource
	// Resources to update.
	Update []UpdateChange
	// Resources to delete split by phases.
	Destroy [][]resource.Resource
}

SyncResult describes the actions to perform to sync the template resources.

type Template

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

Template is a cluster template.

func Load

func Load(input io.Reader) (*Template, error)

Load the template from input.

func WithCluster

func WithCluster(clusterName string) *Template

WithCluster creates an empty template which contains only cluster model.

Such template can be used for reading a cluster status, deleting a cluster, etc.

func (*Template) ClusterName

func (t *Template) ClusterName() (string, error)

ClusterName returns the name of the cluster associated with the template.

func (*Template) Delete

func (t *Template) Delete(ctx context.Context, st state.State) (*SyncResult, error)

Delete returns a sync result which lists what needs to be deleted from state to remove template from the cluster.

func (*Template) Sync

func (t *Template) Sync(ctx context.Context, st state.State) (*SyncResult, error)

Sync the template against the resource state.

func (*Template) Translate

func (t *Template) Translate() ([]resource.Resource, error)

Translate the template into resources.

func (*Template) Validate

func (t *Template) Validate() error

Validate the template.

type UpdateChange

type UpdateChange struct {
	Old resource.Resource
	New resource.Resource
}

UpdateChange is a pair of old/new resources.