Environments

Honeydew provides support for managing different settings tailored to specific branches. This feature is particularly useful, for example, for teams that need to use different Snowflake databases and schemas for various branches (e.g., the published production branch and other development branches) while maintaining a consistent table naming structure across environments.

The configuration syntax is flexible, allowing you to specify settings for individual branch names or use patterns for broader matches. For example, you can define settings for a specific branch like dev1 or use patterns such as dev* to match any branch starting with dev, or dev[12] to match dev1 or dev2. A wildcard pattern * can be used as a default option to catch all unmatched branches.

Branch name matching rules are evaluated sequentially, ensuring precise control over the settings applied to each branch.

​

Configuration

You can configure environments in the Honeydew UI using the “Workspace actions” menu in the Workspace.

For each environment, you can specify the following settings:

1. Name - the name of the environment.
2. Branch pattern - the pattern to match the branch name.
   1. * - matches all branches
   2. prod - matches prod branch
   3. dev* - matches all branches starting with dev
   4. dev_[12] - matches dev_1 and dev_2
   5. dev_[!12] - matches dev_3, but not dev_1 and dev_2
3. Database - the Snowflake database name (optional)
4. Schema - the Snowflake schema name (optional)
5. Warehouse - the Snowflake warehouse name (optional)
6. Role - the Snowflake role name (optional)

​

Order of Evaluation

There are a few places in Honeydew where you can configure and override Snowflake connection settings:

1. Global Snowflake connection settings (lowest precedence)
2. Environment level Snowflake settings overrides
3. Domain level Snowflake settings overrides (highest precedence)

For example:

1. You have a global Snowflake connection settings, defining a ROLE and a WAREHOUSE
2. You have an environment configuration for the prod branch, defining a different ROLE
3. You have a domain configuration for domain named sales, defining a different WAREHOUSE

When you use the sales domain from the prod branch, Honeydew will use the ROLE from the prod environment configuration and the WAREHOUSE from the sales domain configuration.

The following table shows the different options for defining Snowflake connection settings and their order of evaluation:

​

Use-cases

​

Development and Production Databases / Schemas

When working with multiple environments, it can be important to separate production data from development and testing workflows. For example, in your Snowflake account, you may have separate databases for production (PROD) and development (DEV), both sharing the same schema structure. The DEV database is used for testing and development, while PROD is reserved for live, production data.

In Honeydew, you can configure two environments to manage these databases effectively:

One environment for the prod branch, linked to the PROD database. Another environment for all other branches, linked to the DEV database. This setup ensures that production workflows operate on the correct database while development branches have a safe space to test changes in data.

When you switch branches in Honeydew, the connection settings will be automatically adjusted based on the predefined branch name matching rules. When mapping tables to entities, Honeydew will use the connection settings from the active environment.

When Honeydew determines the source data of an entity, it will use the Database and Schema settings of the environment to resolve relative table paths in the source data.

​

Warehouse Settings

Environments can help optimize resource allocation by adjusting warehouse settings based on usage needs. For example, you can configure an environment for the prod branch with a larger warehouse to handle higher workloads, while the dev branch can use a smaller, cost-efficient warehouse. When switching branches in Honeydew, the warehouse settings will automatically adjust based on predefined branch name rules, ensuring the right resources are used for each environment.

​

Role-based Access Control

Environments can be used to manage role-based access control in Snowflake. For example, you can create a DEV role with access to the DEV database and a PROD role with access to the PROD database, ensuring that users only have access to the data they need for their specific tasks. By configuring environments in Honeydew, you can automatically switch roles based on the active branch, simplifying access management and ensuring data security.

​

YAML Schema

Environments are defined per-workspace, in each workspace’s YAML on the prod branch.

The schema for environments is, for example:

...
environments:
  - name: Prod Environment
    branch_pattern: prod
    snowflake:
      database: PROD
      schema: PROD
      warehouse: PROD_WH
      role: PROD_ROLE
  - name: Dev Environment
    branch_pattern: dev*
    snowflake:
      database: DEV
      schema: DEV
      warehouse: DEV_WH
      role: DEV_ROLE