templates

Documentation

Index

• func GetTemplateFromFile(file string) (*template, error)
• type InstallTemplateCmd
  • func (cmd *InstallTemplateCmd) Run(c *cc.CommonCtx) error
• type ListTemplatesCmd
  • func (cmd *ListTemplatesCmd) Run(c *cc.CommonCtx) error
• type TemplateCmd
• type VerifyTemplateCmd
  • func (cmd *VerifyTemplateCmd) Run(c *cc.CommonCtx) error

Functions

func GetTemplateFromFile

func GetTemplateFromFile(file string) (*template, error)

Types

type InstallTemplateCmd

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"`
	dsc.Config
}

func (*InstallTemplateCmd) Run

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

type ListTemplatesCmd

type ListTemplatesCmd struct {
	TemplatesURL string `arg:"" required:"false" default:"https://topaz.sh/assets/templates/templates.json" help:"URL of template catalog"`
}

func (*ListTemplatesCmd) Run

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

type TemplateCmd

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 VerifyTemplateCmd

type VerifyTemplateCmd struct {
	TemplatesURL string `arg:"" required:"false" default:"https://topaz.sh/assets/templates/templates.json" help:"URL of template catalog"`
}

func (*VerifyTemplateCmd) Run

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