cli

package
v0.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 5, 2025 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Confirm 

func Confirm() (bool, error)

func ExpandCommaSeparatedValues added in v0.6.0 

func ExpandCommaSeparatedValues(values []string) []string

ExpandCommaSeparatedValues takes a slice of strings and expands any comma-separated values into individual elements.

Types

type AddMachineOptions added in v0.7.0 

type AddMachineOptions struct {
	Context       string
	MachineName   string
	PublicIP      *netip.Addr
	RemoteMachine RemoteMachine
	Version       string
}

type CLI 

type CLI struct {
	Config *config.Config
	// contains filtered or unexported fields
}

func New 

func New(configPath string, conn *config.MachineConnection) (*CLI, error)

New creates a new CLI instance with the given config path or remote machine connection. If the connection is provided, the config is ignored for all operations which is useful for interacting with a cluster without creating a config.

func (*CLI) AddMachine 

func (cli *CLI) AddMachine(ctx context.Context, opts AddMachineOptions) (*client.Client, error)

AddMachine provisions a remote machine and adds it to the cluster. It returns a client to interact with the machine which should be closed after use by the caller.

func (*CLI) ConnectCluster 

func (cli *CLI) ConnectCluster(ctx context.Context, contextName string) (*client.Client, error)

ConnectCluster connects to a cluster using the given context name or the current context if not specified. If the CLI was initialised with a machine connection, the config is ignored and the connection is used instead.

func (*CLI) CreateContext added in v0.6.0 

func (cli *CLI) CreateContext(name string) error

func (*CLI) InitCluster 

func (cli *CLI) InitCluster(ctx context.Context, opts InitClusterOptions) (*client.Client, error)

InitCluster initialises a new cluster on a remote machine and returns a client to interact with the cluster. The client should be closed after use by the caller.

func (*CLI) ProgressOut 

func (cli *CLI) ProgressOut() *streams.Out

ProgressOut returns an output stream for progress writer.

func (*CLI) SetCurrentContext added in v0.6.0 

func (cli *CLI) SetCurrentContext(name string) error

type InitClusterOptions added in v0.7.0 

type InitClusterOptions struct {
	Context       string
	MachineName   string
	Network       netip.Prefix
	PublicIP      *netip.Addr
	RemoteMachine *RemoteMachine
	Version       string
}

type RemoteMachine 

type RemoteMachine struct {
	User    string
	Host    string
	Port    int
	KeyPath string
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.