-
Notifications
You must be signed in to change notification settings - Fork 302
feat: add docs for app cloning #2116
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Christos Vontas (cv711)
wants to merge
2
commits into
main
Choose a base branch
from
feat/app-cloning-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+109
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| --- | ||
| nav: | ||
| title: Clone Application | ||
| position: 70 | ||
| --- | ||
|
|
||
| # Guide: Clone Application in PaaS Native | ||
|
|
||
| This guide explains how to clone an application in Shopware PaaS Native. Cloning creates a copy of an existing application, including its codebase and data, to a new application within the same organization. | ||
|
|
||
| **Important**: Cloning can only take place between applications within the same organization. You cannot clone applications across different organizations. | ||
|
|
||
| The cloning process works by creating a snapshot of the source application and then restoring that snapshot to the target application. | ||
|
|
||
| ## Use Cases | ||
|
|
||
| Common scenarios for cloning applications include: | ||
|
|
||
| - **Feature testing**: Clone an application to test new features without affecting the original | ||
| - **Disaster recovery**: Create backups by cloning applications to different projects | ||
| - **Development environments**: Clone production data to development environments for realistic testing | ||
|
|
||
| ## Pre-requisite | ||
|
|
||
| Before cloning an application, ensure that: | ||
|
|
||
| - Both the source and target applications are within the same organization | ||
| - You have access to both the source and target projects | ||
| - The target application already exists (or you have permissions to create it) | ||
| - The latest deployment of the source application was successful (state: `DEPLOYING_STORE_SUCCESS`) | ||
|
|
||
| You can check the deployment status with the following command: | ||
|
|
||
| ```shell | ||
| sw-paas app deploy list | ||
| ``` | ||
|
|
||
| If the state is `DEPLOYING_STORE_FAILED`, you should **NOT** proceed with cloning. Fix the deployment issues first or proceed with an earlier deployment that was successful. | ||
|
|
||
| ## Clone Process | ||
|
|
||
| ### Interactive Mode | ||
|
|
||
| If you run the clone command without any parameters, the CLI will guide you through an interactive selection process: | ||
|
|
||
| ```shell | ||
| sw-paas application clone | ||
| ``` | ||
|
|
||
| The interactive mode will prompt you to select: | ||
|
|
||
| 1. **Source application selection**: | ||
| - Organization (if you have access to multiple) | ||
| - Project within the organization | ||
| - Application within the project | ||
| - Deployment | ||
|
|
||
| 2. **Target application selection**: | ||
| - Project within the same organization (only projects from the selected organization will be shown) | ||
| - Application within the project (the target application must already exist) | ||
|
|
||
| This interactive mode is recommended if you're unsure about the specific IDs or prefer a guided experience. | ||
|
|
||
| ### Manual Mode | ||
|
|
||
| If you know the specific IDs, you can provide them directly as command-line flags: | ||
|
|
||
| ```shell | ||
| sw-paas application clone \ | ||
| --organization-id <organization-id> \ | ||
| --project-id <source-project-id> \ | ||
| --application-id <source-application-id> \ | ||
| --target-application-id <target-application-id> \ | ||
| --target-project-id <target-project-id> | ||
| ``` | ||
|
|
||
| ### How Cloning Works | ||
|
|
||
| The cloning process happens in two stages: | ||
|
|
||
| 1. **Snapshot creation**: The system creates a snapshot of the source application, including its database and filesystem data | ||
| 2. **Snapshot restoration**: The snapshot is then restored to the target application, overwriting any existing data | ||
|
|
||
| This ensures that the target application receives an exact copy of the source application's state at the time of the selected deployment. | ||
|
|
||
| ### Monitor Clone Progress | ||
|
|
||
| After initiating the clone, you can monitor the progress using: | ||
|
|
||
| ```shell | ||
| sw-paas app deploy list | ||
| ``` | ||
|
|
||
| Or get detailed information about a specific deployment: | ||
|
|
||
| ```shell | ||
| sw-paas app deploy get | ||
| ``` | ||
|
|
||
| The clone operation may take some time depending on the size of the application data. Wait until the deployment status shows `DEPLOYING_STORE_SUCCESS` before considering the clone complete. | ||
|
|
||
| ## Post-Clone Tasks | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think here we should be explicit about at least these 2 tasks:
|
||
|
|
||
| After the clone is successfully completed, you may need to: | ||
|
|
||
| 1. **Update application configuration**: Review and adjust any environment-specific settings in the cloned application | ||
| 2. **Configure domains**: Set up custom domains for the cloned application if needed | ||
| 3. **Update secrets**: Ensure all necessary secrets and environment variables are configured for the new application | ||
| 4. **Test the cloned application**: Verify that the cloned application is working correctly before using it in production | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Section heading uses nonstandard hyphenation and singular form. Consider changing "Pre-requisite" to "Prerequisites" (matches other docs like get-started/cli.md and fits the multiple items listed).