Deploy using UI

Instructions for using the UI to deploy Kubeflow on Google Cloud Platform (GCP)

This page provides instructions for using the Kubeflow deployment web app to deploy Kubeflow on GCP. The deployment web app currently supports Kubeflow v0.5.0.

For more control over your deployment, see the guide to deployment using the CLI. The CLI supports Kubeflow v0.6.1 and later versions.

Overview of the deployment user interface (UI)

Here’s a partial screenshot of the deployment UI:

Kubeflow deployment UI

Follow these steps to open the deployment UI and deploy Kubeflow on GCP:

  1. Open https://deploy.kubeflow.cloud/ in your web browser. You should see a form like the one in the above screenshot.
  2. Sign in to your browser using an account that has the owner role for your GCP project.
  3. Complete the following fields on the form:

    • Project: Enter your GCP project ID.
    • Deployment name: Enter a short name that you can use to recognize this deployment of Kubeflow. The maximum length for the deployment name is 25 characters.
    • Choose how to connect to Kubeflow: You can choose one of the following options:

      • Login with GCP Iap: Choose this option if you want to use Cloud Identity-Aware Proxy (Cloud IAP) for access control. Cloud IAP is the best option for production deployments or deployments with access to sensitive data. See more details below.
      • Login with Username Password: Choose this option if you want to allow users to access Kubeflow with a username and password, that is, with basic authentication. See more details below.
      • Setup Endpoint later: (Not recommended.) Choose this option if you want to skip the authentication process and set up the URI for the Kubeflow UI later. See more details below.
    • GKE zone: Enter the GCP zone in which to create your deployment. The default is us-central-1a.

    • Kubeflow version: Choose one of the available versions of Kubeflow. You can see all the versions on the Kubeflow releases page. If you need a version that does not show on the deployment UI, you need to deploy Kubeflow using the CLI.

    • Create Permanent Storage: Check this option if you plan to use Kubeflow Pipelines and you need persistent storage for your pipeline data. The default is not to add persistent storage. For more information, see the guide to upgrading and reinstalling Kubeflow Pipelines.

    • Share Anonymous Usage Report: Check this option to allow Kubeflow to report usage data using Spartakus. Spartakus does not report any personal information. The default is to enable the reporting of usage data.

  4. Click Create Deployment.

  5. Watch for the deployment updates in the information box at the bottom of the deployment UI.

Authenticating with Cloud IAP

This section contains details about using Cloud IAP to control access to Kubeflow. Cloud IAP is the best option for production deployments or deployments with access to sensitive data.

  1. Follow the guide to setting up OAuth credentials.

  2. Choose the Login with GCP Iap option on the Kubeflow deployment UI.

  3. Enter your OAuth client ID and OAuth client secret into the corresponding fields on the deployment UI.

  4. Complete the rest of the form as described above.

Kubeflow will be available at the following URI:

https://<deployment_name>.endpoints.<project>.cloud.goog/

It can take 10-15 minutes for the URI to become available. You can watch for updates in the information box on the deployment UI. If the deployment takes longer than expected, click Kubeflow Service Endpoint to try accessing your Kubeflow URI.

Authenticating with username and password

This section contains details about using basic authentication (username and password) to control access to Kubeflow.

  1. Choose the Login with Username Password option on the Kubeflow deployment UI.

  2. Enter a username and a password for use when accessing the UI for your Kubeflow deployment.

  3. Complete the rest of the form as described above.

  4. Click Kubeflow Service Endpoint to access your Kubeflow URI.

You can choose to deploy Kubeflow without creating an endpoint for the Kubeflow service.

  1. Choose the Setup Endpoint later option on the Kubeflow deployment UI.
  2. Finish the setup later by inserting your OAuth client into the Kubeflow cluster. Read more about customizing Kubeflow and securing your clusters.

Next steps