Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-05-26 01:17:00 +02:00
Code Issues Projects Releases Wiki Activity

Align availability information in the docs (#8177)

Browse Source
This commit is contained in:
Melinda Fekete 2024-10-03 10:33:22 +02:00 committed by GitHub
parent 10dffcd232
commit 415e3489d4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
68 changed files with 256 additions and 253 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/docs/how-to/how-to-add-feature-flag-naming-patterns.mdx
View File

@ -2,9 +2,9 @@
title: How to add feature flag naming patterns
---
:::info Availability
:::note Availability
Feature flag naming patterns is an in-development, **enterprise-only** feature.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7`+
:::

4
website/docs/how-to/how-to-add-strategy-constraints.md
View File

@ -2,9 +2,9 @@
title: How to add strategy constraints
---
:::info Availability
:::note Availability
Before Unleash 4.16, strategy constraints were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**.
**Version**: `4.16+`
:::

7
website/docs/how-to/how-to-add-users-to-unleash.md
View File

@ -2,7 +2,12 @@
title: How to add new users to your Unleash instance
---
> This feature was introduced in Unleash v4 for Unleash Open-Source.
:::note Availability
**Version**: `4.0+`
:::
You can add new users to Unleash in `Admin > Users`.

4
website/docs/how-to/how-to-clone-environments.mdx
View File

@ -2,9 +2,9 @@
title: How to clone environments
---
:::info availability
:::note Availability
Environment cloning was made available in Unleash 4.19.
**Plan**: [Enterprise](https://www.getunleash.io/plans/enterprise) | **Version**: `4.19+`
:::

8
website/docs/how-to/how-to-create-and-assign-custom-project-roles.md
View File

@ -4,9 +4,9 @@ title: How to create and assign custom project roles
import VideoContent from '@site/src/components/VideoContent.jsx'
:::info availability
:::note Availability
Custom project roles were introduced in **Unleash 4.6** and are only available in Unleash Enterprise.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.6+`
:::
@ -32,9 +32,9 @@ It takes about three steps to create custom project roles:
## Assigning custom project roles
:::info Multiple project roles
:::note Availability
Multiple project roles is an enterprise feature available from **Unleash 5.6** onwards. See [multiple project roles](../reference/rbac.md#multiple-project-roles) for more info.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.6+`.
:::

4
website/docs/how-to/how-to-create-and-assign-custom-root-roles.md
View File

@ -2,9 +2,9 @@
title: How to create and assign custom root roles
---
:::info availability
:::note Availability
Custom root roles were introduced in **Unleash 5.4** and are only available in Unleash Enterprise.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.4+`
:::

4
website/docs/how-to/how-to-create-and-display-banners.md
View File

@ -2,9 +2,9 @@
title: How to create and display banners
---
:::info Availability
:::note Availability
Banners were introduced in **Unleash 5.7** and are only available in Unleash Enterprise.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7+`
:::

4
website/docs/how-to/how-to-create-and-manage-user-groups.md
View File

@ -2,9 +2,9 @@
title: How to create and manage user groups
---
:::info availability
:::note Availability
User groups are available to Unleash Enterprise users since **Unleash 4.14**.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.14+`
:::

4
website/docs/how-to/how-to-create-personal-access-tokens.mdx
View File

@ -2,9 +2,9 @@
title: How to create Personal Access Tokens
---
:::info availability
:::note Availability
Personal access tokens are planned to be released in **Unleash 4.17**.
**Version**: `4.17+`
:::

4
website/docs/how-to/how-to-create-service-accounts.mdx
View File

@ -2,9 +2,9 @@
title: How to create service accounts
---
:::info availability
:::note Availability
Service accounts is an enterprise feature available from Unleash 4.21 onwards.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
:::

5
website/docs/how-to/how-to-define-custom-context-fields.md
View File

@ -2,10 +2,9 @@
title: How to define custom context fields
---
:::info Availability
:::note Availability
Before Unleash 4.16, custom context fields were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**. They were introduced in Unleash 3.2.28.
**Version**: `4.16+`
:::

4
website/docs/how-to/how-to-download-login-history.mdx
View File

@ -2,9 +2,9 @@
title: How to download your login history
---
:::info availability
:::note Availability
Login history is an enterprise feature available from Unleash 4.22 onwards.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
:::

5
website/docs/how-to/how-to-enable-openapi.mdx
View File

@ -6,10 +6,9 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::info Availability
:::note Availability
OpenAPI schemas were introduced in v4.13.0 of Unleash and v0.10.0 of the Unleash proxy.
Since v5.2.0 Unleash has OpenAPI enabled by default.
**Unleash version**: `4.13+` | **Unleash Proxy version**: `0.10+`
:::

4
website/docs/how-to/how-to-environment-import-export.mdx
View File

@ -3,9 +3,9 @@ title: Environment Import & Export
---
import VideoContent from '@site/src/components/VideoContent.jsx'
:::info Availability
:::note Availability
The environment import and export first appeared in Unleash 4.22.0.
**Version**: `4.22+`
:::

4
website/docs/how-to/how-to-import-export.md
View File

@ -3,9 +3,9 @@ title: '[Deprecated] Import & Export'
---
import ApiRequest from '@site/src/components/ApiRequest'
:::info Availability
:::note Availability
The import and export API first appeared in Unleash 3.3.0.
**Version**: `3.3+`
:::

2
website/docs/how-to/how-to-set-up-group-sso-sync.md
View File

@ -4,7 +4,7 @@ title: How to Set Up User Group SSO Syncing
:::note Availability
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: 4.18+
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.18+`
:::

4
website/docs/how-to/how-to-setup-provisioning-with-entra.md
View File

@ -2,9 +2,9 @@
title: How to Setup Entra Provisioning
---
:::info availability
:::note Availability
The **Provisioning capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.1+`
:::

4
website/docs/how-to/how-to-setup-provisioning-with-okta.md
View File

@ -2,9 +2,9 @@
title: How to Setup Okta Provisioning
---
:::info availability
:::note Availability
The **Provisioning capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.1+`
:::

3
website/docs/how-to/how-to-setup-sso-keycloak-group-sync.md
View File

@ -2,10 +2,9 @@
title: 'How to set up Keycloak and Unleash to sync user groups'
---
:::note Availability
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: 4.18+
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.18+`
:::

6
website/docs/reference/actions.md
View File

@ -2,11 +2,13 @@
title: Actions
---
:::info Availability
:::note Availability
Actions were introduced as a beta feature in **Unleash 5.11** and are only available in Unleash Enterprise.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.11+` in BETA
:::
## Overview
Actions allow you to configure automated actions to be executed based on signals received from an external system.

5
website/docs/reference/api-tokens-and-client-keys.mdx
View File

@ -43,12 +43,13 @@ Personal access tokens follow their own special format, and only contain an opti
### API token visibility
:::info project-level visibility
:::note Availability
Project-level visibility and access to API tokens was introduced in Unleash 4.22.
**Version**: `4.22+`
:::
By default, only admin users can create API tokens, and only admins can see their values.
However, any [client](#client-tokens client tokens) and [front-end tokens](#front-end-tokens) that are applicable to a project, will also be visible to any members of that project that have the `READ_PROJECT_API_TOKEN` permission (all project members by default).

4
website/docs/reference/api/legacy/unleash/admin/segments.mdx
View File

@ -4,9 +4,9 @@ title: /api/admin/segments
import ApiRequest from '@site/src/components/ApiRequest'; export const basePath = "api/admin/segments"; export const path = (p) => `${basePath}/${p}`;
:::info Availability
:::note Availability
Segments are available to Unleash Pro and Unleash Enterprise users since **Unleash 4.13**.
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.13+`
:::

4
website/docs/reference/api/legacy/unleash/client/features.md
View File

@ -114,9 +114,9 @@ Used to fetch details about a specific feature flag. This is mainly provided to
### Strategy Constraints {#strategy-constraints}
:::info Availability
:::note Availability
Before Unleash 4.16, strategy constraints were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**.
**Version**: `4.16+`
:::

16
website/docs/reference/applications.mdx
View File

@ -4,23 +4,15 @@ title: Applications
import Figure from '@site/src/components/Figure/Figure.tsx'
An **application** is defined as anything that sends requests to the [Unleash client API](/reference/api/unleash/client), the [Unleash front-end API](front-end-api.md), the Unleash admin API, or any other API that Unleash exposes. This includes [Unleash SDKs](./sdks/index.md), [Unleash Edge](/docs/generated/unleash-edge.md), the [Unleash proxy](/docs/generated/unleash-proxy.md), and even the admin UI.
:::note Availability
Applications can be accessed in the UI by going to the /applications page or manually by clicking Configure -> Applications. After clicking on your application, you will see an application overview.
:::info Availability
The following three sections: "Application Overview," "Connected Instances," and "Project Applications" were released in Unleash 5.11.
**Version**: `5.11+`
:::
An **application** is any service that sends requests to the [Unleash Client API](/reference/api/unleash/client), the [Unleash Frontend API](front-end-api.md), the Unleash Admin API, or any other API that Unleash exposes. This includes [Unleash SDKs](./sdks/index.md), [Unleash Edge](/docs/generated/unleash-edge.md), the [Unleash proxy](/docs/generated/unleash-proxy.md), and even the Admin UI.
Under the application, you have two tabs:
- [Overview](#application-overview)
- [Connected Instances](#connected-instances)
In the Admin UI, you can access Applications in **Configure > Applications**.
## Application overview

4
website/docs/reference/banners.md
View File

@ -2,9 +2,9 @@
title: Banners
---
:::info Availability
:::note Availability
Banners were introduced in **Unleash 5.7** and are only available in Unleash Enterprise.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7+`
:::

15
website/docs/reference/change-requests.md
View File

@ -4,10 +4,9 @@ title: Change Requests
import VideoContent from '@site/src/components/VideoContent.jsx';
:::info Availability
:::note Availability
The change requests feature is an enterprise-only feature that was introduced in **Unleash 4.19.0**.
The change requests for segments was introduced in **Unleash 5.4.0**.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.19+`
:::
@ -67,9 +66,9 @@ From here, if you have the correct permissions, you can approve and schedule or
### Scheduled changes
:::info Availability
:::note Availability
Change request scheduling was released in Unleash 5.10.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.10+`
:::
@ -144,6 +143,12 @@ Admin users will always see the change request UI so that they can test the chan
## Change Request for segments
:::note Availability
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.4+`
:::
Changes to project [segments](segments.mdx) (as opposed to global segments) also go through the change request process. This is to prevent a backdoor in the change request process.
Since projects segments are not environment specific and change requests are always environment specific we allow to attach segment change to any environment with change requests enabled.

2
website/docs/reference/command-menu.md
View File

@ -4,7 +4,7 @@ title: Command Menu
:::note Availability
**Version**: 6.2+.
**Version**: `6.2+`
:::

24
website/docs/reference/dependent-features.md
View File

@ -2,11 +2,10 @@
title: Dependent Features
---
:::info Availability
:::note Availability
**Dependent features** were first introduced in Unleash 5.7 for Pro and Enterprise users.
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7+`
**Variant dependencies** were first introduced in Unleash 5.12 for Pro and Enterprise users.
:::
## Overview
@ -25,13 +24,20 @@ A feature flag can have only one parent dependency but multiple child flags can
In order for the child feature to be evaluated, the corresponding parent value criteria must be satisfied.
Parent value criteria can be set to one of the 3 options:
* parent feature must be **enabled**.
* parent feature must be **disabled**. This is useful when your parent is a [kill-switch](./feature-toggle-types.md#feature-toggle-types) with the inverted enabled/disabled logic.
* parent feature must be **enabled with variants**. This is useful when your parent is part of A/B testing, and you need **variant dependencies**.
- Parent feature must be **enabled**.
- Parent feature must be **disabled**. This is useful when your parent is a [kill-switch](./feature-toggle-types.md#feature-toggle-types) with the inverted enabled/disabled logic.
- Parent feature must be **enabled with variants**. This is useful when your parent is part of A/B testing, and you need [variant dependencies](#variant-dependencies).
#### Variant dependencies
:::note Availability
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.12+`
:::
For the variant dependencies, if the parent feature variant is evaluated to the expected value, the dependency is satisfied. You can specify variant values from all [strategy variants](./strategy-variants.md) and all [feature environment variants](./feature-toggle-variants.md). The parent dependency variant is compared to the actual value that the parent dependency is evaluated to in a given environment.
For the **variant dependencies**, if the parent feature variant is evaluated to the expected value, the dependency is satisfied.
You can specify variant values from all [strategy variants](./strategy-variants.md) and all [feature environment variants](./feature-toggle-variants.md). The parent dependency variant
is compared to the actual value that the parent dependency is evaluated to in a given environment.
Consult [strategy variants order](./strategy-variants.md#strategy-variants-and-strategies-order) and [variants comparison](./strategy-variants#strategy-variants-vs-feature-flag-variants) sections for more details on the variant evaluation order.
## Managing dependencies

49
website/docs/reference/environments.md
View File

@ -3,9 +3,9 @@ id: environments
title: Environments
---
:::info Availability
:::note Availability
Environments were released in Unleash v4.3.0.
**Version**: `4.3+`
:::
@ -13,15 +13,9 @@ Environments were released in Unleash v4.3.0.
<iframe src="https://www.loom.com/embed/95239e875bbc4e09a5c5833e1942e4b0" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style={{position: 'absolute', top: '0', left: '0', width: '100%', height: '100%'}}></iframe>
</div>
Environments is a new way to organize activation strategy configurations for feature flags into separate environments. In Unleash, a feature lives across all your environments — after all, the goal is to get the new feature released as soon as possible — but it makes sense to configure the activation differently per environment. You might want the feature enabled for everyone in development, but only for yourself in production, for instance.
Environments are a way to organize activation strategy configurations for feature flags. A feature exists in all environments, as the goal is to release it as soon as possible, but it makes sense to configure activation differently depending on the environment. [Open Source](https://www.getunleash.io/pricing) and [Pro](https://www.getunleash.io/pricing) customers have two preconfigured environments, **development** and **production**. [Enterprise](https://www.getunleash.io/pricing) customers can have unlimited environments.
Previously, Unleash Enterprise could use [strategy constraints](../reference/strategy-constraints.md) to control the rollout across environments. With the new environments feature, this is no longer necessary. Now all activation strategies belong to an explicit environment instead.
Further, connected applications will use environment-scoped API keys to make sure they only download feature flag configurations for the environment they are running in.
Finally, metrics have also been upgraded to record the environment. This, in turn, means that Unleash can display usage metrics per environment.
Despite this being a shift in how Unleash works, everything will continue to work exactly how it did for existing users. For backwards compatibility, we have created an environment named "default" that will contain all of the existing flags and API keys. Read more about that in [the migration section](#migration).
Connected applications use environment-scoped API keys to ensure they download only the relevant feature flag configurations for the environment they are running in. Unleash tracks usage metrics per environment.
![A graph showing how environments work. Each project can have multiple features, and each feature can have different activation strategies in each of its environments.](/img/environments_overview.svg 'A feature flag exists across all environments, but take different activation strategies per environment.')
@ -45,13 +39,7 @@ Environments exist on a global level, so they are available to all projects with
## How to start using environments
In order to start using environments you need to be on Unleash v4.2 or higher.
If you are on v4.2, you also need to have the environment feature enabled (if you are using Unleash Hosted, please reach out on [contact@getunleash.io](mailto:contact@getunleash.io) if you want to start using environments.
If you are on v4.3 or later, environments are already enabled for you.
Note that in order to enable an environment for a feature flag, you must first add activation strategies for that environment. You cannot enable an environment without activation strategies.
To enable an environment for a feature flag, you must first add activation strategies for that environment. You cannot enable an environment without activation strategies.
### Step 1: Enable new environments for your Project
@ -75,7 +63,7 @@ In order for the SDK to download the feature flag configuration for the correct
:::note Availability
Environment cloning was made available in Unleash 4.19.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.19+`
:::
@ -94,7 +82,7 @@ Once created, the new environment works just as any other environment.
## Migration
To ease migration we have created a special environment called “default”. All existing activation strategies have been added to this environment. All existing Client API keys have also been scoped to work against the default environment to ensure zero disruption as part of the upgrade.
To ease migration we have created a special environment called **default**. All existing activation strategies have been added to this environment. All existing Client API keys have also been scoped to work against the default environment to ensure zero disruption as part of the upgrade.
If you're currently using strategy constraints together with the “environment” field on the Unleash Context, you should be aware that the new environment support works slightly differently. With environments, the SDK API will use the client's API key to determine which environment the client is configured for. The API then sends _only_ strategies belonging to the client's environment. This means that you might not need the "environment" property of the Unleash Context anymore.
@ -129,26 +117,3 @@ In order to support configuration per environment we had to rebuild our feature
- **/api/admin/features** - _deprecated (scheduled for removal in Unleash v5.0). The [old feature flags admin API](/reference/api/legacy/unleash/admin/features.md) still works, but strategy configuration will be assumed to target the “default” environment._
- **/api/admin/projects/:projectId/features** - New feature API to be used for feature flags which also adds support for environments. See [the documentation](/reference/api/legacy/unleash/admin/features.md) to learn more.
## Plan Differences
### Open-Source (free)
- Will get access to two preconfigured environments: “development” and “production”. Existing users of Unleash will also get an additional “default” environment to simplify the adoption of environments.
- Will be possible to turn environments on/off for all projects.
### Pro (commercial)
- Will get access to two preconfigured environments: “development” and “production”. Existing users of Unleash will also get an additional “default” environment to simplify the adoption of environments.
- Will be possible to turn environments on/off for the default project.
### Enterprise (commercial)
- Will get access to two preconfigured environments: “development” and “production”. Existing users of Unleash will also get an additional “default” environment to simplify the adoption of environments.
- Will be possible to turn environments on/off for all projects
- Will be allowed to update and remove environments.
- Will be allowed to create new environments and clone existing environments.
## Rollout Plan
- **Unleash v4.2** will provide _early access_ to environment support. This means that it can be enabled per customer via a feature flag.
- **Unleash v4.3** plans to provide general access to the environment support for all users of Unleash (Open-Source, Pro, Enterprise).

6
website/docs/reference/event-types.mdx
View File

@ -574,12 +574,6 @@ This event fires when you drop all existing tags as part of a configuration impo
### `feature-potentially-stale-on`
:::info Availability
`feature-potentially-stale-on` events are currently in development and expected to be stabilized in one of the upcoming releases.
:::
This event fires when Unleash marks a feature flag as potentially stale. Feature flags are marked as potentially stale when they exceed the expected lifetime of their [feature flag type](/reference/feature-toggle-types.md).
``` json title="Example event when my-feature is marked as potentially stale"

4
website/docs/reference/feature-flag-naming-patterns.mdx
View File

@ -2,9 +2,9 @@
title: Feature Flag Naming Patterns
---
:::info Availability
:::note Availability
Feature flag naming patterns is an **enterprise-only** feature released in Unleash v5.7.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7+`
:::

4
website/docs/reference/feature-lifecycle.md
View File

@ -2,9 +2,9 @@
title: Feature Lifecycle
---
:::info Availability
:::note Availability
Feature lifecycle was introduced in **Unleash 6.2**
**Version**: `6.2+`
:::

7
website/docs/reference/feature-toggle-types.md
View File

@ -2,7 +2,12 @@
title: Feature Flag Types
---
> This feature was introduced in _Unleash v3.5.0_.
:::note Availability
**Version**: `3.5+`
:::
You can use feature flags to support different use cases, each with their own specific needs. Heavily inspired by [Pete Hodgson's article on feature flags](https://martinfowler.com/articles/feature-toggles.html), Unleash introduced the concept of feature flag types in version `3.5.0`.

7
website/docs/reference/feature-toggle-variants.md
View File

@ -9,10 +9,9 @@ If you'd like to keep the old variants in your hosted instance [contact us](http
:::
:::info Availability
:::note Availability
**Feature flag variants** were first introduced in Unleash 3.2.
In Unleash 4.21, variants were updated to be **environment-dependent**, meaning the same feature could have different variant configurations in different environments.
**Version**: `3.2+`
:::
@ -22,7 +21,7 @@ Variants facilitate A/B testing and experimentation by letting you create contro
## What are variants?
Whenever you create a feature flag, you can assign it any number of _variants_. This is commonly done in cases where you want to serve your users different versions of a feature to see which performs better. A feature can have different variants in each of its environments.
Whenever you create a feature flag, you can assign it any number of _variants_. This is commonly done in cases where you want to serve your users different versions of a feature to see which performs better. A feature can have different variants in each of its environments as of version 4.21.
A variant has four components that define it:
- a **name**:

4
website/docs/reference/front-end-api.md
View File

@ -2,9 +2,9 @@
title: Front-end API access
---
:::info Availability
:::note Availability
The Unleash front-end API was released in Unleash 4.18. You can read more in the [Unleash 4.18 release blog post](https://www.getunleash.io/blog/new-features-direct-client-side-front-end-api-access-sync-user-groups-and-clone-environments).
**Version**: `4.18+`
:::

4
website/docs/reference/impression-data.md
View File

@ -2,9 +2,9 @@
title: Impression Data
---
:::info Availability
:::note Availability
The impression data feature was introduced in **Unleash 4.7**. It is available in the JavaScript-based proxy clients and in some server-side SDKs. Please refer to the [SDK compatibility table](../reference/sdks/index.md#server-side-sdk-compatibility-table) for an overview of server-side SDKs that support it.
**Version**: `4.7+`. Requires [SDK compatibility](../reference/sdks/index.md#server-side-sdk-compatibility-table).
:::

6
website/docs/reference/insights.mdx
View File

@ -4,12 +4,13 @@ title: Insights
import Figure from '@site/src/components/Figure/Figure.tsx'
:::info Availability
:::note Availability
Insights is released in Unleash 6.0 and is available for Enterprise and Pro customers. For Pro customers only the Total users and Total flags charts are available.
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.0+`
:::
Insights is a feature designed to help you better understand and gain insights into what is happening in your Unleash instance. You can view insights across all projects or by selecting single or multiple projects using the filter.
In total, there are 6 different charts available that show information over time:
@ -22,7 +23,6 @@ In total, there are 6 different charts available that show information over time
- Updates per environment type (Enterprise)
### Total users
The Total users chart provides information about the total number of current users in your Unleash instance. This chart helps you understand how the user base is growing or changing over time. Additionally, it shows the number of users in selected projects and how the user distribution varies among them.

10
website/docs/reference/integrations/datadog.md
View File

@ -3,7 +3,11 @@ id: datadog
title: Datadog
---
> This feature was introduced in _Unleash v4.0.0_.
:::note Availability
**Version**: `4.0+`
:::
The Datadog integration allows Unleash to post Updates to Datadog when a feature flag is updated. To set up this integration, you need to set up a webhook connector for your channel. You can follow [Submitting events to Datadog](https://docs.datadoghq.com/api/latest/events/#post-an-event) on how to do that.
@ -16,7 +20,6 @@ The Datadog integration will perform a single retry if the HTTP POST against the
You can choose to trigger updates for the following events:
- feature-created
- feature-updated (*)
- feature-metadata-updated
- feature-project-change
- feature-archived
@ -30,8 +33,7 @@ You can choose to trigger updates for the following events:
- feature-environment-disabled
- feature-environment-variants-updated
- feature-potentially-stale-on
> *) Deprecated, and will not be used after transition to environments in Unleash v4.3
- feature-updated (deprecated in v4.3)
#### Parameters {#parameters}

12
website/docs/reference/integrations/integrations.md
View File

@ -4,15 +4,13 @@ title: Integrations
---
import DocCardList from '@theme/DocCardList';
:::info Availability
:::note Availability
Unleash integrations were introduced in _Unleash v3.11.0_.
Integrations were previously known as _addons_.
**Version**: `3.11+`
:::
Unleash integrations allows you to extend Unleash with new functionality and to connect to external applications.
Unleash integrations (previously known as addons) allows you to extend Unleash with new functionality and to connect to external applications.
Unleash has two types of integrations: Integrations that allow you to listen to changes in Unleash and trigger updates in other systems (for instance via webhooks or direct integrations) and integrations that communicate with Unleash (such as the Jira integrations).
@ -49,9 +47,9 @@ Our wonderful community has also created the following integrations:
## Integration events
:::info Availability
:::note Availability
Integration events were introduced as a beta feature in **Unleash 6.1**.
**Version**: `6.1+`
:::

9
website/docs/reference/integrations/jira-cloud-plugin-installation.md
View File

@ -3,6 +3,12 @@ title: Jira Cloud Integration - Installation
---
import Figure from '@site/src/components/Figure/Figure.tsx'
:::note Availability
**Version**: `4.0+`
:::
## Prerequisites
### Jira Cloud
@ -11,9 +17,6 @@ import Figure from '@site/src/components/Figure/Figure.tsx'
For Jira Data Center, check out the [Jira Server plugin](jira-server-plugin-installation.md)
### Unleash
- Unleash v4 or higher
## Required access levels

10
website/docs/reference/integrations/jira-server-plugin-installation.md
View File

@ -8,6 +8,12 @@ The Jira Server plugin is **deprecated**, please use the [Unleash Jira Cloud plu
:::
:::note Availability
**Version**: `4.0+`
:::
With the Unleash Jira server plugin you can create new feature flags in Unleash from a Jira issue as well as link
existing flags to Jira issues.
@ -21,10 +27,6 @@ The plugin also shows you current status of connected flags.
For Jira Cloud, refer to the [Jira Cloud plugin](jira-cloud-plugin-installation)
### Unleash
- Unleash v4 or higher
## Required access levels
### Unleash

4
website/docs/reference/integrations/slack-app.md
View File

@ -4,9 +4,9 @@ title: Slack App
import Figure from '@site/src/components/Figure/Figure.tsx'
:::info Availability
:::note Availability
The Slack App integration was introduced in **Unleash 5.5**.
**Version**: `5.5+`
:::

11
website/docs/reference/integrations/slack.md
View File

@ -9,7 +9,12 @@ This Slack integration is deprecated and will be removed in a future release. We
:::
> This feature was introduced in _Unleash v3.11.0_.
:::note Availability
**Version**: `3.11+`
:::
The Slack integration allows Unleash to post Updates when a feature flag is updated. To set up Slack, you need to configure an incoming Slack webhook URL. You can follow [Sending messages using Incoming Webhooks](https://api.slack.com/incoming-webhooks) on how to do that. You can also choose to [create a slack app for Unleash](https://api.slack.com/apps), which will provide you with additional functionality to control how Unleash communicates messages on your Slack workspace.
@ -22,7 +27,6 @@ The Slack integration will perform a single retry if the HTTP POST against the S
You can choose to trigger updates for the following events:
- feature-created
- feature-updated (*)
- feature-metadata-updated
- feature-project-change
- feature-archived
@ -34,8 +38,7 @@ You can choose to trigger updates for the following events:
- feature-stale-off
- feature-environment-enabled
- feature-environment-disabled
> *) Deprecated, and will not be used after transition to environments in Unleash v4.3
- feature-updated (deprecated in v4.3)
#### Parameters {#parameters}

11
website/docs/reference/integrations/teams.md
View File

@ -3,7 +3,12 @@ id: teams
title: Microsoft Teams
---
> This feature was introduced in _Unleash v4.0.0_.
:::note Availability
**Version**: `4.0+`
:::
The MicrosoftTeams integration allows Unleash to post Updates when a feature flag is updated. To set up this integration, you need to set up a webhook connector for your channel. You can follow [Creating an Incoming Webhook for a channel](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) on how to do that.
@ -16,7 +21,6 @@ The Microsoft Teams integration will perform a single retry if the HTTP POST aga
You can choose to trigger updates for the following events:
- feature-created
- feature-updated (*)
- feature-metadata-updated
- feature-project-change
- feature-archived
@ -28,8 +32,7 @@ You can choose to trigger updates for the following events:
- feature-stale-off
- feature-environment-enabled
- feature-environment-disabled
> *) Deprecated, and will not be used after transition to environments in Unleash v4.3
- feature-updated (deprecated in v4.3)
#### Parameters {#parameters}

11
website/docs/reference/integrations/webhook.md
View File

@ -3,7 +3,12 @@ id: webhook
title: Webhook
---
> This feature was introduced in _Unleash v3.11.0_.
:::note Availability
**Version**: `3.11+`
:::
The Webhook Integration introduces a generic way to post messages from Unleash to third party services. Unleash allows you to define a webhook which listens for changes in Unleash and posts them to third party services.
@ -16,7 +21,6 @@ The webhook will perform a single retry if the HTTP POST call fails (either a 50
You can choose to trigger updates for the following events (we might add more event types in the future):
- feature-created
- feature-updated (*)
- feature-metadata-updated
- feature-project-change
- feature-archived
@ -46,8 +50,7 @@ You can choose to trigger updates for the following events (we might add more ev
- change-request-scheduled-application-failure
- change-request-schedule-suspended
- feature-potentially-stale-on
> *) Deprecated, and will not be used after transition to environments in Unleash v4.3
- feature-updated (deprecated in v4.3)
#### Parameters {#parameters}

4
website/docs/reference/login-history.md
View File

@ -2,9 +2,9 @@
title: Login History
---
:::info Availability
:::note Availability
Login history is an enterprise feature available from Unleash 4.22 onwards.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
:::

4
website/docs/reference/maintenance-mode.mdx
View File

@ -2,9 +2,9 @@
title: Maintenance Mode
---
:::info Availability
:::note Availability
Maintenance mode was introduced in Unleash 4.22.0.
**Version**: `4.22+`
:::

6
website/docs/reference/network-view.mdx
View File

@ -4,11 +4,9 @@ title: Network View
import Figure from '@site/src/components/Figure/Figure.tsx'
:::info Availability
:::note Availability
The network view was released in Unleash 4.21. It is available to Pro and Enterprise users.
You must configure the [data source](#data-source) to activate the feature.
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
:::

4
website/docs/reference/notifications.md
View File

@ -2,9 +2,9 @@
title: Notifications
---
:::info Availability
:::note Availability
Notifications were introduced in Unleash 4.22.0 for pro and enteprise customers.
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
:::

12
website/docs/reference/playground.mdx
View File

@ -4,9 +4,9 @@ title: Playground
import Figure from '@site/src/components/Figure/Figure.tsx'
import VideoContent from '@site/src/components/VideoContent.jsx'
:::info Availability
:::note Availability
The Unleash playground is available in all Unleash versions from Unleash 4.14 onwards. Unleash 5.3 introduced a more advanced playground that allows you to query multiple environments and multiple values for a single context value at the same time.
**Version**: `4.14+`
:::
@ -41,9 +41,9 @@ The [Unleash context](../reference/unleash-context.md) represents a client SDK's
#### Multiple values for a single context field
:::info Availability
:::note Availability
The ability to specifiy multiple values for a single context field was introduced in Unleash 5.3.
**Version**: `5.3+`
:::
@ -83,9 +83,9 @@ You can compare how a feature evaluates in different environments. If you select
### Detailed evaluation results
:::info Availability
:::note Availability
Detailed evaluation results were added to the playground in Unleash 4.15.
**Version**: `4.15+`
:::

4
website/docs/reference/projects.md
View File

@ -45,7 +45,7 @@ The available project settings depend on a user's [root and project roles](rbac.
:::note Availability
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing). | **Version**: 6.2 in BETA.
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing). | **Version**: `6.3+`
:::
@ -96,7 +96,7 @@ import Figure from '@site/src/components/Figure/Figure.tsx'
:::note Availability
**Version**: 5.2.0+.
**Version**: `5.2+`.
:::

33
website/docs/reference/rbac.md
View File

@ -3,9 +3,11 @@ id: rbac
title: Role-based Access control
---
This document forms the specifications
for [Role-Based Access Control](https://en.wikipedia.org/wiki/Role-based_access_control) (RBAC) which was introduced as part of
the **Unleash v4 release**.
:::note Availability
**Version**: `4.0+`
:::
## Core principles {#core-principles}
@ -24,8 +26,6 @@ Unleash has two levels in its hierarchy of resources:
![RBAC overview](/img/rbac.png)
Unleash v4 allows you control access to both root resources and individual project resources.
## Predefined roles
Unleash comes with a set of built-in predefined roles that you can use. The _root roles_ are available to all Unleash
@ -45,9 +45,9 @@ When you add a new user, you can assign them one of the root roles listed below.
## Custom Root Roles
:::info availability
:::note Availability
Custom root roles were introduced in **Unleash 5.4** and are only available in Unleash Enterprise.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.4+`
:::
@ -138,9 +138,9 @@ You can assign the following root permissions:
## Custom Project Roles
:::info availability
:::note Availability
Custom project roles were introduced in **Unleash 4.6** and are only available in Unleash Enterprise.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.6+`
:::
@ -196,9 +196,9 @@ You can assign the following permissions on a per-environment level within the p
## Multiple Project Roles
:::info availability
:::note Availability
Multiple project roles is an enterprise feature available from **Unleash 5.6** onwards.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.6+`
:::
@ -214,10 +214,9 @@ role that encapsulates the needed permissions.
## User Groups
:::info availability
:::note Availability
User groups are available to Unleash Enterprise users since **Unleash 4.14**. Root role groups are planned to be
released in **Unleash 5.1**.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.14+`
:::
@ -231,7 +230,7 @@ A user group consists of the following:
- a **description** (optional)
- a **list of users** (required)
- a list of SSO groups to sync from (optional)
- a root role associated with the group (optional) (only available in **Unleash 5.1** and later)
- a root role associated with the group (optional; available in v5.1+)
Groups do nothing on their own. They must either be given a root role directly or a role on a project to assign
permissions.
@ -247,9 +246,9 @@ user will inherit most permissive permissions of all their groups in that projec
## User Group SSO Integration
:::info availability
:::note Availability
User group syncing is planned to be released in Unleash 4.18 and will be available for Enterprise customers.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.18+`
:::

2
website/docs/reference/resource-limits.mdx
View File

@ -4,7 +4,9 @@ title: Resource Limits
import Figure from '@site/src/components/Figure/Figure.tsx'
:::note Availability
**Version**: `6.2+`
:::
<Figure caption="When you're close to reaching the limit for a resource, you'll see a warning in the Unleash UI. The warning will tell you what the limit is, how close you are to reaching it, and how you can increase the limit." img="/img/project-limit-warning.png" />

4
website/docs/reference/scim.md
View File

@ -3,9 +3,9 @@ id: scim
title: Provisioning
---
:::info Availability
:::note Availability
Provisioning is only available in Unleash Enterprise. This feature is in beta, please reach out to us if you'd like this feature enabled in your Unleash instance.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.1+`
:::

4
website/docs/reference/search-operators.md
View File

@ -2,9 +2,9 @@
title: Search with filters/operators
---
:::info Availability
:::note Availability
Search with filters/operators was introduced in **Unleash 5.9**.
**Version**: `5.9+`
:::

7
website/docs/reference/segments.mdx
View File

@ -4,10 +4,11 @@ title: Segments
import VideoContent from '@site/src/components/VideoContent.jsx'
:::info Availability
Segments are available to Unleash Pro and Unleash Enterprise users since **Unleash 4.13** and
was made available for Open Source from Unleash v5.5.
:::note Availability
**Version**: `4.13+` for [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
**Version**: `5.5+` for [Open Source](https://www.getunleash.io/pricing).
:::

4
website/docs/reference/service-accounts.md
View File

@ -2,9 +2,9 @@
title: Service Accounts
---
:::info Availability
:::note Availability
Service accounts is an enterprise feature available from Unleash 4.21 onwards.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
:::

5
website/docs/reference/signals.md
View File

@ -2,12 +2,13 @@
title: Signals
---
:::info Availability
:::note Availability
Signals were introduced as a beta feature in **Unleash 5.11** and are only available in Unleash Enterprise.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.11+` in BETA
:::
## Overview
Signals represent that something happened somewhere. Signal endpoints allow external systems to let Unleash know about these signals via a simple HTTP API.

6
website/docs/reference/sso.md
View File

@ -2,7 +2,11 @@
title: Single Sign-On
---
> The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details.
:::note Availability
**Plan**: [Enterprise](https://www.getunleash.io/pricing)
:::
Unleash Enterprise supports SAML 2.0, OpenID Connect and Google Authentication. In addition, Unleash supports username/password authentication out of the box.

15
website/docs/reference/stickiness.md
View File

@ -18,17 +18,14 @@ For instance: When using the [gradual rollout activation strategy](../reference/
## Custom stickiness {#custom-stickiness}
:::info
Custom stickiness is available starting from Unleash Enterprise v4.
:::note Availability
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.0+` and [SDK compatibility](../reference/sdks/index.md#server-side-sdk-compatibility-table) .
:::
When using [the gradual rollout strategy](../reference/activation-strategies.md#gradual-rollout) or [feature flag variants](./feature-toggle-variants.md), you can use parameters other than the user id to calculate stickiness. More specifically, you can use any field, custom or otherwise, of the [Unleash Context](../reference/unleash-context.md) as long as you have enabled custom stickiness for these fields.
:::note SDK compatibility
Custom stickiness is supported by all of our SDKs except for the Rust SDK. You can always refer to the [SDK compatibility table](../reference/sdks/index.md#server-side-sdk-compatibility-table) for the full overview.
:::
### Enabling custom stickiness
@ -38,9 +35,9 @@ To enable custom stickiness on a field, navigate to the Create Context screen in
## Project default stickiness
:::info Availability
:::note Availability
Project default stickiness was introduced in **Unleash v5**.
**Version**: `5.0+`
:::

10
website/docs/reference/strategy-constraints.md
View File

@ -3,12 +3,9 @@ title: Strategy Constraints
---
import VideoContent from '@site/src/components/VideoContent.jsx'
:::info Availability
:::note Availability
Before Unleash 4.16, strategy constraints were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**.
Unleash 4.9 introduced a more comprehensive set of constraint operators. These require that both Unleash *and* your client SDK of choice support them. See the [SDK compatibility table](../reference/sdks/index.md#strategy-constraints) for more information. Prior to Unleash 4.9, the only available operators were `IN` and `NOT_IN`.
**Version**: `4.16+`
:::
@ -78,8 +75,7 @@ To clarify, here's a few example strategy constraints and what they do:
In this section, `<context-field>` is used as a placeholder for an arbitrary context field. With the exception of the `currentTime` field, you can use any context field in its place.
:::
Unleash currently supports 15 different constraint operators.
The operators can be grouped into four different categories based on their method of comparison.
Unleash supports a wide range of constraint operators. `IN` and `NOT_IN` are basic operators that are available in all versions and SDKs. All other operators require Unleash version 4.9+ and [SDK compatibility](../reference/sdks/index.md#strategy-constraints).
### Constraint negation / inversion {#constraint-negation}

5
website/docs/reference/strategy-variants.md
View File

@ -4,9 +4,10 @@ title: Strategy Variants
import VideoContent from '@site/src/components/VideoContent.jsx'
:::info Availability
:::note Availability
**Version**: `5.4+`
**Strategy variants** were first introduced in Unleash 5.4.
:::

7
website/docs/reference/tags.md
View File

@ -3,7 +3,12 @@ id: tags
title: Tags
---
> This feature was introduced in Unleash 3.11.0
:::note Availability
**Version**: `3.11+`
:::
Do you want to filter your features to avoid having to see all features belonging to other teams than your own? Do you want to write a plugin that only gets notified about changes to features that your plugin knows how to handle?

4
website/docs/reference/unleash-context.md
View File

@ -42,9 +42,9 @@ For operators that work on non-string types, such as numeric and date time opera
## Custom context fields
:::info Availability
:::note Availability
Before Unleash 4.16, custom context fields were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**. They were introduced in Unleash 3.2.28.
**Version**: `4.16+`
:::

7
website/docs/topics/a-b-testing.md
View File

@ -54,7 +54,12 @@ If you want to run a more advanced experiment, then take a look at using [featur
### Impression data
[Impression data](../reference/impression-data.md) is an Unleash feature that was released in Unleash 4.7.
:::note Availability
**Version**: `4.7+`
:::
It allows you to capture events whenever a feature flag is checked in your applications.
The event contains all the information about the flag and the current context, so you can pass everything onto your third-party analytics provider, such as [Google Analytics](https://analytics.google.com/analytics) or [Posthog](https://posthog.com/).
This makes Unleash even more useful as an A/B testing tool and makes it much easier to correlate events and variants with feature flags and Unleash context.

19
website/docs/understanding-unleash/proxy-hosting.mdx
View File

@ -43,9 +43,9 @@ Hosting Edge requires a little more setup than the Unleash-hosted Frontend API d
## Unleash hosts everything
:::info Availability
:::note Availability
This setup is only available to Pro and Enterprise customers.
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
:::
@ -64,12 +64,13 @@ While this is easy to get started with, it comes with the limitations described
## Unleash hosts the API, you host Edge
:::info Availability
:::note Availability
This setup is only available to Pro and Enterprise customers.
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
:::
![An architecture diagram of using Edge in a setup where Unleash hosts the API and you host the proxy.](/img/proxy-hosting-unleash-api-customer-proxy-edge.svg)
@ -117,12 +118,13 @@ The following can be used to pass new tokens to Edge for different project/envir
## You host everything
:::info Availability
:::note Availability
This setup is only available open-source and Enterprise customers.
**Plan**: [Open Source](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
:::
![An architecture diagram of using the proxy in a single-region, self-hosted setup.](/img/proxy-hosting-customer-single-edge.svg)
You host everything yourself. Everything runs where and how you configure it to.
@ -151,12 +153,13 @@ If you are an existing Proxy user, see our [Edge migration guide](https://github
Please take note of the section covering features Edge does not currently support in the same linked document before planning a migration.
:::
:::info Availability
:::note Availability
This setup is only available to Pro and Enterprise customers.
**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
:::
![An architecture diagram of using the proxy in a setup where Unleash hosts the API and you host the proxy.](/img/proxy-hosting-unleash-api-customer-proxy.svg)
You host the proxy yourself. It runs in a standalone container alongside your other applications in your cloud or hosting setup. Unleash manages the Unleash API, the admin UI, and the backing database in our AWS setup: the API and the UI run together in a Kubernetes deployment and connect to an Amazon RDS database.

8
website/docs/using-unleash/deploy/email-service.md
View File

@ -2,7 +2,13 @@
title: Email service
---
New since Unleash v4.0.0 is an email service allowing us to send reset password and welcome mails to new users. In order for this to work you'll need to tell unleash what SMTP service you'd like to send mails from.
:::note Availability
**Version**: `4.0+`
:::
Email service allows you to send password reset and welcome emails to new users. For this to work you'll need to tell Unleash what SMTP service you'd like to send emails from.
If the service is not configured you'll see a log line every time you add a new user saying

4
website/docs/using-unleash/troubleshooting/feature-not-available.md
View File

@ -6,9 +6,9 @@ Occasionally, users might come across a situation where a documented Unleash fea
You can usually find availability information in the feature's documentation page, displayed in a box like this:
:::info Availability
:::note Availability
**Cool new feature** was introduced as a beta feature in **Unleash 5.5** and is only available in Unleash Enterprise. We plan to make this feature generally available to all Enterprise users in **Unleash 5.6**.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.5+`
:::