resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
terraform/BUILDING.md

66 lines
2.6 KiB
Markdown
Raw Normal View History

initial rename and update
2015-08-18 20:09:15 +02:00
# Building Terraform
maint: Codify a Vagrant-based release process * update Vagrantfile to modern Consul-style version * add `make release` for a one-shot command to get from fresh vagrant machine to a built release * add RELEASING.md to document details about the release process
2015-05-26 23:12:44 +02:00
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
This document contains details about the process for building release-style
binaries for Terraform.
(If you are intending instead to make changes to Terraform and build binaries
only for your local testing, see
[the contributing guide](.github/CONTRIBUTING.md).)
maint: Codify a Vagrant-based release process * update Vagrantfile to modern Consul-style version * add `make release` for a one-shot command to get from fresh vagrant machine to a built release * add RELEASING.md to document details about the release process
2015-05-26 23:12:44 +02:00
## Versioning
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
Until Terraform v1.0, Terraform's versioning scheme is as follows:
* Full version strings start with a zero in the initial position.
* The second position increments for _major_ releases, which may contain
backwards incompatible changes.
* The third and final position increments for _minor_ releases, which
we aim to keep backwards compatible with prior releases for the same major
version.
maint: Codify a Vagrant-based release process * update Vagrantfile to modern Consul-style version * add `make release` for a one-shot command to get from fresh vagrant machine to a built release * add RELEASING.md to document details about the release process
2015-05-26 23:12:44 +02:00
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
Although the Terraform team takes care to preserve compatibility between
Edit BUILDING.md Split a sentence under the "Versioning" section into two sentences to improve flow
2019-11-18 00:04:22 +01:00
major releases, major release upgrades will often require a subset of users
to take specific upgrade actions. This issue will persist while the product
design is refined in preparation for more specific backward-compatibility promises
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
in a later Terraform 1.0 release.
maint: Codify a Vagrant-based release process * update Vagrantfile to modern Consul-style version * add `make release` for a one-shot command to get from fresh vagrant machine to a built release * add RELEASING.md to document details about the release process
2015-05-26 23:12:44 +02:00
## Process
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
Terraform release binaries are built via cross-compilation on a Linux
system, using [gox](https://github.com/mitchellh/gox).
initial rename and update
2015-08-18 20:09:15 +02:00
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
The steps below are a subset of the steps HashiCorp uses to prepare the
official distribution packages available from
[the download page](https://www.terraform.io/downloads.html). This
process will generate an executable for each of the supported target platforms.
initial rename and update
2015-08-18 20:09:15 +02:00
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
HashiCorp prepares release binaries on Linux amd64 systems. This build process
may need to be adjusted for other host platforms.
maint: Codify a Vagrant-based release process * update Vagrantfile to modern Consul-style version * add `make release` for a one-shot command to get from fresh vagrant machine to a built release * add RELEASING.md to document details about the release process
2015-05-26 23:12:44 +02:00
```sh
initial rename and update
2015-08-18 20:09:15 +02:00
# clone the repository if needed
git clone https://github.com/hashicorp/terraform.git
cd terraform
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
# Verify that the unit tests are passing
maint: Codify a Vagrant-based release process * update Vagrantfile to modern Consul-style version * add `make release` for a one-shot command to get from fresh vagrant machine to a built release * add RELEASING.md to document details about the release process
2015-05-26 23:12:44 +02:00
make test
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
# Run preparation steps and then build the executable for each target platform
# in the subdirectory "pkg".
initial rename and update
2015-08-18 20:09:15 +02:00
# This generates binaries for each platform and places them in the pkg folder
Makefile/docs: Lock in 1.6 req, doc vendored deps * Drop Go 1.5 compatibility env vars * Drop `make updatedeps` from `Makefile` and docs * Update README w/ vendored dep instructions
2016-02-20 00:57:39 +01:00
make bin
initial rename and update
2015-08-18 20:09:15 +02:00
```
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
Official releases are subsequently then packaged, hashed, and signed before
uploading to [the HashiCorp releases service](https://releases.hashicorp.com/terraform/).
Those final packaging steps are not fully reproducible using the contents
of this repository due to the use of HashiCorp's private signing key. However,
you can place the generated executables in `.zip` archives to produce a
similar result without the checksums and digital signature.
initial rename and update
2015-08-18 20:09:15 +02:00
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
## Release Bundles for use in Terraform Enterprise
initial rename and update
2015-08-18 20:09:15 +02:00
Revise our contributing/development documentation Our documentation for how to contribute was in quite a state of disrepair, with some documents still describing things as they were before moving providers into separate repositories, others making assumptions about Go development that are no longer true in modules mode, and so forth. This is an attempt at a reset to a good state that should work with the codebase as it currently stands, and should hopefully serve as a basis for iterative improvement from here. These new instructions lean primarily on standard Go toolchain usage and instruct using the Makefile only for some Terraform-specific situations that the Go toolchain does not automatically handle. The idea here is that this direct usage of primary commands in the Go toolchain is less likely to be broken by changes in future Go releases, and should be immediately familiar to anyone who has experience with Go development.
2019-10-12 02:28:54 +02:00
If you wish to build distribution archives that blend official Terraform
release executables with a mixture of official and third-party provider builds,
see [the `terraform-bundle` tool](tools/terraform-bundle).