Skip to content

Commit ba1180d

Browse files
Apply suggestions from code review
Co-authored-by: Malte Sander <[email protected]>
1 parent fd0e4a8 commit ba1180d

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

docs/modules/zookeeper/pages/usage_guide/listenerclass.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Apache ZooKeeper offers an API. The Operator deploys a service called `<name>` (where `<name>` is the name of the ZookeeperCluster) through which ZooKeeper can be reached.
55

66
The operator deploys a xref:listener-operator:listener.adoc[Listener] for the Server pods.
7-
The listener defaults to only being accessible from within the Kubernetes cluster, but this can be changed by setting `.spec.nodes.config.listenerClass`:
7+
The listener defaults to only being accessible from within the Kubernetes cluster, but this can be changed by setting `.spec.servers.roleConfig.listenerClass`:
88

99
[source,yaml]
1010
----

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ pub mod versioned {
164164
#[serde(flatten)]
165165
pub common: GenericRoleConfig,
166166

167-
/// This field controls which [ListenerClass](DOCS_BASE_URL_PLACEHOLDER/listener-operator/listenerclass.html) is used to expose the ZooKeeper nodes.
167+
/// This field controls which [ListenerClass](DOCS_BASE_URL_PLACEHOLDER/listener-operator/listenerclass.html) is used to expose the ZooKeeper servers.
168168
#[serde(default = "default_listener_class")]
169169
pub listener_class: String,
170170
}

rust/operator-binary/src/listener.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ pub fn build_role_listener(
6464
ZK_CONTROLLER_NAME,
6565
&resolved_product_image.app_version_label,
6666
&zk_role.to_string(),
67-
"global", // TODO (@NickLarsenNZ): update build_recommended_labels to have an optional role_group
67+
"none", // TODO (@NickLarsenNZ): update build_recommended_labels to have an optional role_group
6868
))
6969
.context(RecommendedLabelsSnafu)?
7070
.build(),
@@ -81,7 +81,7 @@ pub fn build_role_listener(
8181

8282
// TODO (@NickLarsenNZ): This could be a method we can put on a Resource that takes a role_name
8383
pub fn role_listener_name(zk: &v1alpha1::ZookeeperCluster, zk_role: &ZookeeperRole) -> String {
84-
// TODO (@NickLarsenNZ): Make a convention, do we use name_any() and allow empty string? or metadata.name.expect, or handle the error?
84+
// TODO (@NickLarsenNZ): Make a convention, do we use name_any() and allow empty string? or handle the error (as unlikely as it would be)?
8585
format!("{zk}-{zk_role}", zk = zk.name_any())
8686
}
8787

rust/operator-binary/src/znode_controller.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ async fn reconcile_cleanup(
360360
/// This uses the _Server_ Role [Listener] address because it covers ZooKeeper replicas across all
361361
/// RoleGroups.
362362
/// This does mean that when the listenerClass is `external-stable`, the operator will need to be
363-
/// able to access the external adress (eg: Load Balancer).
363+
/// able to access the external address (eg: Load Balancer).
364364
///
365365
/// [Listener]: ::stackable_operator::crd::listener::v1alpha1::Listener
366366
// NOTE (@NickLarsenNZ): If we want to keep this traffic internal, we would need to choose one of

0 commit comments

Comments
 (0)