pack

type Dependency struct {

	// Name on the pack dependency which must match the MetadataPack.Name
	// value if the source is empty. Otherwise, the source dictates where the
	// pack is loaded from, allowing the same pack to be used multiple times as
	// a dependency with different variables.
	Name string `hcl:"name,label"`

	// Alias overrides the dependency pack's Name in references when set,
	// allowing the same pack source to be used multiple times as with different
	// variable values.
	Alias string `hcl:"alias,optional"`

	// Ref is the git reference of the pack at which to add. Ignored if not
	// specifying a git source. Defaults to latest.
	Ref string `hcl:"ref,optional"`

	// Source is the remote source where the pack can be fetched. This string
	// can follow any format as supported by go-getter or be a local path
	// indicating the pack has already been downloaded.
	Source string `hcl:"source,optional"`

	// Enabled is a boolean flag to determine whether the dependency is
	// available for loading. This allows easy administrative control.
	Enabled *bool `hcl:"enabled,optional"`
}

type File struct {

	// Name represents the name of the file as a reference from the pack
	// directory.
	Name string

	// Path is the absolute path of the file in question.
	Path string

	// Content is the file contents as a byte array.
	Content []byte
}

type ID string

type Metadata struct {
	App          *MetadataApp         `hcl:"app,block"`
	Pack         *MetadataPack        `hcl:"pack,block"`
	Integration  *MetadataIntegration `hcl:"integration,block"`
	Dependencies []*Dependency        `hcl:"dependency,block"`
}

type MetadataApp struct {

	// URL is the HTTP(S) url to the homepage of the application to provide a
	// quick reference to the documentation and help pages.
	URL string `hcl:"url"`

	// Author is an identifier to the author and maintainer of the pack such as
	// HashiCorp or James Rasell
	//
	// Deprecated: Nomad Pack tech preview 4 removes this field, we keep it here for
	// backwards compatibility only.
	Author string `hcl:"author,optional"`
}

type MetadataIntegration struct {

	// Identifier is a unique identifier that points to a specific integration
	// registered in the HashiCorp Developer Integrations Library.
	Identifier string `hcl:"identifier"`

	// Flags is an array of strings referencing various booleans you
	// can enable for your pack as it will display in the integrations
	// library. All flag options are specified within this file:
	// https://github.com/hashicorp/integrations/blob/main/flags.hcl
	Flags []string `hcl:"flags,optional"`

	// You can optionally override the pack.name value here to adjust
	// the name that will be displayed in HashiCorp Developer. For example,
	// your pack name may be "hello_world", whereas on HashiCorp Developer
	// you would like the name to render as "Hello World".
	Name string `hcl:"name,optional"`
}

type MetadataPack struct {

	// Name of the pack which acts as a convenience for use within template
	// rendering.
	Name string `hcl:"name"`

	// Alias will optionally override the provided Pack name value when set
	Alias string `hcl:"alias,optional"`

	// Description is a small overview of the application that is deployed by
	// the pack.
	Description string `hcl:"description,optional"`

	// URL is the HTTP(S) url of the pack which is acts as a convenience when
	// managing packs within a registry.
	//
	// Deprecated: Nomad Pack tech preview 4 removes this field, we keep it here for
	// backwards compatibility only.
	URL string `hcl:"url,optional"`

	// Version is the version of the pack which is acts as a convenience when
	// managing packs within a registry.
	Version string `hcl:"version"`
}

type Pack struct {

	// Metadata is the contents of the Pack metadata.hcl file. It contains
	// high-level information about the pack which is useful for operators and
	// is also exposed as template variables during rendering.
	Metadata *Metadata

	// TemplateFiles are the templated files which constitute this Pack. The
	// list includes both helper templates and Nomad resource templates and all
	// files within the list will be processed by the rendering engine.
	TemplateFiles []*File

	// AuxiliaryFiles are the files included in the "templates" directory of the
	// Pack that will also be rendered, but not run.
	AuxiliaryFiles []*File

	// RootVariableFile is the file which contains the root variables that can
	// include a description, type, and default value. This is parsed along
	// with any override variables and stored within Variables.
	RootVariableFile *File

	// OutputTemplateFile contains the optional output template file. If this
	// string is empty, it is assumed there is no output template to render and
	// print.
	OutputTemplateFile *File
	// contains filtered or unexported fields
}