Skip to content

docs: highlight cloud KMS integration support for patch signing#489

Open
eseidel wants to merge 17 commits intomainfrom
docs/cloud-signing-cta
Open

docs: highlight cloud KMS integration support for patch signing#489
eseidel wants to merge 17 commits intomainfrom
docs/cloud-signing-cta

Conversation

@eseidel
Copy link
Contributor

@eseidel eseidel commented Feb 6, 2026

Summary

  • Add comprehensive cloud KMS integration documentation with --public-key-cmd and --sign-cmd options
  • Include examples for HashiCorp Vault, GCP Cloud KMS, AWS KMS, Azure Key Vault, 1Password, and macOS Keychain
  • Add CI/CD integration tips section
  • Convert the old warning note to a positive "Enterprise Key Management" tip

Related

Test plan

  • Verify documentation renders correctly
  • Test example commands where possible

Add prominent call-to-actions for enterprise customers using cloud key
management services (AWS KMS, GCP Cloud KMS, Azure Key Vault, HashiCorp
Vault) or HSMs. Since Shorebird only signs a small hash, integrating with
external signing services is straightforward.
- State what's supported directly instead of apologizing for limitations
- Remove redundant "contact us" notes (already covered by Enterprise tip)
- Use active voice throughout
- Tighten verbose passages
@eseidel eseidel requested a review from tomarra February 6, 2026 13:52
@eseidel eseidel marked this pull request as draft February 6, 2026 14:27
Add comprehensive documentation for command-based signing with:
- HashiCorp Vault Transit
- GCP Cloud KMS
- AWS KMS
- Azure Key Vault
- 1Password CLI
- macOS Keychain

Also includes CI/CD integration tips and GitHub Actions example.
@eseidel eseidel marked this pull request as ready for review February 6, 2026 16:09
@eseidel eseidel enabled auto-merge (squash) February 6, 2026 16:11
@eseidel eseidel disabled auto-merge February 6, 2026 16:11
@tomarra
Copy link
Contributor

tomarra commented Feb 6, 2026

Making some flow changes to this page as how the new content was added in doesn't feel right.

@eseidel
Copy link
Contributor Author

eseidel commented Feb 6, 2026

Please do, thanks!

@tomarra
Copy link
Contributor

tomarra commented Feb 6, 2026

A bit more structured as a Guide given that it lives in that folder

CleanShot 2026-02-06 at 13 29 53@2x

@tomarra
Copy link
Contributor

tomarra commented Feb 6, 2026

This probably should be held until shorebirdtech/shorebird#3605 is landed and released

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants