From 160b9a06046ea97ef8fa21fad717642d91fbec57 Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Wed, 14 Dec 2022 15:26:41 +0100 Subject: [PATCH] docs: small fixes (#2688) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## What This PR contains two small doc updates/fixes: 1. Update the availability notice on SSO syncing to indicate that it has been released. 2. Add a note to the Import API description that importing environments will make Unleash delete API keys belonging to those environments. ## Why 1. To keep the docs up to date. 2. Because this behavior surprised (and rightly so, I'd say) a user, who then suddenly had all their SDKs unable to connect. Co-authored-by: Nuno Góis --- website/docs/how-to/how-to-set-up-group-sso-sync.md | 2 +- website/docs/reference/deploy/import-export.md | 12 +++++++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/website/docs/how-to/how-to-set-up-group-sso-sync.md b/website/docs/how-to/how-to-set-up-group-sso-sync.md index 55766e354a..f75005446a 100644 --- a/website/docs/how-to/how-to-set-up-group-sso-sync.md +++ b/website/docs/how-to/how-to-set-up-group-sso-sync.md @@ -4,7 +4,7 @@ title: How set up user group SSO syncing :::info availability -User group syncing is planned to be released in Unleash 4.18 and will be available for enterprise customers. +User group syncing was released in Unleash 4.18 and is available for enterprise customers. ::: diff --git a/website/docs/reference/deploy/import-export.md b/website/docs/reference/deploy/import-export.md index 38bb99058a..e7cf5e6e66 100644 --- a/website/docs/reference/deploy/import-export.md +++ b/website/docs/reference/deploy/import-export.md @@ -64,6 +64,12 @@ For example if you want to download just feature-toggles as yaml: ### API Import {#api-import} +:::caution Importing environments + +If you import an environment into an instance that already has that environment defined, Unleash will delete any API keys created specifically for that environment. This is to prevent unexpected access to the newly imported environments. + +::: + You can import feature-toggles and strategies by POSTing to the `/api/admin/state/import` endpoint (keep in mind this will require authentication).\ You can either send the data as JSON in the POST-body or send a `file` parameter with `multipart/form-data` (YAML files are also accepted here). @@ -76,7 +82,11 @@ You can customize the import with query parameters: If you want the database to be cleaned before import (**all strategies and features will be removed**), specify a `drop` query parameter. -> You should never use this in production environments. +:::caution + +You should be cautious about using the `drop` query parameter in production environments. + +::: Example usage: