-
Notifications
You must be signed in to change notification settings - Fork 37
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
docs: add include-core-images-only option #4283
Conversation
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
@lennessyy could we maybe mention this in the Cluster Backup page, under maybe prereqs? That would help readers that maybe using Edge not get confused as why the backup is not working.
| `--api-key` | Your Palette API key. | | ||
| `--cluster-profile-ids` | Comma-separated list of cluster profile IDs to download content for. | | ||
| `--cred-file-path` | Path to the JSON file storing registry credentials if you are using a private registry. | | ||
| `--include-palette-content` | Whether to include images for the Palette agent itself, including images to support cluster creation and cluster management. For airgap installations, you must use either this option or the `--include-core-images-only` option. We recommend you use `--include-core-images-only` instead to reduce the size of the content bundle. | |
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.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'we' instead of 'We'.
| `--api-key` | Your Palette API key. | | ||
| `--cluster-profile-ids` | Comma-separated list of cluster profile IDs to download content for. | | ||
| `--cred-file-path` | Path to the JSON file storing registry credentials if you are using a private registry. | | ||
| `--include-palette-content` | Whether to include images for the Palette agent itself, including images to support cluster creation and cluster management. For airgap installations, you must use either this option or the `--include-core-images-only` option. We recommend you use `--include-core-images-only` instead to reduce the size of the content bundle. | |
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.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'we' instead of 'We'.
* docs: add include-core-images-only option * docs: fix broken link * docs: copy edit * docs: fix broken link * docs: add note about backup and restore --------- Co-authored-by: Lenny Chen <[email protected]> (cherry picked from commit 3c4f507)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation and see the Github Action logs for details |
* docs: add include-core-images-only option * docs: fix broken link * docs: copy edit * docs: fix broken link * docs: add note about backup and restore --------- Co-authored-by: Lenny Chen <[email protected]> (cherry picked from commit 3c4f507) Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Karl Cardenas <[email protected]>
🎉 This issue has been resolved in version 4.5.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Describe the Change
This PR adds the option
--include-core-images-only
to the Palette Edge CLI command to build content bundles.Changed Pages
💻 Add Preview URL for Page
Jira Tickets
🎫 PE-5315
Backports
Can this PR be backported?