Merge branch 'docs/edit-feature-flags' into 'master'
Edit Feature Flags topic See merge request gitlab-org/gitlab-ce!31956
This commit is contained in:
commit
be3ec70556
1 changed files with 18 additions and 13 deletions
|
@ -85,7 +85,7 @@ NOTE: **NOTE**
|
||||||
We'd highly recommend you to use the [Environment](../../../ci/environments.md)
|
We'd highly recommend you to use the [Environment](../../../ci/environments.md)
|
||||||
feature in order to quickly assess which flag is enabled per environment.
|
feature in order to quickly assess which flag is enabled per environment.
|
||||||
|
|
||||||
## Rollout Strategy
|
## Rollout strategy
|
||||||
|
|
||||||
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/8240) in GitLab 12.2.
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/8240) in GitLab 12.2.
|
||||||
|
|
||||||
|
@ -97,33 +97,38 @@ However, a feature will be enabled for 50% of logged-in users if the matching en
|
||||||
|
|
||||||
### All users
|
### All users
|
||||||
|
|
||||||
Enables the feature for all users.
|
Enables the feature for all users. It is implemented using the Unleash
|
||||||
|
[`default`](https://unleash.github.io/docs/activation_strategy#default)
|
||||||
**All users** is implemented using the Unleash [default](https://unleash.github.io/docs/activation_strategy#default) activation strategy.
|
activation strategy.
|
||||||
|
|
||||||
### Percent rollout (logged in users)
|
### Percent rollout (logged in users)
|
||||||
|
|
||||||
**Percent rollout (logged in users)** enables the feature for a percentage of authenticated users. Set a value of 15%, for example, to enable the feature for 15% of authenticated users.
|
Enables the feature for a percentage of authenticated users. It is
|
||||||
|
implemented using the Unleash
|
||||||
|
[`gradualRolloutUserId`](https://unleash.github.io/docs/activation_strategy#gradualrolloutuserid)
|
||||||
|
activation strategy.
|
||||||
|
|
||||||
|
Set a value of 15%, for example, to enable the feature for 15% of authenticated users.
|
||||||
|
|
||||||
A rollout percentage may be between 0% and 100%.
|
A rollout percentage may be between 0% and 100%.
|
||||||
|
|
||||||
CAUTION: **Caution:**
|
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](#ruby-application-example) below.
|
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](#ruby-application-example) below.
|
||||||
|
|
||||||
**Percent rollout (logged in users)** is implemented using the Unleash [gradualRolloutUserId](https://unleash.github.io/docs/activation_strategy#gradualrolloutuserid) activation strategy.
|
## Target users
|
||||||
|
|
||||||
## Target Users
|
|
||||||
|
|
||||||
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/8240) in GitLab 12.2.
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/8240) in GitLab 12.2.
|
||||||
|
|
||||||
A feature flag may be enabled for a list of target users.
|
A feature flag may be enabled for a list of target users. It is implemented
|
||||||
|
using the Unleash [`userWithId`](https://unleash.github.io/docs/activation_strategy#userwithid)
|
||||||
|
activation strategy.
|
||||||
|
|
||||||
![Feature flag target users](img/target_users_v12_2.png)
|
![Feature flag target users](img/target_users_v12_2.png)
|
||||||
|
|
||||||
CAUTION: **Caution:**
|
CAUTION: **Caution:**
|
||||||
The Unleash client **must** be given a user id for the feature to be enabled for target users. See the [Ruby example](#ruby-application-example) below.
|
The Unleash client **must** be given a user ID for the feature to be enabled for
|
||||||
|
target users. See the [Ruby example](#ruby-application-example) below.
|
||||||
**Target users** is implemented using the Unleash [userWithId](https://unleash.github.io/docs/activation_strategy#userwithid) activation strategy.
|
|
||||||
|
|
||||||
## Integrating with your application
|
## Integrating with your application
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue