You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Feature toggle documentation is now broken into 3 sections:
- Overview: Introduction, getting started, and misc (default values).
- Targeting: Targeting controls within an environment.
- Providers: List of provider libraries.
There are minimal content changes in here (other than adding a few icons and moving a few lines around where it made sense after the restructure). I'll be following this up with some other PRs to add content for all of the new features that we have added over the past few months.
description: Octopus Feature Toggles allow progressive delivery of changes and instant rollback
9
-
navOrder: 95
10
+
navOrder: 95
10
11
---
11
12
12
13
Octopus Feature Toggles support toggling features on or off in real-time, without redeploying, and progressively releasing changes to subsets of your users.
13
14
14
15
:::div{.hint}
15
-
Octopus Feature Toggles are currently in Alpha, available to a small set of customers.
16
+
Octopus Feature Toggles are currently in Alpha, available to a small set of customers.
16
17
17
18
If you are interested in this feature please register your interest on the [roadmap card](https://roadmap.octopus.com/c/121-feature-toggles) and we'll keep you updated.
18
19
:::
19
20
20
-
## Usage
21
+
## Usage
21
22
22
-
### Create a Feature Toggle
23
+
### Create a Feature Toggle
23
24
24
-
Feature Toggles are located within Octopus Projects:
25
+
Feature Toggles are located within Octopus Projects:
25
26
**Project ➜ Feature Toggles**
26
27
27
28
Create a new Toggle and give it name.
@@ -32,17 +33,17 @@ Create a new Toggle and give it name.
32
33
33
34
Octopus Feature Toggles rely on [OpenFeature](https://openfeature.dev/) as the client SDK.
34
35
35
-
Follow the [OpenFeature guide for installing the SDK for your language](https://openfeature.dev/ecosystem?instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=SDK) into your application.
36
+
Follow the [OpenFeature guide for installing the SDK for your language](https://openfeature.dev/ecosystem?instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=SDK) into your application.
36
37
37
-
Configure OpenFeature to use the [Octopus Provider](#providers).
38
+
Configure OpenFeature to use the [Octopus Provider](/docs/feature-toggles/providers).
38
39
39
40
The Octopus OpenFeature Provider requires a client identifier when instantiated. This is a [JWT](https://jwt.io/introduction) which specifies the Octopus Project, Environment, and Tenant (if applicable). This tells the Octopus Feature Toggle service which set of toggles to evaluate.
40
41
41
42
:::div{.hint}
42
-
The Octopus Feature Toggle client identifier is available via the Octopus variable `Octopus.FeatureToggles.ClientIdentifier` or via the Feature Toggle UI (see below).
43
+
The Octopus Feature Toggle client identifier is available via the Octopus variable `Octopus.FeatureToggles.ClientIdentifier` or via the Feature Toggle UI (see below).
43
44
:::
44
45
45
-
For applications deployed by Octopus, the recommended way is to have Octopus inject the client identifier as part of deployment, for example by injecting it into a configuration file or environment variable. The client identifier is made available via the Octopus variable `Octopus.FeatureToggles.ClientIdentifier`.
46
+
For applications deployed by Octopus, the recommended way is to have Octopus inject the client identifier as part of deployment, for example by injecting it into a configuration file or environment variable. The client identifier is made available via the Octopus variable `Octopus.FeatureToggles.ClientIdentifier`.
46
47
47
48
For applications not deployed by Octopus, or cannot have the client identifier supplied during deployment for any reason, the client identifier can be obtained via the portal UI, as shown below.
48
49
@@ -52,7 +53,7 @@ For applications not deployed by Octopus, or cannot have the client identifier s
52
53
53
54
The previewed client identifier may then be copied into your application configuration.
54
55
55
-
For example, an ASP.NET application could have an `appsettings.json` file which contained the following:
56
+
For example, an ASP.NET application could have an `appsettings.json` file which contained the following:
Configuring the providers is documented in the README files in the repositories.
120
-
121
-
## Segments {#segments}
122
-
123
-
Segments allow enabling a toggle for a subset of users.
124
-
125
-
Segments are key/value pairs, and are supplied by your applications via the [OpenFeature EvaluationContext](https://openfeature.dev/docs/reference/concepts/evaluation-context).
126
-
127
-
128
-
Common segment examples include:
129
-
130
-
- Specific users. e.g. `user-id/123456`
131
-
- Specific accounts. e.g. `account-id/123456`
132
-
- License types. e.g. `license-type/free`
133
-
- Geographic regions. e.g. `region/eu`
134
-
- Rollout rings. e.g. `ring/early-adopter`
135
-
136
-
The Evaluation Context can be supplied at different points in your application, for example:
137
-
138
-
- On start-up
139
-
- During each web request
140
-
- At the evaluation site
141
-
142
-
The following example shows adding a key/value to the evaluation context in C#.
143
-
144
-
```cs
145
-
// The client would be injected by IoC in many cases
146
-
varclient=OpenFeature.Api.Instance.GetClient();
147
-
// The following is hard-coded, whereas a real-world use would set this dynamically
If your Project uses [Tenants](/docs/tenants/), then Toggles may be enabled for subsets of your Tenants.
169
-
170
-
The options for configuring a Feature Toggle for Tenants are:
171
-
172
-
- All Tenants
173
-
- Specific Tenants Included
174
-
- % of Tenants
175
-
- Specific Tenants Excluded
176
-
177
-
For example, the configuration shown below will result in the Toggle evaluating as `On` for 10% of Tenants, always including `Acme` and never including `Cyberdyne Systems`.
You can additionally control rollout within an environment. See [Feature Toggle targeting](/docs/feature-toggles/targeting) for more information.
180
109
181
110
## Default Values {#default-values}
182
111
183
-
Toggle default values are configured both on the Toggle in Octopus, and at the evaluation site in your client application. It's important to understand how these interact.
112
+
Toggle default values are configured both on the Toggle in Octopus, and at the evaluation site in your client application. It's important to understand how these interact.
184
113
185
114
The default value on the Toggle in Octopus will be returned if the environment being evaluated has not been configured with an explicit value.
186
115
@@ -192,4 +121,4 @@ The default value supplied in client code (the `false` argument in the example b
description: OpenFeature providers for Octopus Feature Toggles
10
+
navOrder: 97
11
+
---
12
+
13
+
These are the available Octopus OpenFeature provider SDKs. Getting started instructions for each of these providers is documented in the README files in the repositories.
description: Targeting options for Octopus Feature Toggles
11
+
navOrder: 96
12
+
---
13
+
14
+
## Tenants {#tenants}
15
+
16
+
If your Project uses [Tenants](/docs/tenants/), then Toggles may be enabled for subsets of your Tenants.
17
+
18
+
The options for configuring a Feature Toggle for Tenants are:
19
+
20
+
- All Tenants
21
+
- Specific Tenants Included
22
+
- % of Tenants
23
+
- Specific Tenants Excluded
24
+
25
+
For example, the configuration shown below will result in the Toggle evaluating as `On` for 10% of Tenants, always including `Acme` and never including `Cyberdyne Systems`.
Segments allow enabling a toggle for a subset of users.
32
+
33
+
Segments are key/value pairs, and are supplied by your applications via the [OpenFeature EvaluationContext](https://openfeature.dev/docs/reference/concepts/evaluation-context).
34
+
35
+
Common segment examples include:
36
+
37
+
- Specific users. e.g. `user-id/123456`
38
+
- Specific accounts. e.g. `account-id/123456`
39
+
- License types. e.g. `license-type/free`
40
+
- Geographic regions. e.g. `region/eu`
41
+
- Rollout rings. e.g. `ring/early-adopter`
42
+
43
+
The Evaluation Context can be supplied at different points in your application, for example:
44
+
45
+
- On start-up
46
+
- During each web request
47
+
- At the evaluation site
48
+
49
+
The following example shows adding a key/value to the evaluation context in C#.
50
+
51
+
```cs
52
+
// The client would be injected by IoC in many cases
53
+
varclient=OpenFeature.Api.Instance.GetClient();
54
+
// The following is hard-coded, whereas a real-world use would set this dynamically
0 commit comments