Creating a Feature Flag
Step-by-Step User Guide
Overview
Feature Flags allow you to control the availability of features to specific groups or segments of users in UpGrade. This guide will walk you through the steps to create and enable a simple feature flag in the UpGrade UI.
Steps to Create a Feature Flag
Step 1: Navigate to the Feature Flags Root Page
After logging in to the UpGrade portal, navigate to the Feature Flags section from the left-hand sidebar. This is where you can view, create, and manage all your feature flags.
If no feature flags have been created yet, the list will be empty. To begin creating a feature flag, click on the Add Feature Flag button located on the top right of the screen.
Step 2: Define the Feature Flag Properties
In the "Add Feature Flag" dialog, you’ll need to define the following properties:
Name: Enter a descriptive name for your feature flag. For example, “My Flag.”
Key: Provide a unique key identifier that the client application will use to retrieve the feature flag. For example, “MY_FLAG.”
Description: (Optional) Add a brief description of the feature flag, such as “This is my feature flag.”
App Context: Select the application context where this feature flag will run. This ensures the flag is linked to a specific part of your software.
Tags: (Optional) Add tags for easier organization. You can type a tag name and press enter.
After filling in these fields, click the Create button to save your feature flag.
Step 3: View and Configure the Feature Flag
Once created, you’ll be taken to the feature flag’s details page. Here, you can further configure which users will see the feature flag by defining Include Lists and Exclude Lists.
In this example, we will define an include list to specify which users should experience the feature associated with this flag.
Step 4: Add an Include List
In the Include Lists section, click Add Include List.
Choose a Type from the dropdown. For this example, select Individual.
In the Values field, enter the user IDs that should be included, separated by commas (e.g.,
user1, user2, user3).In the Name field, give this include list a meaningful name, such as “My Users.”
(Optional) Add a description if needed.
Click Create to add this include list to the feature flag. The include list will appear in the Include Lists section, where you can enable or disable it as needed.
Step 5: Enable the Include List
To activate the include list for the feature flag, toggle the switch next to the list you created. You will be prompted to confirm this action. Click Enable to proceed.
Once enabled, the include list will dictate which users will see the feature associated with the flag. You can have multiple include or exclude lists, and enable or disable them as needed.
Step 6: Enable the Feature Flag
With the include list set up, you can now enable the feature flag itself. To do this, toggle the Enable switch at the top right of the feature flag’s details page. Confirm the action by clicking Enable in the pop-up dialog.
Final Confirmation
After enabling the feature flag, it will immediately apply to the users or groups defined in the enabled include lists. You can always return to the Feature Flags Root page to view existing feature flags or create a new one.
