Skip to content

Commit ebcb5bc

Browse files
committed
fix: remove v2 references in comments
1 parent 8be7586 commit ebcb5bc

5 files changed

Lines changed: 8 additions & 9 deletions

File tree

rust/operator-binary/src/controller.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ pub(crate) mod dereference;
5050
pub(crate) mod node_id_hasher;
5151
pub(crate) mod validate;
5252

53-
/// The type-safe role-group name from stackable-operator's v2 module. Re-exported so the rest
53+
/// The type-safe role-group name from stackable-operator. Re-exported so the rest
5454
/// of the operator can refer to it as `controller::RoleGroupName`.
5555
pub use stackable_operator::v2::types::operator::{RoleGroupName, RoleName};
5656

@@ -101,7 +101,6 @@ pub enum PodDescriptorsError {
101101
/// The cluster identity (`name`, `namespace`, `uid`) is captured here so that owner
102102
/// references for child objects can be built straight from this struct (via its
103103
/// [`Resource`] impl) without threading the raw [`v1alpha1::KafkaCluster`] around.
104-
/// This mirrors the hive-/opensearch-operator's `ValidatedCluster`.
105104
pub struct ValidatedCluster {
106105
/// `ObjectMeta` carrying `name`, `namespace` and `uid`, so this struct can act as the
107106
/// owner [`Resource`] for child objects.

rust/operator-binary/src/controller/build/properties/product_logging/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const KAFKA_LOG4J2_FILE: &str = "kafka.log4j2.xml";
2626

2727
/// The static, env-driven Vector agent configuration (`vector.yaml`).
2828
///
29-
/// The v2 [`vector_container`](stackable_operator::v2::product_logging::framework::vector_container)
29+
/// The [`vector_container`](stackable_operator::v2::product_logging::framework::vector_container)
3030
/// mounts this file and supplies its `${...}` values (`LOG_DIR`, `DATA_DIR`, `NAMESPACE`,
3131
/// `CLUSTER_NAME`, `ROLE_NAME`, `ROLE_GROUP_NAME`, `VECTOR_AGGREGATOR_ADDRESS`) as env vars.
3232
const VECTOR_CONFIG: &str = include_str!("vector.yaml");

rust/operator-binary/src/controller/build/resource/rbac.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! Builds the cluster-wide RBAC resources (`ServiceAccount` and `RoleBinding`).
22
//!
3-
//! The names come from the v2 [`ResourceNames`](stackable_operator::v2::role_utils::ResourceNames)
3+
//! The names come from [`ResourceNames`](stackable_operator::v2::role_utils::ResourceNames)
44
//! and are identical to the previously used `commons::rbac::build_rbac_resources`
55
//! (`<cluster>-serviceaccount`, `<cluster>-rolebinding`, `<product>-clusterrole`), so switching to
66
//! this builder does not rename any RBAC objects.

rust/operator-binary/src/controller/build/resource/statefulset.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -765,12 +765,12 @@ fn add_common_pod_config(
765765
Ok(())
766766
}
767767

768-
/// Adds the v2 Vector log-aggregation sidecar container, when the Vector agent is enabled.
768+
/// Adds the Vector log-aggregation sidecar container, when the Vector agent is enabled.
769769
///
770770
/// Whether Vector is enabled, the per-container log config and the (validated) aggregator
771771
/// discovery `ConfigMap` name are resolved up-front in
772772
/// [`ValidatedLogging`](crate::controller::validate::ValidatedLogging). The container mounts the
773-
/// static `vector.yaml` from the `config` volume and is driven by the env vars the v2
773+
/// static `vector.yaml` from the `config` volume and is driven by the env vars the
774774
/// [`vector_container`] sets.
775775
fn add_vector_container(
776776
pod_builder: &mut PodBuilder,

rust/operator-binary/src/controller/validate.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ pub enum Error {
110110
/// Validated logging configuration for a Kafka role group's Kafka and (optional) Vector
111111
/// containers.
112112
///
113-
/// Produced up-front by [`validate_logging`] (mirroring the hive-/opensearch-operator) so that
114-
/// an invalid custom log `ConfigMap` name or a missing Vector aggregator discovery `ConfigMap`
115-
/// name fails reconciliation during validation rather than at resource-build time.
113+
/// Produced up-front by [`validate_logging`] so that an invalid custom log `ConfigMap` name or a
114+
/// missing Vector aggregator discovery `ConfigMap` name fails reconciliation during validation
115+
/// rather than at resource-build time.
116116
#[derive(Clone, Debug, PartialEq)]
117117
pub struct ValidatedLogging {
118118
pub kafka_container: ValidatedContainerLogConfigChoice,

0 commit comments

Comments
 (0)