Configuration reference documentation

[szvincze]

Motivation

Currently there is no documentation how to configure the different NSM components, the users can only use the examples from deployments-k8s repository.
However the executable components dumps a table with the environment variables they use for configuration into their log, it would be desirable to have them in a document that can be used by the users if they want to differ from the examples.

Here is a link to a draft document I created that bundles configuration of some basic NSM system components.

The idea is to create configuration reference document for each configurable components per release and create automated check in the CI if the documents are still valid or there are changes in the code that shall be updated in the document.
Additionally there could be a parameter implemented in the commands that supports the automated generation and validity check of the documents too. Though I think, creating such documents manually and checking them would be quite a good first step.