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
@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.

aadam-shopware and others added 4 commits February 3, 2026 10:28
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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