Merge pull request #1186 from Unleash/docs/4.3-minor-updates
docs: update existing articles and screenshots to match version 4.3
@ -11,7 +11,9 @@ Please refer to [Create token](../user_guide/api-token) on how to create an API
|
||||
|
||||
Please note that it may take up to 60 seconds for the new key to propagate to all Unleash instances due to eager caching.
|
||||
|
||||
> If you need an API token to use in a client SDK you should create a "client token" as these have less access.
|
||||
:::note
|
||||
If you need an API token to use in a client SDK you should create a "client token" as these have fewer access rights.
|
||||
:::
|
||||
|
||||
## Step 2: Use Admin API {#step-2-use-admin-api}
|
||||
|
||||
@ -20,12 +22,14 @@ Now that you have an access token with admin privileges we can use that to perfo
|
||||
In the example below we will use the [Unleash Admin API](../api/admin/features) to enable the “Demo” feature toggle using curl.
|
||||
|
||||
```sh
|
||||
curl -X POST -H "Content-Type: application/json" -H "Authorization: admintoken" https://app.unleash-hosted.com/demo/api/admin/features/Demo/toggle/on
|
||||
curl -X POST -H "Content-Type: application/json" \
|
||||
-H "Authorization: admintoken" \
|
||||
https://app.unleash-hosted.com/demo/api/admin/features/Demo/toggle/on
|
||||
```
|
||||
|
||||
**Great success!** We have now enabled the feature toggle. We can also verify that it was actually changed by the API user by navigating to the history (audit log) for this feature toggle.
|
||||
|
||||

|
||||

|
||||
|
||||
## API overview {#api-overview}
|
||||
|
||||
|
@ -3,14 +3,18 @@ id: archived_toggles
|
||||
title: Archived toggles
|
||||
---
|
||||
|
||||
In unleash you may choose to "archive" a feature toggle when it is not needed anymore. You do this by clicking the "Archive" button on the feature toggle details view. By archiving a feature toggle it will not be available to Client SDKs anymore.
|
||||
You can _archive_ a feature toggle when it is not needed anymore. You do this by clicking the "Archive" button on the feature toggle details view. When you archive a feature toggle, it will no longer be available to Client SDKs.
|
||||
|
||||
.
|
||||
.
|
||||
|
||||
You will not be able to "fully delete a feature toggle". The reason for this is to avoid old toggles suddenly "waking up again". This could, in worst case, re-activate old functionality in code where the use of the feature toggle has not been cleaned up yet.
|
||||
You can not "fully delete a feature toggle". This is to prevent you from creating a new feature toggle with the same name as an old one. This could potentially reactivate old functionality in code that still referenced the old toggle and result in unintended consequences.
|
||||
|
||||
## Viewing archived toggles
|
||||
|
||||
You can find archived toggles in the toggle archive. The archive is accessible from the global feature toggle list.
|
||||
|
||||
## Reviving a feature toggle {#reviving-a-feature-toggle}
|
||||
|
||||
If you want to re-use a feature toggle which has been archived you may revive in from the archive. You do that by clicking the "revive icon". Please not that revived toggles will be "disabled" when they are active again.
|
||||
If you want to re-use a feature toggle that you previously archived, you can revive in from the feature toggle archive. Click the "revive icon" to revive the toggle. Revived toggles will be in the disabled state when you re-enable them.
|
||||
|
||||
.
|
||||
.
|
||||
|
@ -3,16 +3,16 @@ id: audit_log
|
||||
title: The audit log
|
||||
---
|
||||
|
||||
When something is not working as expected it is important to be able to track what changed when, and who performed the change.
|
||||
The audit log lets you track changes in Unleash. It lists _what_ changed, _when_ it changed, and _who_ performed the change.
|
||||
|
||||
## Audit log per feature toggle {#audit-log-per-feature-toggle}
|
||||
## Feature toggle log {#audit-log-per-feature-toggle}
|
||||
|
||||
Unleash comes with a audit log, available on a feature toggle level. You access the audit log via the “history” tab in the feature toggle view.
|
||||
Each feature toggle has its own audit log. The audit log is available under the "Event log" tab in the tab view.
|
||||
|
||||

|
||||

|
||||
|
||||
## Global Audit Log {#global-audit-log}
|
||||
|
||||
Unleash also keeps an audit log across all toggles and activation strategies, tracking all changes. You access the global audit log via the “Event history”, which you can find in the drawer menu.
|
||||
Unleash also keeps an audit log across all toggles and activation strategies, tracking all changes. You access the global audit log via the “Event history”, which you can find in the drawer menu. The global audit log is only accessible by users with instance admin access.
|
||||
|
||||

