diff options
author | Daniel Gruesso <dgruesso@gitlab.com> | 2019-06-06 05:55:28 +0300 |
---|---|---|
committer | Evan Read <eread@gitlab.com> | 2019-06-06 05:55:28 +0300 |
commit | 8e2bb09add72c0503419f61add28db3fa097e21b (patch) | |
tree | d5154fa46a0ceeb9286d28883a1f8f06b4675f51 /doc/user/clusters | |
parent | dd0d9b27fd3653d236320c34cbdc1f9def5c972d (diff) |
Add Jupyter git extension section
Diffstat (limited to 'doc/user/clusters')
-rw-r--r-- | doc/user/clusters/applications.md | 31 | ||||
-rw-r--r-- | doc/user/clusters/img/jupyter-git-extension.gif | bin | 0 -> 2120084 bytes | |||
-rw-r--r-- | doc/user/clusters/img/jupyter-gitclone.png | bin | 0 -> 64120 bytes |
3 files changed, 29 insertions, 2 deletions
diff --git a/doc/user/clusters/applications.md b/doc/user/clusters/applications.md index 97abe99fe62..b520c4fb579 100644 --- a/doc/user/clusters/applications.md +++ b/doc/user/clusters/applications.md @@ -140,8 +140,8 @@ that installs additional useful packages on top of the base Jupyter. You will also see ready-to-use DevOps Runbooks built with Nurtch's [Rubix library](https://github.com/amit1rrr/rubix). More information on -creating executable runbooks can be found in [our Nurtch -documentation](../project/clusters/runbooks/index.md#nurtch-executable-runbooks). Note that +creating executable runbooks can be found in [our Runbooks +documentation](../project/clusters/runbooks/index.md#executable-runbooks). Note that Ingress must be installed and have an IP address assigned before JupyterHub can be installed. @@ -152,6 +152,33 @@ chart is used to install this application with a [`values.yaml`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/vendor/jupyter/values.yaml) file. +#### Jupyter Git Integration + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/28783) in GitLab 12 for project-level clusters. + +When installing JupyterHub onto your Kubernetes cluster, [JupyterLab's Git extension](https://github.com/jupyterlab/jupyterlab-git) +is automatically provisioned and configured using the authenticated user's: + +- Name +- Email +- Newly created access token + +JupyterLab's Git extension enables full version control of your notebooks as well as issuance of Git commands within Jupyter. +Git commands can be issued via the **Git** tab on the left panel or via Jupyter's command line prompt. + +NOTE: **Note:** +JupyterLab's Git extension stores the user token in the JupyterHub DB in encrypted format +and in the single user Jupyter instance as plain text. This is because [Git requires storing +credentials as plain text](https://git-scm.com/docs/git-credential-store). Potentially, if +a nefarious user finds a way to read from the file system in the single user Jupyter instance +they could retrieve the token. + +![Jupyter's Git Extension](img/jupyter-git-extension.gif) + +You can clone repositories from the files tab in Jupyter: + +![Jupyter clone repository](img/jupyter-gitclone.png) + ### Knative > Available for project-level clusters since GitLab 11.5. diff --git a/doc/user/clusters/img/jupyter-git-extension.gif b/doc/user/clusters/img/jupyter-git-extension.gif Binary files differnew file mode 100644 index 00000000000..13a88d97425 --- /dev/null +++ b/doc/user/clusters/img/jupyter-git-extension.gif diff --git a/doc/user/clusters/img/jupyter-gitclone.png b/doc/user/clusters/img/jupyter-gitclone.png Binary files differnew file mode 100644 index 00000000000..41d467f806a --- /dev/null +++ b/doc/user/clusters/img/jupyter-gitclone.png |