No results for ""
EXPAND ALL
  • Home
  • API docs

Environments

Read time: 4 minutes
Last edited: Dec 02, 2024

Overview

This category explains what environments are in LaunchDarkly and how to use them to manage different business areas or areas of your product lifecycle.

Environments are organizational units contained within projects. Environments allow you to manage your feature flags throughout your entire development lifecycle, from local development through production. Typical environments within a project could be Production, QA, Staging, or individual development environments.

You can create multiple environments within each project, and all projects must have at least one environment. To learn more about projects, read Projects.

Every project starts with two environments. In this topic, learn about:

  • Default environments
  • View a project's environments
  • Critical environments
  • Migrate content between environments

You can create as many additional environments as you need. In this category, learn how to:

You can also use the REST API: Environments

Default environments

Your first project has two environments, Test and Production, by default. Each environment has its own SDK key, client-side ID, and mobile key, which are used to connect the LaunchDarkly SDKs to a specific environment.

Each feature flag that you create has its own set of targeting rules for each environment. This means that you can change your flag targeting rules in a development or staging environment for QA testing before rolling out to production.

By default, LaunchDarkly marks your Production environment as "critical" to indicate that it affects your customers or the health of your systems.

View a project's environments

To view a project's environments:

  1. Click the project dropdown. The project menu appears:
The project menu.
The project menu.
  1. Select Project settings.
  2. Select Environments. The Environments list appears.

Open environments

You can open environments from the Flags list, or while on a flag's Targeting tab:

  • On the Flags list, opening an environment adds that environment's flag status to the list
  • On the flag's Targeting tab, opening an environment adds a new section with that environment's flag targeting rules

To open an environment from the Flags list or the flag's Targeting tab:

  1. Click the + next to the list of environment sections.
  2. Search for the environment you want, and select it from the list.
The environment selection menu.
The environment selection menu.

The new environment, and its related flag targeting information, appears. The number of environments you can view at once is limited by the width of your browser.

Critical environments

Critical environments, such as Production, affect your customers or the health of your systems.

When you create a new environment, we strongly recommend enabling the following safeguards for your critical environments:

  • Require comments for flag and segment changes
  • Require confirmation for flag and segment changes

LaunchDarkly also enables some safeguards for critical environments, such as prompting you to check these environments when you archive a flag or view flags across multiple environments. Additionally, you can create custom roles that allow or deny access to critical environments.

To mark an environment as critical after you have created it:

  1. Click the project dropdown. The project menu appears:
The project menu.
The project menu.
  1. Select Project settings.
  2. Select Environments. The Environments list appears.
  3. Click the overflow menu for the environment.
  4. Select Mark as critical.
  5. The "Mark environment as critical" dialog appears.
  6. Review the recommended safeguards:
  • (Optional) Select the Require comments for flag and segment changes checkbox to force members who modify flags and segments to leave a comment to explain their changes.
  • (Optional) Select the Require confirmation for flag and segment changes checkbox to force members who modify flags and segments to verify they wish to make these changes.
  1. Click Mark as critical.

To remove the critical designation from an environment, click the overflow menu for the environment and select "Mark as non-critical."

To view examples of custom role policies that use critical environments, read Example: Grant access to specific environments and flags.

Environment and SDK credentials

You can view the environment key, SDK key, mobile key, and client-side ID for an environment from the Environments list:

The Environments list with the overflow menu open and the SDK credential options displayed.
The Environments list with the overflow menu open and the SDK credential options displayed.

To learn how to find, copy, and reset SDK keys, mobile keys, and client-side IDs for an environment, read Copy and reset SDK credentials for an environment.

Favorite environments

You can add environments to your "Favorites" list, which is pinned to the top of the environments list. This list makes them easy to find when you want to open a commonly-used environment.

To add an environment to your favorites list:

  1. From the Flags list, hover on the environment you want to add to your favorites, and click the three-dot overflow menu that appears.
  2. Click Add to favorites.

The environment is added to your favorites list.

You can also add an environment to your favorites list from a flag's details page using the environment's overflow menu.

To remove an environment from your favorites list, click Remove from favorites in the overflow menu.

Migrate content between environments

You can migrate some, but not all, content between environments from the Flags list. To learn more, read Compare and copy flag settings between two environments.

Alternatively, you can use the REST API to migrate flags from one environment to another. First, GET the feature flag you wish to import, then PATCH to update the flag configuration in production.

You can also use the REST API: Get feature flag, Update feature flag