Docs: Central Dashboard

Mon, 01 Jan 0001 00:00:00 +0000

Out of date

This guide contains outdated information pertaining to Kubeflow 1.0. This guide needs to be updated for Kubeflow 1.1.

This Kubeflow component has stable status. See the Kubeflow versioning policies.

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 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.
A registration flow that prompts new users to set up their namespace if necessary.

Overview of Kubeflow UIs

The Kubeflow UIs include the following:

Home, a central dashboard for navigation between the Kubeflow components.
Pipelines for a Kubeflow Pipelines dashboard.
Notebook Servers for Jupyter notebooks.
Katib for hyperparameter tuning.
Artifact Store for tracking of artifact metadata.
Manage Contributors for sharing user access across namespaces in the Kubeflow deployment.

The central dashboard looks like this:

Accessing the central dashboard

To access the central dashboard, you need to connect to the Istio gateway that provides access to the Kubeflow service mesh.

How you access the Istio gateway varies depending on how you’ve configured it.

URL pattern with Google Cloud Platform (GCP)

If you followed the guide to deploying Kubeflow on GCP, the Kubeflow central UI is accessible at a URL of the following pattern:

https://<application-name>.endpoints.<project-id>.cloud.goog/

The URL brings up the dashboard illustrated above.

If you deploy Kubeflow with Cloud Identity-Aware Proxy (IAP), Kubeflow uses the Let’s Encrypt service to provide an SSL certificate for the Kubeflow UI. For troubleshooting issues with your certificate, see the guide to monitoring your Cloud IAP setup.

Using kubectl and port-forwarding

If you didn’t configure Kubeflow to integrate with an identity provider then you can port-forward directly to the Istio gateway.

Port-forwarding typically does not work if any of the following are true:

You’ve deployed Kubeflow on GCP using the GCP deployment UI or the default settings with the CLI deployment. (If you want to use port forwarding, you must deploy Kubeflow on an existing Kubernetes cluster using the kfctl_k8s_istio configuration.)
You’ve configured the Istio ingress to only accept HTTPS traffic on a specific domain or IP address.
You’ve configured the Istio ingress to perform an authorization check (for example, using Cloud IAP or Dex).

You can access Kubeflow via kubectl and port-forwarding as follows:

Install kubectl if you haven’t already done so:
- If you’re using Kubeflow on GCP, run the following command on the command line: gcloud components install kubectl.
- Alternatively, follow the kubectl installation guide.

Use the following command to set up port forwarding to the Istio gateway.

export NAMESPACE=istio-system
kubectl port-forward -n ${NAMESPACE} svc/istio-ingressgateway 8080:80

Access the central navigation dashboard at:
```
http://localhost:8080/
```
Depending on how you’ve configured Kubeflow, not all UIs work behind port-forwarding to the reverse proxy.

For some web applications, you need to configure the base URL on which the app is serving.

For example, if you deployed Kubeflow with an ingress serving at https://example.mydomain.com and configured an application to be served at the URL https://example.mydomain.com/myapp, then the app may not work when served on https://localhost:8080/myapp because the paths do not match.

Next steps

Explore the contributor management option 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 in Kubeflow.

Docs: Registration Flow

Mon, 01 Jan 0001 00:00:00 +0000

Out of date

This guide contains outdated information pertaining to Kubeflow 1.0. This guide needs to be updated for Kubeflow 1.1.

This guide is for Kubeflow users who are logging in to Kubeflow for the first time. The user may be the person who deployed Kubeflow, or another person who has permission to access the Kubeflow cluster and use Kubeflow.

Introduction to namespaces

Depending on the setup of your Kubeflow cluster, you may need to create a namespace when you first log in to Kubeflow. Namespaces are sometimes called profiles or workgroups.

Kubeflow prompts you to create a namespace under the following circumstances:

For Kubeflow deployments that support multi-user isolation: Your username does not yet have an associated namespace with role bindings that give you administrative (owner) access to the namespace.
For Kubeflow deployments that support single-user isolation: The Kubeflow cluster has no namespace role bindings.

If Kubeflow doesn’t prompt you to create a namespace, then your Kubeflow administrator may have created a namespace for you. You should be able to see the Kubeflow central dashboard and start using Kubeflow.

Prerequisites

Your Kubeflow administrator must perform the following steps:

Deploy Kubeflow to a Kubernetes cluster, by following the Kubeflow getting-started guide.
Give you access to the Kubernetes cluster. See the guide to multi-tenancy.

Creating your namespace

If you don’t yet have a suitable namespace associated with your username, Kubeflow shows the following screen when you first log in:

Click Start Setup and follow the instructions on the screen to set up your namespace. The default name for your namespace is your username.

After creating the namespace, you should see the Kubeflow central dashboard, with your namespace available in the dropdown list at the top of the screen:

Next steps

Set up a Jupyter notebook in Kubeflow.
Read more about multi-tenancy in Kubeflow.

Kubeflow – Central Dashboard

Docs: Central Dashboard

Out of date

Overview of Kubeflow UIs

Accessing the central dashboard

URL pattern with Google Cloud Platform (GCP)

Using kubectl and port-forwarding

Next steps

Docs: Registration Flow

Out of date

Introduction to namespaces

Prerequisites

Creating your namespace

Next steps