feat: Rollout crate/typos for operators

.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:

docs/modules/druid/pages/getting_started/first_steps.adoc

@@ -76,7 +76,7 @@ include::example$getting_started/getting_started.sh[tag=install-druid]
 
 This creates the actual Druid Stacklet.
 
-WARNING: This Druid instance uses Derby (`dbType: derby`) as a metadata store, which is an interal SQL database.
+WARNING: This Druid instance uses Derby (`dbType: derby`) as a metadata store, which is an internal SQL database.
 It is not persisted and not suitable for production use!
 Consult the https://druid.apache.org/docs/latest/design/metadata-storage#available-metadata-stores[Druid documentation{external-link-icon}^] for a list of supported databases and setup instructions for production instances.
 

docs/modules/druid/pages/index.adoc

@@ -94,7 +94,7 @@ pipelines you can install with a single command.
 == [[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 include Druid as part of the data pipeline:
 
 === Waterlevel demo

docs/modules/druid/pages/usage-guide/extensions.adoc

@@ -32,7 +32,7 @@ You can configure Druid to load more extensions by adding them to the `additiona
 ----
 spec:
   clusterConfig:
-    additionalExtenions:
+    additionalExtensions:
     - druid-avro-extensions
     - druid-google-extensions
     ...

docs/modules/druid/partials/s3-credentials.adoc

@@ -13,7 +13,7 @@ metadata:
     secrets.stackable.tech/class: s3-credentials-class  # <1>
 stringData:
   accessKey: YOUR_VALID_ACCESS_KEY_ID_HERE
-  secretKey: YOUR_SECRET_ACCES_KEY_THATBELONGS_TO_THE_KEY_ID_HERE
+  secretKey: YOUR_SECRET_ACCESS_KEY_THATBELONGS_TO_THE_KEY_ID_HERE
 ----
 
 <1> This label connects the `Secret` to the `SecretClass`.

rust/operator-binary/src/controller/build/security.rs

@@ -364,7 +364,7 @@ pub fn build_tls_key_stores_cmd(tls: &DruidTlsSecurity) -> Vec<String> {
 
     vec![
         // FIXME: *Technically* we should only add the system truststore in case any webPki usage is detected,
-        // wether that's in S3, LDAP, OIDC, FTE or whatnot.
+        // whether that's in S3, LDAP, OIDC, FTE or whatnot.
         format!(
             "cert-tools generate-pkcs12-truststore --pkcs12 '{STACKABLE_MOUNT_TLS_DIR}/{TRUST_STORE_FILE}:{STACKABLE_TRUST_STORE_PASSWORD}' --pem /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem --out {STACKABLE_TLS_DIR}/{TRUST_STORE_FILE} --out-password '{STACKABLE_TRUST_STORE_PASSWORD}'"
         ),

rust/operator-binary/src/crd/memory.rs

@@ -161,7 +161,7 @@ impl TryFrom<&Resources<HistoricalStorage, NoRuntimeLimits>> for HistoricalDeriv
 /// Only KiB precision is supported. Upd to 1KiB will be rounded away.
 fn format_for_druid(memory_quantity: &MemoryQuantity) -> String {
     let k = memory_quantity.scale_to(BinaryMultiple::Kibi);
-    // floor instead of round so we don't accidently make the memory quantity
+    // floor instead of round so we don't accidentally make the memory quantity
     // bigger than it should be
     let v = k.value.floor() as usize;
     format!("{v}Ki")

tests/templates/kuttl/commons/ingestioncheck-tls.py

@@ -132,7 +132,7 @@ def query_datasource(self, url, sql, expected, iterations):
     task_status = json.loads(task)["status"]["statusCode"]
     print(f"Current task status: [{task_status}]")
     assert task_status == "RUNNING" or task_status == "SUCCESS", (
-        f"Taskstatus not running or succeeeded: {task_status}"
+        f"Taskstatus not running or succeeded: {task_status}"
     )
     job_finished = task_status == "SUCCESS"
 

tests/templates/kuttl/commons/ingestioncheck.py

@@ -102,7 +102,7 @@ def query_datasource(self, url, sql, expected, iterations):
     task_status = json.loads(task)["status"]["statusCode"]
     print(f"Current task status: [{task_status}]")
     assert task_status == "RUNNING" or task_status == "SUCCESS", (
-        f"Taskstatus not running or succeeeded: {task_status}"
+        f"Taskstatus not running or succeeded: {task_status}"
     )
     job_finished = task_status == "SUCCESS"
 

tests/templates/kuttl/ingestion-s3-ext/03-install-druid.yaml.j2

@@ -95,4 +95,4 @@ metadata:
     secrets.stackable.tech/class: s3-credentials-class
 stringData:
   accessKey: YOUR_VALID_ACCESS_KEY_ID_HERE
-  secretKey: YOUR_SECRET_ACCES_KEY_THATBELONGS_TO_THE_KEY_ID_HERE
+  secretKey: YOUR_SECRET_ACCESS_KEY_THATBELONGS_TO_THE_KEY_ID_HERE

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]*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]*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-start\b[^\n]*?#\}).*?(?:(?:^|[^{])(?:#|//|;)[ \t]*typos:ignore-block-end\b|<!--[ \t]*typos:ignore-block-end\b[^\n]*?-->|/\*[ \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"