Current status

REANA Helm chart allows to use various environment variables to govern the behaviour of its infrastructure components.

Sometimes these variables are not documented. For example, the authentication sidecar version can be customised via:

components:
  reana_job_controller:
    environment:
      KRB5_CONTAINER_IMAGE: "registry.cern.ch/reanahub/reana-auth-krb5:1.0.3"

But the KRB5_CONTAINER_IMAGE variable name is not exposed in the Helm documentation file helm/reana/README.md.

Another example of this kind is REANA_WORKFLOW_ENGINE_IMAGE_CWL.

Expected behaviour

All the environment variables that REANA Helm chart allows to set by the person deploying REANA should be properly exposed in helm/reana/README.md.

Here is an example of a "good" environment variable that appears both in the template and in the docs:

$ rg REANA_OPENSEARCH_USER
helm/reana/values.yaml
125:      REANA_OPENSEARCH_USER: reana

helm/reana/README.md
63:| `components.reana_workflow_controller.environment.REANA_OPENSEARCH_USER`                                  | OpenSearch user name for Basic Authentication.                                                                                                                                                                                                                                                                                                                                                                                       | reana                                                                                                  |

The purpose of this issue is to go through all the REANA Helm template files and document all not-yet-documented environment variables in this kind.