Skip to content

Commit

Permalink
docs(4.3): update strategy constraints documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasheartman committed Dec 14, 2021
1 parent 23dafcb commit 915be4c
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 23 deletions.
67 changes: 44 additions & 23 deletions website/docs/advanced/strategy-constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,49 +4,70 @@ title: Strategy Constraints
---

<div class="alert alert--info" role="alert">
Strategy constraints part of Unleash Pro and Enterprise.
Strategy constraints are part of Unleash Pro and Enterprise.
</div>
<br />
<BR />

Strategy constraints allow you to set pre-conditions on activation strategies that needs to be satisfied for the activation strategies to take effect.
Strategy constraints allow you to set preconditions on activation strategies that must be satisfied for the activation strategy to take effect. For example, you might want a strategy to only trigger if a user belongs to a specific group or is in a specific country.

## Constrain on custom context fields {#constrain-on-custom-context-fields}
Constraints use fields from the [Unleash Context](../user_guide/unleash_context) to determine whether a strategy should apply or not. You can constrain on both standard context fields and on custom context fields.

It is also possible to constrain an activation strategy configuration on custom context fields. A common use case is a multi-tenant service where you want to control roll-out on a tenant identifier. This allows you to decide which customer should get access to your new feature.
To be able to constrain on a field, it must be listed under the Context Field menu. If a field isn't listed, you can add it. See [the section on defining your own custom fields](#define-your-own-custom-fields) for more info.

![Custom constraints](/img/custom-constraints.png)
## How to add strategy constraints

## Define your own custom fields {#define-your-own-custom-fields}
To add a strategy constraint, you'll need a feature toggle with a defined strategy.

Then, use the "add constraint" button in the UI, choose your context field, and the appropriate values that you wish to constrain it to.

![A feature toggle strategy view showing a button labeled with add constraints.](/img/add-constraint.png)


### Constraining on standard context fields

To constrain on a standard context field, choose the field you wish to constrain on. If the context field you want to constrain on isn't listed, you'll need to add it manually via the Context Field menu. Follow the procedure as if you were [defining custom context fields](#define-your-own-custom-fields), but give it a name that matches the desired field in the Unleash Context. Note that context fields are case-sensitive.

### Constraining on custom context fields {#constrain-on-custom-context-fields}

If you need context data that isn't available in the default Unleash Context, you can also constrain on custom context fields. A common use case is a multi-tenant service where you want to use a tenant identifier to control the feature rollout. This would allow you to decide which users should get access to your new feature based on the tenant.

![A toggle with the gradual rollout strategy. The toggle is constrained on the custom content field \"region\" and set to only activate if the region is Africa or Europe.](/img/custom-constraints.png)

#### Defining custom fields {#define-your-own-custom-fields}

> Starting with Unleash-enterprise version 3.2.28 customers can define their custom context fields via the user interface.
You can also define your own custom context fields that you can use together with strategy constraints. We have seen customers use multiple variants of custom context fields to control their feature roll-out:
You can also define custom context fields to use with strategy constraints. We have seen customers use multiple variants of custom context fields to control their feature rollout, such as:

- `region`
- `country`
- `customerType`
- `tenantId`

Combining strategy constraints with the [gradual rollout strategy](../user_guide/activation_strategy#gradual-rollout) would allow you to do a gradual rollout to a specific segment of your user base.

- region
- country
- customerType
- tenantId
##### Step 1: Navigate to “Context Fields“ {#step-1-navigate-to-context-fields}

Combining strategy constraints with the “flexibleRollout” allows you to do a gradual roll-out to a specific segment of your user base.
Locate “context fields in the menu"

### Step 1: Navigate to “Context Fields“ {#step-1-navigate-to-context-fields}
![The top Unleash navigation menu with the \"advanced\" section expanded. The dropdown shows a number of options, including one called \"context fields\", which is highlighted by an overlaid arrow.](/img/context-fields.png)

Locate “context fields in the menu
##### Step 2: Define new context field {#step-2-define-new-context-field}

![Context fields](/img/context-fields.png)
Next you can define your new context field. The minimum requirement is to give it a unique _name_. In addition, you can give it a description and define [_legal values_](#what-is-legal-values).

### Step 2: Define new context field {#step-2-define-new-context-field}
![A form to define new context fields. It has fields labeled \"name\", \"description\", and \"legal values\".](/img/new_context_field.png)

Next you can define your new context field. The minimum requirement is to give it a unique _name_. In addition, you can give it a description and define the legal values.
###### What are “legal values”? {#what-is-legal-values}

![New context fields](/img/new_context_field.png)
To constrain what values a user can enter for a context field in the Unleash Admin UI, you can use _legal values_. This is a set of predefined values that show up as a dropdown

#### What is “legal values”? {#what-is-legal-values}
A context field's _legal values_ are a set of predefined values that you can

Legal values defines all possible values for the context field. this will be used in Unleash Admin UI to guide users when working with context fields to make sure they only use legal values.
define all possible values for that context field. These values appear in the Unleash Admin UI to guide users when working with context fields to make sure they only use legal values.

![New context fields](/img/constraints_legal_values.png)
![A modal to define constraints. The \"region\" context field is selected and a dropdown is showing the legal values defined for that field: Africa, Asia, Europe, North-America.](/img/constraints_legal_values.png)

## [Deprecated]: Constrain on a specific environment {#constrain-on-a-specific-environment}
### [Deprecated]: Constrain on a specific environment {#constrain-on-a-specific-environment}

Before Unleash 4.3, using strategy constraints was the recommended way to have different toggle configurations per environment. Now that Unleash has environment support built in, we no longer recommend you use strategy constraints for this. Instead, see the [environments documentation](../user_guide/environments).
Binary file added website/static/img/add-constraint.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/img/constraints_legal_values.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/img/custom-constraints.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 915be4c

Please sign in to comment.