Central Dashboard

Overview of the Kubeflow user interfaces (UIs)

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

Your Kubeflow deployment includes a central dashboard that provides quick accessto the Kubeflow components deployed in your cluster. The dashboard includes thefollowing features:

  • Shortcuts to specific actions, a list of recent pipelines and notebooks, andmetrics, giving you an overview of your jobs and cluster in one view.
  • A housing for the UIs of the components running in the cluster, includingPipelines, Katib, Notebooks, and more.
  • A registration flow formanaging users and namespaces. You can set up a single namespace (workgroup)for a shared deployment, or configuremulti-user isolation.

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 theKubeflow deployment.

The central dashboard looks like this:

Kubeflow central UI

Accessing the central dashboard

To access the central dashboard, you need to connect to theIstio gateway thatprovides access to the Kubeflowservice 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:

  1. 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 theLet’s Encrypt service to provide an SSL certificatefor the Kubeflow UI. For troubleshooting issues with your certificate, see theguide tomonitoring your Cloud IAP setup.

Using kubectl and port-forwarding

If you didn’t configure Kubeflow to integrate with an identity providerthen 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 theGCP deployment UI or the default settingswith the CLI deployment. (If you want touse port forwarding, you must deploy Kubeflow on an existing Kubernetescluster using the kfctl_k8s_istioconfiguration.)

  • You’ve configured the Istio ingress to only acceptHTTPS 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 commandline: gcloud components install kubectl.
    • Alternatively, follow the kubectlinstallation guide.
  • Use the following command to set up port forwarding to theIstio gateway.
  1. export NAMESPACE=istio-system
  2. kubectl port-forward -n istio-system svc/istio-ingressgateway 8080:80
  • Access the central navigation dashboard at:
  1. http://localhost:8080/

Depending on how you’ve configured Kubeflow, not all UIs work behindport-forwarding to the reverse proxy.

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

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

Next steps

Set up your Jupyter notebooks in Kubeflow.

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified 18.02.2020: Refactor multiuser guides (#1682) (688286b9)