Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Notebooks: Rename "Notebook" to "Workbench" in web documentation #3530

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ <h4 class="section-head">What is Kubeflow?</h4>
alt="Jupyter Logo"
/>
<div class="card-body bg-primary-dark">
<h5 class="card-title text-white section-head">Notebooks</h5>
<h5 class="card-title text-white section-head">Workbenches</h5>
<p class="card-text text-white">
Kubeflow includes services to create and manage interactive <a target="_blank" rel="noopener" href="/docs/components/notebooks/">Jupyter
notebooks</a>. You can customize your notebook deployment and your compute resources to
Kubeflow includes services to create and manage interactive <a target="_blank" rel="noopener" href="/docs/components/notebooks/">Workbenches</a>.
You can customize your workbench deployment and your compute resources to
suit your data science needs. Experiment with your workflows locally, then
deploy them to a cloud when you're ready.
</p>
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/about/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ The following table outlines which components are maintained by each Working Gro
</tr>
<tr>
<td>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/notebook-controller">Notebook Controller</a>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/notebook-controller">Workbench Controller</a>
</td>
</tr>
<tr>
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/components/central-dash/customizing-menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ data:
{
"type": "item",
"link": "/jupyter/",
"text": "Notebooks",
"text": "Workbenches",
"icon": "book"
},
.
Expand Down Expand Up @@ -98,7 +98,7 @@ data:
{
"type": "item",
"link": "/jupyter/",
"text": "Notebooks",
"text": "Workbenches",
"icon": "book"
},
.
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/components/central-dash/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ Your Kubeflow deployment includes a central dashboard that provides quick access
to the Kubeflow components deployed in your cluster. The dashboard includes the
following features:

- Shortcuts to specific actions, a list of recent pipelines and notebooks, and
- Shortcuts to specific actions, a list of recent pipelines and workbenches, and
metrics, giving you an overview of your jobs and cluster in one view.
- A housing for the UIs of the components running in the cluster, including
**Pipelines**, **Katib**, **Notebooks**, and more.
**Pipelines**, **Katib**, **Workbenches**, and more.
- A [registration flow](/docs/components/central-dash/registration-flow/) that
prompts new users to set up their namespace if necessary.

Expand All @@ -24,7 +24,7 @@ The Kubeflow UIs include the following:

* **Home**: Home, the central hub to access recent resources, active
experiments, and useful documentation.
* **Notebook Servers**: To manage [Notebook servers](/docs/components/notebooks/).
* **Workbench Servers**: To manage [Workbench servers](/docs/components/notebooks/).
* **TensorBoards**: To manage TensorBoard servers.
* **Models**: To manage deployed [KFServing models](/docs/components/kfserving/kfserving/).
* **Volumes**: To manage the cluster's Volumes.
Expand Down Expand Up @@ -125,4 +125,4 @@ You can access Kubeflow via `kubectl` and port-forwarding as follows:
option](/docs/components/multi-tenancy/) where you
can set up a single namespace for a shared deployment or configure
multi-tenancy for your Kubeflow deployment.
* [Set up your Jupyter notebooks](/docs/components/notebooks/setup/) in Kubeflow.
* [Set up your Workbenches](/docs/components/notebooks/setup/) in Kubeflow.
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,5 @@ with your namespace available in the dropdown list at the top of the screen:

## Next steps

* [Set up a Jupyter notebook](/docs/components/notebooks/setup/) in Kubeflow.
* [Set up a Workbench](/docs/components/notebooks/setup/) in Kubeflow.
* Read more about [multi-tenancy in Kubeflow](/docs/components/multi-tenancy/).
36 changes: 18 additions & 18 deletions content/en/docs/components/multi-tenancy/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,36 +29,36 @@ to which you have view or modify access.
alt="Select active profile "
class="mt-3 mb-3 border border-info rounded">

This guide illustrates the user isolation functionality using the Jupyter
notebooks service which is the first service in the system to have full
This guide illustrates the user isolation functionality using the Kubeflow
workbenches service which is the first service in the system to have full
integration with the multi-user isolation functionality.

After you select an active profile, the Notebooks Servers UI
displays only the active notebook servers in the currently selected
profile. All other notebook servers remain hidden from you. If you switch
the active profile, the view switches the list of active notebooks
appropriately. You can connect to any of the listed notebook servers and
view and modify the existing Jupyter notebooks available in the server.
After you select an active profile, the Workbenches Servers UI
displays only the active workbench servers in the currently selected
profile. All other workbench servers remain hidden from you. If you switch
the active profile, the view switches the list of active workbenches
appropriately. You can connect to any of the listed workbench servers and
view and modify the existing Kubeflow workbenches available in the server.

