Skip to main content

Setting up CI/CD for dbt State Preview

note

CI/CD setup only applies when using the standalone dbt State web app.

When running dbt State in CI/CD environments (for example, GitHub Actions, GitLab CI, Jenkins), browser-based authentication is not possible. For this reason, dbt State supports OAuth client credentials for authentication in CI environments.

dbt State automatically detects when it's running in a CI environment. If OAuth client credentials are not provided, dbt State disables itself and displays a warning, allowing your dbt commands to continue without caching.

OAuth client credentials​

OAuth client authentication requires two credentials:

  • Client ID — A unique identifier for your OAuth client
  • Client secret — A secret key used to authenticate your client

Prerequisites​

Before configuring CI/CD authentication, make sure you have:

  • dbt State installed and configured. Refer to Set up dbt State for more information.
  • Admin permissions in your dbt State organization.

Creating an OAuth client​

  1. In the dbt State web app, navigate to the Clients tab.
  2. Click Add OAuth Client.
  3. Enter a name and description for the new client and click Create.
  4. Copy the client ID and secret to use in your CI/CD environment configuration.

Configuring authentication​

Once you have the client ID and secret, set the following environment variables in your CI/CD platform. Using environment variables is the recommended approach for CI/CD environments as it keeps sensitive credentials out of your code repository.

DBT_ENGINE_STATE_OAUTH_CLIENT_ID=your-client-id
DBT_ENV_SECRET_STATE_OAUTH_CLIENT_SECRET=your-client-secret

Make sure to replace your-client-id and your-client-secret with the values from your OAuth client.

Verify dbt State is active​

  1. Run any dbt transformation job in your orchestrated environment.

  2. Check the log output. You should see a message like this, then the specific dbt State step status:

    dbt State adapter: dbt-state v2.10.1 is enabled

Was this page helpful?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

0
Loading