deployment

Documentation

Index

• Constants
• type Config
• type Instance
  • func New(ctx resource.Context, cfg Config) (i Instance, err error)
• type Settings
  • func SettingsFromCommandLine() (*Settings, error)
  • func (s *Settings) String() string

Constants

const (
	// HubValuesKey values key for the Docker image hub.
	HubValuesKey = "global.hub"

	// TagValuesKey values key for the Docker image tag.
	TagValuesKey = "global.tag"

	// ImagePullPolicyValuesKey values key for the Docker image pull policy.
	ImagePullPolicyValuesKey = "global.imagePullPolicy"

	// LatestTag value
	LatestTag = "latest"
)

Types

type Config

type Config struct {
	Name string

	// Namespace of deployment. If left empty, default will be used.
	Namespace namespace.Instance

	// The yaml contents to deploy.
	Yaml string
}

type Instance

type Instance interface {
	resource.Resource

	// Name of the deployment, for debugging purposes.
	Name() string

	// Namespace of the deployment, if any.
	Namespace() namespace.Instance
}

Instance of a deployment. Wraps over pkg/test/deployment instances for test framework integration purposes.

func New

func New(ctx resource.Context, cfg Config) (i Instance, err error)

New returns a new instance of deployment.

type Settings

type Settings struct {
	// Hub value to use in Helm templates
	Hub string

	// Tag value to use in Helm templates
	Tag string

	// Image pull policy to use for deployments. If not specified, the defaults of each deployment will be used.
	PullPolicy string
}

Settings provide kube-specific Settings from flags.

func SettingsFromCommandLine

func SettingsFromCommandLine() (*Settings, error)

SettingsFromCommandLine returns Settings obtained from command-line flags. flag.Parse must be called before calling this function.

func (*Settings) String

func (s *Settings) String() string

String implements fmt.Stringer