|
||||

|
||||
|
@ -13,7 +13,7 @@ In this example we want to define an activation strategy offers a scheduled rele
|
||||
|
||||
First we need to "define" our new strategy. To add a new "Strategy", open the Strategies tab from the sidebar.
|
||||
|
||||

|
||||

|
||||
|
||||
We name our strategy `TimeStamp` and add one required parameter of type string, which we call `enableAfter`.
|
||||
|
||||
@ -21,7 +21,7 @@ We name our strategy `TimeStamp` and add one required parameter of type string,
|
||||
|
||||
After we have created the strategy definition, we can now decide to use that activation strategy for our feature toggle.
|
||||
|
||||

|
||||

|
||||
|
||||
In the example we want to use our custom strategy for the feature toggle named `demo.TimeStampRollout`.
|
||||
|
||||
|
@ -23,7 +23,7 @@ The built-in activation strategies:
|
||||
|
||||
When you create a new feature toggle you will get the standard activation strategy, if you don’t configure any specific strategies. The standard activation strategy will always evaluate to true, given that the feature toggle is enabled.
|
||||
|
||||

|
||||

|
||||
|
||||
## The UserIDs strategy {#the-userids-strategy}
|
||||
|
||||
@ -31,15 +31,15 @@ When we have deployed some new code to production it would be nice to enable the
|
||||
|
||||
A userId is how you identify users in your system (email, UUID, etc) and is provided as part of the Unleash Context to the client SDK.
|
||||
|
||||

|
||||

|
||||
|
||||
## Multiple activation strategies {#multiple-activation-strategies}
|
||||
|
||||
In order to increase the exposure of the feature which is protected with the feature toggle you can configure multiple activation strategies on the same feature toggle.
|
||||
|
||||

|
||||

|
||||
|
||||
In the example above we have to configure two activation strategies, **userWithId** and **flexibleRollout**. If one of them evaluates to true the feature toggle is considered enabled. In the example we have enabled the feature toggle for usersWithId (_productlead@mycompany.com and me@mycompany.com_) in addition to 75% of the traffic.
|
||||
In the example above we have to configure two activation strategies, **userWithId** and **flexibleRollout**. If one of them evaluates to true the feature toggle is considered enabled. In the example we have enabled the feature toggle for usersWithId (*productlead@mycompany.com* and *me@mycompany.com*) in addition to 75% of the traffic.
|
||||
|
||||
## Summary {#summary}
|
||||
|
||||
|
@ -25,7 +25,7 @@ Despite this being a shift in how Unleash works, everything will continue to wor
|
||||
|
||||
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
## How to start using environments
|
||||
@ -45,7 +45,7 @@ Navigate to the project and choose the “environments” tab.
|
||||
|
||||
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
### Step 2: Configure activation strategies for the new environment
|
||||
@ -54,7 +54,7 @@ From the “feature toggle view” you will now be able to configure activation
|
||||
|
||||
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
### Step 3: Create environment specific API keys
|
||||
@ -63,7 +63,7 @@ In order for the SDK to download the feature toggle configuration for the correc
|
||||
|
||||
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
|
||||
@ -76,7 +76,7 @@ If you're currently using strategy constraints together with the “environment
|
||||
|
||||
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
|
||||
|
@ -17,7 +17,7 @@ Projects are a way to organize your feature toggles within Unleash. Within a lar
|
||||
|
||||
A common pattern is to organize the feature toggles according to key areas of the application, e.g. “Basic user process” and “Advanced user process”. This is illustrated below.
|
||||
|
||||

|
||||

|
||||
|
||||
## Creating a new project {#creating-a-new-project}
|
||||
|
||||
@ -25,15 +25,15 @@ When you log into Unleash for the first time, there is a Default project already
|
||||
|
||||
From the top-line menu – click on “Projects”
|
||||
|
||||

|
||||

|
||||
|
||||
The available projects will now be listed. To create a new Project – choose the “Add new project”
|
||||
|
||||

|
||||

|
||||
|
||||
The configuration of a new Project is now available. the following input is available to create the new Project.
|
||||
|
||||

|
||||

|
||||
|
||||
| Item | Description |
|
||||
| ------------ | ---------------------------------- |
|
||||
@ -43,48 +43,46 @@ The configuration of a new Project is now available. the following input is avai
|
||||
|
||||
## Deleting an existing project {#deleting-an-existing-project}
|
||||
|
||||
To keep your feature toggles clean, removing deprecated projects is important. From the overview of Projects –
|
||||
To keep your feature toggles clean, removing deprecated projects is important. From the overview of Projects –
|
||||
1. In the top right of the project card, find the project menu represented by three vertical dots.
|
||||
|
||||
|
||||

