document resource limits

[fhennig]

There is a common resource in the operator-rs to configure pod resource settings. We want to have some documentation for the resources concept that can be linked from the operators. It should be similar to this page: https://docs.stackable.tech/home/stable/concepts/s3.html.

Blocking / Open questions

• Operators use different names and amounts of PVCs. How do we want to handle this via a general concepts page?
• Java product-based Operators e.g. calculate down the heap memory (currently 0.8 * pod memory) that will be set for the process. How do we specify this per operator (not required for python based ones)?

Acceptance

• A new concepts page for resources is included in the documentation
• This page shows the usage of allocating PVCs (with a hint that this must adhere to the PVCs required by the operator)
• This page shows the utilization of memory and CPU settings
• Optional: The relationship of pod memory and e.g. Java heap is described (not sure this belongs in a general concepts page)
• This page is referenced by all operators using these resources (please add the Issues/PRs here)

Products

• Airflow [Merged by Bors] - document resource limits airflow-operator#172
• Druid [Merged by Bors] - document resource limits druid-operator#308
• HBase [Merged by Bors] - document resource limits hbase-operator#256
• Hadoop HDFS [Merged by Bors] - document resource limits hdfs-operator#244
• Hive [Merged by Bors] - document resource limits hive-operator#249
• Kafka [Merged by Bors] - document resource limits kafka-operator#485
• NiFi [Merged by Bors] - document resource limits nifi-operator#353
• Spark [Merged by Bors] - Resources limits spark-k8s-operator#147
• Superset [Merged by Bors] - document resource limits superset-operator#279
• Trino [Merged by Bors] - document resource limits trino-operator#301
• ZooKeeper [Merged by Bors] - document resource limits zookeeper-operator#563
• OPA [Merged by Bors] - document resource limits opa-operator#352

[razvan]

Bugfix for link to roles concept: #293

[lfrancke]

All done, thank you!