From c763a18782340527f3a5a77a9e77486e2f44ade3 Mon Sep 17 00:00:00 2001 From: Stacky McStackface Date: Wed, 7 Oct 2026 09:31:30 +0000 Subject: [PATCH 1/2] chore: Generated commit to update templated files since the last template run up to stackabletech/operator-templating@0f53eecffba74cfb96c8d4635c656edb20a3ac85 Reference-to: stackabletech/operator-templating@0f53eec (feat: Rollout crate/typos for operators) --- .pre-commit-config.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 74002636..842399b1 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -7,6 +7,19 @@ default_language_version: node: system repos: + # The word lists live in a per-repo `typos.toml`, which is not templated. + # typos has no layered configuration (https://github.com/crate-ci/typos/issues/193). + # A templated config can currently not be extended locally. + - repo: https://github.com/crate-ci/typos + rev: 00f422f3b19c57bc6338715ebfe3316d38768461 # v1.50.3 + hooks: + - id: typos + # Drop the upstream default `--write-changes` so the hook only + # reports failures instead of writing changes. + # Keep `--force-exclude` so the excludes in typos.toml still + # apply to the paths prek passes in. + args: ["--force-exclude"] + - repo: https://github.com/pre-commit/pre-commit-hooks rev: 3e8a8703264a2f4a69428a0aa4dcb512790b2c8c # 6.0.0 hooks: From 12f50a8bf3e48830280cfeb4db8d4a8a9436f7eb Mon Sep 17 00:00:00 2001 From: Maxi Wittich Date: Wed, 7 Oct 2026 11:55:29 +0200 Subject: [PATCH 2/2] chore: Add typos.toml and fix spelling findings --- docs/modules/kafka/pages/index.adoc | 2 +- .../pages/usage-guide/kraft-controller.adoc | 2 +- .../02-create-kerberos-secretclass.yaml.j2 | 2 +- .../02-create-kerberos-secretclass.yaml.j2 | 2 +- .../kraft-kerberos/30-access-kafka.txt.j2 | 2 +- .../02-create-kerberos-secretclass.yaml.j2 | 2 +- .../smoke-kraft/60_test_client_auth_tls.sh | 2 +- typos.toml | 42 +++++++++++++++++++ 8 files changed, 49 insertions(+), 7 deletions(-) create mode 100644 typos.toml diff --git a/docs/modules/kafka/pages/index.adoc b/docs/modules/kafka/pages/index.adoc index 9e1a86c6..f557d3f3 100644 --- a/docs/modules/kafka/pages/index.adoc +++ b/docs/modules/kafka/pages/index.adoc @@ -51,7 +51,7 @@ But you can also connect using xref:spark-k8s:index.adoc[Apache Spark] or with a == [[demos]]Demos xref:management:stackablectl:index.adoc[] supports installing xref:demos:index.adoc[] with a single command. -The demos are complete data piplines which showcase multiple components of the Stackable platform working together and which you can try out interactively. +The demos are complete data pipelines which showcase multiple components of the Stackable platform working together and which you can try out interactively. Both demos below inject data into Kafka using NiFi and read from the Kafka topics using Druid. === Waterlevel demo diff --git a/docs/modules/kafka/pages/usage-guide/kraft-controller.adoc b/docs/modules/kafka/pages/usage-guide/kraft-controller.adoc index 0bb755ce..100498d4 100644 --- a/docs/modules/kafka/pages/usage-guide/kraft-controller.adoc +++ b/docs/modules/kafka/pages/usage-guide/kraft-controller.adoc @@ -236,7 +236,7 @@ broker.id=2000 We then need to inform the operator to use these ids instead of generating new ones. This is done by creating a configmap map containing the id mapping and pointing the `spec.clusterProperties.brokerIdPodConfigMapName` property of the `KafkaCluster` resource to it. -These two properties must be preserverd for the rest of the migration process and the lifetime of the cluster. +These two properties must be preserved for the rest of the migration process and the lifetime of the cluster. The complete example `KafkaCluster` resource after applying the required changes looks as follows: diff --git a/tests/templates/kuttl/kerberos/02-create-kerberos-secretclass.yaml.j2 b/tests/templates/kuttl/kerberos/02-create-kerberos-secretclass.yaml.j2 index 04ae9a63..17eb432d 100644 --- a/tests/templates/kuttl/kerberos/02-create-kerberos-secretclass.yaml.j2 +++ b/tests/templates/kuttl/kerberos/02-create-kerberos-secretclass.yaml.j2 @@ -47,7 +47,7 @@ metadata: name: secret-operator-keytab data: {% if test_scenario['values']['kerberos-backend'] == 'mit' %} - # To create keytab. When promted enter password asdf + # To create keytab. When prompted enter password asdf # cat | ktutil << 'EOF' # list # add_entry -password -p stackable-secret-operator@CLUSTER.LOCAL -k 1 -e aes256-cts-hmac-sha384-192 diff --git a/tests/templates/kuttl/kraft-kerberos/02-create-kerberos-secretclass.yaml.j2 b/tests/templates/kuttl/kraft-kerberos/02-create-kerberos-secretclass.yaml.j2 index 04ae9a63..17eb432d 100644 --- a/tests/templates/kuttl/kraft-kerberos/02-create-kerberos-secretclass.yaml.j2 +++ b/tests/templates/kuttl/kraft-kerberos/02-create-kerberos-secretclass.yaml.j2 @@ -47,7 +47,7 @@ metadata: name: secret-operator-keytab data: {% if test_scenario['values']['kerberos-backend'] == 'mit' %} - # To create keytab. When promted enter password asdf + # To create keytab. When prompted enter password asdf # cat | ktutil << 'EOF' # list # add_entry -password -p stackable-secret-operator@CLUSTER.LOCAL -k 1 -e aes256-cts-hmac-sha384-192 diff --git a/tests/templates/kuttl/kraft-kerberos/30-access-kafka.txt.j2 b/tests/templates/kuttl/kraft-kerberos/30-access-kafka.txt.j2 index 32131d14..f35f3677 100644 --- a/tests/templates/kuttl/kraft-kerberos/30-access-kafka.txt.j2 +++ b/tests/templates/kuttl/kraft-kerberos/30-access-kafka.txt.j2 @@ -108,7 +108,7 @@ data: echo Sent message: \"$sent_message\" # Explicit numeric offset (not "-o stored"/"auto.offset.reset=beginning"): the bundled kcat's - # librdkafka (1.7.0) mis-detects broker feature support against Kafka >=4.0 brokers, which + # librdkafka (1.7.0) misdetects broker feature support against Kafka >=4.0 brokers, which # dropped old low-numbered API versions (KIP-896). It matches ApiVersions by exact version # instead of range, so it wrongly reports the ListOffsets logical-offset query as unsupported # ("Failed to query logical offset BEGINNING: Local: Required feature not supported by diff --git a/tests/templates/kuttl/opa/02-create-kerberos-secretclass.yaml.j2 b/tests/templates/kuttl/opa/02-create-kerberos-secretclass.yaml.j2 index 061a316f..0d443b61 100644 --- a/tests/templates/kuttl/opa/02-create-kerberos-secretclass.yaml.j2 +++ b/tests/templates/kuttl/opa/02-create-kerberos-secretclass.yaml.j2 @@ -28,7 +28,7 @@ kind: Secret metadata: name: secret-operator-keytab data: - # To create keytab. When promted enter password asdf + # To create keytab. When prompted enter password asdf # cat | ktutil << 'EOF' # list # add_entry -password -p stackable-secret-operator@CLUSTER.LOCAL -k 1 -e aes256-cts-hmac-sha384-192 diff --git a/tests/templates/kuttl/smoke-kraft/60_test_client_auth_tls.sh b/tests/templates/kuttl/smoke-kraft/60_test_client_auth_tls.sh index bae7473b..64ed766c 100755 --- a/tests/templates/kuttl/smoke-kraft/60_test_client_auth_tls.sh +++ b/tests/templates/kuttl/smoke-kraft/60_test_client_auth_tls.sh @@ -5,7 +5,7 @@ unset TOPIC unset BAD_TOPIC -echo "Connecting to boostrap address $KAFKA" +echo "Connecting to bootstrap address $KAFKA" echo "Start client auth TLS testing..." ############################################################################ diff --git a/typos.toml b/typos.toml new file mode 100644 index 00000000..bda45448 --- /dev/null +++ b/typos.toml @@ -0,0 +1,42 @@ +# Configuration for typos (https://github.com/crate-ci/typos), run via the prek +# hook in .pre-commit-config.yaml. + +[files] +# Bare `typos` skips hidden dirs by default, but prek passes explicit paths and +# so does check them. Turn it off so both agree. +ignore-hidden = false + +extend-exclude = [ + # Ignore `.git`, which the above `ignore-hidden = false` would otherwise pull in. + ".git/", + # Generated by crate2nix (`make regenerate-nix`). Already skipped by the prek + # top-level `exclude`; listed here so a bare `typos` run agrees. + "Cargo.nix", + # Generated by `make regenerate-charts` from the Rust doc comments, which are + # checked at their source. The rest is Kubernetes' own schema documentation. + "extra/crds.yaml", +] + +[default] +# typos has no native suppression directive +# (https://github.com/crate-ci/typos/issues/316), so these regexes provide one. +# A marker must sit in a comment: after `#`, `//` or `;` (free text may follow), +# or inside a closed ``, `/* */` or `{# #}` (free text may precede the +# closer). An unterminated `typos:ignore-block-start` suppresses nothing. +# +# Use one of the following when the word is correct at one place but would still be a typo elsewhere: +# +# # typos:ignore-line at the end of the line it applies to +# # typos:ignore-next-line on its own line, above the offending line +# # typos:ignore-block-start / typos:ignore-block-end around a block +extend-ignore-re = [ + '(?Rm)^.*?(?:(?:^|[^{])(?:#|//|;)[ \t]*typos:ignore-line\b.*|(?:|/\*[ \t]*typos:ignore-line\b.*?\*/|\{#[ \t]*typos:ignore-line\b.*?#\})[ \t]*)$', + '(?Rm)^[ \t]*(?:(?:#|//|;)[ \t]*typos:ignore-next-line\b.*|(?:|/\*[ \t]*typos:ignore-next-line\b.*?\*/|\{#[ \t]*typos:ignore-next-line\b.*?#\})[ \t]*)\r?\n.*$', + '(?ms)(?:(?:^|[^{])(?:#|//|;)[ \t]*typos:ignore-block-start\b||/\*[ \t]*typos:ignore-block-start\b[^\n]*?\*/|\{#[ \t]*typos:ignore-block-start\b[^\n]*?#\}).*?(?:(?:^|[^{])(?:#|//|;)[ \t]*typos:ignore-block-end\b||/\*[ \t]*typos:ignore-block-end\b[^\n]*?\*/|\{#[ \t]*typos:ignore-block-end\b[^\n]*?#\})', +] + +# Before adding an entry in here, consider an in-place marker instead. +# Every entry below gets a one-line comment saying what the word is. +[default.extend-words] +# Azure Kubernetes Service +aks = "aks"