|
||||

|
||||
|
||||
2. Click on Delete Project
|
||||
|
||||

|
||||

|
||||
|
||||
## Filter feature toggles on projects {#filter-feature-toggles-on-projects}
|
||||
|
||||
When browsing the feature toggles in Unleash, you might want to filter the view by looking only at the ones included in the project of interest. This is possible from the Feature toggle overview.
|
||||
|
||||
From the top-line menu – choose the hamburger icon
|
||||
From the UI top navigation menu, choose "Feature toggles".
|
||||
|
||||

|
||||

|
||||
|
||||
The list of features toggles can be filtered on the project of your choice. By default, all feature toggles are listed in the view.
|
||||
|
||||

|
||||

|
||||
|
||||
From the drop-down, chose the project to filter on.
|
||||
|
||||

|
||||

|
||||
|
||||
The view will now be updated with the filtered feature toggles.
|
||||
|
||||
## Assigning project to a new feature toggle {#assigning-project-to-a-new-feature-toggle}
|
||||
|
||||
When creating a new feature toggle, the project where the feature toggle will be created may be chosen. The default project is “Default”
|
||||
When you create a new feature toggle, you can choose which project to create it in. The default project is whatever project you are currently configuring.
|
||||
|
||||

|
||||

|
||||
|
||||
All available projects are available from the drop-down menu.
|
||||
|
||||

|
||||

|
||||
|
||||
## Change project for an existing feature toggle {#change-project-for-an-existing-feature-toggle}
|
||||
|
||||
There might be a need to change the project a feature toggle belongs to. Changing the project is possible from the feature toggle configuration page.
|
||||
If you want to change which project a feature toggle belongs to, you can change that from the feature toggle's configuration page. Under the _settings_ tab, choose the _project_ option and choose the new project from the dropdown menu.
|
||||
|
||||

|
||||
|
||||
To change the project, simply change the project from the drop-down menu.
|
||||

|
||||
|
@ -18,13 +18,13 @@ A toggle being (potentially) stale, does not affect how it performs in your appl
|
||||
|
||||
In order to assist with removing unused feature toggles, Unleash provides a technical debt dashboard in the management-ui. You can find it by clicking on “Advanced” in the top-line menu then choose _Reporting_ in the dropdown menu.
|
||||
|
||||

|
||||

|
||||
|
||||
The dasboard includes a health report card, and a list of toggles that can be filtrated on different parameters.
|
||||
|
||||
### Report card {#report-card}
|
||||
|
||||

|
||||

|
||||
|
||||
The report card includes some statistics of your application. It lists the overall amount of your active toggles, the overall amount of stale toggles, and lastly, the toggles that Unleash believes should be stale. This calculation is performed on the basis of toggle types:
|
||||
|
||||
@ -46,6 +46,6 @@ The health rating updates once every hour, so there may be some lag if you have
|
||||
|
||||
### Toggle list {#toggle-list}
|
||||
|
||||

|
||||

|
||||
|
||||
The toggle list gives an overview over all of your toggles and their status. In this list you can sort the toggles by their name, last seen, created, expired, status and report. This will allow you to quickly get an overview over which toggles may be worth deprecating and removing from the code.
|
||||
|
Before Width: | Height: | Size: 470 KiB After Width: | Height: | Size: 122 KiB |
Before Width: | Height: | Size: 318 KiB After Width: | Height: | Size: 75 KiB |
Before Width: | Height: | Size: 597 KiB After Width: | Height: | Size: 108 KiB |
Before Width: | Height: | Size: 617 KiB After Width: | Height: | Size: 122 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 81 KiB |
Before Width: | Height: | Size: 555 KiB After Width: | Height: | Size: 101 KiB |
Before Width: | Height: | Size: 527 KiB After Width: | Height: | Size: 172 KiB |
Before Width: | Height: | Size: 580 KiB After Width: | Height: | Size: 71 KiB |
Before Width: | Height: | Size: 638 KiB After Width: | Height: | Size: 71 KiB |
Before Width: | Height: | Size: 599 KiB After Width: | Height: | Size: 112 KiB |
Before Width: | Height: | Size: 588 KiB After Width: | Height: | Size: 120 KiB |
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 69 KiB |
Before Width: | Height: | Size: 568 KiB After Width: | Height: | Size: 226 KiB |
Before Width: | Height: | Size: 562 KiB After Width: | Height: | Size: 155 KiB |
Before Width: | Height: | Size: 704 KiB After Width: | Height: | Size: 90 KiB |
Before Width: | Height: | Size: 548 KiB After Width: | Height: | Size: 108 KiB |