mirror of
https://github.com/opentofu/opentofu.git
synced 2025-01-02 04:07:22 -06:00
909989acfa
Normally "terraform init" will download and install the plugins necessary to work with a particular configuration, but sometimes Terraform is deployed in a network that, for one reason or another, cannot access the official plugin repository for automatic download. terraform-bundle provides an alternative method, allowing the auto-download process to be run out-of-band on a separate machine that _does_ have access to the repository. The result is a zip file that can be extracted onto the target system to install both the desired Terraform version and a selection of providers, thus avoiding the need for on-the-fly plugin installation. This is provided as a separate tool from Terraform because it is not something that most users will need. In the rare case where this is needed, we will for the moment assume that users are able to build this tool themselves. We may later release it in a pre-built form, if it proves to be generally useful. It uses the same API from the plugin/discovery package is is used by the auto-install behavior in "terraform init", so plugin versions are resolved in the same way. However, it's expected that several different Terraform configurations will run from the same bundle, so this tool allows the bundle to include potentially many versions of the same provider and thus allows each Terraform configuration to select from the available versions in the bundle, avoiding the need to upgrade all configurations to new provider versions in lockstep.
84 lines
2.6 KiB
Go
84 lines
2.6 KiB
Go
// terraform-bundle is a tool to create "bundle archives" that contain both
|
|
// a particular version of Terraform and a set of providers for use with it.
|
|
//
|
|
// Such bundles are useful for distributing a Terraform version and a set
|
|
// of providers to a system out-of-band, in situations where Terraform's
|
|
// auto-installer cannot be used due to firewall rules, "air-gapped" systems,
|
|
// etc.
|
|
//
|
|
// When using bundle archives, it's suggested to use a version numbering
|
|
// scheme that adds a suffix that identifies the archive as being a bundle,
|
|
// to make it easier to distinguish bundle archives from the normal separated
|
|
// release archives. This tool by default produces files with the following
|
|
// naming scheme:
|
|
//
|
|
// terraform_0.10.0-bundle2017070302_linux_amd64.zip
|
|
//
|
|
// The user is free to rename these files, since the archive filename has
|
|
// no significance to Terraform itself and the generated pseudo-version number
|
|
// is not referenced within the archive contents.
|
|
//
|
|
// If using such a bundle with an on-premises Terraform Enterprise installation,
|
|
// it's recommended to use the generated version number (or a modification
|
|
// thereof) as the tool version within Terraform Enterprise, so that
|
|
// bundle archives can be distinguished from official releases and from
|
|
// each other even if the same core Terraform version is used.
|
|
//
|
|
// Terraform providers in general release more often than core, so it is
|
|
// intended that this tool can be used to periodically upgrade providers
|
|
// within certain constraints and produce a new bundle containing these
|
|
// upgraded provider versions. A bundle archive can include multiple versions
|
|
// of the same provider, allowing configurations containing provider version
|
|
// constrants to be gradually migrated to newer versions.
|
|
package main
|
|
|
|
import (
|
|
"log"
|
|
"os"
|
|
|
|
"io/ioutil"
|
|
|
|
"github.com/mitchellh/cli"
|
|
)
|
|
|
|
const Version = "0.0.1"
|
|
|
|
func main() {
|
|
ui := &cli.ColoredUi{
|
|
OutputColor: cli.UiColorNone,
|
|
InfoColor: cli.UiColorNone,
|
|
ErrorColor: cli.UiColorRed,
|
|
WarnColor: cli.UiColorYellow,
|
|
|
|
Ui: &cli.BasicUi{
|
|
Reader: os.Stdin,
|
|
Writer: os.Stdout,
|
|
ErrorWriter: os.Stderr,
|
|
},
|
|
}
|
|
|
|
// Terraform's code tends to produce noisy logs, since Terraform itself
|
|
// suppresses them by default. To avoid polluting our console, we'll do
|
|
// the same.
|
|
if os.Getenv("TF_LOG") == "" {
|
|
log.SetOutput(ioutil.Discard)
|
|
}
|
|
|
|
c := cli.NewCLI("terraform-bundle", Version)
|
|
c.Args = os.Args[1:]
|
|
c.Commands = map[string]cli.CommandFactory{
|
|
"package": func() (cli.Command, error) {
|
|
return &PackageCommand{
|
|
ui: ui,
|
|
}, nil
|
|
},
|
|
}
|
|
|
|
exitStatus, err := c.Run()
|
|
if err != nil {
|
|
ui.Error(err.Error())
|
|
}
|
|
|
|
os.Exit(exitStatus)
|
|
}
|