From c5268df8a76a250e5dac9f1fcd18e17efbb2dc36 Mon Sep 17 00:00:00 2001 From: Dan Murphy Date: Tue, 19 Mar 2024 11:27:43 +0100 Subject: [PATCH 1/3] chore: #1247 helm readme update to tofo-controller --- charts/tf-controller/README.md | 19 +++++++++++-------- charts/tf-controller/README.md.gotmpl | 19 +++++++++++-------- 2 files changed, 22 insertions(+), 16 deletions(-) diff --git a/charts/tf-controller/README.md b/charts/tf-controller/README.md index 84b67107..a9a2813d 100644 --- a/charts/tf-controller/README.md +++ b/charts/tf-controller/README.md @@ -1,17 +1,20 @@ -# Weave GitOps Terraform Controller +# Tofu Controller ![Version: 0.16.0-rc.4](https://img.shields.io/badge/Version-0.16.0--rc.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.16.0-rc.4](https://img.shields.io/badge/AppVersion-v0.16.0--rc.4-informational?style=flat-square) -The Helm chart for Weave GitOps Terraform Controller +This is the Helm chart for the [Tofu Controller](https://github.com/flux-iac/tofu-controller), an IAC controller for Flux [Flux](https://fluxcd.io) to reconcile OpenTofu and Terraform resources in the GitOps way. + +## Prerequisites + +Before using tofu-controller, you must to install Flux by using either `flux install` or `flux bootstrap` command. For full instructions see [Flux installation](https://fluxcd.io/flux/installation/) ## Installation -Before using TF-controller, you have to install Flux by using either `flux install` or `flux bootstrap` command. -After that you can install TF-controller manually with Helm by: +To install tofu-controller manually using Helm: ```shell -# Add tf-controller helm repository -helm repo add tf-controller https://flux-iac.github.io/tofu-controller/ +# Add tofu-controller helm repository +helm repo add tofu-controller https://flux-iac.github.io/tofu-controller/ # Install tf-controller helm upgrade -i tofu-controller tofu-controller/tf-controller \ @@ -20,11 +23,11 @@ helm upgrade -i tofu-controller tofu-controller/tf-controller \ ### Using cross-namespace references -The Terraform CRD for TF-controller includes references to other objects, for example to a Flux source, which can be in a different namespace to the Terraform. However, being able to access objects in another namespace is usually considered a security risk, so references crossing namespaces are (since version 0.16.0) disallowed by default. If you want to allow them, set the Helm chart value `allowCrossNamespaceRefs: true` (see the table below). +The Terraform CRDs for tofu-controller can include references to other objects, for example to a Flux source, which can be in a different namespace to the Terraform CRD. However, being able to access objects in another namespace is usually considered a security risk, so references crossing namespaces are (since version 0.16.0) disallowed by default. If you want to allow them, set the Helm chart value `allowCrossNamespaceRefs: true` (see the table below). ## Configuration -The following table lists the configurable parameters of the TF-controller chart and their default values. +The following table lists the configurable parameters of the tofu-controller chart and their default values. __Note__: If you need to use the `imagePullSecrets` it would be best to set `serviceAccount.create: true` and `runner.serviceAccount.create: true` diff --git a/charts/tf-controller/README.md.gotmpl b/charts/tf-controller/README.md.gotmpl index 67e9b779..4be6189a 100644 --- a/charts/tf-controller/README.md.gotmpl +++ b/charts/tf-controller/README.md.gotmpl @@ -1,17 +1,20 @@ -# Weave GitOps Terraform Controller +# Tofu Controller {{ template "chart.badgesSection" . }} -The Helm chart for Weave GitOps Terraform Controller +This is the Helm chart for the [Tofu Controller](https://github.com/flux-iac/tofu-controller), an IAC controller for Flux [Flux](https://fluxcd.io) to reconcile OpenTofu and Terraform resources in the GitOps way. + +## Prerequisites + +Before using tofu-controller, you must to install Flux by using either `flux install` or `flux bootstrap` command. For full instructions see [Flux installation](https://fluxcd.io/flux/installation/) ## Installation -Before using TF-controller, you have to install Flux by using either `flux install` or `flux bootstrap` command. -After that you can install TF-controller manually with Helm by: +To install tofu-controller manually using Helm: ```shell -# Add tf-controller helm repository -helm repo add tf-controller https://flux-iac.github.io/tofu-controller/ +# Add tofu-controller helm repository +helm repo add tofu-controller https://flux-iac.github.io/tofu-controller/ # Install tf-controller helm upgrade -i tofu-controller tofu-controller/tf-controller \ @@ -20,11 +23,11 @@ helm upgrade -i tofu-controller tofu-controller/tf-controller \ ### Using cross-namespace references -The Terraform CRD for TF-controller includes references to other objects, for example to a Flux source, which can be in a different namespace to the Terraform. However, being able to access objects in another namespace is usually considered a security risk, so references crossing namespaces are (since version 0.16.0) disallowed by default. If you want to allow them, set the Helm chart value `allowCrossNamespaceRefs: true` (see the table below). +The Terraform CRDs for tofu-controller can include references to other objects, for example to a Flux source, which can be in a different namespace to the Terraform CRD. However, being able to access objects in another namespace is usually considered a security risk, so references crossing namespaces are (since version 0.16.0) disallowed by default. If you want to allow them, set the Helm chart value `allowCrossNamespaceRefs: true` (see the table below). ## Configuration -The following table lists the configurable parameters of the TF-controller chart and their default values. +The following table lists the configurable parameters of the tofu-controller chart and their default values. __Note__: If you need to use the `imagePullSecrets` it would be best to set `serviceAccount.create: true` and `runner.serviceAccount.create: true` From a9c95e7b8447af8978df8fc59217f595c2440b48 Mon Sep 17 00:00:00 2001 From: Dan Murphy Date: Wed, 20 Mar 2024 09:48:09 +0100 Subject: [PATCH 2/3] chore: #1247 helm readme update Signed-off-by: Dan Murphy --- charts/tf-controller/README.md.gotmpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/tf-controller/README.md.gotmpl b/charts/tf-controller/README.md.gotmpl index 4be6189a..83e47359 100644 --- a/charts/tf-controller/README.md.gotmpl +++ b/charts/tf-controller/README.md.gotmpl @@ -6,7 +6,7 @@ This is the Helm chart for the [Tofu Controller](https://github.com/flux-iac/tof ## Prerequisites -Before using tofu-controller, you must to install Flux by using either `flux install` or `flux bootstrap` command. For full instructions see [Flux installation](https://fluxcd.io/flux/installation/) +Before using tofu-controller, you must install Flux by using either `flux install` or `flux bootstrap` command. For full instructions see [Flux installation](https://fluxcd.io/flux/installation/) ## Installation From e16d15c4f3a2a2b4d455694b40f39cd98f0c29c4 Mon Sep 17 00:00:00 2001 From: Dan Murphy Date: Wed, 20 Mar 2024 09:50:10 +0100 Subject: [PATCH 3/3] chore: #1247 helm readme update Signed-off-by: Dan Murphy --- charts/tf-controller/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/tf-controller/README.md b/charts/tf-controller/README.md index a9a2813d..40a22795 100644 --- a/charts/tf-controller/README.md +++ b/charts/tf-controller/README.md @@ -6,7 +6,7 @@ This is the Helm chart for the [Tofu Controller](https://github.com/flux-iac/tof ## Prerequisites -Before using tofu-controller, you must to install Flux by using either `flux install` or `flux bootstrap` command. For full instructions see [Flux installation](https://fluxcd.io/flux/installation/) +Before using tofu-controller, you must install Flux by using either `flux install` or `flux bootstrap` command. For full instructions see [Flux installation](https://fluxcd.io/flux/installation/) ## Installation