README, values

Author: jakub-id

README.md

@@ -1,5 +1,7 @@
 # About
 
+This project provides Okapi deployment automation when deploying Okapi modules on Kubernetes.
+
 `okapi-hooks` is a helper container for Okapi module registration (deploy + install/uninstall + undeploy)
 and a corresponding Helm chart that binds to Helm's `post-instal` and `post-upgrade`
 [lifecycle hooks](https://helm.sh/docs/topics/charts_hooks/).
@@ -18,11 +20,11 @@ dependencies:
     version: ">0.1.0-0" #or a specific version
 ```
 
-the subchart is then configured with the following minimal values:
+the subchart must be configured with the following minimal values:
 
 ```yaml filename=values.yaml
 moduleUrl: "http://mod-x:80"
-moduleVersion: 0.1.0-main
+moduleVersion: 0.1.0-main #used to replace @version@ placeholder in MD
 moduleDescriptor: |
   {
     "id" : "mod-x-@version@",
@@ -34,14 +36,16 @@ tenants:
 ```
 see [values.yaml](./chart/values.yaml) for a complete list of configuration options.
 
-The parent chart is then build with
+The parent chart is then build with:
 
 ```bash
 cd /path/to/parent/chart
 helm dependency build
 helm package .
 ```
 
+The chart expects a deployed secret called `okapi-secret` with `OKAPI_USER/OKAPI_PASS` or `OKAPI_TOKEN` keys.
+
 ## Environment variables
 
 The container can be configured with the following environment variables:

chart/values.yaml

@@ -3,19 +3,24 @@
 nameOverride: ""
 fullnameOverride: ""
 
-#required, Okapi base URL with scheme and port
-okapiUrl: "http://okapi:9130"
-#required, Okapi secret name
-okapiSecret: "okapi-secret"
-#required, specify the module base URL with scheme and port
+#REQUIRED values that must be specified by the parent chart:
+
+#Module base URL with scheme and port, NO DEFAULT
 moduleUrl: ""
-#required, specify the ModuleDescriptor literal (JSON)
+#ModuleDescriptor literal (JSON), NO DEFAULT
 moduleDescriptor: ""
-#required, to be replaced in the ModuleDescriptor
-moduleVersion: "0.1.0"
-#required, specify the Okapi tenant(s) to be used
+#Okapi tenant(s) to deploy the module to, NO DEFAULTS
 tenants: []
-#required, specify the Okapi admin tenant(s) to be used
+
+#REQUIRED values with defaults in the subchart, may be overridden by parent chart:
+
+#Used to replace @version@ in the module descriptor, must be specified only if @version@ placeholder is used
+moduleVersion: "0.1.0"
+#Okapi base URL with scheme and port
+okapiUrl: "http://okapi:9130"
+#Okapi secret name, the secret must include OKAPI_USER/OKAPI_PASS or OKAPI_TOKEN keys
+okapiSecret: "okapi-secret"
+#Okapi admin tenant
 supertenant: supertenant