pack

Documentation

Index

• Constants
• func CreateFrom(dest, src string, appName string) error
• func Find(packsDir, name string) ([]string, error)
• func List(packsDir, repoName string) ([]string, error)
• type Pack
  • func FromDir(dir string) (*Pack, error)
  • func (p *Pack) SaveDir(dest string) error

Constants

const (
	// ChartfileName is the default Chart file name.
	ChartfileName = "Chart.yaml"
	// ValuesfileName is the default values file name.
	ValuesfileName = "values.yaml"
	// IgnorefileName is the name of the Helm ignore file.
	IgnorefileName = ".helmignore"
	// DeploymentName is the name of the deployment file.
	DeploymentName = "deployment.yaml"
	// ServiceName is the name of the service file.
	ServiceName = "service.yaml"
	// IngressName is the name of the ingress file.
	IngressName = "ingress.yaml"
	// NotesName is the name of the NOTES.txt file.
	NotesName = "NOTES.txt"
	// HelpersName is the name of the helpers file.
	HelpersName = "_helpers.tpl"
	// TemplatesDir is the relative directory name for templates.
	TemplatesDir = "templates"
	// ChartsDir is the directory name for the packaged chart.
	// This also doubles as the directory name for chart dependencies.
	ChartsDir = "charts"
	//TasksFileName is the name of the tasks file in a draft pack
	TasksFileName = "tasks.toml"
	//TargetTasksFileName is the name of the file where the tasks file from the
	//  draft pack will be copied to
	TargetTasksFileName = ".draft-tasks.toml"
)

Functions

func CreateFrom

func CreateFrom(dest, src string, appName string) error

CreateFrom scaffolds a directory with the src pack

func Find

func Find(packsDir, name string) ([]string, error)

Find loops through each pack repo in packsDir to find pack with given name

func List

func List(packsDir, repoName string) ([]string, error)

List returns a list of all pack names found in the specified repository or error.

If repoName == "", List returns the set of all packs aggregated across all repositories.

Types

type Pack

type Pack struct {
	// Chart is the Helm chart to be installed with the Pack.
	Chart *chart.Chart
	// Files are the files inside the Pack that will be installed.
	Files map[string]io.ReadCloser
}

Pack defines a Draft Starter Pack.

func FromDir

func FromDir(dir string) (*Pack, error)

FromDir takes a string name, tries to resolve it to a file or directory, and then loads it.

This is the preferred way to load a pack. It will discover the pack encoding and hand off to the appropriate pack reader.

func (*Pack) SaveDir

func (p *Pack) SaveDir(dest string) error

SaveDir saves a pack as files in a directory.