Documentation ¶
Index ¶
- Constants
- func PromptYesNo(label string, def bool) bool
- type BackupCmd
- type CLI
- type CertsCmd
- type ConfigCmd
- type ConfigName
- type ConfigureCmd
- type ConsoleCmd
- type DeleteConfigCmd
- type DeleteManifestCmd
- type ExportCmd
- type GenerateCertsCmd
- type GetManifestCmd
- type ImportCmd
- type InstallCmd
- type InstallTemplateCmd
- type ListCertsCmd
- type ListConfigCmd
- type ListTemplatesCmd
- type ManifestCmd
- type NewConfigCmd
- type RemoveCertFileCmd
- type RenameConfigCmd
- type RestartCmd
- type RestoreCmd
- type RunCmd
- type SaveContext
- type SetManifestCmd
- type StartCmd
- type StartRunCmd
- type StatusCmd
- type StopCmd
- type TemplateCmd
- type TestCmd
- type TestExecCmd
- type TestTemplateCmd
- type TrustCertsCmd
- type UninstallCmd
- type UpdateCmd
- type UseConfigCmd
- type VerifyTemplateCmd
- type VersionCmd
Constants ¶
View Source
const (
CLIConfigurationFile = "topaz.json"
)
Variables ¶
This section is empty.
Functions ¶
func PromptYesNo ¶ added in v0.32.0
Types ¶
type CLI ¶
type CLI struct { Run RunCmd `cmd:"" help:"run topaz in console mode"` Start StartCmd `cmd:"" help:"start topaz in daemon mode"` Stop StopCmd `cmd:"" help:"stop topaz instance"` Restart RestartCmd `cmd:"" help:"restart topaz instance"` Status StatusCmd `cmd:"" help:"status of topaz daemon process"` Manifest ManifestCmd `cmd:"" help:"manifest commands"` Templates TemplateCmd `cmd:"" help:"template commands"` Console ConsoleCmd `cmd:"" help:"open console in the browser"` Directory directory.DirectoryCmd `cmd:"" aliases:"ds" help:"directory commands"` Authorizer authorizer.AuthorizerCmd `cmd:"" aliases:"az" help:"authorizer commands"` Config ConfigCmd `cmd:"" help:"configure topaz service"` Certs CertsCmd `cmd:"" help:"cert commands"` Install InstallCmd `cmd:"" help:"install topaz container"` Uninstall UninstallCmd `cmd:"" help:"uninstall topaz container"` Update UpdateCmd `cmd:"" help:"update topaz container version"` Version VersionCmd `cmd:"" help:"version information"` NoCheck bool `name:"no-check" json:"noCheck,omitempty" short:"N" env:"TOPAZ_NO_CHECK" help:"disable local container status check"` LogLevel int `name:"log" short:"L" type:"counter" default:"0" help:"log level"` Import ImportCmd `cmd:"" help:"'topaz import' was moved to 'topaz directory import'" hidden:""` Export ExportCmd `cmd:"" help:"'topaz export' was moved to 'topaz directory export'" hidden:""` Backup BackupCmd `cmd:"" help:"'topaz backup' was moved to 'topaz directory backup'" hidden:""` Restore RestoreCmd `cmd:"" help:"'topaz restore' was moved to 'topaz directory restore'" hidden:""` Configure ConfigureCmd `cmd:"" help:"'topaz configure' was moved to 'topaz config new'" hidden:""` Test TestCmd `cmd:"" help:"'topaz test' was moved to 'topaz directory test'" hidden:""` }
type CertsCmd ¶ added in v0.30.25
type CertsCmd struct { List ListCertsCmd `cmd:"" help:"list dev certs"` Generate GenerateCertsCmd `cmd:"" help:"generate dev certs"` Trust TrustCertsCmd `cmd:"" help:"trust/untrust dev certs"` Remove RemoveCertFileCmd `cmd:"" help:"remove dev certs"` }
type ConfigCmd ¶ added in v0.32.0
type ConfigCmd struct { Use UseConfigCmd `cmd:"" help:"set active configuration"` New NewConfigCmd `cmd:"" help:"create new configuration"` List ListConfigCmd `cmd:"" help:"list configurations"` Rename RenameConfigCmd `cmd:"" help:"rename configuration"` Delete DeleteConfigCmd `cmd:"" help:"delete configuration"` }
type ConfigName ¶ added in v0.32.0
type ConfigName string
func (ConfigName) AfterApply ¶ added in v0.32.0
func (c ConfigName) AfterApply(ctx *kong.Context) error
func (ConfigName) String ¶ added in v0.32.0
func (c ConfigName) String() string
type ConfigureCmd ¶
type ConfigureCmd struct{}
type ConsoleCmd ¶ added in v0.30.0
type ConsoleCmd struct {
ConsoleAddress string `arg:"" default:"https://localhost:8080/ui/directory" help:"gateway address of the console service"`
}
type DeleteConfigCmd ¶ added in v0.32.0
type DeleteConfigCmd struct { Name ConfigName `arg:"" required:"" help:"topaz config name"` ConfigDir string `flag:"" required:"false" default:"${topaz_cfg_dir}" help:"path to config folder" ` }
type DeleteManifestCmd ¶ added in v0.30.0
type DeleteManifestCmd struct { Force bool `flag:"" help:"do not ask for conformation to delete manifest"` clients.DirectoryConfig }
type GenerateCertsCmd ¶ added in v0.30.25
type GenerateCertsCmd struct { CertsDir string `flag:"" default:"${topaz_certs_dir}" help:"path to dev certs folder" ` Force bool `flag:"" default:"false" help:"force generation of dev certs, overwriting existing cert files"` Trust bool `flag:"" default:"false" help:"add generated certs to trust store"` DNSNames []string `flag:"" default:"localhost" help:"list of DNS names used to generate dev certs"` }
type GetManifestCmd ¶ added in v0.30.0
type GetManifestCmd struct { Path string `arg:"path" help:"filepath to manifest file" type:"path" optional:""` Stdout bool `flag:"" help:"output manifest to --stdout"` clients.DirectoryConfig }
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"` }
type InstallTemplateCmd ¶ added in v0.30.24
type InstallTemplateCmd struct { Name string `arg:"" required:"" help:"template name"` Force bool `flag:"" short:"f" default:"false" required:"false" help:"skip confirmation prompt"` NoConfigure bool `optional:"" default:"false" help:"do not run configure step, to prevent changes to the config .yaml file"` NoTests bool `optional:"" default:"false" help:"do not execute assertions as part of template installation"` NoConsole bool `optional:"" default:"false" help:"do not open console when template installation is finished"` 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"` TemplatesURL string `arg:"" required:"false" default:"https://topaz.sh/assets/templates/templates.json" help:"URL of template catalog"` ContainerVersion string `optional:"" hidden:"" default:"" env:"CONTAINER_VERSION"` ConfigName string `optional:"" help:"set config name"` clients.DirectoryConfig }
type ListCertsCmd ¶ added in v0.30.25
type ListCertsCmd struct {
CertsDir string `flag:"" required:"false" default:"${topaz_certs_dir}" help:"path to dev certs folder" `
}
type ListConfigCmd ¶ added in v0.32.0
type ListConfigCmd struct {
ConfigDir string `flag:"" required:"false" default:"${topaz_cfg_dir}" help:"path to config folder" `
}
type ListTemplatesCmd ¶ added in v0.30.24
type ListTemplatesCmd struct {
TemplatesURL string `arg:"" required:"false" default:"https://topaz.sh/assets/templates/templates.json" help:"URL of template catalog"`
}
type ManifestCmd ¶ added in v0.30.0
type ManifestCmd struct { Get GetManifestCmd `cmd:"" help:"get manifest"` Set SetManifestCmd `cmd:"" help:"set manifest"` Delete DeleteManifestCmd `cmd:"" help:"delete manifest"` }
type NewConfigCmd ¶ added in v0.32.0
type NewConfigCmd struct { Name ConfigName `short:"n" help:"config name"` LocalPolicyImage string `short:"l" help:"local policy image name"` Resource string `short:"r" help:"resource url"` Stdout bool `short:"p" help:"print to stdout"` EdgeDirectory bool `short:"d" help:"enable edge directory" default:"false"` Force bool `flag:"" default:"false" short:"f" required:"false" help:"skip confirmation prompt"` }
type RemoveCertFileCmd ¶ added in v0.30.25
type RemoveCertFileCmd struct {
CertsDir string `flag:"" required:"false" default:"${topaz_certs_dir}" help:"path to dev certs folder" `
}
type RenameConfigCmd ¶ added in v0.32.0
type RenameConfigCmd struct { Name ConfigName `arg:"" required:"" help:"topaz config name"` NewName ConfigName `arg:"" required:"" help:"topaz new config name"` ConfigDir string `flag:"" required:"false" default:"${topaz_cfg_dir}" help:"path to config folder" ` }
type RestartCmd ¶ added in v0.31.5
type RestartCmd struct { StartRunCmd Wait bool `optional:"" default:"false" help:"wait for ports to be opened"` }
type RestoreCmd ¶
type RestoreCmd struct{}
type RunCmd ¶
type RunCmd struct {
StartRunCmd
}
type SetManifestCmd ¶ added in v0.30.0
type SetManifestCmd struct { Path string `arg:"" help:"filepath to manifest file" type:"path" optional:""` Stdin bool `flag:"" help:"set manifest from --stdin"` clients.DirectoryConfig }
type StartCmd ¶
type StartCmd struct { StartRunCmd Wait bool `optional:"" default:"false" help:"wait for ports to be opened"` }
type StartRunCmd ¶ added in v0.31.0
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"`
}
type StopCmd ¶
type TemplateCmd ¶ added in v0.30.24
type TemplateCmd struct { List ListTemplatesCmd `cmd:"" help:"list template"` Install InstallTemplateCmd `cmd:"" help:"install template"` Verify VerifyTemplateCmd `cmd:"" help:"verify template content links" hidden:""` }
type TestCmd ¶ added in v0.25.8
type TestCmd struct { Exec TestExecCmd `cmd:"" help:"'topaz test exec' was moved to 'topaz directory test exec'" hidden:""` Template TestTemplateCmd `cmd:"" help:"'topaz test template' was moved to 'topaz directory test template'" hidden:""` }
type TestExecCmd ¶ added in v0.25.8
type TestExecCmd struct{}
type TestTemplateCmd ¶ added in v0.25.8
type TestTemplateCmd struct{}
type TrustCertsCmd ¶ added in v0.30.25
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"` }
type UpdateCmd ¶ added in v0.20.19
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"` }
type UseConfigCmd ¶ added in v0.32.0
type UseConfigCmd struct { Name ConfigName `arg:"" required:"" help:"topaz config name"` ConfigDir string `flag:"" required:"false" default:"${topaz_cfg_dir}" help:"path to config folder" ` }
type VerifyTemplateCmd ¶ added in v0.31.0
type VerifyTemplateCmd struct {
TemplatesURL string `arg:"" required:"false" default:"https://topaz.sh/assets/templates/templates.json" help:"URL of template catalog"`
}
type VersionCmd ¶
type VersionCmd struct { Container bool `short:"c" help:"display topazd container version" default:"false"` 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"` }
Source Files ¶
Click to show internal directories.
Click to hide internal directories.