TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-04-24 05:51:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: correct import and export documentation (#4137)

Browse Source
This commit is contained in:
Stefan Benz 2022-08-08 12:02:15 +02:00 committed by GitHub
parent 52f098e6ad
commit a7d63271bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/docs/guides/integrate/export-and-import.md
View File

@ -12,20 +12,18 @@ Currently, this doesn't include the following points:
* Global IDPs * Global IDPs
* Global second/multi factors * Global second/multi factors
* Machine keys * Machine keys
* PAT's * Personal Access Tokens
* Application keys * Application keys
* Passwordless authentication
Which results in that if you want to import, and you have no defined organization-specific custom policies, the experience for your users will not be exactly like in your old instance. Which results in that if you want to import, and you have no defined organization-specific custom policies, the experience for your users will not be exactly like in your old instance.
```suggestion
::note Note that the ressources will be migrated without the event stream. This means that you will not have the audit trail for the imported objects. :::note
Note that the resources will be migrated without the event stream. This means that you will not have the audit trail for the imported objects.
*** With this export and import the current audit trail is not included, the resources will be newly created *** :::
### Export from V1 to import into V2 directly ### Export from V1 to import into V2 directly
***To use this requests you have to have an access token with enough permissions to export and import.***
To export all necessary data you only have to use one request, as an example: To export all necessary data you only have to use one request, as an example:
```bash ```bash
@ -50,7 +48,9 @@ curl --request POST \
* "timeout": timeout of the call to export the data * "timeout": timeout of the call to export the data
* "response_output": to output the export as response to the call * "response_output": to output the export as response to the call
***To import the exported data into you new instance, you have to have an already existing instance on a ZITADEL V2, with all desired configuration and global resources.*** :::note
To import the exported data into you new instance, you have to have an already existing instance on a ZITADEL V2, with all desired configuration and global resources.
:::
Then as an example you can use one request for the import: Then as an example you can use one request for the import:
@ -66,9 +66,10 @@ curl --request POST \
## Export from V1 to Import into V2 thorugh GCS ## Export from V1 to Import into V2 thorugh GCS
***To use this requests you have to have an access token with enough permissions to export and import.*** :::note
To use this requests you have to have an access token with enough permissions to export and import.
***The used serviceaccount has to have at least the role "Storage Object Creator" to create objects on GCS*** The used serviceaccount has to have at least the role "Storage Object Creator" to create objects on GCS
:::
To export all necessary data you only have to use one request which results in a file in your GCS, as an example: To export all necessary data you only have to use one request which results in a file in your GCS, as an example:
@ -100,9 +101,10 @@ curl --request POST \
* "bucket": used bucket for output on GCS * "bucket": used bucket for output on GCS
* "serviceaccount_json": base64-encoded serviceaccount.json used to output the file on GCS * "serviceaccount_json": base64-encoded serviceaccount.json used to output the file on GCS
***To import the exported data into you new instance, you have to have an already existing instance on a ZITADEL V2, with all desired configuration and global resources.*** :::note
To import the exported data into you new instance, you have to have an already existing instance on a ZITADEL V2, with all desired configuration and global resources.
***The used serviceaccount has to have at least the role "Storage Object Viewer" to create objects on GCS*** The used serviceaccount has to have at least the role "Storage Object Viewer" to read objects from GCS
:::
Then as an example you can use one request for the import: Then as an example you can use one request for the import: