atst/terraform

ATAT Terraform

Welcome! You've found the ATAT IaC configurations.

ATAT is configured using terraform and a wrapper script called secrets-tool. With terraform we can configure infrastructure in a programatic way and ensure consistency across environments.

Directory Structure

modules/ - Terraform modules. These are modules that can be re-used for multiple environments.

providers/ - Specific environment configurations. (dev,production, etc)

Setup

Install the following requirements.

I highly recommend tfenv which will help you manage versions of TF and install new ones as needed. It gives you the ability to switch back and forth between versions as necessary, especially when doing upgrades and managing multiple environments. Think of it like pyenv.

Python is required for the secrets-tool. It is used to wrap terraform and pass secrets in to terraform from Azure KeyVault. This approach avoids leaving secrets on the filesystem in any way and allow for restricting access to secrets to specific operators.

Azure CLI is necessary for creating some intial resources, but is also used by the Python Azure SDK to make calls in some cases.

Requirements:

• tfenv
• Python 3.7
• Python pip
• Python virtualenv # FIXME: Switch to pipenv
• azure cli
• powershell See below

tfenv

tfenv will allow you to install TF versions. For example.

tfenv install 0.12.18

0.12.18 at time of writing

To select a version to use

tfenv use 0.12.18

Powershell

Some things you need to use powershell. Specifically getting client profiles for the VPN.

Install powershell on Linux

Powershell on recent versions of Ubuntu is available through snap.

For Ubuntu 19.10

snap install powershell --classic

Running Terraform

First, you'll need to log in to Azure. With the Azure CLI installed, you can run the following.

az login

Next, you'll need to initialize the environment. This process pulls down the terraform provider module from github as well as pulls in the modules that will be used by this provider/environment setup.

cd providers/dev/
terraform init

Once initialized, you can run a plan. A plan compares the terraform definitions you have configured in the provider directory (Ex. providers/dev) with what is in the shared state file in the Azure Object Storage (which all providers are currently configured for). This then also compares it to the state of the services which are running in Azure.

If nothing has been applied, you'll see all the resources defined in terraform as all new with a + next to the resource name. If the resource exists, but has changed, you'll see a ~ next to the resource and the delta of the change to be applied.

If you're plan looks good, you can run the apply.

terraform apply

Check the output for errors. Sometimes the syntax is valid, but some of the configuration may be wrong and only rejected by the Azure API at run time. If this is the case, fix your mistake, and re-run.

Shutting down and environment

To shutdown and remove an environment completely as to not incur any costs you would need to run a terraform destroy.

terraform destroy

This will destroy all resources defined in the provider so use with caution!! This will include things like KeyVault, Postgres, and so on. You may lose data!!

Advanced Terraform

Targeted Apply

Sometimes you're writing a new module and don't want to make changes to anything else. In this case you can limit what TF changes.

terraform plan -target=module.vpc

In the above example, this will only run a plan (plan/apply/destroy) on the specific module. This can be a module, or resource. You can get a list of module and resources by running terraform show.

VPN Setup

Configure OpenVPN clients for Azure VPN Gateway About P2S VPN client profiles Configure a VPN client for P2S OpenVPN protocol connections: Azure AD authentication (Preview) Create an Azure Active Directory tenant for P2S OpenVPN protocol connections

The docs above should help with client configuration. The last doc (Create an Azure Active Directory..) is necessary to run the command to add the VPN app for AD.

Copied here for convenience. Just enter this in your browser.

# For Public Azure - Government has a different URL, see doc above
https://login.microsoftonline.com/common/oauth2/authorize?client_id=41b23e61-6c1e-4545-b367-cd054e0ed4b4&response_type=code&redirect_uri=https://portal.azure.com&nonce=1234&prompt=admin_consent

Adding a client

TODO

Downloading a client profile

TODO