provider

Documentation

Index

• type DeploymentClient
  • func NewDeploymentClient(address string, interactive bool) *DeploymentClient
  • func (p *DeploymentClient) Down(deploymentRequest *deploy.DeploymentDownRequest) (<-chan *deploy.DeploymentDownEvent, <-chan error)
  • func (p *DeploymentClient) Up(deploymentRequest *deploy.DeploymentUpRequest) (<-chan *deploy.DeploymentUpEvent, <-chan error)
• type Provider
  • func NewProvider(providerId string, project *project.Project, fs afero.Fs) (Provider, error)
• type ProviderExecutableOption
  • func WithStderr(stderr chan<- string) ProviderExecutableOption
  • func WithStdout(stdout chan<- string) ProviderExecutableOption
• type ProviderImage
  • func NewImageProvider(imageName string) *ProviderImage
  • func (pi *ProviderImage) Install() error
  • func (pi *ProviderImage) Start(options *StartOptions) (string, error)
  • func (pi *ProviderImage) Stop() error
  • func (pi *ProviderImage) Uninstall() error
• type ProviderProcess
  • func StartProviderExecutable(fs afero.Fs, executablePath string, opts ...ProviderExecutableOption) (*ProviderProcess, error)
  • func (b *ProviderProcess) Stop() error
• type StandardProvider
  • func NewStandardProvider(providerId string, fs afero.Fs) (*StandardProvider, error)
  • func (sp *StandardProvider) Install() error
  • func (sp *StandardProvider) Start(opts *StartOptions) (string, error)
  • func (sp *StandardProvider) Stop() error
• type StartOptions

Types

type DeploymentClient

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

func NewDeploymentClient

func NewDeploymentClient(address string, interactive bool) *DeploymentClient

func (*DeploymentClient) Down

func (p *DeploymentClient) Down(deploymentRequest *deploy.DeploymentDownRequest) (<-chan *deploy.DeploymentDownEvent, <-chan error)

func (*DeploymentClient) Up

func (p *DeploymentClient) Up(deploymentRequest *deploy.DeploymentUpRequest) (<-chan *deploy.DeploymentUpEvent, <-chan error)

type Provider

type Provider interface {
	Install() error
	Start(opts *StartOptions) (string, error)
	Stop() error
}

func NewProvider

func NewProvider(providerId string, project *project.Project, fs afero.Fs) (Provider, error)

NewProvider - Returns a new provider instance based on the given providerId string The providerId string is in the form of <org-name>/<provider-name>@<version>

type ProviderExecutableOption

type ProviderExecutableOption = func(*ProviderProcess)

func WithStderr

func WithStderr(stderr chan<- string) ProviderExecutableOption

func WithStdout

func WithStdout(stdout chan<- string) ProviderExecutableOption

type ProviderImage

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

func NewImageProvider

func NewImageProvider(imageName string) *ProviderImage

NewImageProvider - Returns a new image provider instance based on the given image name [registry-host[:port]/][username/]repository[:tag]

func (*ProviderImage) Install

func (pi *ProviderImage) Install() error

func (*ProviderImage) Start

func (pi *ProviderImage) Start(options *StartOptions) (string, error)

func (*ProviderImage) Stop

func (pi *ProviderImage) Stop() error

func (*ProviderImage) Uninstall

func (pi *ProviderImage) Uninstall() error

type ProviderProcess

type ProviderProcess struct {
	Address string
	// contains filtered or unexported fields
}

ProviderProcess - A deployment engine based on a locally executable binary file

func StartProviderExecutable

func StartProviderExecutable(fs afero.Fs, executablePath string, opts ...ProviderExecutableOption) (*ProviderProcess, error)

func (*ProviderProcess) Stop

func (b *ProviderProcess) Stop() error

type StandardProvider

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

func NewStandardProvider

func NewStandardProvider(providerId string, fs afero.Fs) (*StandardProvider, error)

func (*StandardProvider) Install

func (sp *StandardProvider) Install() error

func (*StandardProvider) Start

func (sp *StandardProvider) Start(opts *StartOptions) (string, error)

func (*StandardProvider) Stop

func (sp *StandardProvider) Stop() error

type StartOptions

type StartOptions struct {
	Env    map[string]string
	StdOut chan<- string
	StdErr chan<- string
}