Skip to content

Commit d0cf985

Browse files
renaudhagerTrayserCassatombojerIsengo1989Copilot
authored
Updated PaaS native application document section (#1945)
* Updated PaaS native application document section * Update docs for new paas-cli * Described possible shopware paas native event types * Fix typo * Update products/paas/shopware/monitoring/watch.md Co-authored-by: Copilot <[email protected]> * Update products/paas/shopware/fundamentals/applications.md Co-authored-by: Copilot <[email protected]> * Update products/paas/shopware/fundamentals/applications.md Co-authored-by: Copilot <[email protected]> * fix/markdown * fix/small-grammar-issues --------- Co-authored-by: Patrick Derks <[email protected]> Co-authored-by: Tom Bojer <[email protected]> Co-authored-by: Micha Hobert <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent f3bf8f2 commit d0cf985

File tree

3 files changed

+82
-9
lines changed

3 files changed

+82
-9
lines changed

products/paas/shopware/fundamentals/applications.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ Shopware PaaS Native supports multiple applications within a project, such as en
1010

1111
Each application has its own compute resources, infrastructure, and deployment configuration, so you can tailor each environment to its specific needs.
1212

13-
For instance, you might allocate smaller, hibernating compute instances for staging, while reserving larger, always-on resources for production.
13+
For instance, you might allocate smaller, hibernating compute instances for staging while reserving larger, always-on resources for production.
1414

1515
## Creating an Application
1616

17-
Deploy a new application to a project:
17+
Create a new application to a project:
1818

1919
```sh
2020
sw-paas application create
2121
```
2222

23-
## Build and Deployments
23+
## Build your application
2424

2525
To trigger a new build for the application via CLI, use the following command:
2626

@@ -34,6 +34,41 @@ This command initiates the build process, packaging your application and prepari
3434
sw-paas application build logs
3535
```
3636

37+
## Update your application
38+
39+
To update your application, you need to run the following command and provide the commit SHA:
40+
41+
```sh
42+
sw-paas application update
43+
```
44+
45+
This command initiates the build process, waits until it's done, and runs the deployment for you.
46+
47+
## Deploy a specific build of your application
48+
49+
To create a deployment with a specific build, use the following command:
50+
51+
```sh
52+
sw-paas application deploy create
53+
```
54+
55+
It will let you choose which build you want to deploy.
56+
This is very handy, since you can choose any successful build to deploy: the latest one to bring your change live, or a previous one to fix an issue that arose.
57+
58+
## Deployments management
59+
60+
To list all past deployments:
61+
62+
```sh
63+
sw-paas application deploy list
64+
```
65+
66+
To get details about a given deployment:
67+
68+
```sh
69+
sw-paas application deploy get
70+
```
71+
3772
## Plugin Management
3873

3974
Plugin management is done [via Composer](../../../../guides/hosting/installation-updates/extension-managment#installing-extensions-with-composer) because the platform runs in a high-availability and clustered environment.
@@ -112,16 +147,14 @@ cdn.shopware.shop
112147

113148
This configuration ensures that all traffic to your custom domain is routed through the Fastly CDN for optimal performance and caching.
114149

115-
#### Application Updates
150+
#### Application Deployment
116151

117152
Following domain creation, you must redeploy your application. You can do it by using:
118153

119154
```sh
120-
sw-paas application build start
155+
sw-paas application deploy create
121156
```
122157

123-
This process will be automated in future releases.
124-
125158
#### Shopware Configuration
126159

127160
Subsequently, you can configure the domain within Shopware and associate it with a storefront. Status update functionality is currently under development and should be considered a beta feature.

products/paas/shopware/get-started/quickstart.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,20 @@ Initialize a new PaaS project:
7171
sw-paas project create --name "my-shopware-app" --repository "[email protected]:username/repo.git"
7272
```
7373

74-
## Step 4: Deploy an Application Instance of the project
74+
## Step 4: Create and deploy an Application Instance of the project
7575

76-
Deploy your application. Choose your earlier created project:
76+
Create your application:
7777

7878
```sh
7979
sw-paas application create
8080
```
8181

82+
Then, deploy your application:
83+
84+
```sh
85+
sw-paas application deploy create
86+
```
87+
8288
Monitor the deployment progress:
8389

8490
```sh

products/paas/shopware/monitoring/watch.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,37 @@ Common event types include:
4242
- `EVENT_TYPE_DEPLOYMENT_FINISHED` - When a deployment completes
4343

4444
The event stream will continue running until you stop it with `Ctrl+C`. All events are displayed in real-time with timestamps and detailed information about what's happening in your project.
45+
46+
## Understanding different Event Types
47+
48+
Events are generally linked to a preceding action.
49+
Each action is connected to a specific event type, which is emitted when a state change occurs.
50+
The type of each event is indicated in the output of the `sw-paas watch` command and can help to understand what is happening in your project.
51+
52+
Especially for deployments, the history of the events can be used to understand what happened during a deployment.
53+
To list all events of a specific deployment, use the following command:
54+
55+
```bash
56+
sw-paas application deploy get
57+
```
58+
59+
The output of the `DEPLOYMENT STATUS HISTORY` shows all events that were emitted during the deployment.
60+
This contains events from the underlying PaaS infrastructure as well as events from the shop itself.
61+
62+
The following table lists the most common event types and their descriptions:
63+
64+
| Event | Description |
65+
|-------|-------------|
66+
| `UNSPECIFIED` | Default or unspecified deployment status |
67+
| `PENDING` | Deployment is queued and waiting to start |
68+
| `BASE` | Infrastructure: Base infrastructure components are being deployed |
69+
| `BASE_FAILED` | Infrastructure: Base infrastructure deployment has failed |
70+
| `BASE_SUCCESS` | Infrastructure: Base infrastructure deployment completed successfully |
71+
| `SHOP` | Infrastructure: Shop-specific infrastructure components are being deployed |
72+
| `SHOP_FAILED` | Infrastructure: Shop infrastructure deployment has failed |
73+
| `SHOP_SUCCESS` | Infrastructure: Shop infrastructure deployment completed successfully |
74+
| `DEPLOYING_STORE` | Store: Shopware store application is being deployed |
75+
| `DEPLOYING_STORE_FAILED` | Store: Shopware store deployment has failed |
76+
| `DEPLOYING_STORE_SUCCESS` | Store: Shopware store deployment completed successfully |
77+
| `DEPLOYMENT_SUCCESS` | Complete deployment finished successfully |
78+
| `DEPLOYMENT_FAILED` | Complete deployment has failed |

0 commit comments

Comments
 (0)