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
- type BuilderConfig
- type Config
- type ConfigSourcer
- 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
- type ReleaserConfig
Constants ¶
This section is empty.
Variables ¶
var Options = []sdk.Option{ sdk.WithComponents(&ConfigSourcer{}, &Builder{}, &Platform{}, &Releaser{}), }
Options are the SDK options to use for instantiation for this plugin.
Functions ¶
This section is empty.
Types ¶
type Builder ¶ added in v0.11.0
type Builder struct {
// contains filtered or unexported fields
}
func (*Builder) BuildFunc ¶ added in v0.11.0
func (b *Builder) BuildFunc() interface{}
BuildFunc implements component.Builder
func (*Builder) BuildODRFunc ¶ added in v0.11.0
func (b *Builder) BuildODRFunc() interface{}
BuildODRFunc implements component.BuilderODR
type BuilderConfig ¶ added in v0.11.0
type BuilderConfig 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 Platform ¶ added in v0.11.0
type Platform struct {
// contains filtered or unexported fields
}
func (*Platform) AuthFunc ¶ added in v0.11.0
func (p *Platform) AuthFunc() interface{}
AuthFunc implements component.Authenticator
func (*Platform) ConfigSet ¶ added in v0.11.0
ConfigSet is called after a configuration has been decoded we can use this to validate the config
func (*Platform) DefaultReleaserFunc ¶ added in v0.11.0
func (p *Platform) DefaultReleaserFunc() interface{}
DefaultReleaserFunc implements component.PlatformReleaser
func (*Platform) DeployFunc ¶ added in v0.11.0
func (p *Platform) DeployFunc() interface{}
DeployFunc implements component.Platform
func (*Platform) DestroyFunc ¶ added in v0.11.0
func (p *Platform) DestroyFunc() interface{}
DestroyFunc implements component.Destroyer
func (*Platform) StatusFunc ¶ added in v0.11.0
func (p *Platform) StatusFunc() interface{}
func (*Platform) ValidateAuthFunc ¶ added in v0.11.0
func (p *Platform) ValidateAuthFunc() interface{}
ValidateAuthFunc implements component.Authenticator
type Releaser ¶ added in v0.11.0
type Releaser struct {
// contains filtered or unexported fields
}
func (*Releaser) DestroyFunc ¶ added in v0.11.0
func (r *Releaser) DestroyFunc() interface{}
DestroyFunc implements component.Destroyer
func (*Releaser) ReleaseFunc ¶ added in v0.11.0
func (r *Releaser) ReleaseFunc() interface{}
ReleaseFunc implements component.ReleaseManager
func (*Releaser) StatusFunc ¶ added in v0.11.0
func (r *Releaser) StatusFunc() interface{}
StatusFunc implements component.Status
type ReleaserConfig ¶ added in v0.11.0
type ReleaserConfig struct{}
Source Files