cmd

Documentation

Index

• func Download(packages []Package, opts DownloadOpts) error
• func Execute() error
• type Config
• type DirSpec
• type DownloadOpts
• type Furyconf
  • func (f *Furyconf) Parse(prefix string) ([]Package, error)
  • func (f *Furyconf) Validate() error
• type Package
• type PackageURL
• type ProviderKind
• type ProviderOptSpec
• type ProviderPattern
• type RegistrySpec
• type VersionPattern

Functions

func Download

func Download(packages []Package, opts DownloadOpts) error

func Execute

func Execute() error

Execute is the main entrypoint of furyctl

Types

type Config

type Config struct {
	Packages     []Package
	DownloadOpts DownloadOpts
	Prefix       string
}

type DirSpec

type DirSpec struct {
	VendorFolder string
	Kind         string
	Name         string
	Registry     bool
	Provider     ProviderOptSpec
}

DirSpec is the abstraction of the fields needed for generating a destination directory

type DownloadOpts

type DownloadOpts struct {
	Parallel bool
	Https    bool
	Fallback bool
}

type Furyconf

type Furyconf struct {
	VendorFolderName string          `yaml:"vendorFolderName"`
	Versions         VersionPattern  `yaml:"versions"`
	Roles            []Package       `yaml:"roles"`
	Modules          []Package       `yaml:"modules"`
	Bases            []Package       `yaml:"bases"`
	Provider         ProviderPattern `mapstructure:"provider"`
}

Furyconf is reponsible for the structure of the Furyfile

func (*Furyconf) Parse

func (f *Furyconf) Parse(prefix string) ([]Package, error)

Parse reads the furyconf structs and created a list of packaged to be downloaded

func (*Furyconf) Validate

func (f *Furyconf) Validate() error

Validate is used for validation of configuration and initization of default parameters

type Package

type Package struct {
	Name         string          `yaml:"name"`
	Version      string          `yaml:"version"`
	Url          string          `yaml:"url"`
	Dir          string          `yaml:"dir"`
	Kind         string          `yaml:"kind"`
	ProviderOpt  ProviderOptSpec `mapstructure:"provider"`
	ProviderKind ProviderKind    `mapstructure:"providerKind"`
	Registry     bool            `mapstructure:"registry"`
}

Package is the type to contain the definition of a single package

type PackageURL

type PackageURL struct {
	Prefix        string
	Blocks        []string
	Kind          string
	Version       string
	Registry      bool
	CloudProvider ProviderOptSpec
	KindSpec      ProviderKind
}

PackageURL is the representation of the fields needed to elaborate an url

type ProviderKind

type ProviderKind map[string][]RegistrySpec

ProviderKind is the abstraction of the following structure:

modules:

aws
 - uri: https://github.com/terraform-aws-modules
   label: official-modules

type ProviderOptSpec

type ProviderOptSpec struct {
	Name  string `mapstructure:"name"`
	Label string `mapstructure:"label"`
}

ProviderOptSpec is the type that allows to explicit name of cloud provider and referenced label

type ProviderPattern

type ProviderPattern map[string]ProviderKind

ProviderPattern is the abstraction of the following structure: provider:

modules:
  aws
   - uri: https://github.com/terraform-aws-modules
     label: official-modules

type RegistrySpec

type RegistrySpec struct {
	BaseURI string `mapstructure:"url"`
	Label   string `mapstructure:"label"`
}

RegistrySpec contains the couple uri/label to identify each tf new repo declared

type VersionPattern

type VersionPattern map[string]string

VersionPattern Map from glob pattern to version associated (e.g. {"aws/*" : "v1.15.4-1"}