Skip to content

README.md

Latest commit

 

History

History
54 lines (37 loc) · 2.07 KB

README.md

File metadata and controls

54 lines (37 loc) · 2.07 KB

workflow-plugin-tofu

⚠️ Experimental — This plugin compiles and passes its unit tests but has not been validated in any active GoCodeAlone-internal production deployment. Use with caution. Please open an issue if you adopt it so we can promote it to verified status.

License Go Reference

OpenTofu/Terraform adapter for workflow IaC — generates HCL from abstract infra specs, executes plan/apply, and handles state import/export.

What it provides

Pipeline step types:

  • step.iac_generate_hcl — Generate HCL configuration from abstract workflow infra specs
  • step.tofu_init — Run tofu init (downloads providers + modules)
  • step.tofu_plan — Run tofu plan and capture the execution plan
  • step.tofu_apply — Run tofu apply to provision infrastructure
  • step.tofu_state_import — Import existing resources into Tofu state
  • step.tofu_state_export — Export Tofu state for use by other workflow steps

Prerequisites

  • OpenTofu or Terraform installed and on $PATH
  • Provider credentials configured via env vars (e.g. AWS_ACCESS_KEY_ID, GOOGLE_CREDENTIALS, ARM_CLIENT_ID)

Install

# In your wfctl.yaml
version: 1
plugins:
  - name: workflow-plugin-tofu
    version: v0.1.2
    source: github.com/GoCodeAlone/workflow-plugin-tofu

Then:

wfctl plugin install

Minimal example

See examples/minimal/config.yaml.

Documentation

License

MIT. See LICENSE.