Skip to content

Commit f8477fb

Browse files
adwk67maltesander
andauthored
Apply suggestions from code review
Co-authored-by: Malte Sander <malte.sander.it@gmail.com>
1 parent 1ce3037 commit f8477fb

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

modules/tutorials/pages/jupyterhub.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The example notebook is used to demonstrate simple read/write interactions with
88

99
== Keycloak
1010

11-
Keycloak is installed using a https://github.com/stackabletech/demos/blob/main/stacks/jupyterhub-keycloak/keycloak.yaml[Deployment] that loads realm configuration mounted as a ConfigMap.
11+
Keycloak is installed using a https://github.com/stackabletech/demos/blob/main/stacks/jupyterhub-keycloak/keycloak.yaml[Deployment] that loads its realm configuration mounted as a ConfigMap.
1212

1313
[#services]
1414
=== Services
@@ -43,7 +43,7 @@ They are:
4343
4444
The keycloak and jupyterhub endpoints are defined in the jupyter hub chart values i.e. for the purposes of the demo (that does not use any pre-defined DNS settings), the ports have to be known before the jupyter hub components are deployed.
4545
46-
This can be achieved by having the keycloak deployment write out its co-ordinates into a ConfigMap during start-up, which can then be referenced by the JupyterHub chart like this:
46+
This can be achieved by having the keycloak deployment write out its node URL and node IP into a ConfigMap during start-up, which can then be referenced by the JupyterHub chart like this:
4747
4848
[source,yaml]
4949
----
@@ -83,14 +83,14 @@ options:
8383
<2> This information is passed to a variable in one of the start-up config scripts
8484
<3> And then used for JupyterHub settings (this is where port `31095` is hard-coded for the proxy service)
8585
86-
NOTE: The node port IP found in the ConfigMap `keycloak-address` can be used for opening the JupyterHb UI.
86+
NOTE: The node port IP found in the ConfigMap `keycloak-address` can be used for opening the JupyterHub UI.
8787
On Kind this can be any node - not necessarily the one where the proxy Pod is running.
8888
This is due to the way in which Docker networking is used within the cluster.
8989
On other clusters it might be necessary to use the exact Node on which the proxy is running.
9090
9191
=== Discovery
9292
93-
As mentioned above in <<services, Services>>, keycloak writes out its endpoint information to a ConfigMap, shown in the code section below.
93+
As mentioned above in <<services, Services>>, a Keycloak sidecar container writes out its endpoint information to a ConfigMap, shown in the code section below.
9494
9595
.Writing the ConfigMap
9696
[%collapsible]
@@ -300,7 +300,7 @@ This section of the JupyterHub configuration specifies that we are using Generic
300300
...
301301
----
302302
303-
<1> We need to either provide a list of users using `allowed_users`, or to explicitly allow _all_ users, as done here
303+
<1> We need to either provide a list of users using `allowed_users`, or to explicitly allow _all_ users, as done here.
304304
We will delegate this to Keycloak so that we do not have to maintain users in two places
305305
<2> Each admin user will have access to an Admin tab on the JupyterHub UI where certain user-management actions can be carried out.
306306
<3> Define the Keycloak scope
@@ -385,7 +385,7 @@ As mentioned in the <<services, Services>> section above, we want to define the
385385
NOTE: When using Spark from within a notebook, please the <<provisos, Provisos>> section below.
386386
387387
In the same way, we can use another script to define a driver service for each user.
388-
This is essential when using Spark from within a JupyterHUb notebook so that executor pods can be spawned from the user's kernel in a user-specific way.
388+
This is essential when using Spark from within a JupyterHub notebook so that executor pods can be spawned from the user's kernel in a user-specific way.
389389
This script instructs JupyterHub to use `KubeSpawner` to create a service referenced by the UID of the parent Pod.
390390
391391
[source,yaml]

0 commit comments

Comments
 (0)