Skip to content

Conversation

@aadam-shopware
Copy link
Contributor

This pull request adds comprehensive documentation to the secrets-vault-guide.md for Shopware PaaS, clarifying the distinction between system-managed and user-managed secrets, safe handling practices, and maintenance guidelines. It introduces best practices for secret management, details on permissions, and steps for recovery and support, helping users avoid common pitfalls and platform outages.

Secret Management & Ownership:

  • Added detailed explanations distinguishing system-managed secrets (critical for platform operation and not user-editable) from user-managed secrets, with a reference table describing common secrets, their purpose, and editability.
  • Included clear warnings and best practices to prevent deletion or modification of system-managed secrets, outlining the consequences and escalation steps if issues arise.

Secret Maintenance & Cleanup:

  • Provided a recommended process for auditing, backing up, and deleting unused or legacy secrets, including how to handle typo or deprecated secrets.
  • Added instructions for filtering secrets by application and maintaining documentation of secret ownership and usage.

Safety, Recovery & Support:

  • Outlined safety measures such as regular backups, credential rotation, and limiting access, along with step-by-step guidance for recovering from accidental deletions.
  • Documented the escalation process for unresolved issues, including what

@aadam-shopware aadam-shopware marked this pull request as ready for review January 26, 2026 08:59

### System-Managed vs. User-Managed Secrets

**System-managed secrets** are automatically created and maintained by Shopware PaaS for internal operations. While these secrets are visible when you run `sw-paas vault list`, they should not be modified or deleted as they are critical for platform functionality.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why can the user see them and delete them if they are system managed. we should just have here an list of environment variables which cannot be set because we set them 🤔

@Isengo1989 Isengo1989 added the Improvement PR created to append/modify info in the existing article label Jan 26, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Extends the Shopware PaaS Vault guide with additional documentation around secret ownership (system-managed vs user-managed), safe maintenance/cleanup practices, and recovery/support guidance.

Changes:

  • Added a “Default Secrets & Ownership” section including a reference table and guidance on identifying system-managed secrets.
  • Added operational guidance for permissions/behavior, housekeeping of legacy/typo secrets, and recovery/escalation steps.
  • Updated the spelling wordlist to include “NATS”.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
products/paas/shopware/guides/secrets-vault-guide.md Adds extended documentation for secret ownership, maintenance, safety, and recovery.
.wordlist.txt Adds “NATS” to the repository wordlist.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +170 to +171
::: warning Important
Shopware PaaS does not maintain version history for secrets. Once a secret is modified or deleted, the previous value cannot be recovered through the platform.
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

::: warning Important uses a title-style admonition syntax that isn't used elsewhere in this docs repo (other pages consistently use ::: warning / ::: info without an inline title, e.g. products/paas/shopware/fundamentals/secrets.md:49). This may render incorrectly or break the docs build depending on the markdown plugin. Use the same admonition syntax as the rest of the docs (e.g. ::: warning and move “Important” into the body text).

Suggested change
::: warning Important
Shopware PaaS does not maintain version history for secrets. Once a secret is modified or deleted, the previous value cannot be recovered through the platform.
::: warning
**Important:** Shopware PaaS does not maintain version history for secrets. Once a secret is modified or deleted, the previous value cannot be recovered through the platform.

Copilot uses AI. Check for mistakes.
Comment on lines +130 to +145
### Filtering Secrets by Application

By default, `sw-paas vault list` shows secrets across all applications in your organization, which can lead to duplicate entries if multiple apps use the same secret names.

To view secrets for a specific application:

```sh
sw-paas vault list --application-id YOUR-APP-ID
```

To find your application ID:

```sh
sw-paas application list
```

Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section states that sw-paas vault list shows secrets "across all applications" and suggests filtering with --application-id. However, the existing Shopware PaaS docs describe Vault secrets as organization-global and reusable across applications (products/paas/shopware/fundamentals/secrets.md:11–12), which conflicts with the idea of per-application filtering. Please align the wording with the actual Vault scope/CLI behavior (either clarify what “application” means here or remove/adjust the --application-id filtering guidance if secrets aren’t app-scoped).

Suggested change
### Filtering Secrets by Application
By default, `sw-paas vault list` shows secrets across all applications in your organization, which can lead to duplicate entries if multiple apps use the same secret names.
To view secrets for a specific application:
```sh
sw-paas vault list --application-id YOUR-APP-ID
```
To find your application ID:
```sh
sw-paas application list
```
### Understanding Organization-wide Secrets
The `sw-paas vault list` command shows all secrets stored in your organization’s Vault. Because secrets are organization-global and reusable, the same secret values can be referenced by multiple applications using the same secret name.
If multiple applications in your organization use a secret with the same name, they are all referring to the same underlying Vault secret, not separate per-application copies.
This means you manage each secret once at the organization level, and then reference it from the applications that need it.

Copilot uses AI. Check for mistakes.

### System-Managed Secret Restrictions

System-managed secrets are read-only and should not be modified or deleted. They are essential for:
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The doc describes system-managed secrets as "read-only" (implying the platform prevents edits/deletes) but also warns that deleting them will cause outages. This is internally inconsistent. Please clarify whether deletion/editing is technically blocked by the platform/CLI, or whether it’s possible but forbidden/unsupported (and adjust wording accordingly).

Suggested change
System-managed secrets are read-only and should not be modified or deleted. They are essential for:
System-managed secrets must be treated as read-only and must not be modified or deleted via the CLI, UI, or API. The platform does not technically prevent you from changing or removing these secrets, but doing so is unsupported and will break critical platform functionality. They are essential for:

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Improvement PR created to append/modify info in the existing article

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants