Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity
7c85cab6b2
unleash.unleash/website/docs/reference/environments.md

155 lines
10 KiB
Markdown
Raw Normal View History

fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
---
id: environments
title: Environments
---
docs: slight update to environment docs (#3187) ## What & why This update does three things: 1. Adjusts the environment cloning feature availability notice: because this has been released. 2. Updates the availability notice for environments (to conform with the standard docusaurus way of doing things): for consistency 3. Add a brief explanation of environment types: because this isn't documented anywhere ## Sources The note about how environment types work is sourced from this old [slack thread (internal to the team)](https://unleash-community.slack.com/archives/G01MU2Q49QC/p1659600175175769)
2023-02-24 13:48:45 +01:00
:::info Availability
Environments were released in Unleash v4.3.0.
:::
chore: add video to envrionments
2021-10-26 11:21:48 +02:00
<div style={{position: 'relative', paddingBottom: '56.25%', height: '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>
docs: Polish text on environments. There's a number of small text adjustments and typo fixes in here with the goal of clarifying how environments and the migration process work.
2021-11-11 15:36:41 +01:00
Environments is a new way to organize activation strategy configurations for feature toggles 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.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
refactor: move docs into new structure / fix links for SEO (#2416) ## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
2022-11-22 10:05:30 +01:00
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.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: Polish text on environments. There's a number of small text adjustments and typo fixes in here with the goal of clarifying how environments and the migration process work.
2021-11-11 15:36:41 +01:00
Further, connected applications will use environment-scoped API keys to make sure they only download feature toggle configurations for the environment they are running in.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: Polish text on environments. There's a number of small text adjustments and typo fixes in here with the goal of clarifying how environments and the migration process work.
2021-11-11 15:36:41 +01:00
Finally, metrics have also been upgraded to record the environment. This, in turn, means that Unleash can display usage metrics per environment.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: add paragraph to intro: things will still work (default env)
2021-11-12 08:26:19 +01:00
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 toggles and API keys. Read more about that in [the migration section](#migration).
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
![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 toggle exists across all environments, but take different activation strategies per environment.')
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: slight update to environment docs (#3187) ## What & why This update does three things: 1. Adjusts the environment cloning feature availability notice: because this has been released. 2. Updates the availability notice for environments (to conform with the standard docusaurus way of doing things): for consistency 3. Add a brief explanation of environment types: because this isn't documented anywhere ## Sources The note about how environment types work is sourced from this old [slack thread (internal to the team)](https://unleash-community.slack.com/archives/G01MU2Q49QC/p1659600175175769)
2023-02-24 13:48:45 +01:00
## Environment types
All environments in Unleash have a **type**. When you create a new environment, you must also assign it a type.
The built-in environment types are:
- Development
- Test
- Pre-production
- Production
The **production** environment type is special: Unleash will show additional confirmation prompts when you change something that could impact users in environments of this type. The built-in "production" environment is a production-type environment.
The other environment types do not currently have any functionality associated with them. This may change in the future.
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
## Global and project-level environments
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
Environments exist on a global level, so they are available to all projects within Unleash. However, every [project](./projects.md) might not need to use every environment. That's why you can also choose which of the global environments should be available within a project.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
## How to start using environments
docs: remove references to environments being a beta feature. Also specify that if you're on version 4.3, you don't need to do anything.
2021-11-26 13:53:46 +01:00
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.
docs: add notes about users having to add strats to enable envs.
2021-11-12 08:33:55 +01:00
Note that in order to enable an environment for a feature toggle, you must first add activation strategies for that environment. You cannot enable an environment without activation strategies.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
### Step 1: Enable new environments for your Project
docs: Polish text on environments. There's a number of small text adjustments and typo fixes in here with the goal of clarifying how environments and the migration process work.
2021-11-11 15:36:41 +01:00
Navigate to the project and choose the “environments” tab.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
![A project view showing the Environments tab. The UI displays three environment toggles: "default", "development", and "production". The "default" environment is enabled.](/img/environments_configure.png 'Configure environment for this project')
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
### Step 2: Configure activation strategies for the new environment
docs: add notes about users having to add strats to enable envs.
2021-11-12 08:33:55 +01:00
From the “feature toggle view” you will now be able to configure activation strategies per environment. You can also enable and disable environments here. Remember that an environment must have activation strategies before you can enable it.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
![A feature toggle strategies tab showing three different environments, of which one is active. The UI displays data about the currently selected environment, ](/img/environments_strategies.png 'Add strategy configuration per environment')
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
### Step 3: Create environment specific API keys
docs: Polish text on environments. There's a number of small text adjustments and typo fixes in here with the goal of clarifying how environments and the migration process work.
2021-11-11 15:36:41 +01:00
In order for the SDK to download the feature toggle configuration for the correct environment you will need to create an API token for a defined environment.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
![An API key creation form. The form's fields are "username", "token type", "project", and, crucially, "environment". The development environment is selected.](/img/environments_api_keys.png 'Create Environment specific API Keys')
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: add environment cloning and how-to guide (#2249) * docs: add environment cloning and how-to guide * add next steps in how-to, update reference * update how-to, add images * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/user_guide/environments.md Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/user_guide/environments.md Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/sidebars.js Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * address PR comments * Update website/docs/how-to/how-to-clone-environments.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * fix uppercase in guide Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-11-03 13:14:08 +01:00
## Cloning environments
:::note Availability
docs: slight update to environment docs (#3187) ## What & why This update does three things: 1. Adjusts the environment cloning feature availability notice: because this has been released. 2. Updates the availability notice for environments (to conform with the standard docusaurus way of doing things): for consistency 3. Add a brief explanation of environment types: because this isn't documented anywhere ## Sources The note about how environment types work is sourced from this old [slack thread (internal to the team)](https://unleash-community.slack.com/archives/G01MU2Q49QC/p1659600175175769)
2023-02-24 13:48:45 +01:00
Environment cloning was made available in Unleash 4.19.
docs: add environment cloning and how-to guide (#2249) * docs: add environment cloning and how-to guide * add next steps in how-to, update reference * update how-to, add images * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/user_guide/environments.md Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/user_guide/environments.md Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/sidebars.js Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * address PR comments * Update website/docs/how-to/how-to-clone-environments.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * fix uppercase in guide Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-11-03 13:14:08 +01:00
:::
Unleash environments can be cloned. Cloning an environment creates a **new** environment based on the selected source environment. When cloning an environment, you select any number of projects whose feature toggle configurations will also be cloned. These projects will have identical configurations for the source and target environments. However, the environments can then be configured independently and will not stay in sync with each other.
When cloning an environment, you must give the new environment
- a name
- an environment type
- a list of projects to clone feature configurations in
refactor: move docs into new structure / fix links for SEO (#2416) ## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
2022-11-22 10:05:30 +01:00
You can also clone user permissions into the new environment. When you do that, permissions in the new environment will be the same as in the environment you cloned from. If you don't clone permissions, only admins and project editors can make changes in the new environment. You can change permissions after creation by using [custom project roles](../reference/rbac#custom-project-roles).
docs: add environment cloning and how-to guide (#2249) * docs: add environment cloning and how-to guide * add next steps in how-to, update reference * update how-to, add images * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/user_guide/environments.md Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/user_guide/environments.md Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/sidebars.js Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * address PR comments * Update website/docs/how-to/how-to-clone-environments.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * fix uppercase in guide Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-11-03 13:14:08 +01:00
In order to clone an environment, you can follow the [how to clone environments](../how-to/how-to-clone-environments.mdx) guide.
Once created, the new environment works just as any other environment.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
## Migration
docs: Polish text on environments. There's a number of small text adjustments and typo fixes in here with the goal of clarifying how environments and the migration process work.
2021-11-11 15:36:41 +01:00
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.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
![A strategy constraint using the environment field of the unleash context.](/img/environments_strategy_constraints.png 'You will not use strategy constraints for environments any more.')
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
### Addons
docs: Polish text on environments. There's a number of small text adjustments and typo fixes in here with the goal of clarifying how environments and the migration process work.
2021-11-11 15:36:41 +01:00
We have made some slight changes to events related to feature toggles: there's one deprecation and several new event types. Most of the new events contain _project_ and _environment_ data.
To avoid missing important updates, you will also need to update your addon configuration to subscribe to the new events.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
**Deprecated events:**
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
- **FEATURE_UPDATE** - _not used after switching to environments_
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
**New Events**
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
- **FEATURE-METADATA-UPDATED** - The feature toggle metadata was updated (across all environments).
- **FEATURE-STRATEGY-ADD**¹ - An activation strategy was added to a feature toggle in an environment. The _data_ will contain the updated strategy configuration.
- **FEATURE-STRATEGY-UPDATE**¹ - An activation strategy was updated for a feature toggle. The _data_ will contain the updated strategy configuration.
- **FEATURE-STRATEGY-REMOVE**¹ - An activation strategy was removed for a feature toggle.
- **FEATURE-ENVIRONMENT-ENABLED**¹ - Signals that a feature toggle has been _enabled_ in a defined environment.
- **FEATURE-ENVIRONMENT-DISABLED**¹ - Signals that a feature toggle has been _disabled_ in a defined environment.
- **FEATURE-PROJECT-CHANGE**¹ - The feature toggle was moved to a new project.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
> 1. These feature events will contain _project_ and _environment_ as part of the event metadata.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
### API
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
docs: Polish text on environments. There's a number of small text adjustments and typo fixes in here with the goal of clarifying how environments and the migration process work.
2021-11-11 15:36:41 +01:00
In order to support configuration per environment we had to rebuild our feature toggle admin API to account for environments as well. This means that we're making the following changes to the API:
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
refactor: move docs into new structure / fix links for SEO (#2416) ## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
2022-11-22 10:05:30 +01:00
- **/api/admin/features** - _deprecated (scheduled for removal in Unleash v5.0). The [old feature toggles 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 toggles which also adds support for environments. See [the documentation](/reference/api/legacy/unleash/admin/features.md) to learn more.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
## Plan Differences
### Open-Source (free)
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
- 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.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
### Pro (commercial)
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
- 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.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
### Enterprise (commercial)
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
- 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.
docs: add environment cloning and how-to guide (#2249) * docs: add environment cloning and how-to guide * add next steps in how-to, update reference * update how-to, add images * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/user_guide/environments.md Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/user_guide/environments.md Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/sidebars.js Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/how-to/how-to-clone-environment.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * address PR comments * Update website/docs/how-to/how-to-clone-environments.mdx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update website/docs/user_guide/environments.md Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * fix uppercase in guide Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-11-03 13:14:08 +01:00
- Will be allowed to create new environments and clone existing environments.
fix: Environments documentation This commits adds the inital documentation to make it easier to understand the new feature envrionment concept. I expect that we will need multiple iterations to make it spot on. Related to #1042
2021-10-25 18:49:42 +02:00
## Rollout Plan
docs: add feature toggle reference, new how-to (#1694) * Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
- **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).
Reference in New Issue Copy Permalink