debian-mirror-gitlab/doc/operations/feature_flags.md

stage	group	info
Release	Progressive Delivery	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers

Feature Flags (PREMIUM)

Introduced in GitLab 11.4.

With Feature Flags, you can deploy your application's new features to production in smaller batches. You can toggle a feature on and off to subsets of users, helping you achieve Continuous Delivery. Feature flags help reduce risk, allowing you to do controlled testing, and separate feature delivery from customer launch.

For an example of feature flags in action, see GitLab for Deploys, Feature Flags, and Error Tracking.

How it works

GitLab uses Unleash, a feature toggle service.

By enabling or disabling a flag in GitLab, your application can determine which features to enable or disable.

You can create feature flags in GitLab and use the API from your application to get the list of feature flags and their statuses. The application must be configured to communicate with GitLab, so it's up to developers to use a compatible client library and integrate the feature flags in your app.

Create a feature flag

To create and enable a feature flag:

1. Navigate to your project's Operations > Feature Flags.
2. Click the New feature flag button.
3. Enter a name that starts with a letter and contains only lowercase letters, digits, underscores (_), or dashes (-), and does not end with a dash (-) or underscore (_).
4. Enter a description (optional, 255 characters max).
5. Enter details about how the flag should be applied:
   • In GitLab 13.0 and earlier, add Environment specs. For each environment, include the Status (default enabled) and Rollout strategy (defaults to All users).
   • In GitLab 13.1 and later, add Feature Flag Strategies. For each strategy, include the Type (defaults to All users) and Environments (defaults to all environments).
6. Click Create feature flag.

You can change these settings by clicking the {pencil} (edit) button next to any feature flag in the list.

Rollout strategy (legacy)

Introduced in GitLab 12.2.

In GitLab 13.0 and earlier, the Rollout strategy setting affects which users will experience the feature as enabled. Choose the percentage of users that the feature will be enabled for. The rollout strategy will have no effect if the environment spec is disabled.

It can be set to:

• All users
• Percent of users
  • Optionally, you can click the Include additional user IDs checkbox and add a list of specific users IDs to enable the feature for.
• User IDs

Feature flag strategies

• Introduced in GitLab 13.0.
• It's deployed behind a feature flag, disabled by default.
• It's enabled on GitLab.com.
• To use it in GitLab self-managed instances, ask a GitLab administrator to enable it. (CORE ONLY)

You can apply a feature flag strategy across multiple environments, without defining the strategy multiple times.

GitLab Feature Flags use Unleash as the feature flag engine. In Unleash, there are strategies for granular feature flag controls. GitLab Feature Flags can have multiple strategies, and the supported strategies are:

• All users
• Percent of Users
• User IDs
• User List

Strategies can be added to feature flags when creating a feature flag, or by editing an existing feature flag after creation by navigating to Operations > Feature Flags and clicking {pencil} (edit).

All users

Enables the feature for all users. It uses the default Unleash activation strategy.

Percent of Users

Enables the feature for a percentage of authenticated users. It uses the gradualRolloutUserId Unleash activation strategy.

For example, set a value of 15% to enable the feature for 15% of authenticated users.

The rollout percentage can be from 0% to 100%.

NOTE: Note: Stickiness (consistent application behavior for the same user) is guaranteed for logged-in users, but not anonymous users.

CAUTION: Caution: If this strategy is selected, then the Unleash client must be given a user ID for the feature to be enabled. See the Ruby example below.

User IDs

Introduced in GitLab 12.2. Updated to be defined per environment in GitLab 12.6.

Enables the feature for a list of target users. It is implemented using the Unleash userWithId activation strategy.

Enter user IDs as a comma-separated list of values. For example, user@example.com, user2@example.com, or username1,username2,username3, and so on.

NOTE: Note: User IDs are identifiers for your application users. They do not need to be GitLab users.

CAUTION: Caution: The Unleash client must be given a user ID for the feature to be enabled for target users. See the Ruby example below.

User List

Introduced in GitLab 13.1.

Enables the feature for lists of users created with the Feature Flag User List API. Similar to User IDs, it uses the Unleash userWithId activation strategy.

Enable or disable feature flag strategies

This feature is under development, but is ready for testing. It's deployed behind a feature flag that is disabled by default. GitLab administrators with access to the GitLab Rails console can enable it for your instance.

To enable it:

Feature.enable(:feature_flags_new_version)

To disable it:

Feature.disable(:feature_flags_new_version)

Disable a feature flag for a specific environment

