api

Documentation

Index

• type Component
• type ComponentFactory
• type Environment
  • func GetEnvironment(r component.Repository) Environment
• type Resettable

Types

type Component

type Component interface {
	component.Instance

	// Start this component
	Start(ctx context.Instance, scope lifecycle.Scope) error
}

Component is an internal extension of the component.Instance API.

type ComponentFactory

type ComponentFactory func() (Component, error)

ComponentFactory method

type Environment

type Environment interface {
	Component

	// TODO(nmittler): Remove this.
	// Evaluate the given template with environment specific template variables.
	Evaluate(tmpl string) (string, error)

	DumpState(context string)
}

Environment internal interface for all environments.

func GetEnvironment

func GetEnvironment(r component.Repository) Environment

GetEnvironment from the repository

type Resettable

type Resettable interface {
	Reset() error
}

Resettable interface is implemented by Deployments that needs to be reset before reuse.