improve helm documentation

Author: Knappek

CHANGELOG.md

@@ -23,6 +23,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Change above affects also `"response_from": "kafka"` proxy functionality. RIG will forward to clients only Kafka body, no headers. This means, when using binary mode, clients receive only the data part, no CloudEvents context attributes.
 - Changed `response_from` handler to expect a message in binary format, **NOT** a cloud event (`kafka` and `http_async`). [#321](https://github.com/Accenture/reactive-interaction-gateway/pull/321)
 - Updated Helm v2 template, kubectl yaml file and instructions in the `deployment` folder [#288](https://github.com/Accenture/reactive-interaction-gateway/issues/288)
+- Publish Helm Chart to Github pages. With this change, we can simply install the chart using
+
+    ```shell
+    helm repo add accenture https://accenture.github.io/reactive-interaction-gateway
+    helm install rig accenture/reactive-interaction-gateway
+    ```
+  
+  More information, follow the [deployment Readme](./deployment/README.md). [#319](https://github.com/Accenture/reactive-interaction-gateway/issues/319)
 
 ### Fixed
 

deployment/README.md

@@ -1,34 +1,28 @@
 # Running RIG on Kubernetes
 
-## Kubectl
+The easiest way to deploy RIG is using Helm:
 
-```bash
-kubectl apply -f kubectl/rig.yaml
+```shell
+helm repo add accenture https://accenture.github.io/reactive-interaction-gateway
+# Helm v3
+helm install rig accenture/reactive-interaction-gateway
+# Helm v2
+helm install --name=rig accenture/reactive-interaction-gateway-helm-v2
 ```
 
-## Helm
+Check out the [Helm v2 README](helm/reactive-interaction-gateway-helm-v2/README.md) or [Helm v3 README](./helm/reactive-interaction-gateway/README.md) and [Operator's Guide](https://accenture.github.io/reactive-interaction-gateway/docs/rig-ops-guide.html) for more information on configuring RIG.
 
-The Helm Charts in [./helm/reactive-interaction-gateway-helm-v2](./helm/reactive-interaction-gateway-helm-v2) and [./helm/reactive-interaction-gateway](./helm/reactive-interaction-gateway) are essentially the same but only use a different `apiVersion` in the `Chart.yaml`.
+## Deploy with kubectl
 
-### Version 2
+> This deployment is not recommended as lots of configurations is hard coded
 
 ```bash
-cd helm
-# install
-helm install --name=rig reactive-interaction-gateway-helm-v2
+kubectl apply -f kubectl/rig.yaml
 ```
 
-### Version 3
+## Some Additional information
 
-```bash
-cd helm
-# dry run to verify that everything is ok
-helm install rig reactive-interaction-gateway --dry-run
-# install
-helm install rig reactive-interaction-gateway
-```
-
-## Communication
+### Communication
 
 Both `kubectl` and `helm` deploy bunch of Kubernetes resources:
 
@@ -40,25 +34,26 @@ To allow external communication (outside of your cluster) do:
 
 ```bash
 # both helm versions
-helm upgrade --set service.type=LoadBalancer rig reactive-interaction-gateway
+helm upgrade --set service.type=LoadBalancer rig accenture/reactive-interaction-gateway
 # for kubectl update kubectl/rig.yaml to use a service of type LoadBalancer instead of ClusterIP
 ```
 
-## Scaling
+### Scaling
 
 Scale the deployment and create multiple pods
 
 ```bash
-helm upgrade --set service.type=LoadBalancer --set replicaCount=<replicas> rig reactive-interaction-gateway
+# both helm versions
+helm upgrade --set service.type=LoadBalancer --set replicaCount=<replicas> rig accenture/reactive-interaction-gateway
 # or
 kubectl scale deployment/<deployment_name> --replicas <replicas>
 ```
 
 You can also inspect the logs of the pods with `kubectl logs <pod_name>` to see how they automatically re-balance Kafka consumers (if you are using Kafka) and adapt Proxy APIs from other nodes.
 
-## Configuration
+### Configuration
 
-### Node host
+#### Node host
 
 Every node in cluster needs to be discoverable by other nodes. For that Elixir/Erlang uses so called `long name` or `short name`. We are using `long name` which is formed in the following way `app_name@node_host`. `app_name` is in our case set to `rig` and `node_host` is taken from environment variable `NODE_HOST`. This can be either IP or container alias or whatever that is routable in network by other nodes.
 
@@ -71,13 +66,13 @@ We are using the pod IP with:
       fieldPath: status.podIP
 ```
 
-### Node cookie
+#### Node cookie
 
 Nodes in Erlang cluster use cookies as a form of authorization/authentication between them. Only nodes with the same cookie can communicate together. Ideally, it is some generated hash, that's why we recommend adapting `NODE_COOKIE` environment variable in the `values.yaml`.
 
-### Additional configuration
+#### Additional configuration
 
-You can configure bunch of environment variables, please check the [Operator's Guide](https://accenture.github.io/reactive-interaction-gateway/docs/rig-ops-guide.html).
+You can configure bunch of environment variables, please check the [Helm v2 README](helm/reactive-interaction-gateway-helm-v2/README.md) or [Helm v3 README](./helm/reactive-interaction-gateway/README.md) and [Operator's Guide](https://accenture.github.io/reactive-interaction-gateway/docs/rig-ops-guide.html).
 
 ## Cleanup
 

deployment/helm/reactive-interaction-gateway-helm-v2/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v1
-name: reactive-interaction-gateway
-description: A Helm chart for Kubernetes
+name: reactive-interaction-gateway-helm-v2
+description: A Helm v2 chart for Kubernetes
 home: https://github.com/Accenture/reactive-interaction-gateway
 icon: https://github.com/Accenture/reactive-interaction-gateway/blob/master/logo/Reactive-Interaction-Gateway-logo-cropped.png
 
@@ -14,5 +14,8 @@ appVersion: 3.0.0-alpha.1
 
 maintainers:
   - name: kevinbader
+    url: https://github.com/kevinbader
   - name: mmacai
+    url: https://github.com/mmacai
   - name: Knappek
+    url: https://github.com/Knappek

deployment/helm/reactive-interaction-gateway-helm-v2/README.md

@@ -0,0 +1,35 @@
+# reactive-interaction-gateway-helm-v2
+
+![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![AppVersion: 3.0.0-alpha.1](https://img.shields.io/badge/AppVersion-3.0.0-alpha.1-informational?style=flat-square)
+
+A Helm v2 chart for Kubernetes
+
+**Homepage:** <https://github.com/Accenture/reactive-interaction-gateway>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| kevinbader |  | https://github.com/kevinbader |
+| mmacai |  | https://github.com/mmacai |
+| Knappek |  | https://github.com/Knappek |
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| deployment.env.API_HTTPS_PORT | int | `4011` | See docs/rig-ops-guide.md |
+| deployment.env.API_HTTP_PORT | int | `4010` | See docs/rig-ops-guide.md |
+| deployment.env.DISCOVERY_TYPE | string | `"dns"` | See docs/rig-ops-guide.md |
+| deployment.env.INBOUND_HTTPS_PORT | int | `4001` | See docs/rig-ops-guide.md |
+| deployment.env.INBOUND_PORT | int | `4000` | See docs/rig-ops-guide.md |
+| deployment.env.LOG_LEVEL | string | `"warn"` | See docs/rig-ops-guide.md |
+| deployment.env.NODE_COOKIE | string | `"magiccookie"` | See docs/rig-ops-guide.md |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"accenture/reactive-interaction-gateway"` |  |
+| nodeSelector | object | `{}` |  |
+| replicaCount | int | `1` |  |
+| resources | object | `{}` |  |
+| service.type | string | `"ClusterIP"` |  |
+| tolerations | list | `[]` |  |

deployment/helm/reactive-interaction-gateway-helm-v2/values.yaml

@@ -16,11 +16,14 @@ service:
 
 deployment:
   env:
-    ## Proxy ports
+    # Proxy ports
+    # deployment.env.INBOUND_PORT -- See docs/rig-ops-guide.md
     INBOUND_PORT: 4000
+    # deployment.env.INBOUND_HTTPS_PORT -- See docs/rig-ops-guide.md
     INBOUND_HTTPS_PORT: 4001
-    ## Internal HTTP API ports
+    # deployment.env.API_HTTP_PORT -- See docs/rig-ops-guide.md
     API_HTTP_PORT: 4010
+    # deployment.env.API_HTTPS_PORT -- See docs/rig-ops-guide.md
     API_HTTPS_PORT: 4011
 
     ## Hostname for HTTP endpoints
@@ -35,10 +38,11 @@ deployment:
     # CORS: *
 
     ## Discovery
+    # deployment.env.DISCOVERY_TYPE -- See docs/rig-ops-guide.md
     DISCOVERY_TYPE: dns
     ## DNS_NAME is set dynamically
     ## NODE_HOST is set dynamically to PodIP in "templates/deployment.yaml"
-    ## Change magiccookie to some individual hash
+    # deployment.env.NODE_COOKIE -- See docs/rig-ops-guide.md
     NODE_COOKIE: magiccookie
 
 
@@ -101,7 +105,8 @@ deployment:
     # JWT_SESSION_FIELD: /userId
 
     ## Logging
-    # REQUEST_LOG: console,kafka
+    ## REQUEST_LOG: console,kafka
+    # deployment.env.LOG_LEVEL -- See docs/rig-ops-guide.md
     LOG_LEVEL: warn
 
     ## SSE, WS

deployment/helm/reactive-interaction-gateway/Chart.yaml

@@ -14,5 +14,8 @@ appVersion: 2.4.0
 
 maintainers:
   - name: kevinbader
+    url: https://github.com/kevinbader
   - name: mmacai
+    url: https://github.com/mmacai
   - name: Knappek
+    url: https://github.com/Knappek

deployment/helm/reactive-interaction-gateway/README.md

@@ -0,0 +1,35 @@
+# reactive-interaction-gateway
+
+![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![AppVersion: 2.4.0](https://img.shields.io/badge/AppVersion-2.4.0-informational?style=flat-square)
+
+A Helm chart for Kubernetes
+
+**Homepage:** <https://github.com/Accenture/reactive-interaction-gateway>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| kevinbader |  | https://github.com/kevinbader |
+| mmacai |  | https://github.com/mmacai |
+| Knappek |  | https://github.com/Knappek |
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| deployment.env.API_HTTPS_PORT | int | `4011` | See docs/rig-ops-guide.md |
+| deployment.env.API_HTTP_PORT | int | `4010` | See docs/rig-ops-guide.md |
+| deployment.env.DISCOVERY_TYPE | string | `"dns"` | See docs/rig-ops-guide.md |
+| deployment.env.INBOUND_HTTPS_PORT | int | `4001` | See docs/rig-ops-guide.md |
+| deployment.env.INBOUND_PORT | int | `4000` | See docs/rig-ops-guide.md |
+| deployment.env.LOG_LEVEL | string | `"warn"` | See docs/rig-ops-guide.md |
+| deployment.env.NODE_COOKIE | string | `"magiccookie"` | See docs/rig-ops-guide.md |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"accenture/reactive-interaction-gateway"` |  |
+| nodeSelector | object | `{}` |  |
+| replicaCount | int | `1` |  |
+| resources | object | `{}` |  |
+| service.type | string | `"ClusterIP"` |  |
+| tolerations | list | `[]` |  |

deployment/helm/reactive-interaction-gateway/values.yaml

@@ -16,11 +16,14 @@ service:
 
 deployment:
   env:
-    ## Proxy ports
+    # Proxy ports
+    # deployment.env.INBOUND_PORT -- See docs/rig-ops-guide.md
     INBOUND_PORT: 4000
+    # deployment.env.INBOUND_HTTPS_PORT -- See docs/rig-ops-guide.md
     INBOUND_HTTPS_PORT: 4001
-    ## Internal HTTP API ports
+    # deployment.env.API_HTTP_PORT -- See docs/rig-ops-guide.md
     API_HTTP_PORT: 4010
+    # deployment.env.API_HTTPS_PORT -- See docs/rig-ops-guide.md
     API_HTTPS_PORT: 4011
 
     ## Hostname for HTTP endpoints
@@ -35,10 +38,11 @@ deployment:
     # CORS: *
 
     ## Discovery
+    # deployment.env.DISCOVERY_TYPE -- See docs/rig-ops-guide.md
     DISCOVERY_TYPE: dns
     ## DNS_NAME is set dynamically
     ## NODE_HOST is set dynamically to PodIP in "templates/deployment.yaml"
-    ## Change magiccookie to some individual hash
+    # deployment.env.NODE_COOKIE -- See docs/rig-ops-guide.md
     NODE_COOKIE: magiccookie
 
 
@@ -101,7 +105,8 @@ deployment:
     # JWT_SESSION_FIELD: /userId
 
     ## Logging
-    # REQUEST_LOG: console,kafka
+    ## REQUEST_LOG: console,kafka
+    # deployment.env.LOG_LEVEL -- See docs/rig-ops-guide.md
     LOG_LEVEL: warn
 
     ## SSE, WS

docs/rig-dev-guide.md

@@ -44,6 +44,7 @@ To have the project use a newer Elixir version, make sure to change the followin
 
 - Increment `rig` version in the [version](../version) file
 - Increment `appVersion` in the [Helm v2 Chart.yaml](../deployment/helm2/reactive-interaction-gateway/Chart.yaml) and [Helm v3 Chart.yaml](../deployment/helm3/reactive-interaction-gateway/Chart.yaml) files
+- Update Helm chart README files: install [helm-docs](https://github.com/norwoodj/helm-docs) and run `helm-docs` in the root directory
 - Increment image tag in the [Kubernetes rig.yaml](../deployment/kubectl/rig.yaml) file
 - In [CHANGELOG.md](../CHANGELOG.md), rename `[Unreleased]` and add a corresponding link to the bottom of the file
 - Create a signed Git tag either using `git -s` or by creating a release using the Github UI

docs/scaling.md

@@ -20,8 +20,9 @@ Even though it's possible to run RIG anywhere, we recommend to use Kubernetes.
 kubectl scale deployment/reactive-interaction-gateway --replicas 3
 
 # Start right away with 3 nodes using Helm template -- (assuming you are in the deployment directory)
-# v2
-helm install --set replicaCount=3 --name=rig helm2/reactive-interaction-gateway
-# v3
-helm install --set replicaCount=3 rig helm3/reactive-interaction-gateway
+helm repo add accenture https://accenture.github.io/reactive-interaction-gateway
+# Helm v3
+helm install --set replicaCount=3 rig accenture/reactive-interaction-gateway
+# Helm v2
+helm install --set replicaCount=3 --name=rig accenture/reactive-interaction-gateway
 ```