tf-controller

README

TF-controller: GitOps Terraform at your own pace

TF-controller is an experimental controller for Flux to reconcile Terraform resources in the GitOps way. With the power of Flux together with Terraform, TF-controller allows you to GitOps-ify infrastructure, and application resources, in the Kubernetes and Terraform universe, at your own pace.

"At your own pace" means you don't need to GitOps-ify everything at once.

TF-controller offers many GitOps models:

1. Full GitOps Automation Model: GitOps your Terraform resources from the provision steps to the enforcement steps, like a whole EKS cluster.
2. Hybrid GitOps Automation Model: GitOps parts of your existing infrastructure resources. For example, you have an existing EKS cluster. You can choose to GitOps only its nodegroup, or its security group.
3. State Enforcement Model: You have a TFSTATE file, and you'd like to use GitOps enforce it, without changing anything else.
4. Drift Detection Model: You have a TFSTATE file, and you'd like to use GitOps just for drift detection, so you can decide to do things later when a drift occurs.

Quickstart and documentation

To get started check out this guide on how to GitOps your Terraform resources with TF-controller and Flux.

Check out the documentation for a list of features and use cases.

Stargazers over time

Roadmap

Q1 2022

• Support the GitOps way to "apply"
• Drift detection
• Support auto-apply so that the reconciliation detect drifts and always make changes
• Interop with Kustomization controller's health checks
• Terraform outputs as Kubernetes Secrets
• Secret and ConfigMap as input variables
• Support the GitOps way to "plan" / "re-plan"
• Support a multi-tenant model
• Test coverage reaching 70%

Q2 2022

• Performance and scalability
• Interop with Notification controller's Events and Alert
• Test coverage reaching 75%

Q3 2022

• Write back and show plan in PRs
• Test coverage reaching 80%