Flux provider for Terraform

Overview

The Flux provider for Terraform is a plugin that enables bootstrapping of your Kubernetes cluster using Flux v2.

Please note: We take security and our users' trust very seriously. If you believe you have found a security issue in the Terraform Flux Provider, please follow the policy located here.

Documentation

All documentation is available on the Terraform provider website.

Guides

The following guides are available to help you use the provider:

• Bootstrapping a cluster using a GitHub repository using a personal access token (PAT)
• Bootstrapping a cluster using a GitHub repository via SSH
• Bootstrapping a cluster using a GitHub repository via SSH and GPG
• Bootstrapping a cluster using a GitHub repository self-managing the SSH keypair secret)
• Bootstrapping a cluster using a GitHub repository via SSH with flux customizations
• Bootstrapping a cluster using a GitHub repository via SSH and GPG with inline flux customizations
• Bootstrapping a cluster using a Gitlab repository via SSH
• Bootstrapping a cluster using a Gitlab repository via SSH and GPG
• Bootstrapping a cluster using a Helm Release and not the flux_bootstrap_git resource **

** This is the recommended approach if you do not want to perform initial flux bootstrapping.

Requirements

• Terraform 1.5.x or newer
• OpenTofu v1.7.x or newer
• Go 1.22 (to build the provider plugin)

Contributing to the provider

The Flux Provider for Terraform is the work of many contributors. We appreciate your help!

To contribute, please read the contribution guidelines. You may also report an issue.

Community

Need help or want to contribute? Please see the links below. The Flux project is always looking for new contributors and there are a multitude of ways to get involved.

• Getting Started?
  • Look at our Get Started guide and give us feedback
• Need help?
  • First: Ask questions on our GH Discussions page.
  • Second: Talk to us in the #flux channel on CNCF Slack.
  • Please follow our Support Guidelines (in short: be nice, be respectful of volunteers' time, understand that maintainers and contributors cannot respond to all DMs, and keep discussions in the public #flux channel as much as possible).
• Have feature proposals or want to contribute?
  • Propose features on our GitHub Discussions page.
  • Join our upcoming dev meetings (meeting access and agenda).
  • Join the flux-dev mailing list.
  • Check out how to contribute to the project.
  • Check out the project roadmap.

Events

Check out our events calendar, both with upcoming talks, events and meetings you can attend. Or view the resources section with past events videos you can watch.

We look forward to seeing you with us!