Create a GitHub connection

Beta

This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.

Create a GitHub connection in Catalog Explorer to store authentication credentials for Lakeflow Connect ingestion. Any user with the USE CONNECTION privilege on the connection can then create GitHub ingestion pipelines without needing direct access to the credentials.

Alternatively, admin users can create a connection and a pipeline at the same time in the data ingestion UI. See Create an ingestion pipeline.

For privilege requirements, see Connect to managed ingestion sources.

Prerequisites

Complete the source setup. Use the authentication details you obtain to create the connection.

Create a connection

1. In the Databricks workspace, click Catalog > Create > Create a connection.
2. On the Connection basics page of the Set up connection wizard, enter a unique Connection name.
3. In the Connection type drop-down menu, select GitHub.
4. (Optional) Add a comment.
5. Click Next.
6. On the Authentication page, enter the following credentials:
   • Client ID: The client ID from the source setup.
   • Client secret: The client secret from the source setup.
   • (Optional) Enterprise domain: The GitHub Enterprise domain. If not specified, the default api.github.com is used.
7. Click Authorize. You're redirected to the GitHub authorization page.
8. Review and authorize all the requested scopes. You're redirected to the Databricks workspace.
9. Click Create connection.

Next steps

Create an ingestion pipeline.