templates

package
v0.33.3 Latest Latest
Warning

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

Go to latest
Published: Dec 20, 2025 License: Apache-2.0 Imports: 27 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetTemplateFromFile added in v0.32.31

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

Types

type ApplyTemplateCmd added in v0.32.57

type ApplyTemplateCmd struct {
	dsc.Config

	Name  string `arg:"" required:"" help:"template name"`
	Force bool   `flag:"" short:"f" default:"false" required:"false" help:"skip confirmation prompt"`
}

func (*ApplyTemplateCmd) Run added in v0.32.57

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

type DownloadTemplateCmd added in v0.32.57

type DownloadTemplateCmd struct {
	Name         string `arg:"" required:"" help:"template name"`
	Force        bool   `flag:"" short:"f" default:"false" required:"false" help:"skip confirmation prompt"`
	Legacy       bool   `optional:"" default:"false" help:"use legacy templates"`
	TemplatesURL string `optional:"" default:"${topaz_tmpl_url}" env:"TOPAZ_TMPL_URL" help:"URL of template catalog"`
	ConfigName   string `optional:"" help:"set config name"`
}

func (*DownloadTemplateCmd) Run added in v0.32.57

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

type InstallTemplateCmd

type InstallTemplateCmd struct {
	dsc.Config

	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"`
	Legacy            bool   `optional:"" default:"false" help:"use legacy templates (v32)"`
	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 `optional:"" default:"${topaz_tmpl_url}" env:"TOPAZ_TMPL_URL" help:"URL of template catalog"`
	ContainerVersion  string `optional:"" hidden:"" default:"" env:"CONTAINER_VERSION"`
	ConfigName        string `optional:"" help:"set config name"`
}

func (*InstallTemplateCmd) Run

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

type ListTemplatesCmd

type ListTemplatesCmd struct {
	Legacy       bool   `optional:"" default:"false" help:"use legacy templates"`
	TemplatesURL string `optional:"" default:"${topaz_tmpl_url}" env:"TOPAZ_TMPL_URL" 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:""`
	Download DownloadTemplateCmd `cmd:"" help:"download template" hidden:""`
	Apply    ApplyTemplateCmd    `cmd:"" help:"apply template to directory" hidden:""`
}

type VerifyTemplateCmd

type VerifyTemplateCmd struct {
	Name         string `arg:"" optional:"" help:"template name"`
	Legacy       bool   `optional:"" default:"false" help:"use legacy templates"`
	TemplatesURL string `optional:"" default:"${topaz_tmpl_url}" env:"TOPAZ_TMPL_URL" help:"URL of template catalog"`
}

func (*VerifyTemplateCmd) Run

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL