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

* chore(getting-started): add warning to generated script

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

* chore(ruff): apply formatting

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

* chore(readme): render readme

* docs(getting-started): make stackablectl op install output templating consistent with others

Author: NickLarsenNZ

.readme/README.md.j2

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

.readme/partials/main.md.j2

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD041 -->
 This is a Kubernetes operator to manage [Apache Hive](https://hive.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/hive) | [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 Hive](https://hive.apache.org/).
 
 <!-- markdownlint-disable MD041 MD051 -->

docs/modules/hive/examples/getting_started/getting_started.sh

@@ -1,6 +1,21 @@
 #!/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
+#   hive: 0.0.0-dev
+#   listener: 0.0.0-dev
+#   secret: 0.0.0-dev
+#   minio: 4.0.2
+#   postgresql: 12.1.5
+# EOF
+
 # The getting started guide script
 # It uses tagged regions which are included in the documentation
 # https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/
@@ -39,8 +54,8 @@ helm install --wait hive-operator stackable-dev/hive-operator --version 0.0.0-de
 echo "Install minio for S3"
 # tag::helm-install-minio[]
 helm install minio \
---namespace default \
 --version 4.0.2 \
+--namespace default \
 --set mode=standalone \
 --set replicas=1 \
 --set persistence.enabled=false \
@@ -55,7 +70,7 @@ helm install minio \
 echo "Install postgres for Hive"
 # tag::helm-install-postgres[]
 helm install postgresql \
---version=12.1.5 \
+--version 12.1.5 \
 --namespace default \
 --set auth.username=hive \
 --set auth.password=hive \

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

@@ -1,6 +1,21 @@
 #!/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
+#   hive: 0.0.0-dev
+#   listener: 0.0.0-dev
+#   secret: 0.0.0-dev
+#   minio: 4.0.2
+#   postgresql: 12.1.5
+# EOF
+
 # The getting started guide script
 # It uses tagged regions which are included in the documentation
 # https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/
@@ -39,8 +54,8 @@ helm install --wait hive-operator {{ helm.repo_name }}/hive-operator --version {
 echo "Install minio for S3"
 # tag::helm-install-minio[]
 helm install minio \
+--version {{ versions.minio }} \
 --namespace default \
---version 4.0.2 \
 --set mode=standalone \
 --set replicas=1 \
 --set persistence.enabled=false \
@@ -55,7 +70,7 @@ helm install minio \
 echo "Install postgres for Hive"
 # tag::helm-install-postgres[]
 helm install postgresql \
---version=12.1.5 \
+--version {{ versions.postgresql }} \
 --namespace default \
 --set auth.username=hive \
 --set auth.password=hive \

docs/modules/hive/examples/getting_started/install-operator-output.txt

@@ -1,6 +1,4 @@
-# tag::stackablectl-install-operators-output[]
-[INFO ] Installing commons operator in version 0.0.0-dev
-[INFO ] Installing secret operator in version 0.0.0-dev
-[INFO ] Installing listener operator in version 0.0.0-dev
-[INFO ] Installing hive operator in version 0.0.0-dev
-# end::stackablectl-install-operators-output[]
+Installed commons=0.0.0-dev operator
+Installed secret=0.0.0-dev operator
+Installed listener=0.0.0-dev operator
+Installed hive=0.0.0-dev operator

docs/modules/hive/examples/getting_started/install-operator-output.txt.j2

@@ -1,6 +1,4 @@
-# tag::stackablectl-install-operators-output[]
-[INFO ] Installing commons operator in version {{ versions.commons }}
-[INFO ] Installing secret operator in version {{ versions.secret }}
-[INFO ] Installing listener operator in version {{ versions.listener }}
-[INFO ] Installing hive operator in version {{ versions.hive }}
-# end::stackablectl-install-operators-output[]
+Installed commons={{ versions.commons }} operator
+Installed secret={{ versions.secret }} operator
+Installed listener={{ versions.listener }} operator
+Installed hive={{ versions.hive }} operator

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

@@ -111,9 +111,7 @@ include::example$getting_started/getting_started.sh[tag=stackablectl-install-ope
 The tool will show
 
 [source]
-----
-include::example$getting_started/install-operator-output.txt[tag=stackablectl-install-operators-output]
-----
+include::example$getting_started/install_output.txt[]
 
 === Helm
 

tests/templates/kuttl/logging/test_log_aggregation.py

@@ -4,9 +4,9 @@
 
 def check_sent_events():
     response = requests.post(
-        'http://hive-vector-aggregator:8686/graphql',
+        "http://hive-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/smoke/test_metastore.py

@@ -15,9 +15,7 @@
 
 
 def table(db_name, table_name, location):
-    columns = [
-        ColumnBuilder("id", "string", "col comment").build()
-    ]
+    columns = [ColumnBuilder("id", "string", "col comment").build()]
 
     serde_info = SerDeInfoBuilder(
         serialization_lib="org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe"
@@ -40,11 +38,15 @@ def table(db_name, table_name, location):
     return test_table
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     all_args = argparse.ArgumentParser(description="Test hive metastore.")
     all_args.add_argument("-p", "--port", help="Metastore server port", default="9083")
-    all_args.add_argument("-d", "--database", help="Test DB name", default="test_metastore")
-    all_args.add_argument("-m", "--metastore", help="The host or service to connect to", required=True)
+    all_args.add_argument(
+        "-d", "--database", help="Test DB name", default="test_metastore"
+    )
+    all_args.add_argument(
+        "-m", "--metastore", help="The host or service to connect to", required=True
+    )
     args = vars(all_args.parse_args())
 
     database_name = args["database"]
@@ -61,24 +63,46 @@ def table(db_name, table_name, location):
 
         # Local access
         try:
-            hive_client.create_table(table(database_name, local_test_table_name, f"/stackable/warehouse/location_{database_name}_{local_test_table_name}"))
+            hive_client.create_table(
+                table(
+                    database_name,
+                    local_test_table_name,
+                    f"/stackable/warehouse/location_{database_name}_{local_test_table_name}",
+                )
+            )
         except AlreadyExistsException:
             print(f"[INFO]: Table {local_test_table_name} already existed")
-        schema = hive_client.get_schema(db_name=database_name, table_name=local_test_table_name)
-        expected = [FieldSchema(name='id', type='string', comment='col comment')]
+        schema = hive_client.get_schema(
+            db_name=database_name, table_name=local_test_table_name
+        )
+        expected = [FieldSchema(name="id", type="string", comment="col comment")]
         if schema != expected:
-            print("[ERROR]: Received local schema " + str(schema) + " - expected schema: " + expected)
+            print(
+                "[ERROR]: Received local schema "
+                + str(schema)
+                + " - expected schema: "
+                + expected
+            )
             exit(-1)
 
         # S3 access
         try:
-            hive_client.create_table(table(database_name, s3_test_table_name, "s3a://hive/"))
+            hive_client.create_table(
+                table(database_name, s3_test_table_name, "s3a://hive/")
+            )
         except AlreadyExistsException:
             print(f"[INFO]: Table {s3_test_table_name} already existed")
-        schema = hive_client.get_schema(db_name=database_name, table_name=s3_test_table_name)
-        expected = [FieldSchema(name='id', type='string', comment='col comment')]
+        schema = hive_client.get_schema(
+            db_name=database_name, table_name=s3_test_table_name
+        )
+        expected = [FieldSchema(name="id", type="string", comment="col comment")]
         if schema != expected:
-            print("[ERROR]: Received s3 schema " + str(schema) + " - expected schema: " + expected)
+            print(
+                "[ERROR]: Received s3 schema "
+                + str(schema)
+                + " - expected schema: "
+                + expected
+            )
             exit(-1)
 
         # Removed test, because it failed against Hive 3.1.3. We do not know if the behavior of the Hive metastore changed or we made a mistake. We improved the Trino tests to do more stuff with S3 (e.g. writing tables) which passed,