Skip to content

Commit

Permalink
feat: add documentation for changes to import/export functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
yquansah committed Sep 28, 2023
1 parent 1b8f788 commit 271c45d
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion operations/import-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ For convenience, you can supply `--create-namespace` in order for Flipt to autom
flipt import --namespace production --create-namespace flipt.yaml
```

<Note>
In [v1.28.0](https://github.com/flipt-io/flipt/releases/tag/v1.28.0), we introduced some breaking changes to `import`.

You no longer have to use the `--namespace` or `--create-namespace` flags to import resources into a specific namespace.

Check failure on line 56 in operations/import-export.mdx

View workflow job for this annotation

GitHub Actions / lint

Delete `··`

The namespaces are now inferred from the YAML documents themselves. If a namespace your document refers to does not exist in the database, it will be created.

Check failure on line 58 in operations/import-export.mdx

View workflow job for this annotation

GitHub Actions / lint

Replace `··The·namespaces·are·now·inferred·from·the·YAML·documents·themselves.·If·a·namespace·your·document·refers·to·does·not·exist·in·the·database,·it·will·be·created.` with `The·namespaces·are·now·inferred·from·the·YAML·documents·themselves.·If·a·namespace·your·document·refers·to·does·not·exist·in·the·database,·it·will·be·created.⏎`
</Note>

This command supports the `--drop` flag that will drop all of the data in your
Flipt database tables before importing. This is to ensure that no data
collisions occur during the import.
Expand Down Expand Up @@ -79,7 +87,6 @@ flags:
name: Blue
- key: green
name: Green

```
You can also export to a file using the `-o filename` or `--output filename`
Expand All @@ -95,3 +102,13 @@ Use the flag `--namespace` to export from a different namespace.
```yaml
flipt export --namespace production
```

<Note>
In [v1.28.0](https://github.com/flipt-io/flipt/releases/tag/v1.28.0), we have extended this functionality to support exporting state from multiple namespaces to a single YAML file.

The `--namespace` flag is now deprecated, and two new flags now exist.

Check failure on line 109 in operations/import-export.mdx

View workflow job for this annotation

GitHub Actions / lint

Delete `··`

The `--namespaces` flag will accept a comma delimited list of namespaces from which you would like to export from.

Check failure on line 111 in operations/import-export.mdx

View workflow job for this annotation

GitHub Actions / lint

Delete `··`

The `--all-namespaces flag is a boolean flag which tells export to export all namespaces to the single file you specify, or to standard out by default.

Check failure on line 113 in operations/import-export.mdx

View workflow job for this annotation

GitHub Actions / lint

Replace `··The·`--all-namespaces·flag·is·a·boolean·flag·which·tells·export·to·export·all·namespaces·to·the·single·file·you·specify,·or·to·standard·out·by·default.` with `The·`--all-namespaces·flag·is·a·boolean·flag·which·tells·export·to·export·all·namespaces·to·the·single·file·you·specify,·or·to·standard·out·by·default.⏎`
</Note>

0 comments on commit 271c45d

Please sign in to comment.