For example, the following image shows the list of notebook servers available
For example, the following image shows the list of workbench servers available
in a user's primary profile:

<img src="/docs/images/notebooks-in-profile.png"
alt="List of notebooks in active profile "
alt="List of workbenches in active profile "
class="mt-3 mb-3 border border-info rounded">

When an unauthorized user accesses the notebooks in this profile, they see an
When an unauthorized user accesses the workbenches in this profile, they see an
error:

<img src="/docs/images/notebook-access-error.png"
alt="Error listing notebooks in inacessible profile"
alt="Error listing workbenches in inacessible profile"
class="mt-3 mb-3 border border-info rounded">

When you create Jupyter notebook servers from the Notebooks Servers UI,
the notebook pods are created in your active profile. If you don't have
When you create workbench servers from the Workbenches Servers UI,
the workbench pods are created in your active profile. If you don't have
modify access to the active profile, you can only browse currently active
notebook servers and access the existing notebooks but cannot create
new notebook servers in that profile. You can create notebook
workbench servers and access the existing workbenches but cannot create
new workbench servers in that profile. You can create workbench
servers in your primary profile which you have view and modify access to.

## Onboarding a new user
Expand Down Expand Up @@ -285,8 +285,8 @@ profiles in the system along with their contributors.


The contributors have access to all the Kubernetes resources in the
namespace and can create notebook servers as well as access
existing notebooks.
namespace and can create workbench servers as well as access
existing workbenches.

## Managing contributors manually

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/components/multi-tenancy/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ With multi-user isolation, Users are authenticated and authorized, and then prov

## Current integration

These Kubeflow Components can support multi-user isolation: Central Dashboard, Notebooks, Pipelines, AutoML (Katib), KFServing. Furthermore, resources created by the notebooks (for example, training jobs and deployments) also inherit the same access.
These Kubeflow Components can support multi-user isolation: Central Dashboard, Workbenches, Pipelines, AutoML (Katib), KFServing. Furthermore, resources created by the workbenches (for example, training jobs and deployments) also inherit the same access.

Important notes: Multi-user isolation has several configurable dependencies, especially those related to how Kubeflow is configured with the underlying Kubernetes cluster’s identity management system. Additionally, Kubeflow multi-user isolation doesn’t provide hard security guarantees against malicious attempts to infiltrate another user’s profile.

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/components/notebooks/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
title = "Kubeflow Notebooks"
description = "Documentation for Kubeflow Notebooks"
title = "Kubeflow Workbenches"
description = "Documentation for Kubeflow Workbenches"
weight = 10
+++
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
title = "API Reference"
description = "Reference documentation for Kubeflow Notebooks"
description = "Reference documentation for Kubeflow Workbenches"
weight = 900
+++
18 changes: 9 additions & 9 deletions content/en/docs/components/notebooks/container-images.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
+++
title = "Container Images"
description = "About Container Images for Kubeflow Notebooks"
description = "About Container Images for Kubeflow Workbenches"
weight = 30

