For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Started With OpenTofu

Create an OpenTofu workspace and provision infrastructure with Harness IaCM.

Use this guide to create an OpenTofu workspace. Provision infrastructure through Harness Infrastructure as Code Management (IaCM).

What is IaCM?

IaC automates infrastructure management via code. IaCM enhances this by ensuring consistent, accountable, and repeatable deployments. Harness boosts IaCM with real-time cost estimation, automated policy enforcement, and drift detection, ensuring efficient provisioning and compliance with standards.

TERRAFORM TO OPENTOFU MIGRATION

Harness IaCM supports integration with all OpenTofu versions. For Terraform, we support all MPL versions up to 1.5.x, any BSL versions (from 1.6.0) are not supported.

Follow this OpenTofu migration guide to transition from Terraform to OpenTofu and leverage the benefits of this open-source alternative.

Go to What's Supported in IaCM for more information on supported Cloud Providers and Code/Git providers.

spinner

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 you will learn from this topic

This guide covers the following:

  • 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.

Before you begin

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. Go to Getting started with Harness Platform to access or create a Harness account.

    CONTACT HARNESS SUPPORT

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

  • Pipeline permissions: View, Create/Edit, and Execute on Pipelines. Go to RBAC in Harness to review the permissions model, and go to Manage roles to assign a role that includes them.

  • 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.

Go to OpenTofu Documentation to review 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.

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:

Create Cloud Provider Connector with Harness AI

When adding any connector, start by:

  1. Sign in to app.harness.io.

  2. In the module pane, select Infrastructure.

  3. Select Project Setup, and then select Connectors.

  4. Select New Connector (AI).

  5. Select an option, for example "Create a GitHub connector", or type your request to create a connector for your chosen cloud provider or code repository.

Harness creates a YAML file for your connector. Once you select Create, Harness creates your connector and adds it to your project.

EDIT CONNECTOR

Edit your connector by updating the AI generated YAML file, or by selecting Edit Details in the connectors panel.

Go to Connect your Cloud Provider and Connect your Code Repository to connect your cloud provider and code repository.

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. Go to the Use OIDC tab for setup details.


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, go to State Migration to import the state of your existing Terraform projects into a Harness workspace.

Create an OpenTofu Workspace in Harness IaCM
  1. In the module pane, select Infrastructure.

  2. Select an existing project or create a new project.

  3. Select Workspaces, and then select New Workspace.

  4. Select Create new Workspace, then select Start from scratch and complete the following fields in the new workspace wizard:

About workspace

  • Name - Enter a unique name to identify the workspace.

  • Description (optional): Enter an optional description to help identify the workspace.

  • Tags (optional): Add a unique tag to identify the workspace.

Configure repository details

  • Select your Git provider, either Harness Code Repository or Third-party Git provider for other providers like GitHub or GitLab.

  • Git Connector: Select the Git connector you created in the previous step.

  • Git Fetch Type: Select the Git fetch type, either Latest from branch, Git tag or Commit SHA.

  • Git Branch: Specify the branch you want to use for the workspace.

BRANCH WITH JEXL

You can configure the workspace branch as a JEXL expression that references a pipeline variable, and then set the pipeline variable as a runtime input.

Set your branch variable as a runtime input in the pipeline:

  • Folder Path: Specify the folder path to the OpenTofu configuration files in the repository.

Advanced options allow you to include submodules if your code repository includes modules and submodules. Go to Module Registry to review module registry concepts.

Provisioner

  • Connector: Select the cloud provider connector you created in the previous step.

  • Cloud Cost Estimation: Toggle the Enable Cost Estimation switch to enable cloud cost estimation. This lets you estimate the cost of your infrastructure changes before you apply them.

  • Workspace Type: Select OpenTofu as the workspace type you want to use for the workspace.

  • OpenTofu Version: Select the OpenTofu version you want to use for the workspace

Add variable set (optional)

If you have configured variable sets for reuse, select the variable set you want to use for the workspace.

  1. Select Create.


Step 3: add a provision pipeline

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

Harness AI pipeline generation

Create a Provision Pipeline in Harness IaCM

Start by adding the pipeline:

  1. Select the Infrastructure module.

  2. Select Pipelines, then select Create a Pipeline.

  3. Select an option from Harness AI chat or type a request to generate one, for example:

    • "Create a pipeline to Provision an OpenTofu files with an init, plan and apply step."

  4. Review the generated YAML and Harness AI chat summary, and make any changes if necessary.

  5. Select Accept.

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


Step 4: run your pipeline

Now run your pipeline to provision your infrastructure.

To run your provision pipeline, do the following:

  1. Click Save to save your pipeline.

  2. Click Run in the top right corner.

  3. Confirm any runtime inputs if prompted.

  4. Click Run Pipeline.

The pipeline executes the three steps in order: init, plan, and apply. Each step shows progress in real time. Click any step to view detailed logs.

After the apply step completes successfully, your infrastructure is provisioned. Go to the Workspaces view, select your workspace, and open the Resources tab to see the resources created.

ADD PRODUCTION FEATURES

Go to Set Up OpenTofu Provisioner to add approval gates, cost estimation, and variable management to your provisioner.

Next steps

This guide introduced you to the core functionalities and setup of Harness IaCM, from creating workspaces to configuring pipelines. To enhance your experience and team efficiency, get the most out of Harness IaCM's built-in reusable features, including:

  • Workspace Templates: Quickly create new workspaces using pre-defined, customizable templates.

  • Module Registry: Share and reuse infrastructure modules across teams to standardize deployments.

  • Default Pipelines: Start with ready-made pipeline templates to accelerate automation and best practices.

  • Queue Step: Serialize your pipeline execution to track concurrent executions and prevent state conflicts.

  • Harness CLI: Install the unified CLI to list, get, and execute IaCM workspaces from your terminal.

Go to Harness AI Chat use cases for more use cases on Harness AI, and platform integration.

For an interactive onboarding experience including further use cases and features like **drift detection**, **remote backends**, and **policy enforcement**, check out Harness IaCM self-paced training.

Last updated

Was this helpful?