» Private Terraform Enterprise Installation (Preflight Requirements)
Before installing the Private Terraform Enterprise software, you'll need to prepare an appropriate instance and relevant data files. Please make careful note of these requirements, as the installation may not be successful if these requirements are not met.
» Data Files
- TLS private key and certificate
- The installer allows for using a certificate signed by a public or private CA. If you do not use a trusted certificate, your VCS provider will likely reject that certificate when sending webhooks. The key and X.509 certificate should both be PEM (base64) encoded.
- License file (provided by HashiCorp)
Note: If you use a certificate issued by a private Certificate
Authority, you must provide the certificate for that CA in the
Certificate Authority (CA) Bundle section of the installation. This allows services
running within PTFE to access each other properly.
See Installation: Trusting SSL/TLS Certificates
for more on this.
» Linux Instance
Install the software on a Linux instance of your choosing. You will start and manage this instance like any other server.
The Private Terraform Enterprise Installer currently supports the following operating systems:
- Debian 7.7+
- Ubuntu 14.04 / 16.04 / 18.04
- Red Hat Enterprise Linux 7.2+
- CentOS 7+
- Amazon Linux 2016.03 / 2016.09 / 2017.03 / 2017.09 / 2018.03 / 2.0
- Oracle Linux 7.2+
» Hardware Requirements
These requirements provide the instance with enough resources to run the Terraform Enterprise application as well as the Terraform plans and applies.
- At least 40GB of disk space on the root volume
- At least 8GB of system memory
- At least 2 CPU cores
» Software Requirements
RedHat Enterprise Linux (RHEL) has a specific set of requirements. Please see the RHEL Install Guide before continuing.
See the CentOS Install Guide for additional guidance if installing on CentOS.
For Linux distributions other than RHEL, check Docker compatibility:
- The instance should run a supported version of Docker engine (1.7.1 or later, minimum 17.06.2-ce, maximum 17.12.1). This also requires a 64-bit distribution with a minimum Linux Kernel version of 3.10.
- At this time, the 18.x and higher Docker versions are not supported
- In Online mode, the installer will install Docker automatically
- In Airgapped mode, Docker should be installed before you begin
- For RedHat Enterprise and Oracle Linux, you must pre-install Docker as these distributions are not officially supported by Docker Community Edition.
Note: It is not recommended to run Docker under a 2.x kernel.
Private Terraform Enterprise does not support SELinux. The host running the installer must be configured in permissive mode by running:
Future releases may add native support for SELinux.
» Network Requirements
- Have the following ports available to the Linux instance:
- 22 - to access the instance via SSH from your computer. SSH access to the instance is required for administration and debugging.
- 8800 - to access the installer dashboard.
- 443 and 80 - to access the TFE app (both ports are needed; HTTP will redirect to HTTPS).
- 9870-9880 (inclusive) - for internal communication on the host and its subnet; not publicly accessible.
- If a firewall is configured on the instance, be sure that traffic can flow out of the
docker0interface to the instance's primary address. For example, to do this with UFW run:
ufw allow in on docker0. This rule can be added before the
docker0interface exists, so it is best to do it now, before the Docker installation.
- Get a domain name for the instance. Using an IP address to access the product is not supported as many systems use TLS and need to verify that the certificate is correct, which can only be done with a hostname at present.
» Operational Mode Decision
Terraform Enterprise can store its state in a few different ways, and you'll need to decide which works best for your installation. Each option has a different approach to recovering from failures and should be selected based on your organization's preferences.
Note: This decision should be made before you begin installation, because some modes have additional preflight requirements that are detailed below. The operational mode is selected at install time and cannot be changed once the install is running.
- Production - External Services - This mode stores the majority of the stateful data used by the instance in an external PostgreSQL database as well as an external S3-compatible endpoint or Azure blob storage. There is still critical data stored on the instance that must be managed with snapshots. Be sure to check the PostgreSQL Requirements for information that needs to be present for Terraform Enterprise to work. This option is best for users with expertise managing PostgreSQL or users that have access to managed PostgreSQL offerings like AWS RDS.
- Production - Mounted Disk - This mode stores data in a separate directory on the host, with the intention that the directory is configured to store its data on an external disk, such as EBS, iSCSI, etc. This option is best for users with experience mounting performant block storage.
- Demo - This mode stores all data on the instance. The data can be backed up with the snapshot mechanism for restore later. This option is best for initial installation and testing, and is not recommended or supported for true production use.
The decision you make will be entered during setup.
» Mounted Disk Guidelines
The mounted disk option provides significant flexibility in how PTFE stores its data. To help narrow down the possibilites, we've provided the following guidelines for mounted disk storage.
» Supported Mounted Disk Types
The following are supported mounted disk types:
- AWS EBS
- GCP Zonal Persistent Disk
- Azure Disk Storage
- Physically connected disks as in non-cloud hardware
» Disk Resizing
Depending on your cloud or storage application, you may need to confirm the disk has been resized to above Private Terraform Enterprise's minimum disk size of 40GB.
For example, with RedHat-flavor (RHEL, CentOS, Oracle Linux) images in Azure Cloud, the storage disk must be resized above the 30GB default after initial boot with
fdisk, as documented in the Azure knowledge base article How to: Resize Linux osDisk partition on Azure.
» Unsupported Mounted Disk Types
The following are not supported mounted disk types:
The supported mounted disk types provide the necessary reliability and performance for data storage and retrieval in PTFE.
If the type of mounted disk you wish to use is not listed, please contact your HashiCorp representative to get clarification on whether that type is supported.
» PostgreSQL Requirements
When Terraform Enterprise uses an external PostgreSQL database, the following must be present on it:
- PostgreSQL version 9.4 or greater
- User with all privileges granted on the schemas created and the ability to run "CREATE EXTENSION" on the database
- The following PostgreSQL schemas must be installed into the database:
To create schemas in PostgreSQL, the
CREATE SCHEMA command is used. So to
create the above required schemas, the following snippet must be run on the
CREATE SCHEMA rails; CREATE SCHEMA vault; CREATE SCHEMA registry;
When providing optional extra keyword parameters for the database connection,
note an additional restriction on the
sslmode parameter is that only the
disable values are allowed.
» External Vault Option
If you choose to run the instance in the Production operational mode, during the installation, you can also choose to use an external Vault cluster, rather than the default internal Vault provided by PTFE.
Note: This option is also selected at initial installation, and cannot be changed later.
If you will want to use an external Vault cluster when running Terraform Enterprise in production, select that option when initially switching to the Production operational mode. See Externally Managed Vault Cluster for more information on what this option requires.