Skip to content

Commit 8d507ec

Browse files
committed
improve doc
1 parent 0f3d21a commit 8d507ec

1 file changed

Lines changed: 19 additions & 4 deletions

File tree

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
11
# tf-controller
22

3-
A Terraform controller for Flux
3+
`tf-controller` is an experimental controller for Flux to reconcile Terraform resources.
44

55
## Quick start
66

7-
Here's a simple example of how to GitOps-ify your Terraform resources with TF controller and Flux.
7+
Here's a simple example of how to GitOps-ify your Terraform resources with `tf-controller` and Flux.
8+
9+
### Define source
10+
11+
```yaml
12+
apiVersion: source.toolkit.fluxcd.io/v1beta1
13+
kind: GitRepository
14+
metadata:
15+
name: helloworld
16+
namespace: flux-system
17+
spec:
18+
interval: 30s
19+
url: https://github.com/tf-controller/helloworld
20+
ref:
21+
branch: main
22+
```
823
924
### Auto-mode
1025
1126
```yaml
12-
apiVersion: infra.contrib.fluxcd.io
27+
apiVersion: infra.contrib.fluxcd.io/v1alpha1
1328
kind: Terraform
1429
metadata:
1530
name: hello-world
@@ -23,7 +38,7 @@ spec:
2338
namespace: flux-system
2439
```
2540
26-
### Plan and manually approve
41+
### Plan and manual approval
2742
2843
```diff
2944
apiVersion: infra.contrib.fluxcd.io/v1alpha1

0 commit comments

Comments
 (0)