Terraform Output Command

Terraform is a widely used infrastructure-as-code (IaC) tool .it allows the programmer to define, provision, and manage cloud resources in a declarative manner. One of the powerful features of Terraform is the "output" command, which helps the programmer extract and share values from the Terraform configurations. In this article, we are going to learn about the Terraform output command, including its purpose, syntax, usage, and examples, to help you understand how to leverage this powerful tool in the IaC workflows.

Purpose of Terraform Output Command

The main purpose of Terraform output command is to expose values from the Terraform configurations. These output values can be dynamically generated during provisioning or retrieved from existing resources. Then these Outputs can be used to capture information such as resource IDs, IP addresses, DNS names, or any other relevant data that the programmer may need to use in subsequent Terraform configurations, scripts, or tools. Those Outputs provide a way to make the outputs of the infrastructure deployments accessible and usable outside of Terraform, allowing for greater flexibility and integration with other parts of the infrastructure ecosystem.

Syntax of Terraform Output Command

The terraform output command can be written with the help of the below command.

output "<name>" {
  value = <expression>
}

In the above syntax:

<name>:-It is a unique name for the output, which can consist of letters, numbers, underscores, and hyphens.
<expression>:- It is the value or expression that the programmer wants to expose as the output. This can be a reference to a Terraform resource or data source, a computed value, or a combination of multiple values using interpolation syntax.

Usage of Terraform Output Command

When the programmer wants to utilize the functionality of Terraform output command, then the programmer just has to include the code in the Terraform configuration file (.tf) within a module or root module block. After applying the Terraform configuration using the terraform apply command, the programmer can view the values of the outputs using the terraform output command followed by the <name> of the output.

Examples of Terraform Output Command

Let's understand the output command with the help of some examples.

Program 1 (Extracting VPC ID)

Let's consider the scenario in which the programmer deals with an Amazon Web Services (AWS) VPC with Terraform, and the programmer want to extract the VPC ID for further use in the infrastructure. Here's an example of how the programmer can use the Terraform output command to perform the operation:

Code

resource "aws_vpc" "example" {
  cidr_block = "10.0.0.0/16"

  tags = {
    Name = "example-vpc"
  }
}

output "vpc_id" {
  value = aws_vpc.example.id
}

Output:

Explanation

The above program defines an AWS VPC resource named "example" with a given CIDR block and tags. We then define an output called "vpc_id" that references the "id" attribute of the "aws_vpc.example" resource. This makes the VPC ID available as an output that can be accessed using the "vpc_id" name.

Program 2 (Composing Output Values)

Code

resource "aws_vpc" "example" {
  cidr_block = "10.0.0.0/16"

  tags = {
    Name = "example-vpc"
  }
}

resource "aws_subnet" "example_subnet" {
  count = 2

  cidr_block = "10.0.${100 + count.index.index}.0/24"
  vpc_id     = aws_vpc.example.id

  tags = {
    Name = "example-subnet-${count.index.index + 1}"
  }
}

output "subnet_ids" {
  value = aws_subnet.example_subnet.*.id
}

output "subnet_cidr_blocks" {
  value = aws_subnet.example_subnet.*.cidr_block
}

Output:

Explanation

In the above code, we define an AWS VPC with a given CIDR block and tags and two AWS subnets with dynamically generated CIDR blocks and tags. We then define two outputs: "subnet_ids" and "subnet_cidr_blocks." The "subnet_ids" output uses the aws_subnet.example_subnet.*.id reference to capture the IDs of all the subnets created by the "example_subnet" resource. The "subnet_cidr_blocks" output uses the aws_subnet.example_subnet.*.cidr_block reference to capture the CIDR blocks of all the subnets. These outputs can be accessed and used in subsequent Terraform configurations or scripts.

Benefits of Using Terraform Output Command

There is also some benefit of using the terraform output command. These are as follows.

Reusability: The Outputs command allows the programmer to capture and reuse values from the Terraform configurations in subsequent configurations or scripts. This provides a feature to reuse and reduces code duplication, making the IaC code more modular and maintainable.
Flexibility: The Output command provide a way to make the outputs of the infrastructure deployments accessible and usable outside of Terraform. This command also allows for greater flexibility in integrating with other parts of the infrastructure ecosystem, such as provisioning tools, configuration management systems, or monitoring and logging solutions.
Dynamicity: The Output command is also evaluated during the Terraform apply command, which means that they can capture dynamically generated values or computed values based on the current state of your infrastructure. This makes outputs a powerful tool for extracting and managing dynamic information in your IaC workflows.
Clarity: The Output command also allows the programmer to expose specific values from the Terraform configurations and clarify what information is intended to be used outside of Terraform. This enhances the readability and maintainability of your IaC code, as it provides a clear separation of concerns between the inputs and outputs of the infrastructure.
Debugging: The Output command can also be used for debugging and troubleshooting. The programmer can use the Terraform output command to view the values of outputs after applying the Terraform configuration, helping the programmer to verify that the expected values are being generated and used correctly in your infrastructure.

Best Practice

There are some important points that the programmer should keep in mind during the use of terraform commands.

We must ensure the output names are clear, descriptive, and reflect the output value. This will help make the IaC code more readable and maintainable.
The Interpolation syntax allows the programmer to combine values from multiple resources or data sources, generating more complex outputs. This can help the programmer to capture and reuse more specific and dynamic information from the infrastructure.
Sensitive outputs are used when using the terraform output command. It helps the programmer protect secret or private information from being exposed. Also, we have to ensure to mark sensitive outputs appropriately using the sensitive = true argument.
The documentation and comments in the IaC code need to explain what each output value represents, how it is generated, and how it can be used. This will help others who work with the code understand its purpose and usage.

Conclusion

In conclusion, the Terraform output command is a powerful tool that allows the programmer to extract, compose, and share values from the infrastructure deployments. By leveraging the output command, the programmer can enhance the reusability, flexibility, dynamicity, clarity, and debugging of your IaC workflows, enabling more effective infrastructure management as the programmer works with the output command.

Next TopicTerraform Output

← prev next →