Fix typos

crates/k8s-version/src/lib.rs

@@ -23,7 +23,7 @@
 //!
 //! ### Constructing
 //!
-//! Alternatively, they can be constructed programatically using the
+//! Alternatively, they can be constructed programmatically using the
 //! [`ApiVersion::new()`] and [`ApiVersion::try_new()`] functions.
 //!
 //! ```

crates/stackable-certs/CHANGELOG.md

@@ -14,7 +14,7 @@ All notable changes to this project will be documented in this file.
 
 - BREAKING: The functions `generate_leaf_certificate`, `generate_rsa_leaf_certificate` and
   `generate_ecdsa_leaf_certificate` of `CertificateAuthority` accept an additional parameter
-  `subject_alterative_dns_names` ([#1057]).
+  `subject_alternative_dns_names` ([#1057]).
   - The passed SANs are added to the generated certificate, this is needed when the HTTPS server is
     accessible on multiple DNS names and/or IPs.
   - Pass an empty list (`[]`) to keep the existing behavior.

crates/stackable-certs/src/ca/mod.rs

@@ -163,7 +163,7 @@ where
 }
 
 /// A certificate authority (CA) which is used to generate and sign
-/// intermidiate or leaf certificates.
+/// intermediate or leaf certificates.
 #[derive(Debug)]
 pub struct CertificateAuthority<S>
 where
@@ -298,7 +298,7 @@ where
         key_pair: T,
         name: &str,
         scope: &str,
-        subject_alterative_dns_names: impl IntoIterator<Item = &'a str> + Debug,
+        subject_alternative_dns_names: impl IntoIterator<Item = &'a str> + Debug,
         validity: Duration,
     ) -> Result<CertificatePair<T>>
     where
@@ -353,7 +353,7 @@ where
             ]))
             .context(AddCertificateExtensionSnafu)?;
 
-        let sans = subject_alterative_dns_names
+        let sans = subject_alternative_dns_names
             .into_iter()
             .map(|dns_name| {
                 let ia5_dns_name =
@@ -385,11 +385,11 @@ where
         &mut self,
         name: &str,
         scope: &str,
-        subject_alterative_dns_names: impl IntoIterator<Item = &'a str> + Debug,
+        subject_alternative_dns_names: impl IntoIterator<Item = &'a str> + Debug,
         validity: Duration,
     ) -> Result<CertificatePair<rsa::SigningKey>> {
         let key = rsa::SigningKey::new().context(GenerateRsaSigningKeySnafu)?;
-        self.generate_leaf_certificate(key, name, scope, subject_alterative_dns_names, validity)
+        self.generate_leaf_certificate(key, name, scope, subject_alternative_dns_names, validity)
     }
 
     /// Generates an ECDSAasync -based leaf certificate which is signed by this CA.
@@ -401,11 +401,11 @@ where
         &mut self,
         name: &str,
         scope: &str,
-        subject_alterative_dns_names: impl IntoIterator<Item = &'a str> + Debug,
+        subject_alternative_dns_names: impl IntoIterator<Item = &'a str> + Debug,
         validity: Duration,
     ) -> Result<CertificatePair<ecdsa::SigningKey>> {
         let key = ecdsa::SigningKey::new().context(GenerateEcdsaSigningKeySnafu)?;
-        self.generate_leaf_certificate(key, name, scope, subject_alterative_dns_names, validity)
+        self.generate_leaf_certificate(key, name, scope, subject_alternative_dns_names, validity)
     }
 
     /// Create a [`CertificateAuthority`] from a Kubernetes [`Secret`].

crates/stackable-certs/src/lib.rs

