Skip to content

Commit

Permalink
docs: add include-core-images-only option (#4283) (#4333)
Browse files Browse the repository at this point in the history 
* 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]>
  • Loading branch information
@vault-token-factory-spectrocloud @lennessyy @karl-cardenas-coding
3 people authored Oct 18, 2024
1 parent 72333d3 commit 164c210
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 16 deletions.
21 changes: 11 additions & 10 deletions ...content/clusters/edge/edgeforge-workflow/palette-canvos/build-content-bundle.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -272,16 +272,17 @@ Creating a content bundle provides several benefits that may address common use
--include-palette-content
```

| Flag | Description |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--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 content necessary for Palette itself. Required for airgap installations. |
| `--outfile` | Name of your content bundle. The final file name should have the following pattern: `core-<bundle-name>-random-string`. |
| `--palette-endpoint` | API endpoint for your Palette instance. |
| `--project-id` | The ID of your Palette project. |
| `--private-key` | The path to the private key used to sign the content bundle and cluster definition if it is present. This is necessary if your Edge host has an embedded corresponding public key. For more information, refer to [Embed Public Key in Edge Artifacts](./signed-content.md). |
| Flag | Description |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--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. |
| `--include-core-images-only` | Whether to include images for the Palette agent that are necessary for cluster creation only. In airgap installations, we recommend using this option instead of `--include-palette-content` to reduce the size of the content bundle, as Local UI currently does not offer native backup and support features. |
| `--outfile` | Name of your content bundle. The final file name should have the following pattern: `core-<bundle-name>-random-string`. |
| `--palette-endpoint` | API endpoint for your Palette instance. |
| `--project-id` | The ID of your Palette project. |
| `--private-key` | The path to the private key used to sign the content bundle and cluster definition if it is present. This is necessary if your Edge host has an embedded corresponding public key. For more information, refer to [Embed Public Key in Edge Artifacts](./signed-content.md). |

The result is a content bundle that you can use to preload into your installer. The content bundle will be a zst
file in a folder that starts with **content-** followed by a random string. For more information about how to use a
Expand Down
17 changes: 11 additions & 6 deletions ...-content/clusters/edge/local-ui/cluster-management/export-cluster-definition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,17 @@ same time in a single command.
--cluster-definition-profile-ids <CLUSTER_PROFILE_IDS>
```

| Flag | Description |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--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. Refer to [Build Content Bundles](../../edgeforge-workflow/palette-canvos/build-content-bundle.md) for the expected schema of the JSON file. |
| `--include-palette-content` | Whether to include content necessary for Palette itself. Required for airgap installations. |
| `--outfile` | Name of your content bundle. The final file name should have the following pattern: `core-<bundle-name>-random-string`. |
| Flag | Description |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--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. |
| `--include-core-images-only` | Whether to include images for the Palette agent that are necessary for cluster creation only. In airgap installations, we recommend using this option instead of `--include-palette-content` to reduce the size of the content bundle, as Local UI currently does not offer native backup and support features. |
| `--outfile` | Name of your content bundle. The final file name should have the following pattern: `core-<bundle-name>-random-string`. |
| `--palette-endpoint` | API endpoint for your Palette instance. |
| `--project-id` | The ID of your Palette project. |
| `--private-key` | The path to the private key used to sign the content bundle and cluster definition if it is present. This is necessary if your Edge host has an embedded corresponding public key. For more information, refer to [Embed Public Key in Edge Artifacts](../../edgeforge-workflow/palette-canvos/signed-content.md). |

### Validate

Expand Down

0 comments on commit 164c210

Please sign in to comment.