Skip to content

Commit 1dcf5ca

Browse files
committed
small link and wording fixes
1 parent 583e4ad commit 1dcf5ca

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/modules/listener-operator/pages/listener.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44
:fn-kubernetes-service: footnote:[It is actually implemented using them, but don't rely on that.]
55

66
A Listener object represents a single exposed (possibly) load-balanced service that clients can connect to.
7-
It can be thought of as the Stackable Data Platform equivalent of a Kubernetes https://kubernetes.io/docs/concepts/services-networking/service/[Service].{fn-kubernetes-service}
7+
It can be thought of as the Stackable Data Platform equivalent of a Kubernetes https://kubernetes.io/docs/concepts/services-networking/service/[Service,window=_blank].{fn-kubernetes-service}
88
99
The mechanism for the service is controlled by the xref:listenerclass.adoc[].
10-
This way, which a single Listener definition can be reused in different clusters, expressing the same _intent_ regardless of the Kubernetes distribution or cloud provider's limitations.
10+
This way, a single Listener definition can be reused in different clusters, expressing the same _intent_ regardless of the Kubernetes distribution or cloud provider's limitations.
1111

1212
Listeners only direct traffic to Pods that also mount them as a xref:volume.adoc[volume].
1313
The volume allows the operator to xref:#pinning[pin] the Pod to a specific Node, and provides an API for workloads to retrieve their external address.
1414

15+
[#address-api]
1516
== Address API
1617

1718
NOTE: The CRD-based API is intended for external clients that need to retrieve the address.
@@ -23,7 +24,7 @@ Compared to Kubernetes' Services, this list is provided _regardless_ of the type
2324
NOTE: All addresses may not be able to reach all backing Pods. Clients should connect to a _random_ address in the list, not just the first one.
2425

2526
Ports may be remapped from the Service definition.
26-
Never assume that the exposed on an address will match your declared port.
27+
Never assume that the exposed port on an address will match your declared port.
2728
Instead, read the port numbers from `.ports.\{portname\}`.
2829
Otherwise, it will break when using NodePort services.
2930

@@ -36,6 +37,7 @@ These volumes, in turn, can automatically be created for each replica using eith
3637
- StatefulSet's `volumeClaimTemplates` (for long-lived listeners that will be kept across replica restarts and upgrades), or
3738
- Pod's `volumes[].ephemeral` (for temporary listeners that are deleted when their corresponding Pod is deleted)
3839

40+
[#pinning]
3941
== Pinning
4042

4143
When mounting a Listener volume, it will be "pinned" to that node if the xref:listenerclass.adoc[] uses a strategy that depends on the node that the workload is running on.

0 commit comments

Comments
 (0)