Skip to content

Commit 249e23f

Browse files
Apply suggestions from code review
Co-authored-by: Malte Sander <[email protected]>
1 parent 518de0c commit 249e23f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

modules/concepts/pages/service-exposition.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
:listener-operator: xref:listener-operator:index.adoc
33
:secret-operator: xref:secret-operator:index.adoc
44
:listenerclass: xref:listener-operator:listenerclass.adoc
5-
:description: Explore how Stackable uses listener-operator to expose Services.
5+
:description: Explore how Stackable utilizes the listener-operator to expose Services.
66

77
Data products expose interfaces to the outside world.
88
These interfaces (whether UIs, or APIs) can be accessed by other products or by end users.
@@ -14,12 +14,12 @@ This page gives an overview over the different options for service exposition, w
1414
== Motivation
1515

1616
Service exposition is such a complicated topic, that Stackable has build it's own operator for that: {listener-operator}[].
17-
The following section explains the motivation why we wrote such an operator over just using plain regular Kubernetes Services.
17+
The following section explains the motivation behind implementing such an operator instead of using plain regular Kubernetes Services.
1818

19-
=== Tools advertising their address
19+
=== Products advertising their addresses
2020

21-
Some tools need to know how they are externally reachable.
22-
This is e.g. important for HDFS, where the namenode keeps track of which datanode serves which block or Kafka (used for client bootstrapping).
21+
Some products require information about their external accessibility.
22+
This is e.g. important for HDFS, where the namenode keeps track of which datanode serves which block. Another case is Kafka, where it is required for client bootstrapping.
2323
A HDFS client asks the namenode "I want to read block 42, who is serving that?", the namenode responds with "block 42 is served by <ip or hostname of some datanode>".
2424
For that to work, the datanode needs to know it's external address on startup and tell it the namenode.
2525
(And yes, we needed to patch Hadoop source-code for that ;))
@@ -34,7 +34,7 @@ If a tool is secured using TLS or Kerberos, it does not only need to be reachabl
3434
== {listenerclass}[ListenerClasses]
3535

3636
A {listenerclass}[] describes how a product should be exposed.
37-
Please read on {listenerclass}[it's documentation] before continuing on this page.
37+
Please read on {listenerclass}[its documentation] before continuing on this page.
3838

3939
As a quick reminder, the platform ships with 3 default {listenerclass}[ListenerClasses]:
4040

@@ -44,9 +44,9 @@ As a quick reminder, the platform ships with 3 default {listenerclass}[ListenerC
4444

4545
Keep in mind that you are not restricted to this list, you can configure your own custom {listenerclass}[ListenerClasses].
4646

47-
== Configuring the ListenerClass for a stacklet
47+
== Configuring the ListenerClass for a Stacklet
4848

49-
We integrated {listener-operator}[listener-operator] into most of our products, currently only xref:opa:index.adoc[] and xref:spark-k8s:index.adoc[] are not using {listener-operator}[listener-operator].
49+
The {listener-operator}[listener-operator] is integrated into most of the Stackable products, currently only xref:opa:index.adoc[] and xref:spark-k8s:index.adoc[] are not using {listener-operator}[listener-operator].
5050

5151
Most of the tools configure the {listenerclass}[] at the role level as follows:
5252

0 commit comments

Comments
 (0)