null

README

Null

The Null plugin is used for testing and experimentation with the different plugin components.

Documentation

Overview

Package null contains components that do [almost] nothing, primarily aimed to ease experimentation and testing with Waypoint. For example, the null config sourcer can be used to learn about dynamic configuration without the complexity of configuring a real remote system such as Vault. This helps learn the Waypoint side of things before diving into a more real-world system.

Index

• Variables
• type Builder
  • func (b *Builder) BuildFunc() interface{}
  • func (b *Builder) BuildODRFunc() interface{}
• type BuilderConfig
• type Config
• type ConfigSourcer
  • func (cs *ConfigSourcer) Config() (interface{}, error)
  • func (cs *ConfigSourcer) Documentation() (*docs.Documentation, error)
  • func (cs *ConfigSourcer) ReadFunc() interface{}
  • func (cs *ConfigSourcer) StopFunc() interface{}
• type Null
• type Platform
  • func (p *Platform) AuthFunc() interface{}
  • func (p *Platform) Config() (interface{}, error)
  • func (p *Platform) ConfigSet(interface{}) error
  • func (p *Platform) DefaultReleaserFunc() interface{}
  • func (p *Platform) DeployFunc() interface{}
  • func (p *Platform) DestroyFunc() interface{}
  • func (p *Platform) StatusFunc() interface{}
  • func (p *Platform) ValidateAuthFunc() interface{}
• type Releaser
  • func (r *Releaser) Config() (interface{}, error)
  • func (r *Releaser) DestroyFunc() interface{}
  • func (r *Releaser) ReleaseFunc() interface{}
  • func (r *Releaser) StatusFunc() interface{}
• type ReleaserConfig

Variables

var Options = []sdk.Option{
	sdk.WithComponents(&ConfigSourcer{}, &Builder{}, &Platform{}, &Releaser{}),
}

Options are the SDK options to use for instantiation for this plugin.

Types

type Builder

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

func (*Builder) BuildFunc

func (b *Builder) BuildFunc() interface{}

BuildFunc implements component.Builder

func (*Builder) BuildODRFunc

func (b *Builder) BuildODRFunc() interface{}

BuildODRFunc implements component.BuilderODR

type BuilderConfig

type BuilderConfig struct{}

type Config

type Config struct{}

type ConfigSourcer

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

ConfigSourcer implements component.ConfigSourcer

func (*ConfigSourcer) Config

func (cs *ConfigSourcer) Config() (interface{}, error)

Config implements component.Configurable

func (*ConfigSourcer) Documentation

func (cs *ConfigSourcer) Documentation() (*docs.Documentation, error)

func (*ConfigSourcer) ReadFunc

func (cs *ConfigSourcer) ReadFunc() interface{}

ReadFunc implements component.ConfigSourcer

func (*ConfigSourcer) StopFunc

func (cs *ConfigSourcer) StopFunc() interface{}

StopFunc implements component.ConfigSourcer

type Null

type Null struct{}

type Platform

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

func (*Platform) AuthFunc

func (p *Platform) AuthFunc() interface{}

AuthFunc implements component.Authenticator

func (*Platform) Config

func (p *Platform) Config() (interface{}, error)

Config implements Configurable

func (*Platform) ConfigSet

func (p *Platform) ConfigSet(interface{}) error

ConfigSet is called after a configuration has been decoded we can use this to validate the config

func (*Platform) DefaultReleaserFunc

func (p *Platform) DefaultReleaserFunc() interface{}

DefaultReleaserFunc implements component.PlatformReleaser

func (*Platform) DeployFunc

func (p *Platform) DeployFunc() interface{}

DeployFunc implements component.Platform

func (*Platform) DestroyFunc

func (p *Platform) DestroyFunc() interface{}

DestroyFunc implements component.Destroyer

func (*Platform) StatusFunc

func (p *Platform) StatusFunc() interface{}

func (*Platform) ValidateAuthFunc

func (p *Platform) ValidateAuthFunc() interface{}

ValidateAuthFunc implements component.Authenticator

type Releaser

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

func (*Releaser) Config

func (r *Releaser) Config() (interface{}, error)

Config implements Configurable

func (*Releaser) DestroyFunc

func (r *Releaser) DestroyFunc() interface{}

DestroyFunc implements component.Destroyer

func (*Releaser) ReleaseFunc

func (r *Releaser) ReleaseFunc() interface{}

ReleaseFunc implements component.ReleaseManager

func (*Releaser) StatusFunc

func (r *Releaser) StatusFunc() interface{}

StatusFunc implements component.Status

type ReleaserConfig

type ReleaserConfig struct{}