Merge pull request #5 from small-hack/add-comments-and-notes

Update README.md and values.yaml comments

README.md

@@ -1,3 +1,16 @@
 # CloudNativePG Tenant Chart
 
 https://small-hack.github.io/cloudnative-pg-tenant-chart/
+
+## TLDR
+
+```bash
+# add the helm repo locally
+helm repo add cnpg https://small-hack.github.io/cloudnative-pg-tenant-chart
+
+# get the values and edit them if needed
+helm show values cnpg/cnpg-tenant > values.yaml
+
+# install the chart
+helm install cnpg cnpg/cnpg-tenant --values values.yaml
+```

charts/cloudnative-pg-tenant/values.yaml

@@ -7,15 +7,19 @@ superuserSecret:
 
 bootstrap:
   initdb:
+    # -- initial database to create
     database: app
+    # -- owner of the initial database that is created above
     owner: app
     secret:
       name: app-secret
+    # -- list of SQL commands to run as part of the init scripts
     postInitSQL:
       - CREATE ROLE friend
 
 backup:
   destinationPath: "backups"
+  # -- how long to keep backups for
   retentionPolicy: "30d"
   s3Credentials:
     accessKeyId:
@@ -38,9 +42,9 @@ monitoring:
   enablePodMonitor: true
 
 postgresql:
-  pg_hba: 
+  pg_hba:
     - hostnossl all all 0.0.0.0/0 reject
     - hostssl all all 0.0.0.0/0 cert clientcert=verify-full
 
-storage: 
+storage:
   size: 1Gi