{"id":2266,"date":"2018-10-11T14:57:11","date_gmt":"2018-10-11T11:57:11","guid":{"rendered":"https:\/\/upcloud.com\/global\/us\/resources\/tutorials\/terraform-variables\/"},"modified":"2018-10-11T14:57:11","modified_gmt":"2018-10-11T11:57:11","slug":"terraform-variables","status":"publish","type":"tutorial","link":"https:\/\/upcloud.com\/global\/resources\/tutorials\/terraform-variables\/","title":{"rendered":"How to use Terraform variables"},"content":{"rendered":"\n

Variables in Terraform<\/a> are a great way to define centrally controlled reusable values. The information in Terraform variables is saved independently from the deployment plans, which makes the values easy to read and edit from a single file.<\/p>\n\n\n\n

In this guide, we\u2019ll go over the types of available variables in Terraform, how to define them, and how to put them to use. You can use the general information about the variables as a quick cheat sheet, but the examples are a direct continuation of our Terraform Beginners article. If you haven\u2019t installed Terraform yet, follow the guide here to get started<\/a>.<\/p>\n\n\n\n\n\n

Terraform variables<\/h2>\n\n\n\n

Terraform supports a few different variable formats. Depending on the usage, the variables are generally divided into inputs and outputs.<\/p>\n\n\n\n

The input variables define the values that configure your infrastructure. These values can be used again and again without having to remember every occurrence in the event that it needs to be updated.<\/p>\n\n\n\n

Output variables, in contrast, are used to get information about the infrastructure after deployment. These can be useful for passing on information such as IP addresses for connecting to the server.<\/p>\n\n\n\n

\n
Test out Terraform for free<\/a><\/div>\n<\/div>\n\n\n\n

Input variables<\/h2>\n\n\n\n

Input variables are usually defined by a name, type, and default value. However, the type and default values are not strictly necessary. Terraform can deduct the variable’s type from the default or input value.<\/p>\n\n\n\n

Variables can be predetermined in a file or included in the command-line options. The simplest variable is just a name, while the type and value are selected based on the input.<\/p>\n\n\n\n

variable \"variable_name\" {}<\/pre>\n\n\n\n
terraform apply -var variable_name=\"value\"<\/pre>\n\n\n\n
The input variables, like the one above, use several different types: strings, lists, maps, and boolean. Here are some examples of how each type is defined and used.<\/p>\n\n\n\n
String<\/h3>\n\n\n\n
Strings mark a single value per structure and are commonly used to simplify and make complicated values more user-friendly. Below is an example of a string variable definition.<\/p>\n\n\n\n
variable \"template\" {\n  type = string\n  default = \"01000000-0000-4000-8000-000030080200\"\n}<\/pre>\n\n\n\n
A string variable can then be used in resource plans. Surrounded by double quotes, string variables are simple substitutions, such as the example below.<\/p>\n\n\n\n
storage = var.template<\/pre>\n\n\n\n
List<\/h3>\n\n\n\n
Another type of Terraform variables lists. They work much like a numbered catalogue of values. Each value can be called by its corresponding index in the list. Here is an example of a list variable definition.<\/p>\n\n\n\n
variable \"users\" {\n  type    = list\n  default = [\"root\", \"user1\", \"user2\"]\n}<\/pre>\n\n\n\n
Lists can be used in the resource plans similarly to strings, but you\u2019ll also need to denote the index of the value you are looking for.<\/p>\n\n\n\n
username = var.users[0]<\/pre>\n\n\n\n
Map<\/h3>\n\n\n\n
Maps are a collection of string keys and string values. They can be useful for selecting values based on predefined parameters, such as the server configuration and monthly price.<\/p>\n\n\n\n
variable \"plans\" {
  type = map
  default = {
    \"7EUR\"  = \"1xCPU-1GB\"
    \"13EUR\" = \"1xCPU-2GB\"
    \"26EUR\" = \"2xCPU-4GB\"
  }
}<\/pre>\n\n\n\n
You can access the right value by using the matching key. For example, the variable below would set the plan to \"1xCPU-1GB\".<\/tt><\/p>\n\n\n\n
plan = var.plans[\"7EUR\"]<\/pre>\n\n\n\n
The values matching their keys can also be used to look up information on other maps. For example, a shortlist of plans and their corresponding storage sizes is underneath.<\/p>\n\n\n\n
variable \"storage_sizes\" {\n  type = map\n  default = {\n    \"1xCPU-1GB\"  = \"25\"\n    \"1xCPU-2GB\"  = \"50\"\n    \"2xCPU-4GB\"  = \"80\"\n  }\n}<\/pre>\n\n\n\n
These can then be used to find the right storage size based on the monthly price as defined in the previous example.<\/p>\n\n\n\n
size = lookup(var.storage_sizes, var.plans[\"7EUR\"])<\/pre>\n\n\n\n
Boolean<\/h3>\n\n\n\n
The last of the available variable types is boolean. They give the option to employ simple true or false values. For example, you might wish to have a variable that decides when to generate the root user password on a new deployment.<\/p>\n\n\n\n
variable \"set_password\" {\n  default = false\n}<\/pre>\n\n\n\n
The above example boolean can be used similarly to a string variable by simply marking down the correct variable.<\/p>\n\n\n\n
create_password = var.set_password<\/pre>\n\n\n\n
By default, the value is set to false in this example. However, you can overwrite the variable at deployment by assigning a different value in a command-line variable.<\/p>\n\n\n\n
terraform apply -var set_password=\"true\"<\/pre>\n\n\n\n
Output variables<\/h2>\n\n\n\n
Output variables provide a convenient way to get useful information about your infrastructure. As you might have noticed, much of the server details are calculated at deployment and only become available afterwards. You can extract any server-specific values, including the calculated details, using output variables.<\/p>\n\n\n\n
Configuring output variables is really quite simple. All you need to do is define a name for the output and what value it should represent. For example, you could have Terraform show your server\u2019s IP address after deployment with the output variable below.<\/p>\n\n\n\n
output \"public_ip\" {\n  value = upcloud_server.server_name.network_interface[0].ip_address\n}<\/pre>\n\n\n\n
Note that the place of the public network interface on the list of network interfaces depends on which order the NICs are defined in the resources.<\/p>\n\n\n\n
Terraform would then output the public IP address at the end of the apply command process. Alternatively, output variables can also be called on-demand using the terraform output<\/tt> command.\u00a0Next, continue on to set up a variable file for server configuration.<\/p>\n\n\n\n
Defining variables in a file<\/h2>\n\n\n\n
You should have a Terraform project with a basic plan already set up. If not, follow our getting started guide for Terraform<\/a> to begin.<\/p>\n\n\n\n
Go to your Terraform project directory.<\/p>\n\n\n\n
cd ~\/terraform\/base<\/pre>\n\n\n\n
Terraform variables can be defined within the infrastructure plan but should be stored in their own variables file. All files in your Terraform directory using the .tf<\/tt> format will automatically be loaded during operations.<\/p>\n\n\n\n
Create a variables file, for example, variables.tf<\/tt> and open the file for editing.<\/p>\n\n\n\n
Add the below variable declarations to the variables file. Replace the SSH key private file path and the public key with our own.<\/p>\n\n\n\n
variable \"private_key_path\" {
  type = string
  default = \"\/home\/user\/.ssh\/terraform_rsa<\/span>\"
}

variable \"public_key\" {
  type = string
  default = \"ssh-rsa terraform_public_key<\/span>\"
}

variable \"zones\" {
  type = map
  default = {
    \"amsterdam\" = \"nl-ams1\"
    \"london\"    = \"uk-lon1\"
    \"frankfurt\" = \"de-fra1\"
    \"helsinki1\" = \"fi-hel1\"
    \"helsinki2\" = \"fi-hel2\"
    \"chicago\"   = \"us-chi1\"
    \"sanjose\"   = \"us-sjo1\"
    \"singapore\" = \"sg-sin1\"
  }
}

variable \"plans\" {
  type = map
  default = {
    \"7EUR\"  = \"1xCPU-1GB\"
    \"13EUR\" = \"1xCPU-2GB\"
    \"26EUR\" = \"2xCPU-4GB\"
  }
}

