docs: document Omni support bundle encryption - #697
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the documentation to reflect Omni’s default support bundle encryption workflow and aligns the Omni page’s structure and content with the Talos support bundle documentation for a consistent reader experience.
Changes:
- Fixes a typo in the Talos support bundle intro sentence.
- Expands the Omni support bundle page to document default
.ageoutput naming, UI encryption behavior, CLI flags for recipients/defaults, and decryption steps.
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| public/talos/v1.14/troubleshooting/support-bundle.mdx | Corrects a typo in the support bundle description. |
| public/omni/cluster-management/support-bundle.mdx | Documents Omni support bundle encryption defaults, UI/CLI workflows, recipient flags, and decryption instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ## Encryption |
There was a problem hiding this comment.
can we make this title a little less vague
| --encryption-recipients "$(cat ~/.ssh/id_ed25519.pub)" | ||
| ``` | ||
|
|
||
| ### Turn off encryption |
There was a problem hiding this comment.
for the style guide, can we please add a concise introduction before the tabs
657061f to
c115859
Compare
|
|
||
| ```text | ||
| Support bundle encrypted to the following recipients: | ||
| - alongwill (Andy Longwill) |
There was a problem hiding this comment.
do you maybe want to use a name like John Doe, instad of Andy
There was a problem hiding this comment.
I copy pasted this from Talos docs and members of Sidero Labs github organization is public information.
Omni encrypts support bundles by default. The page now covers the .age output name, the omnictl recipient flags, and the encryption checkbox in the download dialog, and it follows the structure of the Talos support bundle page so the two read the same way. Signed-off-by: Oguz Kilcan <oguz.kilcan@siderolabs.com>
c115859 to
423dc7d
Compare
|
/m |
Omni encrypts support bundles by default. The page now covers the .age output name, the omnictl recipient flags, and the encryption checkbox in the download dialog, and it follows the structure of the Talos support bundle page so the two read the same way.