diff options
author | Evan Read <eread@gitlab.com> | 2019-08-19 05:52:59 +0000 |
---|---|---|
committer | GitLab Release Tools Bot <delivery-team+release-tools@gitlab.com> | 2019-08-23 10:08:25 +0000 |
commit | 21a6f54aa6238719f54e5e1435fed5511c59dcd1 (patch) | |
tree | 7c7f35b4d1e74b47a92374e14870c42153d56be9 | |
parent | 38e796bae337123f66aa1d0c8d2bbd4248783d8d (diff) | |
download | gitlab-ce-21a6f54aa6238719f54e5e1435fed5511c59dcd1.tar.gz |
Merge branch 'docs-userid-ff' into 'master'
Add Documentation for Feature Flag Target Users
Closes gitlab-ee#11459
See merge request gitlab-org/gitlab-ce!31918
(cherry picked from commit 69df059405f720cdb8ae8bcdf348dbafa5d1d64e)
c42f5bbc Add documentation for feature flag Target Users
-rw-r--r-- | doc/user/project/operations/feature_flags.md | 15 | ||||
-rw-r--r-- | doc/user/project/operations/img/target_users_v12_2.png | bin | 0 -> 42768 bytes |
2 files changed, 14 insertions, 1 deletions
diff --git a/doc/user/project/operations/feature_flags.md b/doc/user/project/operations/feature_flags.md index 19ccde6e16a..75b0623e6b0 100644 --- a/doc/user/project/operations/feature_flags.md +++ b/doc/user/project/operations/feature_flags.md @@ -112,6 +112,19 @@ If this strategy is selected, then the Unleash client **must** be given a user i **Percent rollout (logged in users)** is implemented using the Unleash [gradualRolloutUserId](https://unleash.github.io/docs/activation_strategy#gradualrolloutuserid) activation strategy. +## Target Users + +> [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. + +![Feature flag target users](img/target_users_v12_2.png) + +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. + +**Target users** is implemented using the Unleash [userWithId](https://unleash.github.io/docs/activation_strategy#userwithid) activation strategy. + ## Integrating with your application In order to use Feature Flags, you need to first @@ -207,7 +220,7 @@ func main() { Here's an example of how to integrate the 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. +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**. ```ruby #!/usr/bin/env ruby diff --git a/doc/user/project/operations/img/target_users_v12_2.png b/doc/user/project/operations/img/target_users_v12_2.png Binary files differnew file mode 100644 index 00000000000..c88d2b7be97 --- /dev/null +++ b/doc/user/project/operations/img/target_users_v12_2.png |