Skip to content

Commit aada633

Browse files
mariekirschpwizla
andauthored
Data transfer between Cloud environments (#2891)
* data transfer content update * Reformat section --------- Co-authored-by: Pierre Wizla <[email protected]>
1 parent be87541 commit aada633

File tree

4 files changed

+56
-0
lines changed

4 files changed

+56
-0
lines changed

docusaurus/docs/cloud/projects/settings.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,7 @@ The <Icon name="faders" /> *Configuration* tab for the environment-level setting
309309
- the Node version of the environment: to change the Node version of the project (see [Modifying Node version](#modifying-node-version)).
310310
- the app's internal name for the environment, which can be useful for debug & support purposes.
311311
- *Connected branch*: to change the branch of the GitHub repository used for your environment (see [Editing Git branch](#editing-git-branch)). Also allows to enable/disable the "deploy on push" option.
312+
- *Environment data*: to transfer data from another environment within the same project (see [Transferring data between environments](#transferring-data-between-environments)).
312313
- *Danger zone*: to reset or permanently delete your Strapi Cloud project's environment (see [Resetting & Deleting environment](#resetting--deleting-environment)).
313314

314315
<ThemedImage
@@ -344,6 +345,33 @@ Ensure the Node version configured in your Strapi project matches the Node versi
344345

345346
3. Click on the **Save & deploy** button for the changes to take effect.
346347

348+
#### Transferring data between environments {#transferring-data-between-environments}
349+
<CloudProBadge /> <CloudScaleBadge />
350+
351+
The data transfer feature allows you to transfer the entire CMS content (database and assets) from one environment to another within the same Strapi Cloud project. This is useful for testing changes in a secondary environment with up-to-date production data, or for preparing and staging content in a secondary environment before taking it to production.
352+
353+
Transferring data between environments currently comes with the following limitations:
354+
355+
- You can only transfer toward a secondary environment (not the production environment).
356+
- Only project owners can initiate and manage ongoing transfers.
357+
- Transfers cannot be initiated on projects that are suspended.
358+
359+
:::caution Data transfers are destructive
360+
Transferring data to an environment will permanently overwrite all existing data and assets in the target environment. The source environment's data remains unaffected, and its CMS can be accessed during the transfer. Environment settings (such as variables and domains) are not affected by the transfer.
361+
:::
362+
363+
To transfer data to a secondary environment:
364+
365+
1. Create and deploy both the source and target [environments](#environments).
366+
1. In the *Environment data* section of the <Icon name="faders" /> *Configuration* tab, click on the **Import data** button.
367+
2. In the modal that opens, select the source environment from the dropdown list. Only fully created and deployed environments are available as sources.
368+
3. Click on **Import data** to proceed, and follow the steps to confirm the transfer.
369+
4. Once initiated, you will be redirected to the environment's dashboard where you can monitor the transfer's progress. Once the transfer is completed, the dashboard will refresh, showing both the ongoing and historic deployments.
370+
371+
:::note
372+
The CMS of the target environment will be inaccessible whilst the transfer is ongoing. You can cancel an ongoing transfer, but this will leave the target environment empty. If an error occurs during the transfer, you will have the option to retry or cancel.
373+
:::
374+
347375
#### Resetting & Deleting environment
348376

349377
You can reset or delete any additional environment of your Strapi Cloud project, but it will be permanent and irreversible. The default, production environment, can however not be neither reset nor deleted.
54.3 KB
Loading
53.1 KB
Loading

docusaurus/static/llms-full.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1163,6 +1163,7 @@ The *Configuration* tab for the environment-level settings enables you to check
11631163
- the Node version of the environment: to change the Node version of the project (see [Modifying Node version](#modifying-node-version)).
11641164
- the app's internal name for the environment, which can be useful for debug & support purposes.
11651165
- *Connected branch*: to change the branch of the GitHub repository used for your environment (see [Editing Git branch](#editing-git-branch)). Also allows to enable/disable the "deploy on push" option.
1166+
- *Environment data*: to transfer data from another environment within the same project (see [Transferring data between environments](#transferring-data-between-environments)).
11661167
- *Danger zone*: to reset or permanently delete your Strapi Cloud project's environment (see [Resetting & Deleting environment](#resetting--deleting-environment)).
11671168

11681169
#### Modifying Node version
@@ -1189,6 +1190,33 @@ Ensure the Node version configured in your Strapi project matches the Node versi
11891190

11901191
3. Click on the **Save & deploy** button for the changes to take effect.
11911192

1193+
#### Transferring data between environments {#transferring-data-between-environments}
1194+
1195+
The data transfer feature allows you to transfer the entire CMS content (database and assets) from one environment to another within the same project. This is useful for testing changes in a secondary environment with up-to-date production data, or for preparing and staging content in a secondary environment before taking it to production.
1196+
1197+
This feature currently comes with the following limitations:
1198+
1199+
- The feature is only available for transfers toward a secondary environment (not the production environment).
1200+
- Only project owners can initiate and manage ongoing transfers.
1201+
- Transfers cannot be initiated on projects that are suspended.
1202+
1203+
:::caution Data transfers are destructive
1204+
Transferring data to an environment will permanently overwrite all existing data and assets in the target environment. The source environment's data remains unaffected, and its CMS can be accessed during the transfer. Environment settings (such as variables and domains) are not affected by the transfer.
1205+
:::
1206+
1207+
:::prerequisites
1208+
- The source and target environments must be fully created and deployed.
1209+
:::
1210+
1211+
1. In the *Environment data* section of the *Configuration* tab, click on the **Import data** button.
1212+
2. In the modal that opens, select the source environment from the dropdown list. Only fully created and deployed environments are available as sources.
1213+
3. Click on **Import data** to proceed, and follow the steps to confirm the transfer.
1214+
4. Once initiated, you will be redirected to the environment's dashboard where you can monitor the transfer's progress. Once the transfer is completed, the dashboard will refresh, showing both the ongoing and historic deployments.
1215+
1216+
:::note
1217+
The CMS of the target environment will be inaccessible whilst the transfer is ongoing. You can cancel an ongoing transfer, but this will leave the target environment empty. If an error occurs during the transfer, you will have the option to retry or cancel.
1218+
:::
1219+
11921220
#### Resetting & Deleting environment
11931221

11941222
You can reset or delete any additional environment of your Strapi Cloud project, but it will be permanent and irreversible. The default, production environment, can however not be neither reset nor deleted.

0 commit comments

Comments
 (0)