File tree Expand file tree Collapse file tree 1 file changed +14
-4
lines changed
crates/stackable-operator/src Expand file tree Collapse file tree 1 file changed +14
-4
lines changed Original file line number Diff line number Diff line change @@ -473,14 +473,24 @@ impl<K: Resource> RoleGroupRef<K> {
473
473
format ! ( "{}-{}-{}" , self . cluster. name, self . role, self . role_group)
474
474
}
475
475
476
- /// Set of functions to define service names on rolegroup level.
477
- /// Headless service for cluster internal purposes only.
476
+ /// Returns the service name used by rolegroups for cluster internal communication only.
477
+ ///
478
+ /// The internal use of of this service name is indicated by the `-headless` suffix.
479
+ /// This service should not be used for communication to external services or clients
480
+ /// and also should not be used to export metrics (like Prometheus). Metrics should be
481
+ /// instead exposed via a dedicated service. Use [`Self::rolegroup_metrics_service_name`]
482
+ /// instead.
478
483
pub fn rolegroup_headless_service_name ( & self ) -> String {
479
484
format ! ( "{name}-headless" , name = self . object_name( ) )
480
485
}
481
486
482
- /// Headless metrics service exposes Prometheus endpoint only
483
- pub fn rolegroup_headless_metrics_service_name ( & self ) -> String {
487
+ /// Returns the service name used by rolegroups to expose metrics (like Prometheus).
488
+ ///
489
+ /// The use for metrics only is indicated by the `-metrics` suffix. This service
490
+ /// should not be used for any internal communication or any other external
491
+ /// communication. For internal communication, use [`Self::rolegroup_headless_service_name`]
492
+ /// instead.
493
+ pub fn rolegroup_metrics_service_name ( & self ) -> String {
484
494
format ! ( "{name}-metrics" , name = self . object_name( ) )
485
495
}
486
496
}
You can’t perform that action at this time.
0 commit comments