cluster

Documentation

Index

• type Manager
  • func NewManager(credentialSource credentials.Source, provisioner provisioner.Provisioner, ...) *Manager
  • func (m *Manager) ApplyManifests(ctx context.Context, o *Options) error
  • func (m *Manager) DeleteManifests(ctx context.Context, o *Options) error
  • func (m *Manager) Destroy(ctx context.Context, o *Options) error
  • func (m *Manager) Provision(ctx context.Context, o *Options) error
• type Options

Types

type Manager

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

Manager is a Kubernetes cluster manager that will orchestrate changes to the cluster infrastructure and the cluster itself.

func NewManager

func NewManager(
	credentialSource credentials.Source,
	provisioner provisioner.Provisioner,
	renderer template.Renderer,
) *Manager

NewManager creates a new cluster manager.

func (*Manager) ApplyManifests

func (m *Manager) ApplyManifests(ctx context.Context, o *Options) error

ApplyManifests applies all manifests to the cluster.

func (*Manager) DeleteManifests

func (m *Manager) DeleteManifests(ctx context.Context, o *Options) error

DeleteManifests deletes all manifests from the cluster in reverse apply order.

func (*Manager) Destroy

func (m *Manager) Destroy(ctx context.Context, o *Options) error

Destroy deletes all applied manifests from a cluster and tears down the cluster infrastructure. Depending on the options it may or may not perform a dry run of the destruction process.

func (*Manager) Provision

func (m *Manager) Provision(ctx context.Context, o *Options) error

Provision performs all steps necessary to create and setup a cluster and the required infrastructure. If a cluster already exists, it should update it if there are pending changes to be rolled out. Depending on the options it may or may not perform a dry run of the pending changes.

type Options

type Options struct {
	DryRun        bool   `json:"dryRun,omitempty" yaml:"dryRun,omitempty"`
	Values        string `json:"values,omitempty" yaml:"values,omitempty"`
	ManifestsDir  string `json:"manifestsDir,omitempty" yaml:"manifestsDir,omitempty"`
	TemplatesDir  string `json:"templatesDir,omitempty" yaml:"templatesDir,omitempty"`
	SkipManifests bool   `json:"skipManifests,omitempty" yaml:"skipManifests,omitempty"`
	AllManifests  bool   `json:"allManifests,omitempty" yaml:"allManifests,omitempty"`
	NoSave        bool   `json:"noSave,omitempty" yaml:"noSave,omitempty"`
	NoHooks       bool   `json:"noHooks,omitempty" yaml:"noHooks,omitempty"`
	FullDiff      bool   `json:"fullDiff,omitempty" yaml:"fullDiff,omitempty"`
}

Options are used to configure the cluster manager.