Skip to content
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

Merged
merged 7 commits into from
Oct 18, 2024
Merged

docs: add include-core-images-only option #4283

merged 7 commits into from
Oct 18, 2024

Conversation

lennessyy
Copy link
Contributor

@lennessyy lennessyy commented Oct 15, 2024

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?

  • Yes.

@lennessyy lennessyy added auto-backport Enable backport backport-version-4-5 Backport changes to the version-4-5 branch. labels Oct 15, 2024
@lennessyy lennessyy marked this pull request as ready for review October 15, 2024 18:51
@lennessyy lennessyy requested a review from a team as a code owner October 15, 2024 18:51
Copy link

netlify bot commented Oct 15, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 5b1cc96
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/6711ab73afa0d00008487686
😎 Deploy Preview https://deploy-preview-4283--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a 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.

@lennessyy lennessyy enabled auto-merge (squash) October 18, 2024 00:27
| `--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. |
Copy link
Contributor

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. |
Copy link
Contributor

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

@lennessyy lennessyy merged commit 3c4f507 into master Oct 18, 2024
15 checks passed
@lennessyy lennessyy deleted the PE-5315 branch October 18, 2024 00:42
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Oct 18, 2024
* 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)
@vault-token-factory-spectrocloud
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
version-4-5

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

vault-token-factory-spectrocloud bot added a commit that referenced this pull request Oct 18, 2024
* 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]>
@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This issue has been resolved in version 4.5.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-4-5 Backport changes to the version-4-5 branch. released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants