cli

Documentation

Index

• func Run(tele Application) error
• type Application
  • func RegisterCommands(app *kingpin.Application) Application
• type BuildCmd
• type CreateCmd
• type GetCmd
• type LoginCmd
• type LogoutCmd
• type PushCmd
• type RemoveCmd
• type StatusCmd

Functions

func Run

func Run(tele Application) error

Run parses CLI arguments and executes an appropriate tele command

Types

type Application

type Application struct {
	cli.Application
	// Hub is the Gravity Hub address to execute the command against
	Hub *string
	// Token is the Gravity authentication token
	Token *string
	// BuildCmd is the extended "tele build" command
	BuildCmd BuildCmd
	// LoginCmd logs into specified Gravity Hub and cluster
	LoginCmd LoginCmd
	// LogoutCmd clears current login information
	LogoutCmd LogoutCmd
	// StatusCmd displays current login information
	StatusCmd StatusCmd
	// PushCmd uploads app installer to Gravity Hub
	PushCmd PushCmd
	// CreateCmd creates specified resource
	CreateCmd CreateCmd
	// GetCmd shows specified resource
	GetCmd GetCmd
	// RemoveCmd removes specified resource
	RemoveCmd RemoveCmd
}

func RegisterCommands

func RegisterCommands(app *kingpin.Application) Application

RegisterCommands registers all tele tool flags, arguments and subcommands

type BuildCmd

type BuildCmd struct {
	*cli.BuildCmd
	// RemoteSupport is the remote support Ops Center to include in tarball
	RemoteSupport *string
	// RemoteSupporToken is the remote support token to include in tarball
	RemoteSupportToken *string
	// CACert is path to certificate authority to include in tarball
	CACert *string
	// EncryptionKey allows to encrypt installer tarball
	EncryptionKey *string
	// Repository is where packages are downloaded from
	//
	// TODO(r0mant): This flag is DEPRECATED and replaced by --hub.
	Repository *string
}

BuildCmd builds app installer tarball

type CreateCmd

type CreateCmd struct {
	*kingpin.CmdClause
	// Filename is the file with resource definition
	Filename *string
	// Force allows to overwrite existing resource
	Force *bool
}

CreateCmd creates specified resource

type GetCmd

type GetCmd struct {
	*kingpin.CmdClause
	// Kind is resource kind
	Kind *string
	// Name is resource name
	Name *string
	// Format is output format
	Format *constants.Format
	// Output is output format
	Output *constants.Format
}

GetCmd shows specified resource

type LoginCmd

type LoginCmd struct {
	*kingpin.CmdClause
	// Cluster is cluster to log into
	Cluster *string
	// OpsCenter is Ops Center to log into
	//
	// TODO(r0mant): REMOVE IN 7.0. This flag is obsolete.
	OpsCenter *string
	// Hub is Gravity Hub to log into
	Hub *string
	// ConnectorID is connector to use for authentication
	ConnectorID *string
	// TTL is login TTL
	TTL *time.Duration
	// Token is token for non-interactive authentication
	Token *string
}

LoginCmd logs into specified Ops Center and cluster

type LogoutCmd

type LogoutCmd struct {
	*kingpin.CmdClause
}

LogoutCmd clears current login information

type PushCmd

type PushCmd struct {
	*kingpin.CmdClause
	// Tarball is installer tarball
	Tarball *string
	// Force allows to overwrite existing app
	Force *bool
	// Quiet allows to suppress console output
	Quiet *bool
}

PushCmd uploads app installer to Ops Center

type RemoveCmd

type RemoveCmd struct {
	*kingpin.CmdClause
	// Kind is resource kind
	Kind *string
	// Name is resource name
	Name *string
	// Force allows to suppress not found errors
	Force *bool
}

RemoveCmd removes specified resource

type StatusCmd

type StatusCmd struct {
	*kingpin.CmdClause
}

StatusCmd shows current login information