Skip to main content

opentofu-quickstart

Last updated on

OpenTofu is an open-source infrastructure-as-code tool, and Harness Infrastructure as Code Management (IaCM) runs your OpenTofu workspaces and pipelines with Git-backed configuration, connectors, and optional cost estimation.

This guide walks you from connectors and workspace creation through a standard provision pipeline (init, plan, apply) and an optional approval between plan and apply.

What will you learn?​

  • Connectors and workspace: Create cloud and Git connectors, then create an OpenTofu workspace wired to your repository and OpenTofu version.
  • Provision pipeline: Generate or author a pipeline that runs init, plan, and apply for your workspace.
  • Approvals: Optionally gate apply behind an approval step.

Prerequisites​

Before you use this guide, ensure you have the following:

  • Harness account with IaCM enabled: You need Infrastructure as Code Management under Infrastructure in Harness when it is entitled on your account. For how to access or create a Harness account, see Getting started with Harness Platform.

    Contact Harness support:

    If IaCM does not appear, see Get started with IaCM or contact your account administrator or Harness Support.

  • Pipeline permissions: You need View, Create/Edit, and Execute for Pipelines. An administrator must assign you a role that includes them. See RBAC in Harness and Manage roles.

  • Git repository: Access to a Git provider with your OpenTofu project.

  • Cloud provider: Access to a cloud provider such as AWS or Google Cloud Platform for the infrastructure you manage.

  • Harness organization and project: An organization and project set up on the Harness Platform.

Sample OpenTofu

The following example OpenTofu (.tf) file declares:

  • Provider Configuration: Specifies the AWS provider and sets the region to "us-east-1". Go to AWS Regions & Availability Zones for a complete region list.
  • Resource Definition: Creates an EC2 instance with the identifier my_first_ec2_instance.
  • AMI: Utilizes ami-123abc321cba18, go to AWS EC2 User Guide to find your AMI image ID.
  • Instance Type: Configures the instance to use a t2.micro. Go to the AWS t2 instances list.
    Tags: To facilitate easy identification and management within AWS resources, a tag name with the value my_first_ec2_instance is applied.
provider "aws" {
  region = "us-east-1"
}

resource "aws_instance" "my_first_ec2_instance" {
  ami = "ami-123abc321cba18"
  instance_type = "t2.micro" # Got to https://aws.amazon.com/ec2/instance-types/t2/ for a full T2 instance type list.

  tags = {
    Name = "my_first_ec2_instance"
  }
}

Go to OpenTofu Documentation for more information on currently supported workspace types.

Set up your workspace​

A workspace is a named environment for storing your OpenTofu configurations and resources. Connect your cloud provider and code repository through Connectors to manage infrastructure changes and updates with Harness IaCM pipelines.

info

Harness recommends configuring your connector before creating your workspace, however, you can also add new connectors during the Create Workspace flow.

Step 1: Create a connector​

Use Harness AI to create and configure your cloud provider and code repository connectors before you create a Workspace:

OIDC Connectors

For easier access and token management, use the OIDC (OpenID Connect) option in the Credentials panel. This allows your connector to assume roles with permissions set in your Cloud Provider, updated only by authorized users. For more details, visit the Use OIDC tab.

Step 2: Create your workspace​

Once you have configured your connectors, you can create a Workspace and select them in the New Workspace panel:

migrate existing projects

For first-time use, use our migration tool to create new workspaces and import your existing Terraform projects into the Harness Platform.

Step 3: Add a provision pipeline​

A pipeline structures workflows to manage tasks like planning infrastructure changes, enforcing policies, and approvals. Learn more about Harness Pipelines. You can also add pipelines through the Harness Platform or use a code-first approach with YAML.

Harness AI pipeline generation​

The Provision operation adds three Terraform plugin steps: init, plan, and apply. Go to Tofu/Terraform Plugins for more information about supported OpenTofu/Terraform commands.

Step 4: Add an Approval step (optional)​

You can add the Approval step to prompt a review of the previous pipeline before proceeding to the next. The most common use case would be to add the Approval step between the plan and apply steps to ensure you are happy with the infrastructure changes and estimated costs (if cost estimation is enabled on your Workspace) that come with them before applying them.

Approval steps hold resources

When using an Approval step, the underlying machine running the pipeline remains active until the approval is resolved. This means it will continue consuming compute resources.