mirror of
https://github.com/Unleash/unleash.git
synced 2025-11-24 20:06:55 +01:00
Move how-to guides to guides
This commit is contained in:
melindafekete
parent
de3a18235a
commit
9a99e2e445
@ -72,7 +72,7 @@ const OPENAPI_TAGS = [
|
||||
{
|
||||
name: 'Import/Export',
|
||||
description:
|
||||
'[Import and export](https://docs.getunleash.io/how-to/how-to-environment-import-export) the state of your Unleash instance.',
|
||||
'[Import and export](https://docs.getunleash.io/reference/import-export) the state of your Unleash instance.',
|
||||
},
|
||||
{
|
||||
name: 'Instance Admin',
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Create and configure a feature flag
|
||||
description: 'This guide shows you how to create feature flags in Unleash and how to add constraints, segments, variants, and more.'
|
||||
slug: /how-to-create-feature-flag
|
||||
pagination_next: how-to/how-to-schedule-feature-releases
|
||||
pagination_next: guides/how-to-schedule-feature-releases
|
||||
---
|
||||
|
||||
[Feature flags](../reference/feature-toggles) are a foundational component of Unleash, enabling you to manage features dynamically. This guide details the process of creating and configuring feature flags within Unleash. You'll learn how to create flags, define activation strategies, enable them, and optionally refine their behavior with constraints, segments, and variants.
|
||||
|
||||
@ -135,7 +135,7 @@ A common challenge is managing a single feature that spans multiple services (fo
|
||||
- **Use separate, coordinated flags**: If the services are owned by different teams and have different release cadences, it's better to create separate flags in their respective projects. This prevents one team from impacting another's release. The rollout can then be coordinated across teams using release templates.
|
||||
|
||||
## Evolve your structure
|
||||
Remember that your initial project and environment structure is not set in stone. Unleash is flexible. You can add new environments, create new projects, and even move flags between them later. For larger migrations, you can use the [Import/Export](/how-to/how-to-environment-import-export) functionality or the [Admin API](/api-overview).
|
||||
Remember that your initial project and environment structure is not set in stone. Unleash is flexible. You can add new environments, create new projects, and even move flags between them later. For larger migrations, you can use the [Import/Export](/reference/import-export) functionality or the [Admin API](/api-overview).
|
||||
|
||||
The system is designed to evolve with your organization, so don't be afraid to start with a simple setup and refactor as your needs change.
|
||||
|
||||
|
||||
@ -29,10 +29,10 @@ From trunk-based development to gradual rollouts, these tutorials show how to re
|
||||
|
||||
Learn more:
|
||||
- [Create a feature flag](/how-to-create-feature-flag)
|
||||
- [Schedule a feature release](/how-to/how-to-schedule-feature-releases)
|
||||
- [Schedule a feature release](/guides/how-to-schedule-feature-releases)
|
||||
- [Trunk-based development](/feature-flag-tutorials/use-cases/trunk-based-development)
|
||||
- [Gradual rollout](/feature-flag-tutorials/use-cases/gradual-rollout)
|
||||
- [Unleash Edge quickstart](/how-to/unleash-edge-quickstart)
|
||||
- [Unleash Edge quickstart](/guides/unleash-edge-quickstart)
|
||||
|
||||
---
|
||||
## Enterprise-grade security and scale
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Unleash Edge quickstart
|
||||
slug: /how-to/unleash-edge-quickstart
|
||||
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
@ -59,7 +59,7 @@ This page highlights the key differences between Unleash OSS and Unleash Enterpr
|
||||
|
||||
| Capability | OSS | Enterprise |
|
||||
|-------------|-----|-------------|
|
||||
| [Export / import](/how-to/how-to-environment-import-export) | ✅ | ✅ |
|
||||
| [Export / import](/reference/import-export) | ✅ | ✅ |
|
||||
| [Terraform provider](/reference/terraform) | ✅ | ✅ |
|
||||
| Multi-region [Enterprise Edge](/understanding-unleash/hosting-options#unleash-edge-options) | ❌ | Available as an add-on |
|
||||
| [Webhooks and integrations](/reference/integrations) | ✅ | ✅ |
|
||||
|
||||
@ -6,8 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
### List integrations and providers {#list-integrations-and-providers}
|
||||
|
||||
`GET https://unleash.host.com/api/admin/addons`
|
||||
|
||||
@ -6,9 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
|
||||
### Revive feature flag {#revive-feature-toggle}
|
||||
|
||||
`POST http://unleash.host.com/api/admin/archive/revive/:featureName`
|
||||
|
||||
@ -7,8 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
|
||||
> The context feature is only available as part of Unleash Enterprise. In order to access the API programmatically you need to make sure you [obtain a API token](/how-to/how-to-create-api-tokens) with admin permissions.
|
||||
|
||||
### List context fields defined in Unleash {#list-context-fields-defined-in-unleash}
|
||||
|
||||
`GET https://unleash.host.com/api/admin/context`
|
||||
|
||||
@ -8,12 +8,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
|
||||
:::note
|
||||
|
||||
In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
:::
|
||||
|
||||
The Events API lets you retrieve [events](/reference/events.mdx) from your Unleash instance.
|
||||
|
||||
## Event endpoints
|
||||
|
||||
@ -7,8 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
# Feature Types API
|
||||
|
||||
`GET: http://unleash.host.com/api/admin/feature-types`
|
||||
|
||||
@ -6,12 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
|
||||
:::info
|
||||
In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an **admin** token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
:::
|
||||
|
||||
|
||||
## Fetching Feature Flags {#fetching-feature-toggles}
|
||||
|
||||
|
||||
|
||||
@ -13,11 +13,6 @@ Most of this API was removed in Unleash v5 (after being deprecated since Unleash
|
||||
:::
|
||||
|
||||
|
||||
:::info
|
||||
In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an **admin** token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
:::
|
||||
|
||||
|
||||
## Fetching Feature Flags {#fetching-feature-toggles}
|
||||
|
||||
:::caution Deprecation notice
|
||||
|
||||
@ -7,8 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
# This document describes the metrics endpoint for admin ui
|
||||
|
||||
### Seen-toggles {#seen-toggles}
|
||||
|
||||
@ -6,8 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> The context feature is only available as part of Unleash Enterprise. In order to access the API programmatically you need to make sure you [obtain an API token](/how-to/how-to-create-api-tokens) with admin permissions.
|
||||
|
||||
### List projects in Unleash {#list-projects-in-unleash}
|
||||
|
||||
`GET https://unleash.host.com/api/admin/projects`
|
||||
|
||||
@ -14,11 +14,6 @@ import ApiRequest from '@site/src/components/ApiRequest'; export const basePath
|
||||
|
||||
:::
|
||||
|
||||
:::note
|
||||
|
||||
To use the admin API, you'll need to [create and use an admin API token](/how-to/how-to-create-api-tokens).
|
||||
|
||||
:::
|
||||
|
||||
The segments API lets you create, read, update, and delete [segments](/reference/segments).
|
||||
|
||||
|
||||
@ -9,11 +9,10 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
:::caution Removal notice
|
||||
|
||||
Api admin state is deprecated from version 5 and removed in version 6. We recommend using the new [Environment Import & Export](/how-to/how-to-environment-import-export).
|
||||
Api admin state is deprecated from version 5 and removed in version 6. We recommend using the new [Environment Import & Export](/reference/import-export).
|
||||
|
||||
:::
|
||||
|
||||
> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
### Export Feature Flags & Strategies {#export-feature-toggles--strategies}
|
||||
|
||||
|
||||
@ -6,7 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
### Fetch Strategies {#fetch-strategies}
|
||||
|
||||
|
||||
@ -7,8 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
### Create a new tag {#create-a-new-tag}
|
||||
|
||||
`POST https://unleash.host.com/api/admin/tags`
|
||||
|
||||
@ -6,8 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
### List all users {#list-all-users}
|
||||
|
||||
`GET https://unleash.host.com/api/admin/user-admin`
|
||||
|
||||
@ -6,7 +6,7 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a Backend token](/how-to/how-to-create-api-tokens.mdx) and add an Authorization header using the token.
|
||||
> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a Backend token](/guides/how-to-create-api-tokens.mdx) and add an Authorization header using the token.
|
||||
|
||||
### Fetching Feature Flags {#fetching-feature-toggles}
|
||||
|
||||
|
||||
@ -7,7 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a Backend token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
### Send metrics {#send-metrics}
|
||||
|
||||
|
||||
@ -7,8 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a Backend token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
### Client registration {#client-registration}
|
||||
|
||||
`POST: http://unleash.host.com/api/client/register`
|
||||
|
||||
@ -14,7 +14,7 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
:::caution Removal notice
|
||||
|
||||
Api admin state is deprecated from version 5 and removed from version 6. We recommend using the new [Environment Import & Export](/how-to/how-to-environment-import-export).
|
||||
Api admin state is deprecated from version 5 and removed from version 6. We recommend using the new [Environment Import & Export](/reference/import-export).
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ This guide provides an overview of how [Unleash Enterprise](https://www.getunlea
|
||||
|
||||
| **FedRAMP Control** | **Unleash Feature** |
|
||||
|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [CM-02 Baseline Configuration](https://csrc.nist.gov/projects/cprt/catalog#/cprt/framework/version/SP_800_53_5_1_0/home?element=CM-2) | Unleash provides [Export](/how-to/how-to-environment-import-export) functionality that facilitates keeping a configuration snapshot of feature flags and related entities in the audit records. Instance-wide configurations, such as projects, users, and roles, can be managed and restored using the [Unleash Terraform provider](/reference/terraform). |
|
||||
| [CM-02 Baseline Configuration](https://csrc.nist.gov/projects/cprt/catalog#/cprt/framework/version/SP_800_53_5_1_0/home?element=CM-2) | Unleash provides [Export](/reference/import-export) functionality that facilitates keeping a configuration snapshot of feature flags and related entities in the audit records. Instance-wide configurations, such as projects, users, and roles, can be managed and restored using the [Unleash Terraform provider](/reference/terraform). |
|
||||
| [CM-05 Access Restrictions for Change](https://csrc.nist.gov/projects/cprt/catalog#/cprt/framework/version/SP_800_53_5_1_0/home?element=CM-5) | Unleash provides advanced [role-based access control](/reference/rbac) (RBAC) controls to implement logical access restrictions. [Change Requests](/reference/change-requests) help you define and track approval flows. |
|
||||
|
||||
## Identification and Authentication
|
||||
|
||||
@ -171,7 +171,7 @@ Consider migrating to [Unleash Enterprise](https://www.getunleash.io/pricing) to
|
||||
|
||||
- The Unleash Edge metrics endpoint `/edge/metrics` has been removed. If you use Unleash Edge, ensure your Edge instances are upgraded to **version 19.1.3 or later** before upgrading the Unleash server to v6 to maintain metrics collection. Core flag evaluation will still work with older Edge versions.
|
||||
- The legacy feature endpoint `/api/feature`, [deprecated in v4](#legacy-v2-routes-removed), has been removed. Update any integrations still using this endpoint.
|
||||
- Deprecated import service: The older file-based import functionality at startup has been removed. Use the current [environment import/export features](/how-to/how-to-environment-import-export) or associated APIs.
|
||||
- Deprecated import service: The older file-based import functionality at startup has been removed. Use the current [environment import/export features](/reference/import-export) or associated APIs.
|
||||
|
||||
### Dropped Internet Explorer support
|
||||
|
||||
@ -275,7 +275,7 @@ Follow along with our video demonstration on upgrading from v3 to v5 with no dow
|
||||
|
||||
In Unleash Open Source v3, client SDKs did not require an API token to connect to the Unleash server. Starting with v4, API token handling, previously an Enterprise feature, was added to the Open Source version. This means that all client SDKs now need to use a client token to connect to Unleash.
|
||||
|
||||
Read more in the [API token documentation](../../how-to/how-to-create-api-tokens).
|
||||
Read more in the [API token documentation](/guides/how-to-create-api-tokens).
|
||||
|
||||
### Configuring Unleash
|
||||
|
||||
|
||||
@ -101,8 +101,8 @@ const SDKS = (() => {
|
||||
|
||||
const getAdmonitions = (sdk) => {
|
||||
const admonitions = {
|
||||
[FRONTEND_SDKS]: `To connect to Unleash from a frontend application, you'll need to use the [Unleash front-end API](/reference/front-end-api) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx)) or the [Unleash proxy](/reference/unleash-proxy) ([how do I create client keys?](/reference/api-tokens-and-client-keys#proxy-client-keys)).`,
|
||||
[BACKEND_SDKS]: `To connect to Unleash, you'll need your Unleash API url (e.g. \`https://<your-unleash>/api\`) and a [backend API token](/reference/api-tokens-and-client-keys.mdx#backend-tokens) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx)).`,
|
||||
[FRONTEND_SDKS]: `To connect to Unleash from a frontend application, you'll need to use the [Unleash front-end API](/reference/front-end-api) ([how do I create an API token?](/guides/how-to-create-api-tokens.mdx)) or the [Unleash proxy](/reference/unleash-proxy) ([how do I create client keys?](/reference/api-tokens-and-client-keys#proxy-client-keys)).`,
|
||||
[BACKEND_SDKS]: `To connect to Unleash, you'll need your Unleash API url (e.g. \`https://<your-unleash>/api\`) and a [backend API token](/reference/api-tokens-and-client-keys.mdx#backend-tokens) ([how do I create an API token?](/guides/how-to-create-api-tokens.mdx)).`,
|
||||
};
|
||||
|
||||
const wrap = (text) => `:::tip\n${text}\n:::`;
|
||||
|
||||
@ -181,7 +181,7 @@ const sidebars: SidebarsConfig = {
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'Import and export',
|
||||
id: 'how-to/how-to-environment-import-export',
|
||||
id: 'reference/import-export',
|
||||
},
|
||||
],
|
||||
},
|
||||
@ -235,7 +235,7 @@ const sidebars: SidebarsConfig = {
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'Schedule a feature release',
|
||||
id: 'how-to/how-to-schedule-feature-releases',
|
||||
id: 'guides/how-to-schedule-feature-releases',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
@ -250,7 +250,7 @@ const sidebars: SidebarsConfig = {
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'Unleash Edge quickstart',
|
||||
id: 'how-to/unleash-edge-quickstart',
|
||||
id: 'guides/unleash-edge-quickstart',
|
||||
},
|
||||
],
|
||||
},
|
||||
@ -611,7 +611,7 @@ const sidebars: SidebarsConfig = {
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'Synchronize Unleash instances',
|
||||
id: 'how-to/how-to-synchronize-unleash-instances',
|
||||
id: 'guides/how-to-synchronize-unleash-instances',
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@ -48,7 +48,27 @@
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-create-api-tokens",
|
||||
"destination": "/reference/api-tokens-and-client-keys#create-an-api-token",
|
||||
"destination": "/guides/how-to-create-api-tokens",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-run-the-unleash-proxy",
|
||||
"destination": "/guides/how-to-run-the-unleash-proxy",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-schedule-feature-releases",
|
||||
"destination": "/guides/how-to-schedule-feature-releases",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-synchronize-unleash-instances",
|
||||
"destination": "/guides/how-to-synchronize-unleash-instances",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/unleash-edge-quickstart",
|
||||
"destination": "/guides/unleash-edge-quickstart",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
@ -1093,12 +1113,12 @@
|
||||
},
|
||||
{
|
||||
"source": "/reference/deploy/environment-import-export",
|
||||
"destination": "/how-to/how-to-environment-import-export",
|
||||
"destination": "/reference/import-export",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/deploy/environment-import-export",
|
||||
"destination": "/how-to/how-to-environment-import-export",
|
||||
"destination": "/reference/import-export",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
|
||||
Loading…
Reference in New Issue
Block a user