+++
Kubeflow Notebooks natively supports three types of notebooks, [JupyterLab](https://github.com/jupyterlab/jupyterlab), [RStudio](https://github.com/rstudio/rstudio), and [Visual Studio Code (code-server)](https://github.com/cdr/code-server), but any web-based IDE should work.
Notebook servers run as containers inside a Kubernetes Pod, which means the type of IDE (and which packages are installed) is determined by the Docker image you pick for your server.
Kubeflow Workbenches natively supports three types of workbenches, [JupyterLab](https://github.com/jupyterlab/jupyterlab), [RStudio](https://github.com/rstudio/rstudio), and [Visual Studio Code (code-server)](https://github.com/cdr/code-server), but any web-based IDE should work.
Workbench servers run as containers inside a Kubernetes Pod, which means the type of IDE (and which packages are installed) is determined by the Docker image you pick for your server.

## Images

We provide a number of [example container images](https://github.com/kubeflow/kubeflow/tree/master/components/example-notebook-servers) to get you started.

### Base Images

These images provide a common starting point for Kubeflow Notebook containers.
These images provide a common starting point for Kubeflow Workbench containers.
See [custom images](#custom-images) to learn how to extend them with your own packages.

Dockerfile | Registry | Notes
Expand Down Expand Up @@ -43,23 +43,23 @@ Dockerfile | Registry | Notes

### Image Dependency Chart

This flow-chart shows how our notebook container images depend on each other.
This flow-chart shows how our workbench container images depend on each other.

<img src="/docs/images/notebook-container-image-chart.png"
alt="A flow-chart showing how notebook container images depend on each other"
alt="A flow-chart showing how workbench container images depend on each other"
class="mt-3 mb-3 border border-info rounded">

## Custom Images

Packages installed by users __after spawning__ a Kubeflow Notebook will only last the lifetime of the pod (unless installed into a PVC-backed directory).
Packages installed by users __after spawning__ a Kubeflow Workbench will only last the lifetime of the pod (unless installed into a PVC-backed directory).

To ensure packages are preserved throughout Pod restarts users will need to either:
1. [Build custom images that include them](https://github.com/kubeflow/kubeflow/tree/master/components/example-notebook-servers#custom-images), or
2. Ensure they are installed in a PVC-backed directory

### Image Requirements

For Kubeflow Notebooks to work with a container image, the image must:
For Kubeflow Workbenches to work with a container image, the image must:
- expose an HTTP interface on port `8888`:
- kubeflow sets an environment variable `NB_PREFIX` at runtime with the URL path we expect the container be listening under
- kubeflow uses IFrames, so ensure your application sets `Access-Control-Allow-Origin: *` in HTTP response headers
Expand All @@ -71,5 +71,5 @@ For Kubeflow Notebooks to work with a container image, the image must:

## Next steps

- Use your container image by specifying it when spawning your notebook server.
- Use your container image by specifying it when spawning your workbench server.
(See the [quickstart guide](/docs/components/notebooks/quickstart-guide/).)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Jupyter TensorFlow Examples"
description = "Examples using Jupyter and TensorFlow in Kubeflow Notebooks"
description = "Examples using Jupyter and TensorFlow in Kubeflow Workbenches"
weight = 40

+++
Expand All @@ -9,7 +9,7 @@ weight = 40

(adapted from [tensorflow/tensorflow - mnist_softmax.py](https://github.com/tensorflow/tensorflow/blob/r1.4/tensorflow/examples/tutorials/mnist/mnist_softmax.py))

1. When creating your notebook server choose a [container image](/docs/components/notebooks/container-images/) which has Jupyter and TensorFlow installed.
1. When creating your workbench server choose a [container image](/docs/components/notebooks/container-images/) which has Jupyter and TensorFlow installed.

2. Use Jupyter's interface to create a new **Python 3** notebook.

Expand Down Expand Up @@ -55,4 +55,4 @@ weight = 40

- See a [simple example](https://github.com/kubeflow/examples/tree/master/pipelines/simple-notebook-pipeline) of creating Kubeflow pipelines in a Jupyter notebook.
- Build machine-learning pipelines with the [Kubeflow Pipelines SDK](/docs/components/pipelines/sdk/sdk-overview/).
- Learn the advanced features available from a Kubeflow notebook, such as [submitting Kubernetes resources](/docs/components/notebooks/submit-kubernetes/) or [building Docker images](/docs/components/notebooks/custom-notebook/).
- Learn the advanced features available from a Kubeflow workbench, such as [submitting Kubernetes resources](/docs/components/notebooks/submit-kubernetes/) or [building Docker images](/docs/components/notebooks/custom-notebook/).
14 changes: 7 additions & 7 deletions content/en/docs/components/notebooks/overview.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
+++
title = "Overview"
description = "An overview of Kubeflow Notebooks"
description = "An overview of Kubeflow Workbenches"
weight = 5

+++
{{% stable-status %}}

## What is Kubeflow Notebooks?
## What is Kubeflow Workbenches?

Kubeflow Notebooks provides a way to run web-based development environments inside your Kubernetes cluster by running them inside Pods.
Kubeflow Workbenches provides a way to run web-based development environments inside your Kubernetes cluster by running them inside Pods.

Some key features include:
- Native support for [JupyterLab](https://github.com/jupyterlab/jupyterlab), [RStudio](https://github.com/jupyterlab/jupyterlab), and [Visual Studio Code (code-server)](https://github.com/cdr/code-server).
- Users can create notebook containers directly in the cluster, rather than locally on their workstations.
- Admins can provide standard notebook images for their organization with required packages pre-installed.
- Access control is managed by Kubeflow's RBAC, enabling easier notebook sharing across the organization.
- Users can create workbench containers directly in the cluster, rather than locally on their workstations.
- Admins can provide standard workbench images for their organization with required packages pre-installed.
- Access control is managed by Kubeflow's RBAC, enabling easier workbench sharing across the organization.

## Next steps

- Get started with Kubeflow Notebooks using the [quickstart guide](/docs/components/notebooks/quickstart-guide/).
- Get started with Kubeflow Workbenches using the [quickstart guide](/docs/components/notebooks/quickstart-guide/).
- Learn how to create your own [container images](/docs/components/notebooks/container-images/).
Loading