docs(getting-started): update stackablectl op install output (#553)

* chore(getting-started): add warning about editing the script

* chore(ruff): apply formatting

* chore(markdownlint): ignore heading rule for template partials

* chore(readme): render readme

* docs(getting-started): update stackablectl op install output

---------

Co-authored-by: Nick <NickLarsenNZ@users.noreply.github.com>

Author: NickLarsenNZ

.readme/README.md.j2

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD041 -->
 {%- set title="Stackable Operator for Apache Hadoop" -%}
 {%- set operator_name="hdfs" -%}
 {%- set operator_docs_slug="hdfs" -%}

.readme/partials/main.md.j2

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD041 -->
 This is a Kubernetes operator to manage [Apache Hadoop](https://hadoop.apache.org/).
 
 {% filter trim %}

README.md

@@ -1,4 +1,4 @@
-<!-- markdownlint-disable MD041 -->
+<!-- markdownlint-disable MD041 --><!-- markdownlint-disable MD041 -->
 <p align="center">
   <img width="150" src="./.readme/static/borrowed/Icon_Stackable.svg" alt="Stackable Logo"/>
 </p>
@@ -13,6 +13,7 @@
 
 [Documentation](https://docs.stackable.tech/home/stable/hdfs) | [Stackable Data Platform](https://stackable.tech/) | [Platform Docs](https://docs.stackable.tech/) | [Discussions](https://github.com/orgs/stackabletech/discussions) | [Discord](https://discord.gg/7kZ3BNnCAF)
 
+<!-- markdownlint-disable MD041 -->
 This is a Kubernetes operator to manage [Apache Hadoop](https://hadoop.apache.org/).
 
 <!-- markdownlint-disable MD041 MD051 -->

docs/modules/hdfs/examples/getting_started/getting_started.sh

@@ -1,6 +1,20 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
+# DO NOT EDIT THE SCRIPT
+# Instead, update the j2 template, and regenerate it for dev:
+# cat <<EOF | jinja2 --format yaml getting_started.sh.j2 -o getting_started.sh
+# helm:
+#   repo_name: stackable-dev
+#   repo_url: https://repo.stackable.tech/repository/helm-dev/
+# versions:
+#   commons: 0.0.0-dev
+#   hdfs: 0.0.0-dev
+#   listener: 0.0.0-dev
+#   secret: 0.0.0-dev
+#   zookeeper: 0.0.0-dev
+# EOF
+
 # This script contains all the code snippets from the guide, as well as some assert tests
 # to test if the instructions in the guide work. The user *could* use it, but it is intended
 # for testing only.

docs/modules/hdfs/examples/getting_started/getting_started.sh.j2

@@ -1,6 +1,20 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
+# DO NOT EDIT THE SCRIPT
+# Instead, update the j2 template, and regenerate it for dev:
+# cat <<EOF | jinja2 --format yaml getting_started.sh.j2 -o getting_started.sh
+# helm:
+#   repo_name: stackable-dev
+#   repo_url: https://repo.stackable.tech/repository/helm-dev/
+# versions:
+#   commons: 0.0.0-dev
+#   hdfs: 0.0.0-dev
+#   listener: 0.0.0-dev
+#   secret: 0.0.0-dev
+#   zookeeper: 0.0.0-dev
+# EOF
+
 # This script contains all the code snippets from the guide, as well as some assert tests
 # to test if the instructions in the guide work. The user *could* use it, but it is intended
 # for testing only.

docs/modules/hdfs/examples/getting_started/install_output.txt

@@ -0,0 +1,5 @@
+Installed commons=0.0.0-dev operator
+Installed secret=0.0.0-dev operator
+Installed listener=0.0.0-dev operator
+Installed zookeeper=0.0.0-dev operator
+Installed hdfs=0.0.0-dev operator

docs/modules/hdfs/examples/getting_started/install_output.txt.j2

@@ -0,0 +1,5 @@
+Installed commons={{ versions.commons }} operator
+Installed secret={{ versions.secret }} operator
+Installed listener={{ versions.listener }} operator
+Installed zookeeper={{ versions.zookeeper }} operator
+Installed hdfs={{ versions.hdfs }} operator

docs/modules/hdfs/pages/getting_started/installation.adoc

@@ -25,13 +25,8 @@ include::example$getting_started/getting_started.sh[tag=stackablectl-install-ope
 
 The tool will show
 
-----
-[INFO ] Installing commons operator
-[INFO ] Installing secret operator
-[INFO ] Installing listener operator
-[INFO ] Installing zookeeper operator
-[INFO ] Installing hdfs operator
-----
+[source]
+include::example$getting_started/install_output.txt[]
 
 TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`. For
 example, you can use the `--cluster kind` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind].

tests/templates/kuttl/logging/test_log_aggregation.py

@@ -4,9 +4,9 @@
 
 def check_sent_events():
     response = requests.post(
-        'http://hdfs-vector-aggregator:8686/graphql',
+        "http://hdfs-vector-aggregator:8686/graphql",
         json={
-            'query': """
+            "query": """
                 {
                     transforms(first:100) {
                         nodes {
@@ -20,29 +20,30 @@ def check_sent_events():
                     }
                 }
             """
-        }
+        },
     )
 
-    assert response.status_code == 200, \
-        'Cannot access the API of the vector aggregator.'
+    assert (
+        response.status_code == 200
+    ), "Cannot access the API of the vector aggregator."
 
     result = response.json()
 
-    transforms = result['data']['transforms']['nodes']
+    transforms = result["data"]["transforms"]["nodes"]
     for transform in transforms:
-        sentEvents = transform['metrics']['sentEventsTotal']
-        componentId = transform['componentId']
+        sentEvents = transform["metrics"]["sentEventsTotal"]
+        componentId = transform["componentId"]
 
-        if componentId == 'filteredInvalidEvents':
-            assert sentEvents is None or \
-                   sentEvents['sentEventsTotal'] == 0, \
-                   'Invalid log events were sent.'
+        if componentId == "filteredInvalidEvents":
+            assert (
+                sentEvents is None or sentEvents["sentEventsTotal"] == 0
+            ), "Invalid log events were sent."
         else:
-            assert sentEvents is not None and \
-                   sentEvents['sentEventsTotal'] > 0, \
-                   f'No events were sent in "{componentId}".'
+            assert (
+                sentEvents is not None and sentEvents["sentEventsTotal"] > 0
+            ), f'No events were sent in "{componentId}".'
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     check_sent_events()
-    print('Test successful!')
+    print("Test successful!")

tests/templates/kuttl/profiling/run-profiler.py

@@ -9,29 +9,32 @@
 def start_profiling_and_get_refresh_header(service_url):
     prof_page = requests.get(
         f"{service_url}/prof"
-        f"?event={EVENT_TYPE}&duration={PROFILING_DURATION_IN_SEC}")
+        f"?event={EVENT_TYPE}&duration={PROFILING_DURATION_IN_SEC}"
+    )
 
-    assert prof_page.ok, \
-        f"""Profiling could not be started.
+    assert prof_page.ok, f"""Profiling could not be started.
         URL: {prof_page.request.url}
         Status Code: {prof_page.status_code}"""
 
-    return prof_page.headers['Refresh']
+    return prof_page.headers["Refresh"]
 
 
 def parse_refresh_header(refresh_header):
-    refresh_time_in_sec, refresh_path = refresh_header.split(';', 1)
+    refresh_time_in_sec, refresh_path = refresh_header.split(";", 1)
     refresh_time_in_sec = int(refresh_time_in_sec)
 
-    assert refresh_time_in_sec == PROFILING_DURATION_IN_SEC, \
-        f"""Profiling duration and refresh time should be equal.
+    assert (
+        refresh_time_in_sec == PROFILING_DURATION_IN_SEC
+    ), f"""Profiling duration and refresh time should be equal.
         expected: {PROFILING_DURATION_IN_SEC}
         actual:   {refresh_time_in_sec}"""
 
-    expected_refresh_path_pattern = \
-        r'/prof-output-hadoop/async-prof-pid-\d+-itimer-\d+.html'
-    assert re.fullmatch(expected_refresh_path_pattern, refresh_path), \
-        f"""The path to the flamegraph contains an unexpected pattern.
+    expected_refresh_path_pattern = (
+        r"/prof-output-hadoop/async-prof-pid-\d+-itimer-\d+.html"
+    )
+    assert re.fullmatch(
+        expected_refresh_path_pattern, refresh_path
+    ), f"""The path to the flamegraph contains an unexpected pattern.
         expected pattern: {expected_refresh_path_pattern}"
         actual path:      {refresh_path}"""
 
@@ -46,23 +49,21 @@ def wait_for_profiling_to_finish(refresh_time_in_sec):
 def fetch_flamegraph(service_url, refresh_path):
     flamegraph_page = requests.get(f"{service_url}{refresh_path}")
 
-    assert flamegraph_page.ok, \
-        f"""The flamegraph could not be fetched.
+    assert flamegraph_page.ok, f"""The flamegraph could not be fetched.
         URL: {flamegraph_page.request.url}
         Status Code: {flamegraph_page.status_code}"""
 
 
 def test_profiling(role, port):
     service_url = (
-        f"http://test-hdfs-{role}-default-0.test-hdfs-{role}-default"
-        f":{port}")
+        f"http://test-hdfs-{role}-default-0.test-hdfs-{role}-default" f":{port}"
+    )
 
     print(f"Test profiling on {service_url}")
 
     refresh_header = start_profiling_and_get_refresh_header(service_url)
 
-    refresh_time_in_sec, refresh_path = \
-        parse_refresh_header(refresh_header)
+    refresh_time_in_sec, refresh_path = parse_refresh_header(refresh_header)
 
     wait_for_profiling_to_finish(refresh_time_in_sec)