provider

Documentation

Index

• type Provider
  • func Get(ctx context.Context, cfg *config.Config) (Provider, error)

Types

type Provider

type Provider interface {
	// Create will create the necessary infrastructure for a Teleport cluster.
	Create(context.Context) error

	// Destroy will destroy all infrastructure for a Teleport cluster.
	Destroy(context.Context) error

	// ServerHost will return the host of the server. It is expected to be connectable with SSH via port 22.
	ServerHost(context.Context) (string, error)

	// Nodes will return the node hosts. It is expected to be connectable with SSH via port 22. The order of the
	// nodes is expected to be stable between runs.
	Nodes(context.Context) ([]string, error)

	// ProxyFQDN will return the FQDN of the proxy.
	ProxyFQDN(context.Context) (string, error)
}

Provider is an interface that will create and manage Teleport clusters.

func Get

func Get(ctx context.Context, cfg *config.Config) (Provider, error)

Get will return a provider given the configuration.