In GitLab 13.0 and earlier, to disable a feature flag for a specific environment:

1. Navigate to your project's Operations > Feature Flags.

2. For the feature flag you want to disable, click the Pencil icon.

3. To disable the flag:

   • In GitLab 13.0 and earlier: Slide the Status toggle for the environment. Or, to delete the environment spec, on the right, click the Remove (X) icon.
   • In GitLab 13.1 and later: For each strategy it applies to, under Environments, delete the environment.

4. Click Save changes.

Disable a feature flag for all environments

To disable a feature flag for all environments:

1. Navigate to your project's Operations > Feature Flags.
2. For the feature flag you want to disable, slide the Status toggle to Disabled.

The feature flag is displayed on the Disabled tab.

Integrate feature flags with your application

To use feature flags with your application, get access credentials from GitLab. Then prepare your application with a client library.

Get access credentials

To get the access credentials that your application needs to communicate with GitLab:

1. Navigate to your project's Operations > Feature Flags.
2. Click the Configure button to view the following:
   • API URL: URL where the client (application) connects to get a list of feature flags.
   • Instance ID: Unique token that authorizes the retrieval of the feature flags.
   • Application name: The name of the running environment. For instance, if the application runs for a production server, the application name would be production or similar. This value is used for the environment spec evaluation.

NOTE: Note: The meaning of these fields might change over time. For example, we are not sure if Instance ID will be single token or multiple tokens, assigned to the Environment. Also, Application name could describe the version of application instead of the running environment.

Choose a client library

GitLab implements a single backend that is compatible with Unleash clients.

With the Unleash client, developers can define, in the application code, the default values for flags. Each feature flag evaluation can express the desired outcome if the flag isn't present in the provided configuration file.

Unleash currently offers many SDKs for various languages and frameworks.

Feature flags API information

For API content, see:

• Feature Flags API
• Feature Flag Specs API (Deprecated and scheduled for removal in GitLab 14.0.)
• Feature Flag User Lists API
• Legacy Feature Flags API

Golang application example

Here's an example of how to integrate feature flags in a Golang application:

package main

import (
    "io"
    "log"
    "net/http"

    "github.com/Unleash/unleash-client-go"
)

type metricsInterface struct {
}

func init() {
    unleash.Initialize(
        unleash.WithUrl("https://gitlab.com/api/v4/feature_flags/unleash/42"),
        unleash.WithInstanceId("29QmjsW6KngPR5JNPMWx"),
        unleash.WithAppName("production"),
        unleash.WithListener(&metricsInterface{}),
    )
}

func helloServer(w http.ResponseWriter, req *http.Request) {
    if unleash.IsEnabled("my_feature_name") {
        io.WriteString(w, "Feature enabled\n")
    } else {
        io.WriteString(w, "hello, world!\n")
    }
}

func main() {
    http.HandleFunc("/", helloServer)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

Ruby application example

Here's an example of how to integrate feature flags in a Ruby application.

The Unleash client is given a user ID for use with a Percent rollout (logged in users) rollout strategy or a list of Target Users.

#!/usr/bin/env ruby

require 'unleash'
require 'unleash/context'

unleash = Unleash::Client.new({
  url: 'http://gitlab.com/api/v4/feature_flags/unleash/42',
  app_name: 'production',
  instance_id: '29QmjsW6KngPR5JNPMWx'
})

unleash_context = Unleash::Context.new
# Replace "123" with the id of an authenticated user.
# Note that the context's user id must be a string:
# https://unleash.github.io/docs/unleash_context
unleash_context.user_id = "123"

if unleash.is_enabled?("my_feature_name", unleash_context)
  puts "Feature enabled"
else
  puts "hello, world!"
end

Feature Flag Related Issues

• Introduced in GitLab 13.2.
• It's deployed behind a feature flag, enabled by default.
• It's enabled on GitLab.com.
• It can't be enabled or disabled per-project
• It's recommended for production use.
• For GitLab self-managed instances, GitLab administrators can opt to disable it.

You can link related issues to a feature flag. In the Linked issues section, click the + button and input the issue reference number or the full URL of the issue.

This feature is similar to the related issues feature.

Enable or disable Feature Flag Related Issues (CORE ONLY)

Feature Flag Related Issues is under development but ready for production use. It is deployed behind a feature flag that is enabled by default. GitLab administrators with access to the GitLab Rails console can opt to disable it for your instance.

To disable it:

Feature.disable(:feature_flags_issue_links)

To enable it:

Feature.enable(:feature_flags_issue_links)