LaunchDarkly

LaunchDarkly is a feature flag management platform.

Integrating Cortex with LaunchDarkly allows you to:

• Track LaunchDarkly feature flags on entities in the catalog.

• Create Scorecards that track progress and drive alignment on projects involving your LaunchDarkly feature flags.

• Perform tasks relating to LaunchDarkly feature flags as a part of a Workflow.

  • For example, you can include a "Create feature flag" step within a Workflow.

How to configure LaunchDarkly with Cortex

Prerequisites

Before getting started, create a LaunchDarkly access token with:

• The Writer role

  • If you are not adding LaunchDarkly-related tasks to your Workflows, you can configure the token with the Reader role.

• 20220603 as the API version

Configure the integration in Cortex

1. In Cortex, navigate to the LaunchDarkly settings page:

   1. In Cortex, click your avatar in the lower left corner, then click Settings.

   2. Under "Integrations", click LaunchDarkly.

2. Click Add configuration.

3. Configure the integration details:

   • Account alias: Enter the alias for this configuration.

   • Access token: Enter your LaunchDarkly access token.

   • Environment: Select your environment.

4. Click Save.

Configure the integration for multiple LaunchDarkly accounts​

The LaunchDarkly integration has multi-account support. You can add a configuration for each additional organization, instance, or account by repeating the process above.

Each configuration requires an alias, which Cortex uses to correlate the designated organization, instance, or account with registrations for various entities. Registrations can also use a default configuration without a listed alias. You can edit aliases and default configurations from the LaunchDarkly page in your Cortex settings. Select the edit icon next to a given configuration and toggle Set as default on. If you only have one configuration, it will automatically be set as the default.

How to connect Cortex entities to LaunchDarkly

Discovery

By default, Cortex will try to "best-guess" the corresponding project in LaunchDarkly based on the key or tags.

Cortex first looks up a LaunchDarkly project using the entity name (e.g. My Service), then the entity identifier (e.g. my-service). For example, if your entity name is “My Service”, then the corresponding LaunchDarkly project's key or tag should contain either “My Service” or "my-service".

If no project was matched, Cortex will try to "best-guess" feature flags from all available projects using feature flag tags.

Editing the entity descriptor

You can find the project key and tags in LaunchDarkly under Account settings > Projects. The URL for the project will contain the key. For example: https://app.launchdarkly.com/projects/default/settings/environments.

If you prefer to use the project tags in the registration instead, you can find it in the projects table or project settings page.

x-cortex-launch-darkly:
  projects:
    - key: project-key
      environments: # Optional
        - environmentName: prod
        - environmentName: staging
      alias: alias-1 # alias is optional and only relevant if you have opted into multi account support
    - tag: project-tag
      environments: # Optional
        - environmentName: prod
      alias: alias-2 # alias is optional and only relevant if you have opted into multi account support
  feature-flags:
    - tag: feature-flag-tag
      environments: # Optional
        - environmentName: staging
      alias: alias-3 # alias is optional and only relevant if you have opted into multi account support

Scorecards and CQL

With the LaunchDarkly integration, you can create Scorecard rules and write CQL queries based on LaunchDarkly projects.

See more examples in the CQL explorer in Cortex.

Check if LaunchDarkly project is set

Check if entity has a registered LaunchDarkly project in its entity descriptor. If no registration exists, we'll try to automatically detect which corresponding LaunchDarkly project is associated with the entity.

Definition: launchDarkly (==/!=) null

Example

For example, you could write a rule in a Scorecard to check whether an entity has a LaunchDarkly project set:

launchDarkly != null

Feature flags

List of flags

Definition: launchDarkly.flags()

Example

In a Scorecard, you could write a rule to check whether an entity has fewer than 10 flags:

launchDarkly.flags().length < 10

Still need help?​

The following options are available to get assistance from the Cortex Customer Engineering team:

• Email: [e-mail], or open a support ticket in the in app Resource Center
• Chat: Available in the Resource Center

• Slack: Users with a connected Slack channel will have a workflow added to their account. From here, you can either @CortexTechnicalSupport or add a :ticket: reaction to a question in Slack, and the team will respond directly.

Don’t have a Slack channel? Talk with your Customer Success Manager.