cliconfig

type Config ¶

type Config struct {
	PluginCacheDir       string                `hcl:"plugin_cache_dir"`
	Hosts                []ConfigHost          `hcl:"host,block"`
	ProviderInstallation *ProviderInstallation `hcl:"provider_installation,block"`
	// contains filtered or unexported fields
}

Config provides methods to create a terraform [CLI config file](https://developer.hashicorp.com/terraform/cli/config/config-file). The main purpose of which is to create a local config that will inherit the default user CLI config and adding new sections to force Terraform to send requests through the Terragrunt Cache server and use the provider cache directory.

func LoadUserConfig() (*Config, error)

func (cfg *Config) AddHost(name string, services map[string]string)

host "registry.terraform.io" {
	services = {
		"providers.v1" = "http://localhost:5758/v1/providers/registry.terraform.io/",
	}
}

func (cfg *Config) Save(configPath string) error

func (cfg *Config) SetProviderInstallation(filesystemMethod *ProviderInstallationFilesystemMirror, directMethod *ProviderInstallationDirect)

provider_installation {
	filesystem_mirror {
		path    = "/path/to/the/provider/cache"
		include = ["example.com/*/*"]
	}
	direct {
		exclude = ["example.com/*/*"]
	}
}

type ConfigHost ¶ added in v0.58.2

type ConfigHost struct {
	Name     string            `hcl:",label"`
	Services map[string]string `hcl:"services,attr"`
}

ConfigHost is the structure of the "host" nested block within the CLI configuration, which can be used to override the default service host discovery behavior for a particular hostname.

type ProviderInstallation ¶

type ProviderInstallation struct {
	FilesystemMirror *ProviderInstallationFilesystemMirror `hcl:"filesystem_mirror,block"`
	Direct           *ProviderInstallationDirect           `hcl:"direct,block"`
}

ProviderInstallation is the structure of the "provider_installation" nested block within the CLI configuration.

type ProviderInstallationDirect ¶

type ProviderInstallationDirect struct {
	Include *[]string `hcl:"include,attr"`
	Exclude *[]string `hcl:"exclude,attr"`
}

func NewProviderInstallationDirect(include, exclude []string) *ProviderInstallationDirect

type ProviderInstallationFilesystemMirror ¶

type ProviderInstallationFilesystemMirror struct {
	Location string    `hcl:"path,attr"`
	Include  *[]string `hcl:"include,attr"`
	Exclude  *[]string `hcl:"exclude,attr"`
}

func NewProviderInstallationFilesystemMirror(location string, include, exclude []string) *ProviderInstallationFilesystemMirror