@@ -43,7 +43,7 @@ pub enum CertificatePairError<E>
 where
     E: std::error::Error + 'static,
 {
-    #[snafu(display("failed to seralize certificate as {key_encoding}"))]
+    #[snafu(display("failed to serialize certificate as {key_encoding}"))]
     SerializeCertificate {
         source: x509_cert::der::Error,
         key_encoding: KeyEncoding,

crates/stackable-operator/CHANGELOG.md

@@ -1501,7 +1501,7 @@ Only rust documentation was changed.
 - status::condition module to compute the cluster resource status ([#571]).
 - Helper function to build RBAC resources ([#572]).
 - Add `ClusterResourceApplyStrategy` to `ClusterResource` ([#573]).
-- Add `ClusterOperation` common struct with `reconcilation_paused` and `stopped` flags ([#573]).
+- Add `ClusterOperation` common struct with `reconciliation_paused` and `stopped` flags ([#573]).
 
 [#571]: https://github.com/stackabletech/operator-rs/pull/571
 [#572]: https://github.com/stackabletech/operator-rs/pull/572
@@ -1846,7 +1846,7 @@ This is a rerelease of 0.25.1 which some last-minute incompatible API changes to
 
 ### Changed
 
-- BREAKING: Removed `commons::s3::S3ConnectionImplementation`. `commons::s3::InlinedBucketSpec::endpoint()` doesn't take arguments since the protocol decision is now based on the existance of TLS configuration ([#390]).
+- BREAKING: Removed `commons::s3::S3ConnectionImplementation`. `commons::s3::InlinedBucketSpec::endpoint()` doesn't take arguments since the protocol decision is now based on the existence of TLS configuration ([#390]).
 - BREAKING: Changes to resource requirements structs to enable deep merging ([#392])
   - Changed fields in `Resources` to no longer be optional
   - Changed atomic fields in `MemoryLimits`, `JvmHeapLimits`, `CpuLimits` and `PvcConfig` to be optional
@@ -1882,7 +1882,7 @@ This is a rerelease of 0.25.1 which some last-minute incompatible API changes to
 ### Added
 
 - Export logs to Jaeger ([#360]).
-- Added common datastructures shared between all operators like `Tls` oder `AuthenticationClass` ([#366]).
+- Added common datastructures shared between all operators like `Tls` or `AuthenticationClass` ([#366]).
 - Added helpers for env variables from Secrets or ConfigMaps ([#370]).
 
 ### Changed
@@ -2096,7 +2096,7 @@ This is a rerelease of 0.25.1 which some last-minute incompatible API changes to
 ### Changed
 
 - BREAKING: In builder: `add_stackable_agent_tolerations` to `add_tolerations` ([#255]).
-- Generic `VALUE` paramters to `impl Into<_>` arguments for consistency ([#253]).
+- Generic `VALUE` parameters to `impl Into<_>` arguments for consistency ([#253]).
 
 ### Removed
 

crates/stackable-operator/crds/DummyCluster.yaml

@@ -597,7 +597,7 @@ spec:
                                 type: object
                             type: object
                           enableVectorAgent:
-                            description: Wether or not to deploy a container with the Vector log agent.
+                            description: Whether or not to deploy a container with the Vector log agent.
                             nullable: true
                             type: boolean
                         type: object
@@ -1209,7 +1209,7 @@ spec:
                                       type: object
                                   type: object
                                 enableVectorAgent:
-                                  description: Wether or not to deploy a container with the Vector log agent.
+                                  description: Whether or not to deploy a container with the Vector log agent.
                                   nullable: true
                                   type: boolean
                               type: object

crates/stackable-operator/src/builder/pdb.rs

@@ -45,7 +45,7 @@ pub enum Error {
 pub struct PodDisruptionBudgetBuilder<ObjectMeta, LabelSelector, PodDisruptionBudgetConstraint> {
     metadata: ObjectMeta,
     selector: LabelSelector,
-    /// Tracks wether either `maxUnavailable` or `minAvailable` is set.
+    /// Tracks whether either `maxUnavailable` or `minAvailable` is set.
     constraint: Option<PodDisruptionBudgetConstraint>,
 }
 

crates/stackable-operator/src/builder/pod/mod.rs

@@ -667,7 +667,7 @@ mod tests {
             .build()
     }
 
-    /// A [`PodBuilder`] that already contains the minum setup to build a Pod (name and container).
+    /// A [`PodBuilder`] that already contains the minimum setup to build a Pod (name and container).
     #[fixture]
     fn pod_builder_with_name_and_container(dummy_container: Container) -> PodBuilder {
         let mut builder = PodBuilder::new();

crates/stackable-operator/src/client.rs

@@ -590,7 +590,7 @@ impl Client {
 pub trait GetApi: Resource + Sized {
     /// The namespace type for `Self`'s scope.
     ///
-    /// This will be [`str`] for namespaced resource, and [`()`] for cluster-scoped resources.
+    /// This will be [`str`] for namespaced resource, and `()` for cluster-scoped resources.
     type Namespace: ?Sized;
     /// Get a [`kube::Api`] for `Self`'s native scope..
     fn get_api(client: kube::Client, ns: &Self::Namespace) -> kube::Api<Self>

crates/stackable-operator/src/commons/resources.rs

@@ -381,7 +381,7 @@ pub enum ResourceRequirementsType {
     // We currently don't use claims in our container builder and thus also
     // do not support setting and validating them. When we do support claims
     // in the future, we can just remove the comment to get support for it
-    // immediatly.
+    // immediately.
     // Claims,
 }
 
@@ -404,7 +404,7 @@ pub trait ResourceRequirementsExt {
         resource: &str,
     ) -> Result<()>;
 
-    /// Returns wether the implementor has a [`ResourceRequirementsType`] set
+    /// Returns whether the implementor has a [`ResourceRequirementsType`] set
     /// for a `resource`.
     fn has_resource_requirement(&self, rr_type: ResourceRequirementsType, resource: &str) -> bool {
         self.check_resource_requirement(rr_type, resource).is_ok()
@@ -424,7 +424,7 @@ pub trait ResourceRequirementsExt {
         Ok(())
     }
 
-    /// Returns wether the implementor has all [`ResourceRequirementsType`]s set
+    /// Returns whether the implementor has all [`ResourceRequirementsType`]s set
     /// for a `resource`.
     fn has_resource_requirements(
         &self,

crates/stackable-operator/src/crd/git_sync/v1alpha1_impl.rs

@@ -432,7 +432,7 @@ mod tests {
 
         let extra_env_vars = env_vars_from([
             ("VAR1", "value1"),
-            ("GITSYNC_USERNAME", "overriden-username"),
+            ("GITSYNC_USERNAME", "overridden-username"),
         ]);
 
         let extra_volume_mounts = [VolumeMount {
@@ -500,7 +500,7 @@ command:
 - -c
 env:
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest
@@ -574,7 +574,7 @@ env:
       key: password
       name: git-credentials
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest
@@ -643,7 +643,7 @@ command:
 - -c
 env:
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest
@@ -682,7 +682,7 @@ command:
 - -c
 env:
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest
@@ -724,7 +724,7 @@ env:
       key: password
       name: git-credentials
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest
@@ -761,7 +761,7 @@ command:
 - -c
 env:
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest

crates/stackable-operator/src/crd/git_sync/v1alpha2_impl.rs

@@ -477,7 +477,7 @@ mod tests {
 
         let extra_env_vars = env_vars_from([
             ("VAR1", "value1"),
-            ("GITSYNC_USERNAME", "overriden-username"),
+            ("GITSYNC_USERNAME", "overridden-username"),
         ]);
 
         let extra_volume_mounts = [VolumeMount {
@@ -545,7 +545,7 @@ command:
 - -c
 env:
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest
@@ -619,7 +619,7 @@ env:
       key: password
       name: git-credentials
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest
@@ -688,7 +688,7 @@ command:
 - -c
 env:
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest
@@ -727,7 +727,7 @@ command:
 - -c
 env:
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest
@@ -769,7 +769,7 @@ env:
       key: password
       name: git-credentials
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest
@@ -806,7 +806,7 @@ command:
 - -c
 env:
 - name: GITSYNC_USERNAME
-  value: overriden-username
+  value: overridden-username
 - name: VAR1
   value: value1
 image: oci.stackable.tech/sdp/product:latest

crates/stackable-operator/src/kvp/consts/keys.rs

@@ -20,7 +20,7 @@ pub const K8S_APP_INSTANCE_KEY: &str = concatcp!(K8S_APP_KEY_PREFIX, "instance")
 pub const K8S_APP_VERSION_KEY: &str = concatcp!(K8S_APP_KEY_PREFIX, "version");
 
 /// The well-known Kubernetes app component key `app.kubernetes.io/component`.
-/// It is used to specify the compoent within the architecture, e.g. `database`.
+/// It is used to specify the component within the architecture, e.g. `database`.
 pub const K8S_APP_COMPONENT_KEY: &str = concatcp!(K8S_APP_KEY_PREFIX, "component");
 
 /// The well-known Kubernetes app part-of key `app.kubernetes.io/part-of`. It is
@@ -33,7 +33,7 @@ pub const K8S_APP_PART_OF_KEY: &str = concatcp!(K8S_APP_KEY_PREFIX, "part-of");
 /// an application, e.g. `helm`.
 pub const K8S_APP_MANAGED_BY_KEY: &str = concatcp!(K8S_APP_KEY_PREFIX, "managed-by");
 
-/// The well-kown Kubernetes app role-group key `app.kubernetes.io/role-group`.
+/// The well-known Kubernetes app role-group key `app.kubernetes.io/role-group`.
 /// It is used to specify to which role group this application belongs to, e.g.
 /// `worker`.
 pub const K8S_APP_ROLE_GROUP_KEY: &str = concatcp!(K8S_APP_KEY_PREFIX, "role-group");

crates/stackable-operator/src/kvp/key.rs

@@ -266,7 +266,7 @@ pub enum KeyNameError {
     #[snafu(display("name segment of key cannot be empty"))]
     NameEmpty,
 
-    /// Indicates that the key name sgement exceeds the maximum length of 63
+    /// Indicates that the key name segment exceeds the maximum length of 63
     /// ASCII characters. It additionally reports how many characters were
     /// encountered during parsing / validation.
     #[snafu(display(
@@ -285,7 +285,7 @@ pub enum KeyNameError {
     NameInvalid,
 }
 
-/// A validated name segement of a key. This part of the key is required.
+/// A validated name segment of a key. This part of the key is required.
 ///
 /// Instances of this struct are always valid. It also implements [`Deref`],
 /// which enables read-only access to the inner value (a [`String`]). It,

crates/stackable-operator/src/kvp/mod.rs

@@ -175,7 +175,7 @@ pub enum KeyValuePairsError {
 /// # Note
 ///
 /// A [`BTreeSet`] is used as the inner collection to preserve order of items
-/// which ultimately prevent unncessary reconciliations due to changes
+/// which ultimately prevent unnecessary reconciliations due to changes
 /// in item order.
 #[derive(Clone, Debug, Default)]
 pub struct KeyValuePairs<T: Value>(BTreeMap<Key, T>);

crates/stackable-operator/src/memory.rs

@@ -275,9 +275,9 @@ impl MemoryQuantity {
 
     /// Returns a value like '1355m' or '2g'. Always returns natural numbers with either 'k', 'm' or 'g',
     /// even if the values is multiple Terabytes or more.
-    /// The original quantity may be rounded down to achive a compact, natural number representation.
+    /// The original quantity may be rounded down to achieve a compact, natural number representation.
     /// This rounding may cause the quantity to shrink by up to 20MB.
-    /// Useful to set memory quantities as JVM paramters.
+    /// Useful to set memory quantities as JVM parameters.
     pub fn format_for_java(&self) -> Result<String> {
         let m = self
             .scale_to_at_most_gb() // Java Heap only supports specifying kb, mb or gb

crates/stackable-operator/src/product_config_utils.rs

@@ -654,13 +654,13 @@ pub fn env_var_from_tuple(entry: (impl Into<String>, impl Into<String>)) -> EnvV
 /// use stackable_operator::product_config_utils::{env_vars_from, insert_or_update_env_vars};
 ///
 /// let env_vars = env_vars_from([("VAR1", "original value 1"), ("VAR2", "original value 2")]);
-/// let env_overrides = env_vars_from([("VAR2", "overriden value 2"), ("VAR3", "new value 3")]);
+/// let env_overrides = env_vars_from([("VAR2", "overridden value 2"), ("VAR3", "new value 3")]);
 ///
 /// let combined_env_vars = insert_or_update_env_vars(&env_vars, &env_overrides);
 ///
 /// let expected_result = env_vars_from([
 ///     ("VAR1", "original value 1"),
-///     ("VAR2", "overriden value 2"),
+///     ("VAR2", "overridden value 2"),
 ///     ("VAR3", "new value 3"),
 /// ]);
 ///

crates/stackable-operator/src/product_logging/spec.rs

@@ -69,7 +69,7 @@ pub struct Logging<T>
 where
     T: Clone + Display + Ord,
 {
-    /// Wether or not to deploy a container with the Vector log agent.
+    /// Whether or not to deploy a container with the Vector log agent.
     pub enable_vector_agent: bool,
 
     /// Log configuration per container.