📖 Add Helm chart readme file (#239)

README.md

@@ -38,7 +38,17 @@ The full list of supported Terraform Cloud features can be found [here](./docs/f
 
 ### Installation
 
-Installation documentation can be found [here](./docs/installation.md).
+The Operator provides [Helm chart](../charts/terraform-cloud-operator) as a first-class method of installation on Kubernetes.
+
+Three simple commands to install the Operator:
+
+```console
+$ helm repo add hashicorp https://helm.releases.hashicorp.com
+$ helm repo update
+$ helm install demo hashicorp/terraform-cloud-operator --wait --version 2.0.0-beta7
+```
+
+More detailed information about the installation and available values can be found [here](../charts/terraform-cloud-operator).
 
 ### Usage
 

docs/installation.md → charts/terraform-cloud-operator/README.md

@@ -1,7 +1,5 @@
 # Installation
 
-The Operator provides [Helm chart](../charts/terraform-cloud-operator) as a first-class method of installation on Kubernetes.
-
 ## :warning: Beta :warning:
 
 By default, Helm does not display development versions (alpha, beta, and release candidate releases). In order to list them, use the following command when looking for available versions:
@@ -29,8 +27,7 @@ Use the option `--version VERSION` with `helm install` and `helm upgrade` comman
 3. Install
 
     ```console
-    $ helm install \
-      demo hashicorp/terraform-cloud-operator \
+    $ helm install demo hashicorp/terraform-cloud-operator \
       --version 2.0.0-beta7 \
       --namespace tfc-operator-system \
       --create-namespace
@@ -41,8 +38,7 @@ Below are examples of the Operator installation/upgrade Helm chart with options.
 ### Install with options
 
 ```console
-$ helm install \
-  demo hashicorp/terraform-cloud-operator \
+$ helm install demo hashicorp/terraform-cloud-operator \
   --version 2.0.0-beta7 \
   --namespace tfc-operator-system \
   --create-namespace \
@@ -71,8 +67,7 @@ that TLS certificate should be installed with the operator by setting the `custo
 ### Upgrade with options
 
 ```console
-$ helm upgrade \
-  demo hashicorp/terraform-cloud-operator \
+$ helm upgrade demo hashicorp/terraform-cloud-operator \
   --version 2.0.0-beta7 \
   --namespace tfc-operator-system \
   --set operator.syncPeriod=5m \
@@ -82,3 +77,24 @@ $ helm upgrade \
 ```
 
 In the above example, the Operator will watch all namespaces in the Kubernetes cluster.
+
+# Values
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| replicaCount | int | 2 | Number of Terraform Cloud Operator replicas. |
+| operator.image.repository | string | "hashicorp/terraform-cloud-operator" | Image repository. |
+| operator.image.pullPolicy | string | "IfNotPresent" | Image pull policy. |
+| operator.image.tag | string | "" | Image tag. |
+| operator.resources.limits.cpu | string | "500m" | Limits as a maximum amount of CPU to be used by a container. |
+| operator.resources.limits.memory | string | "128Mi" | Limits as a maximum amount of memory to be used by a container. |
+| operator.resources.requests.cpu | string | "50m" | Guaranteed minimum amount of CPU to be used by a container. |
+| operator.resources.requests.memory | string | "64Mi" | Guaranteed minimum amount of memory to be used by a container. |
+| operator.syncPeriod | string | "5m" | The minimum frequency at which watched resources are reconciled. Format: 5s, 1m, etc. |
+| operator.watchedNamespaces | list | [] | List of namespaces the controllers should watch. |
+| operator.tfeAddress | string | "" | The API URL of a Terraform Enterprise instance. |
+| operator.skipTLSVerify | bool | false | Whether or not to ignore TLS certification warnings. |
+| controllers.agentPool.workers | int | 1 | The number of the Agent Pool controller workers. |
+| controllers.module.workers | int | 1 | The number of the Module controller workers. |
+| controllers.workspace.workers | int | 1 | The number of the Workspace controller workers. |
+| customCAcertificates | string | "" | Custom Certificate Authority bundle to validate API TLS certificates. Expects a path to a CRT file containing concatenated certificates. |

charts/terraform-cloud-operator/values.yaml

@@ -20,12 +20,12 @@ operator:
   # Operator-global options.
   # The minimum frequency at which watched resources are reconciled.
   # Format: 5s, 1m, etc.
-  syncPeriod: "5m"
+  syncPeriod: 5m
 
-  # List of namespaces the controllers should monitor
+  # List of namespaces the controllers should watch.
   watchedNamespaces: []
 
-  # The API URL of a TFE instance
+  # The API URL of a TFE instance.
   tfeAddress: ""
 
   # Whether or not to ignore TLS certification warnings.
@@ -43,6 +43,6 @@ controllers:
     # The number of the Workspace controller workers.
     workers: 1
 
-# Custom Certificate Authority bundle to validate API TLS certificates
-# Expects a path to a CRT file containing concatenated certificates
+# Custom Certificate Authority bundle to validate API TLS certificates.
+# Expects a path to a CRT file containing concatenated certificates.
 customCAcertificates: ""