Skip to content

Commit 5779ab0

Browse files
author
Tonni Follmann
committed
chart readme generated with helm-docs
1 parent 7b75830 commit 5779ab0

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

charts/tf-controller/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ After that you can install TF-controller manually with Helm by:
1111

1212
```shell
1313
# Add tf-controller helm repository
14-
helm repo add tf-controller https://flux-iac.github.io/tofu-controller
14+
helm repo add tf-controller https://flux-iac.github.io/tofu-controller/
1515

1616
# Install tf-controller
17-
helm upgrade -i tf-controller tf-controller/tf-controller \
17+
helm upgrade -i tofu-controller tofu-controller/tf-controller \
1818
--namespace flux-system
1919
```
2020

@@ -34,9 +34,9 @@ __Note__: If you need to use the `imagePullSecrets` it would be best to set `ser
3434
| allowBreakTheGlass | bool | `false` | Argument for `--allow-break-the-glass` (Controller). AllowBreakTheGlass allows the controller to break the glass and modify Terraform states when the sync loop is broken. |
3535
| allowCrossNamespaceRefs | bool | `false` | If `true`, enable cross-namespace references for controller and branch-planner |
3636
| awsPackage.install | bool | `true` | |
37-
| awsPackage.repository | string | `"ghcr.io/tf-controller/aws-primitive-modules"` | |
37+
| awsPackage.repository | string | `"ghcr.io/flux-iac/aws-primitive-modules"` | |
3838
| awsPackage.tag | string | `"v4.38.0-v1alpha11"` | |
39-
| branchPlanner | object | `{"configMap":"branch-planner","enabled":false,"image":{"pullPolicy":"IfNotPresent","repository":"ghcr.io/weaveworks/branch-planner","tag":""},"podSecurityContext":{"fsGroup":1337},"pollingInterval":"30s","resources":{"limits":{"cpu":"1000m","memory":"1Gi"},"requests":{"cpu":"200m","memory":"64Mi"}},"securityContext":{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":65532,"seccompProfile":{"type":"RuntimeDefault"}},"sourceInterval":"30s"}` | Branch Planner-specific configurations |
39+
| branchPlanner | object | `{"configMap":"branch-planner","enabled":false,"image":{"pullPolicy":"IfNotPresent","repository":"ghcr.io/flux-iac/branch-planner","tag":""},"podSecurityContext":{"fsGroup":1337},"pollingInterval":"30s","resources":{"limits":{"cpu":"1000m","memory":"1Gi"},"requests":{"cpu":"200m","memory":"64Mi"}},"securityContext":{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":65532,"seccompProfile":{"type":"RuntimeDefault"}},"sourceInterval":"30s"}` | Branch Planner-specific configurations |
4040
| caCertValidityDuration | string | `"168h0m"` | Argument for `--ca-cert-validity-duration` (Controller) |
4141
| certRotationCheckFrequency | string | `"30m0s"` | Argument for `--cert-rotation-check-frequency` (Controller) |
4242
| certValidityDuration | string | `"6h0m"` | Argument for `--cert-validity-duration` (Controller) |
@@ -49,7 +49,7 @@ __Note__: If you need to use the `imagePullSecrets` it would be best to set `ser
4949
| extraEnv | object | `{}` | Additional container environment variables. |
5050
| fullnameOverride | string | `""` | Provide a fullname |
5151
| image.pullPolicy | string | `"IfNotPresent"` | Controller image pull policy |
52-
| image.repository | string | `"ghcr.io/weaveworks/tf-controller"` | Controller image repository |
52+
| image.repository | string | `"ghcr.io/flux-iac/tf-controller"` | Controller image repository |
5353
| image.tag | string | `.Chart.AppVersion` | Overrides the image tag whose default is the chart appVersion. |
5454
| imagePullSecrets | list | `[]` | Controller image pull secret |
5555
| installCRDs | bool | `true` | If `true`, install CRDs as part of the helm installation |
@@ -77,10 +77,10 @@ __Note__: If you need to use the `imagePullSecrets` it would be best to set `ser
7777
| rbac.create | bool | `true` | If `true`, create and use RBAC resources |
7878
| replicaCount | int | `1` | Number of TF-Controller pods to deploy |
7979
| resources | object | `{"limits":{"cpu":"1000m","memory":"1Gi"},"requests":{"cpu":"200m","memory":"64Mi"}}` | Resource limits and requests |
80-
| runner | object | `{"creationTimeout":"5m0s","grpc":{"maxMessageSize":4},"image":{"repository":"ghcr.io/weaveworks/tf-runner","tag":"v0.16.0-rc.3"},"serviceAccount":{"allowedNamespaces":[],"annotations":{},"create":true,"name":""}}` | Runner-specific configurations |
80+
| runner | object | `{"creationTimeout":"5m0s","grpc":{"maxMessageSize":4},"image":{"repository":"ghcr.io/flux-iac/tf-runner","tag":"v0.16.0-rc.3"},"serviceAccount":{"allowedNamespaces":[],"annotations":{},"create":true,"name":""}}` | Runner-specific configurations |
8181
| runner.creationTimeout | string | `"5m0s"` | Timeout for runner-creation (Controller) |
8282
| runner.grpc.maxMessageSize | int | `4` | Maximum GRPC message size (Controller) |
83-
| runner.image.repository | string | `"ghcr.io/weaveworks/tf-runner"` | Runner image repository |
83+
| runner.image.repository | string | `"ghcr.io/flux-iac/tf-runner"` | Runner image repository |
8484
| runner.image.tag | string | `.Chart.AppVersion` | Runner image tag |
8585
| runner.serviceAccount.allowedNamespaces | list | `[]` | List of namespaces that the runner may run within |
8686
| runner.serviceAccount.annotations | object | `{}` | Additional runner service Account annotations |
@@ -96,4 +96,4 @@ __Note__: If you need to use the `imagePullSecrets` it would be best to set `ser
9696
| volumes | list | `[]` | Volumes properties for the TF-Controller deployment |
9797

9898
----------------------------------------------
99-
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
99+
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)

0 commit comments

Comments
 (0)