Set up OAuth for Cloud IAP

Creating an OAuth client for Cloud IAP on Google Cloud Platform (GCP)

If you want to use Cloud Identity-Aware Proxy (Cloud IAP) when deploying Kubeflow on GCP, then you must follow these instructions to create an OAuth client for use with Kubeflow.

You can skip the instructions on this page if you want to use basic authentication (username and password) with Kubeflow instead of Cloud IAP. Cloud IAP is recommended for production deployments or deployments with access to sensitive data.

Follow the steps below to create an OAuth client ID that identifies Cloud IAP when requesting access to a user’s email account. Kubeflow uses the email address to verify the user’s identity.

  1. Set up your OAuth consent screen:

    • In the Application name box, enter the name of your application. The example below uses the name “Kubeflow”.
    • Under Support email, select the email address that you want to display as a public contact. You must use either your email address or a Google Group that you own.
    • If you see Authorized domains, enter

      <project>.cloud.goog
      
      • where <project> is your Google Cloud Platform (GCP) project ID.
      • If you are using your own domain, such as acme.com, you should add that as well
      • The Authorized domains option appears only for certain project configurations. If you don’t see the option, then there’s nothing you need to set.
    • Click Save.

    • Here’s an example of the completed form:
      OAuth consent screen

  2. On the credentials screen:

    • Click Create credentials, and then click OAuth client ID.
    • Under Application type, select Web application.
    • In the Name box enter any name for your OAuth client ID. This is not the name of your application nor the name of your Kubeflow deployment. It’s just a way to help you identify the OAuth client ID.
  3. Click Create. A dialog box appears, like the one below:

    OAuth consent screen

  4. Copy the client ID shown in the dialog box, because you need the client ID in the next step.

  5. On the Create credentials screen, find your newly created OAuth credential and click the pencil icon to edit it:

    OAuth consent screen

  6. In the Authorized redirect URIs box, enter the following (if it’s not already present in the list of authorized redirect URIs):

    https://iap.googleapis.com/v1/oauth/clientIds/<CLIENT_ID>:handleRedirect
    
    • <CLIENT_ID> is the OAuth client ID, something like XXX.apps.googleusercontent.com. Do not include the angle brackets around the client ID.
    • Note that the URI is not dependent on the Kubeflow deployment or endpoint. Multiple Kubeflow deployments can share the same OAuth client without the need to modify the redirect URIs.
  7. Press Enter/Return to add the URI. Check that the URI now appears as a confirmed item under Authorized redirect URIs. (The URI should no longer be editable.)

    Here’s an example of the completed form: OAuth credentials

  8. Click Save.

  9. Make note that you can find your OAuth client credentials in the credentials section of the GCP Console. You need to retrieve the client ID and client secret later when you’re ready to enable Cloud IAP.

Next steps

Choose one of the following ways to deploy Kubeflow:

  • Using the UI. This option provides a simple way to deploy Kubeflow.
  • Using the CLI. This option provides more control over the deployment process.