Documentation
¶
Index ¶
- Variables
- func CheckRunning(c *cc.CommonCtx) error
- func CreateCertsDir() (string, error)
- func CreateConfigDir() (string, error)
- func CreateDataDir() (string, error)
- func WriteConfig(w io.Writer, templ string, params *templateParams) error
- type BackupCmd
- type CLI
- type ConfigureCmd
- type ExportCmd
- type ImportCmd
- type InstallCmd
- type LoadCmd
- type RestoreCmd
- type RunCmd
- type SaveCmd
- type StartCmd
- type StatusCmd
- type StopCmd
- type UninstallCmd
- type UpdateCmd
- type VersionCmd
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 CreateCertsDir ¶ added in v0.20.8
func CreateConfigDir ¶
func CreateDataDir ¶ added in v0.20.8
Types ¶
type BackupCmd ¶
type CLI ¶
type CLI struct {
Backup BackupCmd `cmd:"" help:"backup directory data"`
Configure ConfigureCmd `cmd:"" help:"configure topaz service"`
Export ExportCmd `cmd:"" help:"export directory objects"`
Install InstallCmd `cmd:"" help:"install topaz"`
Import ImportCmd `cmd:"" help:"import directory objects"`
Load LoadCmd `cmd:"" help:"load a manifest file"`
Restore RestoreCmd `cmd:"" help:"restore directory data"`
Run RunCmd `cmd:"" help:""`
Save SaveCmd `cmd:"" help:"save a manifest file"`
Start StartCmd `cmd:"" help:"start topaz instance"`
Status StatusCmd `cmd:"" help:"display topaz instance status"`
Stop StopCmd `cmd:"" help:"stop topaz instance"`
Update UpdateCmd `cmd:"" help:"update topaz container version"`
Version VersionCmd `cmd:"" help:"version information"`
Uninstall UninstallCmd `cmd:"" help:"uninstall topaz, removes all locally installed artifacts"`
NoCheck bool `name:"no-check" hidden:"" env:"TOPAZ_NO_CHECK" help:"disable running 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"`
}
type ExportCmd ¶
type ImportCmd ¶
type InstallCmd ¶
type LoadCmd ¶
type RestoreCmd ¶
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"`
}
type SaveCmd ¶
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"`
}
type UninstallCmd ¶
type UninstallCmd struct{}
type UpdateCmd ¶ added in v0.20.19
type VersionCmd ¶
type VersionCmd struct{}
Click to show internal directories.
Click to hide internal directories.