Skip to content

Commit 543b4c1

Browse files
TrayserCassarenaudhagerIsengo1989
authored
feat: add more info from questions raised by customers (#2213)
* feat: add more info from questions raised by customers * Update products/paas/shopware/monitoring/index.md Co-authored-by: Renaud Hager <renaudhager@users.noreply.github.com> * change/links-and-small-fix * fix: remove html tag --------- Co-authored-by: Renaud Hager <renaudhager@users.noreply.github.com> Co-authored-by: Micha <m.hobert@shopware.com>
1 parent b283062 commit 543b4c1

8 files changed

Lines changed: 117 additions & 7 deletions

File tree

products/paas/shopware/faq.md

Lines changed: 62 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ For now, no rollback is possible when you do a force push and lose your git hist
1515
No, all containers are stateless, and local file writes are discouraged. Persistent storage must use S3 buckets or other external storage solutions.
1616
Changes to the filesystem and Shopware code must be made directly in the Git repository.
1717

18+
## Is Shopware PaaS Native available on Azure or Google Cloud Platform?
19+
20+
No, Shopware PaaS Native currently runs on AWS only.
21+
1822
## How can I connect my already deployed application to a new branch?
1923

2024
The application that you create is linked to a commit SHA and not to a branch. You can change the existing application commit SHA by running `sw-paas application update`. What matters is the commit configured for a given application.
@@ -35,6 +39,10 @@ Yes. Follow the guide on [databases](./resources/databases.md).
3539

3640
No, the infrastructure is opinionated and pre-configured. Customizations at the server level are not allowed.
3741

42+
## Can I protect an application with basic auth?
43+
44+
Basic auth is not recommended because it can lead to unexpected behavior in the platform setup. To restrict access temporarily, use Shopware maintenance mode instead.
45+
3846
## Are CDN or database configurations customizable?
3947

4048
No, PaaS uses Fastly as the CDN and provides a fixed database configuration at the moment. Customizations to these resources are currently under development.
@@ -59,18 +67,70 @@ Custom applications and decoupled storefront hosting will be evaluated based on
5967
- `exec`: Best for debugging, maintenance, and interactive work
6068
- `command`: Best for automation, CI/CD, and scheduled tasks
6169

62-
## Can I connect to my PaaS instance via SSH
70+
## Can I connect to my PaaS instance via SSH?
6371

6472
Yes, you can connect to your PaaS instance — but not via traditional SSH. Instead, we provide a remote terminal session through the `sw-paas exec` CLI command. This command allows you to execute shell commands inside your PaaS environment remotely, effectively giving you SSH-like access for troubleshooting, deployments, or interactive sessions.
6573

6674
## Where can I see the status of my PaaS application update?
6775

6876
You can see the status of your PaaS application by running `sw-paas application list`. This command shows the current status of your application, including whether the update was successful or if it's still in progress. To monitor all real-time events associated with the project and its applications run `sw-paas watch` this provides a live stream of events and is especially useful for tracking the progress of an ongoing update.
6977

78+
## Are deployments zero downtime?
79+
80+
Yes. Deployments are designed to be zero downtime and use Kubernetes rolling updates.
81+
82+
## In what order do deployment steps run?
83+
84+
Database migrations run first. After that, the remaining deployment flow is handled by the [deployment helper](../../../guides/hosting/installation-updates/deployments/deployment-helper#execution-flow).
85+
86+
## Can I configure pre-deployment and post-deployment hooks?
87+
88+
Yes. Use the [deployment helper](../../../guides/hosting/installation-updates/deployments/deployment-helper#configuration) to define deployment hooks.
89+
90+
## Can I automate deployments from CI/CD?
91+
92+
Yes. The CLI supports non-interactive execution and machine-to-machine authentication with tokens, so you can trigger builds and deployments from your CI/CD system.
93+
94+
## Can my build contact external services?
95+
96+
Yes. Builds run as regular Docker builds and can contact external endpoints when required, for example configured Composer repositories.
97+
98+
## Are database copies anonymized when cloning an application?
99+
100+
No. Cloning restores an exact snapshot of the source application's database and filesystem data. Anonymization is not currently supported.
101+
102+
## How often does the scheduler run scheduled tasks?
103+
104+
The platform runs the scheduler every 5 minutes.
105+
106+
## Can I configure additional queues?
107+
108+
No. Creating additional queues is not currently supported.
109+
110+
## Are OpenSearch and Grafana protected by SSO?
111+
112+
No. Single sign-on for tools such as Grafana and OpenSearch is not available at this stage.
113+
114+
## Are Blackfire or Tideways included?
115+
116+
No. Tideways and Blackfire are not currently supported as part of the platform.
117+
118+
## Are load tests provided by Shopware PaaS Native?
119+
120+
No, managed load testing is not currently provided as part of the platform.
121+
122+
## How many projects or applications can I create?
123+
124+
The available number depends on the booked plan for your organization.
125+
126+
## How do I request infrastructure changes or support?
127+
128+
Infrastructure change requests and support requests are handled through the standard ticketing process. Agencies can coordinate those requests together with the customer. In some setups, a dedicated Slack channel may also be available for faster coordination.
129+
70130
## Why do I see “Runtime extension management is disabled” when trying to purchase extensions in the admin?
71131

72132
When trying to purchase an extension via the in-app store, the admin shows the error “Runtime extension management is disabled.” Even after setting runtime_extension_management: true in `config/packages/z-shopware.yaml` and deploying, the error will persist.
73133

74-
This behavior is intentional. Runtime extension management is deliberately disabled in the Shopware Admin UI when using PaaS due to its ephemeral nature, and cannot be enabled by changing the runtime_extension_management configuration.
134+
This behavior is intentional. Runtime extension management is deliberately disabled in the Shopware Admin UI when using PaaS due to its ephemeral nature and cannot be enabled by changing the runtime_extension_management configuration.
75135

76136
To use the in-app extension store, the `SwagExtensionStore` plugin must be installed via Composer. Once this extension is installed, the Shopware Admin can connect to the extension store and allow in-app purchases.

products/paas/shopware/fundamentals/applications.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@ Each application has its own compute resources, infrastructure, and deployment c
1212

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

15+
The number of projects and applications available to an organization depends on the booked plan.
16+
17+
## Default resource profile and scaling
18+
19+
Applications are provisioned with a default resource profile for the main Shopware workloads:
20+
21+
| Component | Default replicas | CPU request | Memory request | Memory limit |
22+
|--------------|------------------|-------------|----------------|--------------|
23+
| `storefront` | `2` | `50m` | `256Mi` | `2Gi` |
24+
| `admin` | `1` | `25m` | `128Mi` | `2Gi` |
25+
| `worker` | `1` | `50m` | `256Mi` | `1Gi` |
26+
27+
Horizontal scaling is the primary scaling mechanism in Shopware PaaS Native.
28+
29+
Resource limits above the default profile depend on the booked plan, with some flexibility for scaling within that scope.
30+
1531
## Creating an Application
1632

1733
Create a new application to a project:
@@ -34,6 +50,10 @@ This command initiates the build process, packaging your application and prepari
3450
sw-paas application build logs
3551
```
3652

53+
Builds run as regular Docker builds. External network requests are allowed during the build when your project requires them, for example to reach configured Composer repositories or other external package sources.
54+
55+
If your build needs credentials or other sensitive values, provide them through [Vault secrets](./secrets.md) using `buildenv` or by using `BUILD`-scoped environment variables where appropriate.
56+
3757
## Update your application
3858

3959
To update your application, you need to run the following command and provide the commit SHA:
@@ -44,6 +64,18 @@ sw-paas application update
4464

4565
This command initiates the build process, waits until it's done, and runs the deployment for you.
4666

67+
## Deployment behavior
68+
69+
Deployments are designed to be zero downtime and use Kubernetes rolling updates.
70+
71+
During deployment, database migrations run first. After that, the remaining deployment flow is handled by the [deployment helper](../../../../guides/hosting/installation-updates/deployments/deployment-helper#execution-flow).
72+
73+
This works well for regular Shopware deployments because breaking database changes are expected only during major Shopware upgrades. When upgrading across major versions, make sure your deployment remains backward compatible throughout the rollout.
74+
75+
Pre-deployment and post-deployment hooks are supported through the [deployment helper configuration](../../../../guides/hosting/installation-updates/deployments/deployment-helper#configuration).
76+
77+
Automated deployments from CI/CD are supported. The CLI can run in non-interactive mode and supports machine-to-machine authentication with tokens.
78+
4779
## Deploy a specific build of your application
4880

4981
To create a deployment with a specific build, use the following command:
@@ -71,7 +103,7 @@ sw-paas application deploy get
71103

72104
## Plugin Management
73105

74-
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.
106+
Plugin management is done [via Composer](../../../../guides/hosting/installation-updates/extension-management#installing-extensions-with-composer) because the platform runs in a high-availability and clustered environment.
75107

76108
In such setups, local changes aren't feasible, as all instances must remain identical and stateless. This ensures consistency across all deployments.
77109

products/paas/shopware/fundamentals/organization.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ nav:
66

77
# Organizations
88

9-
An organization serves as the top-level container representing a company or an entity in Shopware PaaS Native. It acts as the primary organizational unit that encompasses all resources, projects, and users associated with a particular business entity. By default, the initial admin user is added to an Organization and can further add more users.
9+
An organization serves as the top-level logical unit representing a company or an entity in Shopware PaaS Native. It acts as the primary organizational unit that encompasses all resources, projects, and users associated with a particular business entity. By default, the initial admin user is added to an Organization and can further add more users.
10+
11+
Organizations are long-lived logical units and do not expire automatically.
1012

1113
To create additional organizations via CLI, run;
1214

@@ -18,6 +20,8 @@ sw-paas organization create
1820

1921
Organization members are users who have been granted access to an organization and its resources.
2022

23+
Access control within an organization is managed by organization administrators through role assignments.
24+
2125
### Roles
2226

2327
Organization members can be assigned different roles that determine their level of access and permissions:

products/paas/shopware/get-started/prepare-codebase.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ Additionally, before installation, verify that each plugin supports **S3-based s
2020

2121
## How to uninstall plugins
2222

23-
To uninstall plugins in the PaaS environment, use the [Deployment Helper](../../../../guides/hosting/installation-updates/deployments/deployment-helper.html#removal-of-extensions) which provides a streamlined process for extension management.
23+
To uninstall plugins in the PaaS environment, use the [Deployment Helper](../../../../guides/hosting/installation-updates/deployments/deployment-helper#removal-of-extensions) which provides a streamlined process for extension management.
2424

2525
The uninstallation process involves two steps:
2626

2727
1. **Set the extension to remove**: Configure the extension state as `remove` in your `.shopware-project.yml` file and deploy the changes to uninstall the extension.
2828

2929
2. **Remove from source code**: After the deployment, remove the extension from your source code and deploy again.
3030

31-
For detailed instructions and configuration examples, refer to the [Removal of extensions](../../../../guides/hosting/installation-updates/deployments/deployment-helper.html#removal-of-extensions) section in the Deployment Helper documentation.
31+
For detailed instructions and configuration examples, refer to the [Removal of extensions](../../../../guides/hosting/installation-updates/deployments/deployment-helper#removal-of-extensions) section in the Deployment Helper documentation.
3232

3333
## Generating the required files
3434

products/paas/shopware/guides/clone-application.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,10 @@ The cloning process happens in two stages:
8989

9090
This ensures that the target application receives an exact copy of the source application's state at the time of the selected deployment.
9191

92+
:::warning
93+
Cloning does not anonymize database content. The restored snapshot includes the full database state and filesystem data from the source application, including scheduled task data stored in the database.
94+
:::
95+
9296
### Monitor clone progress
9397

9498
After initiating the clone, you can monitor the progress using:

products/paas/shopware/monitoring/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,9 @@ nav:
77
# Monitoring
88

99
Shopware PaaS Native provides comprehensive monitoring capabilities to help you track the health and performance of your applications. With built-in monitoring tools, you can observe your application's behavior, troubleshoot issues, and ensure optimal performance in your cloud environment. This section introduces 3 key components used in monitoring: Logs, Traces and Events.
10+
11+
Grafana access is currently provided through credentials returned by the CLI via the `sw-paas open grafana` command. Single sign-on for Grafana and similar tools is not available at this stage.
12+
13+
Application performance monitoring tools such as Tideways or Blackfire are not currently supported as part of the platform, but we are working on it.
14+
15+
Shopware PaaS Native does not currently provide managed load testing as part of the platform.

products/paas/shopware/resources/databases.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ To connect to your database via CLI:
1818
sw-paas open service --service database --port 3306
1919
```
2020

21+
Database access is provided through the CLI tunnel. Direct public database exposure is not supported.
22+
2123
### Note
2224

2325
Please check the [known issues](../known-issues.md) regarding network considerations when running this command.

products/paas/shopware/resources/object-storage.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ nav:
1010

1111
Applications in Shopware PaaS Native are created by default with two S3-compatible object storage buckets. A public bucket and a private bucket.
1212

13-
You can learn more about [shopware filesystem here](../../../../guides/hosting/infrastructure/filesystem.md).
13+
Shopware filesystem is configured to use S3-compatible object storage by default for new applications. This storage setup is part of the platform design and should not be changed later.
14+
15+
You can learn more about the Shopware filesystem [here](../../../../guides/hosting/infrastructure/filesystem.md).

0 commit comments

Comments
 (0)