topaz

Documentation

Index

• type ConsoleCmd
  • func (cmd *ConsoleCmd) Run(c *cc.CommonCtx) error
• type InstallCmd
  • func (cmd *InstallCmd) Run(c *cc.CommonCtx) error
• type RestartCmd
  • func (cmd *RestartCmd) Run(c *cc.CommonCtx) error
• type RunCmd
  • func (cmd *RunCmd) Run(c *cc.CommonCtx) error
• type StartCmd
  • func (cmd *StartCmd) Run(c *cc.CommonCtx) error
• type StartRunCmd
• type StatusCmd
  • func (cmd *StatusCmd) Run(c *cc.CommonCtx) error
• type StopCmd
  • func (cmd *StopCmd) Run(c *cc.CommonCtx) error
• type UninstallCmd
  • func (cmd *UninstallCmd) Run(c *cc.CommonCtx) error
• type UpdateCmd
  • func (cmd *UpdateCmd) Run(c *cc.CommonCtx) error

Types

type ConsoleCmd

type ConsoleCmd struct {
	ConsoleAddress string `arg:""  default:"https://localhost:8080/ui/directory" help:"gateway address of the console service"`
}

func (*ConsoleCmd) Run

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

type InstallCmd

type InstallCmd struct {
	ContainerRegistry string `optional:"" default:"${container_registry}" env:"CONTAINER_REGISTRY" help:"container registry (host[:port]/repo)"`
	ContainerImage    string `optional:"" default:"${container_image}" env:"CONTAINER_IMAGE" help:"container image name"`
	ContainerTag      string `optional:"" default:"${container_tag}" env:"CONTAINER_TAG" help:"container tag"`
	ContainerPlatform string `optional:"" default:"${container_platform}" env:"CONTAINER_PLATFORM" help:"container platform"`
	ContainerVersion  string `optional:"" hidden:"" default:"" env:"CONTAINER_VERSION"`
}

func (*InstallCmd) Run

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

type RestartCmd

type RestartCmd struct {
	StartRunCmd
	Wait bool `optional:"" default:"false" help:"wait for ports to be opened"`
}

func (*RestartCmd) Run

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

type RunCmd

type RunCmd struct {
	StartRunCmd
}

func (*RunCmd) Run

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

type StartCmd

type StartCmd struct {
	StartRunCmd
	Wait bool `optional:"" default:"false" help:"wait for ports to be opened"`
}

func (*StartCmd) Run

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

type StartRunCmd

type StartRunCmd struct {
	ContainerRegistry string   `optional:"" default:"${container_registry}" env:"CONTAINER_REGISTRY" help:"container registry (host[:port]/repo)"`
	ContainerImage    string   `optional:"" default:"${container_image}" env:"CONTAINER_IMAGE" help:"container image name"`
	ContainerTag      string   `optional:"" default:"${container_tag}" env:"CONTAINER_TAG" help:"container tag"`
	ContainerPlatform string   `optional:"" default:"${container_platform}" env:"CONTAINER_PLATFORM" help:"container platform"`
	ContainerName     string   `optional:"" default:"${container_name}" env:"CONTAINER_NAME" help:"container name"`
	ContainerHostname string   `optional:"" name:"hostname" default:"" env:"CONTAINER_HOSTNAME" help:"hostname for docker to set"`
	Env               []string `optional:"" short:"e" help:"additional environment variable names to be passed to container"`
	ContainerVersion  string   `optional:"" hidden:"" default:"" env:"CONTAINER_VERSION"`
}

type StatusCmd

type StatusCmd struct {
	ContainerName string `optional:"" default:"${container_name}" env:"CONTAINER_NAME" help:"container name"`
}

func (*StatusCmd) Run

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

type StopCmd

type StopCmd struct {
	ContainerName string `optional:"" default:"${container_name}" env:"CONTAINER_NAME" help:"container name"`
	Wait          bool   `optional:"" default:"false" help:"wait for ports to be closed"`
}

func (*StopCmd) Run

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

type UninstallCmd

type UninstallCmd struct {
	ContainerRegistry string `optional:"" default:"${container_registry}" env:"CONTAINER_REGISTRY" help:"container registry (host[:port]/repo)"`
	ContainerImage    string `optional:"" default:"${container_image}" env:"CONTAINER_IMAGE" help:"container image name"`
	ContainerTag      string `optional:"" default:"${container_tag}" env:"CONTAINER_TAG" help:"container tag"`
	ContainerName     string `optional:"" default:"${container_name}" env:"CONTAINER_NAME" help:"container name"`
	ContainerVersion  string `optional:"" hidden:"" default:"" env:"CONTAINER_VERSION"`
}

func (*UninstallCmd) Run

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

type UpdateCmd

type UpdateCmd struct {
	ContainerRegistry string `optional:"" default:"${container_registry}" env:"CONTAINER_REGISTRY" help:"container registry (host[:port]/repo)"`
	ContainerImage    string `optional:"" default:"${container_image}" env:"CONTAINER_IMAGE" help:"container image name"`
	ContainerTag      string `optional:"" default:"${container_tag}" env:"CONTAINER_TAG" help:"container tag"`
	ContainerPlatform string `optional:"" default:"${container_platform}" env:"CONTAINER_PLATFORM" help:"container platform"`
	ContainerVersion  string `optional:"" hidden:"" default:"" env:"CONTAINER_VERSION"`
}

func (*UpdateCmd) Run

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