stackabletech / issues

This repository is only for issues that concern multiple repositories or don't fit into any specific repository
2 stars 0 forks source link

Rework operator ENV/CLI documentation section #670

Open maltesander opened 3 days ago

maltesander commented 3 days ago

The Stackable operators offer several configuration settings that are exposed via ENV / CLI variables (e.g. WATCH_NAMESPACE, or KUBERNETES_CLUSTER_DOMAIN).

This currently is documented in most cases similar to Airflow.

We have a separated page for ENV and CLI variables in most operators, which can be summarized as seen here.

Additionally we supply commands to run the operator via cargo or docker, which does not really fit the user documentation and if anything should be moved to the contributors guide.

This should be consolidated to reflect all possible settings via ENV/CLI or even better autogenerated (e.g. all information should be available via --help options in operators).

### Research
- [ ] Can the ENV/CLI part be autogenerated?
- [ ] Can we summarize the ENV/CLI docs in the platform docs instead of each operator