• Home
  • Integrations
  • SDKs
  • Guides
  • API docs
No results for ""
EXPAND ALL

GIVE DOCS FEEDBACK

Automatic configuration

Read time: 6 minutes
Last edited: Jan 02, 2024

Overview

This topic explains how to set up the Relay Proxy's automatic configuration feature.

Relay Proxy automatic configuration is an Enterprise feature

Relay Proxy automatic configuration is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

With automatic configuration, the Relay Proxy automatically detects and supports new connections to updated or new environments whenever changes occur that impact LaunchDarkly SDK keys, mobile keys, or client-side IDs.

Benefits of automatic configuration

In a standard Relay Proxy, without automatic configuration, whenever you add or make changes to environments and projects in LaunchDarkly, you must manually update configuration files and restart the Relay Proxy to reflect the changes.

With automatic configuration enabled, you no longer need to manually update the Relay Proxy's configuration files after you make configuration changes, nor do you need to restart the Relay Proxy for changes to take effect.

Additionally, you can use a page in the LaunchDarkly user interface (UI) to configure your Relay Proxy with the automatic configuration feature. A standard Relay Proxy requires all environments to be defined individually, and you cannot configure it through the LaunchDarkly UI.

You can also use the REST API: Relay Proxy configurations

If you enable automatic configuration, your Relay Proxy automatically detects and reacts to server-sent events including the following:

  • SDK key rotation
  • Mobile key rotation
  • Environment state changes, such as new environment creation, name and tag updates, and environment deletion
  • Project state changes, such as new project creation, name and tag updates, and project deletion

This prevents you from needing to restart your Relay Proxy instances and potentially cause downtime while applying changes. These changes have no impact on your Relay Proxy's performance.

With automatic configuration enabled, you only need to restart the Relay Proxy to upgrade it.

Enabling automatic configuration

Enabling automatic configuration is a two-step process. These steps appear in detail below.

You must:

  1. Create a Relay Proxy configuration in the Relay Proxy tab of the Account settings page and save its unique key.
  2. Configure your Relay Proxy instance to use the unique key from the prior step. You may do so either as a property in your Relay Proxy configuration file or as an environment variable.
Save the Relay Proxy's unique key

When you create a new Relay Proxy, LaunchDarkly assigns a unique key to it. You must save the key immediately after you create the Relay Proxy, because the key is only viewable on creation.

Here's how to create a Relay Proxy configuration in the LaunchDarkly UI:

  1. Navigate to the Account settings page and click into the Relay Proxy tab.
  2. Click Create configuration. The "Create a Relay Proxy configuration" panel appears.
  3. Give the Relay Proxy a human-readable Name.
  4. Choose a Rule from the menu. This rule determines what content the Relay Proxy receives.
  • "All projects and environments" sends changes about all projects and environments to the Relay Proxy.
  • "Inline policy" allows you to specify which projects and environments you can track events for. To learn more, read Writing an inline policy.
  1. Click Save configuration. The Relay Proxy appears on the Relay Proxy tab of the Account settings page with its key visible.
  2. Copy and save the key somewhere secure:
The "Relay proxy" tab with a newly created Relay Proxy. The key is displayed.
The "Relay proxy" tab with a newly created Relay Proxy. The key is displayed.

Next you must specify the key in a Relay Proxy configuration file so it includes the configuration you created. Here's how:

  1. Configure your Relay Proxy to use your new key.
  • If you configured the Relay Proxy with a configuration file, specify the Relay Proxy key in an AutoConfig section as the key property.

  • If you configured the Relay Proxy with environment variables, specify the Relay Proxy key with the AUTO_CONFIG_KEY environment variable. Here's how:

    [AutoConfig]
    key = "rel-EXAMPLE-RELAY-PROXY-CONFIGURATION-KEY"
  1. Start the Relay Proxy.

From now on, the Relay Proxy will respond automatically to the project and environment state changes you specified.

Writing an inline policy

You can use the inline policy editor to specify precise instructions on what environments and projects the Relay Proxy should include or exclude. You can write policies by hand to get exactly the outcomes you want.

There are three ways to write an inline policy:

  • Using the simple editor
  • Using the resource finder
  • Using the advanced editor

Each of these methods is described below.

Expand Using the simple editor

Using the simple editor

You can create simple, one-line policies using the simple editor. To learn more about policy syntax, read Resource specifiers.

To use the simple editor from the "Create a Relay Proxy configuration" panel:

  1. Choose "inline policy" from the Rule menu.
  2. Enter a policy in the "Choose resources for this policy statement" field. In this example, proj/default:env/* gives the Relay Proxy access to all environments within the default project.
The simple policy editor.
The simple policy editor.
  1. Click Save configuration.
Expand Using the resource finder

Using the resource finder

To create an inline policy using the resource finder from the "Create a Relay Proxy configuration" panel:

  1. Choose "inline policy" from the Rule menu.
  2. Click Resource finder. A "Find a resource" dialog appears.
The "Find a resource" dialog.
The "Find a resource" dialog.
  1. Search for the resource you want the Relay Proxy to have access to.
  2. Select the resource. The resource appears in the Choose resources for this policy statement field.
  3. Click Save configuration.
Expand Using the advanced editor

Using the advanced editor

To write more complicated policies you can use the advanced editor. To learn how to write advanced policies, read Understanding policies.

To use the advanced editor from the "Create a Relay Proxy configuration" panel:

  1. Choose "inline policy" from the Rule menu.
  2. Click Advanced editor. The advanced editor window appears.
  3. Enter your policy.
  4. Click Save configuration.
The advanced policy editor.
The advanced policy editor.

Example access policies

You can limit the environments to include in an automatic Relay Proxy configuration. Expand each section below to view custom role policy examples.

Expand Production environment in all projects

Production environment in all projects

Use this policy to give the Relay Proxy access to the production environment in all projects:

[
{
"actions": ["*" ],
"effect": "allow",
"resources": ["proj/*:env/production" ]
}
]
Expand Production environment in one project

Production environment in one project

Use this policy to give the Relay Proxy access to the production environment in the "Mobile" project:

[
{
"actions": ["*"],
"effect": "allow",
"resources": ["proj/mobile:env/production" ]
}
]
Expand All environments in certain projects

All environments in certain projects

Use this policy to give the Relay Proxy access to all environments in projects starting with "Mobile-":

[
{
"actions": ["*"],
"effect": "allow",
"resources": ["proj/mobile-*:env/*" ]
}
]
Expand Production environments in tagged projects

Production environments in tagged projects

Use this policy to give the Relay Proxy access production environments in projects tagged with "mobile":

[
{
"actions": ["*"],
"effect": "allow",
"resources": ["proj/*;mobile:env/production" ]
}
]
Expand All non-production environments in any projects not tagged federal

All non-production environments in any projects not tagged "federal"

Use this policy to give the Relay Proxy access to non-production environments in projects not tagged with "federal":

[
{
"actions": ["*" ],
"effect": "allow",
"resources": ["proj/*:env/*"]
},
{
"actions": ["*"],
"effect": "deny",
"resources": [
"proj/*:env/production",
"proj/*;federal:env/*"
]
}
]

Writing a custom role with access to the Relay Proxy

You can give members access to the Relay Proxy using the relay-proxy-config resource in a custom role policy. To learn more about Relay Proxy resource actions, read Relay Proxy configuration actions.

You can copy and paste this custom role policy into the advanced editor to grant access to all Relay Proxy actions:

[
{
"effect": "allow",
"actions": ["*"],
"resources": ["relay-proxy-config"]
}
]

To learn more about creating custom roles, read Custom roles.