provider

Documentation

Index

• func EnsureProviderExists(fs afero.Fs, prov *Provider) (string, error)
• 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) (*Provider, error)
• type ProviderExecutableOption
  • func WithStderr(stderr chan<- string) ProviderExecutableOption
  • func WithStdout(stdout chan<- string) ProviderExecutableOption
• type ProviderProcess
  • func StartProviderExecutable(fs afero.Fs, executablePath string, opts ...ProviderExecutableOption) (*ProviderProcess, error)
  • func (b *ProviderProcess) Stop() error

Functions

func EnsureProviderExists

func EnsureProviderExists(fs afero.Fs, prov *Provider) (string, error)

EnsureProviderExists - Ensures that the provider exists on the local file system If it doesn't exist and is a nitric provider, it will attempt to download it from the nitric releases

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 struct {
	// contains filtered or unexported fields
}

func NewProvider

func NewProvider(providerId string) (*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 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