teleport

Documentation

Index

• type BuildType
• type Builder
  • func NewBuilder(cfg *config.Config) (*Builder, error)
  • func (b *Builder) Build() ([]string, error)
• type Cluster
  • func NewCluster(ctx context.Context, cfg *config.Config) (*Cluster, error)
  • func (c *Cluster) Create(ctx context.Context) error
  • func (c *Cluster) Deploy(ctx context.Context) error
  • func (c *Cluster) Destroy(ctx context.Context) error
  • func (c *Cluster) Nodes(ctx context.Context) (map[string]NodeInfo, error)
  • func (c *Cluster) SSH(ctx context.Context, nodeName string, command ...string) error
  • func (c *Cluster) TCTL(ctx context.Context, command ...string) error
  • func (c *Cluster) Trust(ctx context.Context, root *Cluster) error
• type NodeInfo

Types

type BuildType

type BuildType string

BuildType is the type of Teleport binary to produce.

const (
	// OSS will build the OSS version of Teleport.
	OSS BuildType = "OSS"
	// Enterprise will build the Enterprise version of Teleport.
	Enterprise BuildType = "enterprise"
	// FIPS will  build the FIPS Enterprise version of Teleport.
	FIPS BuildType = "fips"
)

type Builder

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

Builder will build Teleport binaries.

func NewBuilder

func NewBuilder(cfg *config.Config) (*Builder, error)

NewBuilder creates a new Teleport builder.

func (*Builder) Build

func (b *Builder) Build() ([]string, error)

Build will build the Teleport binary. At the moment, this is hard coded to cross compile for amd64.

type Cluster

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

Cluster will install, set up, and configure Teleport on a host.

func NewCluster

func NewCluster(ctx context.Context, cfg *config.Config) (*Cluster, error)

NewCluster creates a new Teleport cluster that can provision and interact with the cluster.

func (*Cluster) Create

func (c *Cluster) Create(ctx context.Context) error

Create will create infrastructure and install and configure Teleport on the nodes.

func (*Cluster) Deploy

func (c *Cluster) Deploy(ctx context.Context) error

Deploy will install and configure Teleport on the nodes.

func (*Cluster) Destroy

func (c *Cluster) Destroy(ctx context.Context) error

Destroy will destroy the underlying infrastructure.

func (*Cluster) Nodes

func (c *Cluster) Nodes(ctx context.Context) (map[string]NodeInfo, error)

Nodes will create a mapping of names to hosts.

func (*Cluster) SSH

func (c *Cluster) SSH(ctx context.Context, nodeName string, command ...string) error

SSH will allow an interactive SSH session to a node.

func (*Cluster) TCTL

func (c *Cluster) TCTL(ctx context.Context, command ...string) error

TCTL will allow an arbitrary tctl command on the cluster.

func (*Cluster) Trust

func (c *Cluster) Trust(ctx context.Context, root *Cluster) error

Trust will set up a trust relationship with the given provisioner.

type NodeInfo

type NodeInfo struct {
	Host   string
	Roles  []string
	Config string
}

NodeInfo contains information about the node.