kubernetes

Documentation

Index

• func NewSchemaBox() *packr.Box
• type ExecuteAction
  • func (a *ExecuteAction) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ExecuteInstruction
• type ExecuteStep
• type InstallAction
• type InstallArguments
• type InstallStep
• type KubernetesOutput
• type Mixin
  • func New() *Mixin
  • func (m *Mixin) Build() error
  • func (m *Mixin) Execute() error
  • func (m *Mixin) GetSchema() (string, error)
  • func (m *Mixin) Install() error
  • func (m *Mixin) PrintSchema() error
  • func (m *Mixin) PrintVersion(opts version.Options) error
  • func (m *Mixin) Uninstall() error
  • func (m *Mixin) ValidatePayload(b []byte) error
• type Step
• type TestMixin
  • func NewTestMixin(t *testing.T) *TestMixin
• type UninstallAction
• type UninstallArguments
• type UninstallStep

Functions

func NewSchemaBox

func NewSchemaBox() *packr.Box

Types

type ExecuteAction

type ExecuteAction struct {
	Steps []ExecuteStep // using UnmarshalYAML so that we don't need a custom type per action
}

func (*ExecuteAction) UnmarshalYAML

func (a *ExecuteAction) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML takes any yaml in this form ACTION: - kubernetes: ... and puts the steps into the Action.Steps field

type ExecuteInstruction

type ExecuteInstruction struct {
	InstallArguments `yaml:",inline"`

	// Upgrade specific arguments
	Force       *bool `yaml:"force,omitempty"`
	GracePeriod *int  `yaml:"gracePeriod,omitempty"`
	Overwrite   *bool `yaml:"overwrite,omitempty"`
	Prune       *bool `yaml:"prune,omitempty"`
	Timeout     *int  `yaml:"timeout,omitempty"`
}

type ExecuteStep

type ExecuteStep struct {
	ExecuteInstruction `yaml:"kubernetes"`
}

type InstallAction

type InstallAction struct {
	Steps []InstallStep `yaml:"install"`
}

type InstallArguments

type InstallArguments struct {
	Step `yaml:",inline"`

	Namespace string   `yaml:"namespace"`
	Manifests []string `yaml:"manifests,omitempty"`
	Record    *bool    `yaml:"record,omitempty"`
	Selector  string   `yaml:"selector,omitempty"`
	Context   string   `yaml:"context,omitempty"`
	Validate  *bool    `yaml:"validate,omitempty"`
	Wait      *bool    `yaml:"wait,omitempty"`
}

type InstallStep

type InstallStep struct {
	InstallArguments `yaml:"kubernetes"`
}

type KubernetesOutput

type KubernetesOutput struct {
	Name         string `yaml:"name"`
	ResourceType string `yaml:"resourceType"`
	ResourceName string `yaml:"resourceName"`
	Namespace    string `yaml:"namespace,omitempty"`
	JSONPath     string `yaml:"jsonPath"`
}

type Mixin

type Mixin struct {
	*context.Context
	// contains filtered or unexported fields
}

func New

func New() *Mixin

func (*Mixin) Build

func (m *Mixin) Build() error

Build generates the relevant Dockerfile output for this mixin

func (*Mixin) Execute

func (m *Mixin) Execute() error

Execute will reapply manifests using kubectl

func (*Mixin) GetSchema

func (m *Mixin) GetSchema() (string, error)

func (*Mixin) Install

func (m *Mixin) Install() error

func (*Mixin) PrintSchema

func (m *Mixin) PrintSchema() error

func (*Mixin) PrintVersion

func (m *Mixin) PrintVersion(opts version.Options) error

func (*Mixin) Uninstall

func (m *Mixin) Uninstall() error

Uninstall will delete anything created during the install or upgrade step

func (*Mixin) ValidatePayload

func (m *Mixin) ValidatePayload(b []byte) error

type Step

type Step struct {
	Description string             `yaml:"description"`
	Outputs     []KubernetesOutput `yaml:"outputs,omitempty"`
}

type TestMixin

type TestMixin struct {
	*Mixin
	TestContext *context.TestContext
}

func NewTestMixin

func NewTestMixin(t *testing.T) *TestMixin

type UninstallAction

type UninstallAction struct {
	Steps []UninstallStep `yaml:"uninstall"`
}

type UninstallArguments

type UninstallArguments struct {
	Step `yaml:",inline"`

	Namespace string   `yaml:"namespace"`
	Manifests []string `yaml:"manifests,omitempty"`

	Force       *bool  `yaml:force,omitempty"`
	GracePeriod *int   `yaml:"gracePeriod,omitempty"`
	Selector    string `yaml:"selector,omitempty"`
	Context     string `yaml:"context,omitempty"`
	Timeout     *int   `yaml:"timeout,omitempty"`
	Wait        *bool  `yaml:"wait,omitempty"`
}

type UninstallStep

type UninstallStep struct {
	UninstallArguments `yaml:"kubernetes"`
}