1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-28 19:06:12 +01:00
unleash.unleash/website/docs/how-to/how-to-clone-environments.mdx

40 lines
2.0 KiB
Plaintext
Raw Normal View History

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
---
title: How to clone environments
---
:::info availability
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
:::
[Environment cloning](../reference/environments.md#cloning-environments) enables Unleash admins to duplicate existing environments, including all feature flags strategies and their state.
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
## Step 1: Navigate to the environments page {#step-1}
Navigate to the _Environments_ page in the admin UI (available at the URL `/environments`). Use the navigation menu item "Configure" and select "Environments".
![The admin UI navigation "Configure" submenu with the Environments item highlighted.](/img/clone-environment-1.png)
## Step 2: Select an environment to clone {#step-2}
Select an environment to clone. On the right side, open the actions submenu and select "Clone".
![The "production" environment actions submenu with the Clone option highlighted.](/img/clone-environment-2.png)
## Step 3: Fill in the clone environment form {#step-3}
Give your new environment a name. The name must be unique and cannot be the same as the original environment. The name is pre-filled with a suggestion, but you can change it to whatever you like.
Select an environment type, which projects should have their environment configuration cloned, and whether to keep the existing user permissions for the new environment.
![The clone environment form filled with some example data, and the Clone environment button highlighted at the bottom.](/img/clone-environment-3.png)
You can optionally generate an API token for the new environment right away. Select which projects the token should have access to, and the token will be generated when you submit the form.
![The clone environment form with the API Token section highlighted and the Generate an API token now option selected](/img/clone-environment-4.png)
![The token details with the "Copy Token" element highlighted.](/img/clone-environment-5.png)
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 always create API tokens for the new environment by following the [_Generating an API token_](../how-to/how-to-create-api-tokens.mdx) guide.