-
Notifications
You must be signed in to change notification settings - Fork 302
feat: extend pass vault guide for secrets #2082
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
base: main
Are you sure you want to change the base?
Conversation
|
|
||
| ### 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. |
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.
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 🤔
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.
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.
| ::: 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
AI
Jan 26, 2026
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.
::: 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).
| ::: 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. |
| ### 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 | ||
| ``` | ||
|
|
Copilot
AI
Jan 26, 2026
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.
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).
| ### 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. |
|
|
||
| ### System-Managed Secret Restrictions | ||
|
|
||
| System-managed secrets are read-only and should not be modified or deleted. They are essential for: |
Copilot
AI
Jan 26, 2026
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.
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).
| 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: |
This pull request adds comprehensive documentation to the
secrets-vault-guide.mdfor 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:
Secret Maintenance & Cleanup:
Safety, Recovery & Support: