1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
unleash.unleash/docs/activation-strategies.md

61 lines
3.5 KiB
Markdown
Raw Normal View History

2016-12-02 17:58:27 +01:00
# Activation Strategies
It is powerful to be able to turn a feature on and off instantaneously, without redeploying the application. The next level of control comes when you are able to enable a feature for specific users or enable it for a small subset of the users. We achieve this level of control with the help of activation strategies. The simplest strategy is the “default” strategy, which basically means that the feature should be enabled to everyone.
The definition of an activation strategy lives in the Unleash API and can be created via the Unleash UI. The implementation of activation strategies lives in the various client implementations.
Unleash comes with a few common activation strategies. Some of them requires the client to provide the [unleash-context](./unleash-context.md), which gives necessary context for unleash.
## default
Is the simples activation strategies and basically means "active for everyone".
## userWithId
Active for users with a userId defined in the userIds-list. Typically I want to enable a new feature only for myself in production, before I enable it of everyone else. To achieve this we can use the “UserWithIdStrategy”. This strategy allows you to specify a list of specific user ids that you want to expose the new feature for. (A user id may of course be an email if that is more appropriate in your system.)
**Parameters**
- userIds - *List of user ids you want the feature toggle should be enabled for*
## gradualRolloutUserId
2017-02-11 14:35:03 +01:00
Gradually activate feature toggle for logged in users. Stickiness based on user id.
This strategy guarantees that the same user gets the same experience every time,
across devices. It also guarantees that a user which is among the first 10% will also
be among 20% roll-out degree. Thus we ensure that users gets the same experience,
even if we gradually increase the number of users we expose the feature to. To
achieve this we use a hash-algorithm where we normalize the user-id to a number
between 1 and 100.
**Parameters**
- percentage - *The percentage (0-100) you want to enable to feature toggle for.*
- groupId - *Used to define a activation groups, which allows you to correlate across feature toggles.*
## gradualRolloutSessionId
2017-02-11 14:35:03 +01:00
Gradually activate feature toggle. Stickiness based on session id. It is almost
identical to the `gradualRolloutUserId` strategy, with the exception that it works
on session ids. This makes it possible to target all users (not just logged in
users), guaranteeing that a user will get the same experience within a session.
**Parameters**
- percentage - *The percentage (0-100) you want to enable to feature toggle for.*
- groupId - *Used to define a activation groups, which allows you to correlate across feature toggles.*
## gradualRolloutRandom
2017-02-11 14:35:03 +01:00
Randomly activate the feature toggle. No stickiness. We have found this rollout strategy
very useful in some scenarios, especially when we are enabling a feature which is not
visible to the user. It is also the strategy we use to sample metrics and error reports.
**Parameters**
- percentage - *The percentage (0-100) you want to enable to feature toggle for.*
## remoteAddress
2017-02-11 14:35:03 +01:00
Active for remote addresses defined in the IPs list. We sometimes use this strategy to
enable a feature only for IP's in our office network.
**Parameters**
- IPS - *List of IPs to enable the feature for.*
## applicationHostname
Active for client instances with a hostName in the hostNames-list.
**Parameters**
- hostNames - *List of hostnames to enable the feature toggle for.*