cmd

package
v0.25.8 Latest Latest
Warning

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

 Go to latest Published: Aug 16, 2023 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrNotRunning = errors.New("topaz is not running, use 'topaz start' or 'topaz run' to start")

Functions

func CheckRunning added in v0.20.17 

func CheckRunning(c *cc.CommonCtx) error

func CreateCertsDir added in v0.20.8 

func CreateCertsDir() (string, error)

func CreateConfigDir 

func CreateConfigDir() (string, error)

func CreateDataDir added in v0.20.8 

func CreateDataDir() (string, error)

func ProtoToStr added in v0.25.8 

func ProtoToStr(msg proto.Message) string

func WriteConfig 

func WriteConfig(w io.Writer, templ string, params *templateParams) error

Types

type BackupCmd 

type BackupCmd struct {
	File string `arg:""  default:"backup.tar.gz" help:"absolute file path to make backup to"`
	clients.Config
}

func (*BackupCmd) Run added in v0.0.16 

func (cmd *BackupCmd) Run(c *cc.CommonCtx) error

type CLI 

type CLI struct {
	Start     StartCmd     `cmd:"" help:"start topaz in daemon mode"`
	Stop      StopCmd      `cmd:"" help:"stop topaz instance"`
	Status    StatusCmd    `cmd:"" help:"status of topaz daemon process"`
	Run       RunCmd       `cmd:"" help:"run topaz in console mode"`
	Load      LoadCmd      `cmd:"" help:"load manifest from file"`
	Save      SaveCmd      `cmd:"" help:"save manifest to file"`
	Import    ImportCmd    `cmd:"" help:"import directory objects"`
	Export    ExportCmd    `cmd:"" help:"export directory objects"`
	Backup    BackupCmd    `cmd:"" help:"backup directory data"`
	Restore   RestoreCmd   `cmd:"" help:"restore directory data"`
	Test      TestCmd      `cmd:"" help:"execute assertions"`
	Install   InstallCmd   `cmd:"" help:"install topaz container"`
	Configure ConfigureCmd `cmd:"" help:"configure topaz service"`
	Update    UpdateCmd    `cmd:"" help:"update topaz container version"`
	Uninstall UninstallCmd `cmd:"" help:"uninstall topaz container"`
	Version   VersionCmd   `cmd:"" help:"version information"`
	NoCheck   bool         `name:"no-check" env:"TOPAZ_NO_CHECK" help:"disable local container status check"`
}

type ConfigureCmd 

type ConfigureCmd struct {
	PolicyName       string `short:"n" help:"policy name"`
	LocalPolicyImage string `short:"l" help:"local policy image name"`
	Resource         string `short:"r" help:"resource url"`
	Stdout           bool   `short:"p" help:"generated configuration is printed to stdout but not saved"`
	EdgeDirectory    bool   `short:"d" help:"enable edge directory" default:"false"`
	SeedMetadata     bool   `short:"s" help:"enable seed metadata" default:"false"`
}

func (ConfigureCmd) Run 

func (cmd ConfigureCmd) Run(c *cc.CommonCtx) error

type ExportCmd 

type ExportCmd struct {
	Directory string `short:"d" required:"" help:"directory to write .json data"`
	clients.Config
}

func (*ExportCmd) Run added in v0.20.7 

func (cmd *ExportCmd) Run(c *cc.CommonCtx) error

type ImportCmd 

type ImportCmd struct {
	Directory string `short:"d" required:"" help:"directory containing .json data"`
	clients.Config
}

func (*ImportCmd) Run added in v0.20.0 

func (cmd *ImportCmd) Run(c *cc.CommonCtx) error

type InstallCmd 

type InstallCmd struct {
	ContainerName    string `optional:""  default:"topaz" help:"container name"`
	ContainerVersion string `optional:""  default:"latest" help:"container version"`
}

func (InstallCmd) Run 

func (cmd InstallCmd) Run(c *cc.CommonCtx) error

type LoadCmd 

type LoadCmd struct {
	File string `arg:""  default:"manifest.yaml" help:"absolute path to manifest file"`
	clients.Config
}

func (*LoadCmd) Run added in v0.20.0 

func (cmd *LoadCmd) Run(c *cc.CommonCtx) error

type RestoreCmd 

type RestoreCmd struct {
	File string `arg:""  default:"backup.tar.gz" help:"absolute file path to local backup tarball"`
	clients.Config
}

func (*RestoreCmd) Run added in v0.0.16 

func (cmd *RestoreCmd) Run(c *cc.CommonCtx) error

type RunCmd 

type RunCmd struct {
	ContainerName    string   `optional:"" default:"topaz" help:"container name"`
	ContainerVersion string   `optional:"" default:"latest" help:"container version" `
	Hostname         string   `optional:"" help:"hostname for docker to set"`
	Env              []string `optional:"" short:"e" help:"additional environment variable names to be passed to container"`
}

func (*RunCmd) Run 

func (cmd *RunCmd) Run(c *cc.CommonCtx) error

type SaveCmd 

type SaveCmd struct {
	File string `arg:""  default:"manifest.yaml" help:"absolute path to manifest file"`
	clients.Config
}

func (*SaveCmd) Run added in v0.20.7 

func (cmd *SaveCmd) Run(c *cc.CommonCtx) error

type StartCmd 

type StartCmd struct {
	ContainerName    string   `optional:"" default:"topaz" help:"container name"`
	ContainerVersion string   `optional:"" default:"latest" help:"container version" `
	Hostname         string   `optional:"" help:"hostname for docker to set"`
	Env              []string `optional:"" short:"e" help:"additional environment variable names to be passed to container"`
}

func (*StartCmd) Run 

func (cmd *StartCmd) Run(c *cc.CommonCtx) error

type StatusCmd 

type StatusCmd struct{}

func (StatusCmd) Run 

func (cmd StatusCmd) Run(c *cc.CommonCtx) error

type StopCmd 

type StopCmd struct{}

func (StopCmd) Run 

func (cmd StopCmd) Run(c *cc.CommonCtx) error

type TestCmd added in v0.25.8 

type TestCmd struct {
	Exec     TestExecCmd     `cmd:"" help:"execute assertions"`
	Template TestTemplateCmd `cmd:"" help:"output assertions template"`
}

type TestExecCmd added in v0.25.8 

type TestExecCmd struct {
	File string `arg:""  default:"assertions.json" help:"filepath to assertions file"`
	clients.Config
}

func (*TestExecCmd) Run added in v0.25.8 

func (cmd *TestExecCmd) Run(c *cc.CommonCtx) error

type TestTemplateCmd added in v0.25.8 

type TestTemplateCmd struct {
	Pretty bool `arg:"" default:"false" help:"pretty print JSON"`
}

func (*TestTemplateCmd) Run added in v0.25.8 

func (cmd *TestTemplateCmd) Run(c *cc.CommonCtx) error

type UninstallCmd 

type UninstallCmd struct{}

func (UninstallCmd) Run 

func (cmd UninstallCmd) Run(c *cc.CommonCtx) error

type UpdateCmd added in v0.20.19 

type UpdateCmd struct {
	ContainerName    string `optional:"" default:"topaz" help:"container name"`
	ContainerVersion string `optional:"" default:"latest" help:"container version" `
	Hostname         string `optional:"" help:"hostname for docker to set"`
}

func (UpdateCmd) Run added in v0.20.19 

func (cmd UpdateCmd) Run(c *cc.CommonCtx) error

type VersionCmd 

type VersionCmd struct{}

func (*VersionCmd) Run 

func (cmd *VersionCmd) Run(c *cc.CommonCtx) error

Source Files

View all Source files

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.