variable \"storage_sizes\" {
  type = map
  default = {
    \"1xCPU-1GB\" = \"25\"
    \"1xCPU-2GB\" = \"50\"
    \"2xCPU-4GB\" = \"80\"
  }
}
variable \"templates\" {
  type = map
  default = {
    \"ubuntu24\" = \"01000000-0000-4000-8000-000030240200\"
    \"centos9\"  = \"01000000-0000-4000-8000-000050010600\"
    \"debian12\" = \"01000000-0000-4000-8000-000020070100\"
  }
}

variable \"set_password\" {
  type = bool
  default = false
}

variable \"users\" {
  type = list
  default = [\"root\", \"user1\", \"user2\"]
}

variable \"plan\" {
  type = string
  default = \"13EUR\"
}

variable \"template\" {
  type = string
  default = \"ubuntu24\"
}
<\/pre>\n\n\n\n
The above example is really just information storage. It uses the Terraform map variable for the most part which allows you to change the values to be more human-readable.<\/p>\n\n\n\n
Variables set in the file can be overridden at deployment. This allows you to reuse the variables file while still customising the configuration at deployment. For example, although set_password is false in the variables file, you could enable it on the command line.<\/p>\n\n\n\n
terraform apply -var set_password=\"true\"<\/pre>\n\n\n\n
In the same way, you could override the other variables as well.<\/p>\n\n\n\n
Loading variables automatically<\/h2>\n\n\n\n
The variables file described in the previous section can easily be used across many configurations. However, if you need to make more than a couple of changes, it\u2019s worth putting the customisation in a file, too.<\/p>\n\n\n\n
A variable definitions file uses the same basic syntax as Terraform language files but consists only of variable name assignments.<\/p>\n\n\n\n
Terraform automatically loads a number of variable definitions files if named the following way:<\/p>\n\n\n\n
Files named exactly terraform.tfvars<\/tt> or terraform.tfvars.json<\/tt>.
Any files with names ending in .auto.tfvars<\/tt> or .auto.tfvars.json<\/tt>.<\/p>\n\n\n\n
Now, create a new file to define the custom variables called terraform.tfvars<\/tt> then add the following content.<\/p>\n\n\n\n
set_password = \"true\"
users = [\"root\", \"admin\"]
plan = \"26EUR\"
templates = {\"ubuntu20\":\"01000000-0000-4000-8000-000030080200\", \"centos8\":\"01000000-0000-4000-8000-000050010300\"}
template = \"ubuntu20\"
<\/pre>\n\n\n\n
If you want to use JSON formatting instead, files with .tfvars.json<\/tt> ending are parsed as JSON objects. The root object properties correspond to variable names.<\/p>\n\n\n\n
{
  \"set_password\": \"true\",
  \"users\": [\"root\", \"admin\"],
  \"plan\": \"26EUR\"
  \"templates\": {\"ubuntu20\":\"01000000-0000-4000-8000-000030200200\", \"centos8\":\"01000000-0000-4000-8000-000050010400\"},
  \"template\": \"ubuntu20\"
}<\/pre>\n\n\n\n
Next, continue with the section below on how to put the variables in use.<\/p>\n\n\n\n
Using variables in resources<\/h2>\n\n\n\n
The values that are defined in the variables.tf<\/tt> files can be used in the Terraform plans to avoid hard-coding parameters. The following example uses the highlighted variables to select the parameters for deploying a new cloud server.<\/p>\n\n\n\n
Notice the two last variables set in variables.tf<\/tt> which are used as selectors to choose the server plan and OS template.<\/p>\n\n\n\n
resource \"upcloud_server\" \"server1\" {\n  # System hostname\n  hostname = \"terraform.example.com\"\n\n  # Availability zone\n  zone = var.zones[\"amsterdam\"]<\/span>\n    \n  # Number of CPUs and memory in GB\n  plan = var.plans[var.plan]<\/span>\n\n  template {\n    # OS root disk size\n    size = lookup(var.storage_sizes, var.plans[var.plan])<\/span>\n\n    # Template UUID for Ubuntu 18.04\n    storage = var.templates[var.template]<\/span>\n  }\n\n  network_interface { \n    type = \"public\" \n  }\n  network_interface { \n    type = \"utility\" \n  }\n  # Include at least one public SSH key\n  login {\n    user = var.users[0]<\/span>\n    create_password = var.set_password<\/span>\n    keys = [\n      var.public_key<\/span>\n    ]\n  }\n\n  connection {\n    host = self.network_interface[0].ip_address\n    type = \"ssh\"\n    user = var.users[0]<\/span>\n    private_key = file(var.private_key_path)<\/span>\n  }\n}<\/pre>\n\n\n\n
Terraform variables are useful for defining server details without having to remember infrastructure-specific values. They are similarly handy for reusing shared parameters like public SSH keys that do not change between configurations.<\/p>\n\n\n\n
It is also important that the resource plans remain clear of personal details for security reasons. Using the variables, sensitive information such as private keys and usernames won\u2019t get shared unintentionally.<\/p>\n\n\n\n
Defining output variables<\/h2>\n\n\n\n
Output variables provide a convenient way to get useful information about your infrastructure. As you might have noticed, much of the server details are calculated at deployment and only become available afterwards. You can extract any server-specific values, including the calculated details using output variables.<\/p>\n\n\n\n
Configuring output variables is really quite simple. All you need to do is define a name for the output and what value it should correspond to. These can be included in your Terraform plan or in their own file.<\/p>\n\n\n\n
Start by creating an output variables file called output.tf<\/tt> and open it for edit.<\/p>\n\n\n\n
Add the following three variable definitions in the file to output the server\u2019s IP addresses and hostname after deployment. Replace the server_name<\/tt> with the name of your Terraform host.<\/p>\n\n\n\n
output \"public_ip\" {\n  value = upcloud_server.server_name<\/span>.network_interface[0].ip_address\n}\n\noutput \"utility_ip\" {\n  value = upcloud_server.server_name<\/span>.network_interface[1].ip_address\n}\n\noutput \"hostname\" {\n  value = upcloud_server.server_name<\/span>.hostname\n}<\/pre>\n\n\n\n
Save the file and test the output by deploying the server using the usual commands below.<\/p>\n\n\n\n
terraform plan<\/pre>\n\n\n\n
terraform apply<\/pre>\n\n\n\n
upcloud_server.server1: Creation complete after 39s (ID: 00b784aa-15c1-44dc-8252-f4bad865f853)\n\nApply complete! Resources: 1 added, 0 changed, 0 destroyed.\n\nOutputs:\n\nhostname = terraform.example.com\nprivate_ip = 10.5.4.82\npublic_ip = 94.237.45.221<\/pre>\n\n\n\n
The variables you defined will be shown at the end of the deployment, as in the example above. However, you can also retrieve these at any time using the Terraform command. For example, to get the public IP address, you can use the example command below.<\/p>\n\n\n\n
terraform output public_ip<\/pre>\n\n\n\n
94.237.45.221<\/pre>\n\n\n\n
In the same way, you could ask Terraform about any other output variables.<\/p>\n\n\n\n
Using environmental variables<\/h2>\n\n\n\n
You can also set sensitive variables in your environment variables with the TF_VAR_ prefix, avoiding the need to save them in a file. For example, you can set your password in your local environmental variables.<\/p>\n\n\n\n
export TF_VAR_PASSWORD=\"password\"<\/pre>\n\n\n\n
You\u2019ll also need to declare the password variable in your variables.tf<\/tt> fie.<\/p>\n\n\n\n
variable PASSWORD { default = \"\" }<\/pre>\n\n\n\n
The password variable is then usable in the Terraform resources.<\/p>\n\n\n\n
  provisioner \"remote-exec\" {\n    inline = [\n      \"useradd ${var.users[0]}\",\n      \"echo '${var.users[0]}:${var.PASSWORD}' | chpasswd\"\n    ]\n  }<\/pre>\n\n\n\n
When deployed, the remote execution provisioner will create a new user according to the users<\/tt> variable with the PASSWORD<\/tt> as set in the environmental variable.<\/p>\n\n\n\n
Summary<\/h2>\n\n\n\n
Terraform variables provide many convenient uses for infrastructure management. Dividing your deployment plan and configuration parameters into their own files helps to keep everything in order. However, that is just the general purpose of Terraform variables. Defining your infrastructure using variables is the first step towards the advanced features in Terraform.<\/p>\n","protected":false},"author":3,"featured_media":27318,"comment_status":"open","ping_status":"closed","template":"","community-category":[223,235],"class_list":["post-2266","tutorial","type-tutorial","status-publish","has-post-thumbnail","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/tutorial\/2266","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/tutorial"}],"about":[{"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/types\/tutorial"}],"author":[{"embeddable":true,"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/comments?post=2266"}],"version-history":[{"count":0,"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/tutorial\/2266\/revisions"}],"wp:attachment":[{"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/media?parent=2266"}],"wp:term":[{"taxonomy":"community-category","embeddable":true,"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/community-category?post=2266"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}