mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
146 lines
6.4 KiB
Markdown
146 lines
6.4 KiB
Markdown
---
|
|
title: '[Deprecated] Import & Export'
|
|
---
|
|
import ApiRequest from '@site/src/components/ApiRequest'
|
|
|
|
:::info Availability
|
|
|
|
The import and export API first appeared in Unleash 3.3.0.
|
|
|
|
:::
|
|
|
|
:::caution Deprecation notice
|
|
|
|
Api admin state is deprecated from version 5. We recommend using the new [Environment Import & Export](https://docs.getunleash.io/reference/deploy/environment-import-export).
|
|
|
|
:::
|
|
|
|
Unleash supports import and export of feature toggles and strategies at startup and during runtime. The main purpose of the import/export feature is to bootstrap new Unleash instances with feature toggles and their configuration. If you are looking for a granular way to keep seperate Unleash instances in sync we strongly recommend that you take a look at the Unleash Admin APIs.
|
|
|
|
The import mechanism guarantees that:
|
|
- all imported features will be non-archived
|
|
- existing updates to strategies and features are included in the event history
|
|
|
|
All import mechanisms support a `drop` parameter which will clean the database before import (all strategies and features will be removed).
|
|
|
|
:::caution Dropping in production
|
|
Be careful when using the `drop` parameter in production environments: cleaning the database could lead to unintended loss of data.
|
|
:::
|
|
|
|
## Runtime import & export {#runtime-import--export}
|
|
|
|
### State Service {#state-service}
|
|
|
|
Unleash returns a StateService when started, you can use this to import and export data at any time.
|
|
|
|
```javascript
|
|
const unleash = require('unleash-server');
|
|
|
|
const { services } = await unleash.start({...});
|
|
const { stateService } = services;
|
|
|
|
const exportedData = await stateService.export({includeStrategies: false, includeFeatureToggles: true, includeTags: true, includeProjects: true});
|
|
|
|
await stateService.import({data: exportedData, userName: 'import', dropBeforeImport: false});
|
|
|
|
await stateService.importFile({file: 'exported-data.yml', userName: 'import', dropBeforeImport: true})
|
|
```
|
|
|
|
If you want the database to be cleaned before import (all strategies and features will be removed), set the `dropBeforeImport` parameter.
|
|
|
|
It is also possible to not override existing feature toggles (and strategies) by using the `keepExisting` parameter.
|
|
|
|
### API Export {#api-export}
|
|
|
|
The api endpoint `/api/admin/state/export` will export feature-toggles and strategies as json by default.
|
|
You can customize the export with query parameters:
|
|
|
|
| Parameter | Default | Description |
|
|
| --- | --- | --- |
|
|
| format | `json` | Export format, either `json` or `yaml` |
|
|
| download | `false` | If the exported data should be downloaded as a file |
|
|
| featureToggles | `true` | Include feature-toggles in the exported data |
|
|
| strategies | `true` | Include strategies in the exported data |
|
|
| tags | `true` | Include tagtypes, tags and feature_tags in the exported data |
|
|
| projects | `true` | Include projects in the exported data |
|
|
|
|
For example if you want to download just feature-toggles as yaml:
|
|
|
|
<ApiRequest verb="get" url="api/admin/state/export?format=yaml&featureToggles=1&strategies=0&tags=0&projects=0&download=1" title="Export features (and nothing else) as YAML."/>
|
|
|
|
### API Import {#api-import}
|
|
|
|
:::caution Importing environments in Unleash 4.19 and below
|
|
|
|
This is only relevant if you use **Unleash 4.19 or earlier**:
|
|
|
|
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).
|
|
|
|
You can customize the import with query parameters:
|
|
|
|
| Parameter | Default | Description |
|
|
| --- | --- | --- |
|
|
| drop | `false` | If the database should be cleaned before import (see comment below) |
|
|
| keep | `true` | If true, the existing feature toggles and strategies will not be override |
|
|
|
|
If you want the database to be cleaned before import (**all strategies and features will be removed**), specify a `drop` query parameter.
|
|
|
|
:::caution
|
|
|
|
You should be cautious about using the `drop` query parameter in production environments.
|
|
|
|
:::
|
|
|
|
Example usage:
|
|
|
|
<ApiRequest verb="post" url="api/admin/state/import" payload={{ "version": 3, "features": [{"name": "a-feature-toggle", "enabled": true, "description": "#1 feature-toggle"}] }} title="Import data into Unleash."/>
|
|
|
|
## Startup import {#startup-import}
|
|
|
|
You can import toggles and strategies on startup by using an import file in JSON or YAML format. As with other forms of imports, you can also choose to remove the current toggle and strategy configuration in the database before importing.
|
|
|
|
Unleash lets you do this both via configuration parameters and environment variables. The relevant parameters/variables are:
|
|
|
|
| config parameter | environment variable | default | value |
|
|
|--------------------|-----------------------------|---------|---------------------------------------------------------|
|
|
| `importFile` | `IMPORT_FILE` | none | path to the configuration file |
|
|
| `dropBeforeImport` | `IMPORT_DROP_BEFORE_IMPORT` | `false` | whether to clean the database before importing the file |
|
|
|
|
### Importing files
|
|
|
|
To import strategies and toggles from a file (called `configuration.yml` in the examples below), either
|
|
- use the `importFile` parameter to point to the file (you can also passed this into the `unleash.start()` entry point)
|
|
``` shell
|
|
unleash-server --databaseUrl [...] \
|
|
--importFile configuration.yml
|
|
```
|
|
|
|
- set the `IMPORT_FILE` environment variable to the path of the file before starting Unleash
|
|
|
|
``` shell
|
|
IMPORT_FILE=configuration.yml
|
|
```
|
|
|
|
### Drop before import
|
|
:::caution
|
|
You should never use this in production environments.
|
|
:::
|
|
|
|
To remove pre-existing feature toggles and strategies in the database before importing the new ones, either:
|
|
- add the `dropBeforeImport` flag to the `unleash-server` command (or to `unleash.start()`)
|
|
``` shell
|
|
unleash-server --databaseUrl [...] \
|
|
--importFile configuration.yml \
|
|
--dropBeforeImport
|
|
```
|
|
- set the `IMPORT_DROP_BEFORE_IMPORT` environment variable (note the leading `IMPORT_`) to `true`, `t`, or `1`. The variable is case-sensitive.
|
|
|
|
``` shell
|
|
IMPORT_DROP_BEFORE_IMPORT=true
|
|
```
|