plugins

Documentation

Index

• Constants
• func GetPluginCache(cacheDir string) *diskv.Diskv
• func Template(url, os, arch string) (string, error)
• type CustomPlugin
  • func (cp *CustomPlugin) Install(fs afero.Fs, pluginName string) error
  • func (cp *CustomPlugin) WithCache(cache *diskv.Diskv) *CustomPlugin
  • func (cp *CustomPlugin) WithTargetPath(path string) *CustomPlugin
• type TarConfig
• type TypePluginFormat

Constants

const (

	// TerraformCustomPluginCacheDir is the directory used by terraform to search for custom providers
	// We vendor providers here
	// See https://www.terraform.io/docs/configuration/providers.html#third-party-plugins
	TerraformCustomPluginCacheDir = "terraform.d/plugins/{{.OS}}_{{.Arch}}"
	// CustomPluginDir where we place custom binaries
	CustomPluginDir = ".fogg/bin"
)

Functions

func GetPluginCache

func GetPluginCache(cacheDir string) *diskv.Diskv

GetPluginCache returns the cache used for plugins

func Template

func Template(url, os, arch string) (string, error)

Template templatizes a url with os and arch information

Types

type CustomPlugin

type CustomPlugin struct {
	URL       string           `json:"url" yaml:"url" validate:"required"`
	Format    TypePluginFormat `json:"format" yaml:"format" validate:"required"`
	TarConfig *TarConfig       `json:"tar_config,omitempty" yaml:"tar_config,omitempty"`
	TargetDir string           `json:"target_dir,omitempty" yaml:"target_dir,omitempty"`
	// contains filtered or unexported fields
}

CustomPlugin is a custom plugin

func (*CustomPlugin) Install

func (cp *CustomPlugin) Install(fs afero.Fs, pluginName string) error

Install installs the custom plugin

func (*CustomPlugin) WithCache

func (cp *CustomPlugin) WithCache(cache *diskv.Diskv) *CustomPlugin

WithCache adds a cache to plugins

func (*CustomPlugin) WithTargetPath

func (cp *CustomPlugin) WithTargetPath(path string) *CustomPlugin

WithTargetPath sets the target path for this plugin

type TarConfig

type TarConfig struct {
	StripComponents int `json:"strip_components,omitempty" yaml:"strip_components,omitempty"`
}

TarConfig configures the tar unpacking

type TypePluginFormat

type TypePluginFormat string

TypePluginFormat is the plugin format such as binary, zip, tar

const (
	// TypePluginFormatTar is a tar archived plugin
	TypePluginFormatTar TypePluginFormat = "tar"
	// TypePluginFormatBin is a binary plugin
	TypePluginFormatBin TypePluginFormat = "bin"
	// TypePluginFormatZip is a zip archive plugin
	TypePluginFormatZip TypePluginFormat = "zip"
)