From 641d5d73f88e50af9b8b7724934b9ecd8d3b4143 Mon Sep 17 00:00:00 2001 From: byteMuncher0x Date: Mon, 2 Oct 2023 12:52:25 +0100 Subject: [PATCH 1/3] docs: add detail to internal_ssl + fix typos --- README.md | 4 ++-- docs/source/index.md | 4 ++-- docs/source/ssl.md | 14 ++++++++++++-- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bfaf0f52..00814e7c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jupyterhub/kubespawner/test.yaml?logo=github&label=tests)](https://github.com/jupyterhub/kubespawner/actions) [![Code coverage](https://codecov.io/gh/jupyterhub/kubespawner/branch/main/graph/badge.svg)](https://codecov.io/gh/jupyterhub/kubespawner) -The _kubespawner_ (also known as JupyterHub Kubernetes Spawner) enables JupyterHub to spawn +The _kubespawner_ (also known as the JupyterHub Kubernetes Spawner) enables JupyterHub to spawn single-user notebook servers on a [Kubernetes](https://kubernetes.io/) cluster. @@ -51,7 +51,7 @@ simultaneous users), Kubernetes is a wonderful way to do it. Features include: lock-in. You can even spread out your cluster across [multiple clouds at the same time](https://kubernetes.io/docs/user-guide/federation/). -In general, Kubernetes provides a ton of well thought out, useful features - +In general, Kubernetes provides a ton of well-thought-out, useful features - and you can use all of them along with this spawner. ## Requirements diff --git a/docs/source/index.md b/docs/source/index.md index 9a0e7e74..78fbad54 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -2,7 +2,7 @@ # Kubespawner -The _kubespawner_ (also known as JupyterHub Kubernetes Spawner) enables JupyterHub to spawn +The _kubespawner_ (also known as the JupyterHub Kubernetes Spawner) enables JupyterHub to spawn single-user notebook servers on a [Kubernetes](https://kubernetes.io/) cluster. @@ -47,7 +47,7 @@ simultaneous users), Kubernetes is a wonderful way to do it. Features include: - Internal SSL configuration supported -In general, Kubernetes provides a ton of well thought out, useful features - +In general, Kubernetes provides a ton of well-thought-out, useful features - and you can use all of them along with this spawner. ## Requirements diff --git a/docs/source/ssl.md b/docs/source/ssl.md index a0852939..c3035784 100644 --- a/docs/source/ssl.md +++ b/docs/source/ssl.md @@ -1,13 +1,23 @@ # Internal SSL -JupyterHub 1.0 introduces internal_ssl configuration for encryption and authentication of all internal communication. +JupyterHub 1.0 introduces the internal_ssl configuration for encryption and authentication of all internal communication via mutual TLS. -Kubespawner can mount the internal_ssl certificates as Kubernetes secrets into the jupyter user's pod. +If enabled, the Kubespawner will mount the internal_ssl certificates as Kubernetes secrets into the jupyter user's pod. ## Setup +To enable, use the following settings: ``` c.JupyterHub.internal_ssl = True c.JupyterHub.spawner_class = 'kubespawner.KubeSpawner' ``` + +Further configuration can be specified with the following (listed with their default values): +``` +c.KubeSpawner.secret_name_template = "jupyter-{username}{servername}" + +c.KubeSpawner.secret_mount_path = "/etc/jupyterhub/ssl/" +``` + +The Kubespawner sets the `JUPYTERHUB_SSL_KEYFILE`, `JUPYTERHUB_SSL_CERTFILE` and `JUPYTERHUB_SSL_CLIENT_CA` environment variables, with the appropriate paths, on the user's notebook server. From 6eb042b65882de06a2fd7584fbfc48c44e985a85 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 2 Oct 2023 12:02:35 +0000 Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/ssl.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/ssl.md b/docs/source/ssl.md index c3035784..9af8bcfb 100644 --- a/docs/source/ssl.md +++ b/docs/source/ssl.md @@ -7,6 +7,7 @@ If enabled, the Kubespawner will mount the internal_ssl certificates as Kubernet ## Setup To enable, use the following settings: + ``` c.JupyterHub.internal_ssl = True @@ -14,10 +15,11 @@ c.JupyterHub.spawner_class = 'kubespawner.KubeSpawner' ``` Further configuration can be specified with the following (listed with their default values): + ``` c.KubeSpawner.secret_name_template = "jupyter-{username}{servername}" c.KubeSpawner.secret_mount_path = "/etc/jupyterhub/ssl/" ``` -The Kubespawner sets the `JUPYTERHUB_SSL_KEYFILE`, `JUPYTERHUB_SSL_CERTFILE` and `JUPYTERHUB_SSL_CLIENT_CA` environment variables, with the appropriate paths, on the user's notebook server. +The Kubespawner sets the `JUPYTERHUB_SSL_KEYFILE`, `JUPYTERHUB_SSL_CERTFILE` and `JUPYTERHUB_SSL_CLIENT_CA` environment variables, with the appropriate paths, on the user's notebook server. From 5e06959779f397c7e3ac1259dac3771d38da6849 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 21 Nov 2023 15:33:03 +0100 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Yuvi Panda --- README.md | 2 +- docs/source/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 00814e7c..99dd932f 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ simultaneous users), Kubernetes is a wonderful way to do it. Features include: lock-in. You can even spread out your cluster across [multiple clouds at the same time](https://kubernetes.io/docs/user-guide/federation/). -In general, Kubernetes provides a ton of well-thought-out, useful features - +In general, Kubernetes provides a ton of well thought out, useful features - and you can use all of them along with this spawner. ## Requirements diff --git a/docs/source/index.md b/docs/source/index.md index 78fbad54..92726951 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -47,7 +47,7 @@ simultaneous users), Kubernetes is a wonderful way to do it. Features include: - Internal SSL configuration supported -In general, Kubernetes provides a ton of well-thought-out, useful features - +In general, Kubernetes provides a ton of well thought out, useful features - and you can use all of them along with this spawner. ## Requirements