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 steps for new edge cli command #2918

Merged
merged 15 commits into from
Jun 5, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,17 @@ Installer ISO and provider images individually.
If you want your Edge host to have preloaded content and be able to create clusters using the preloaded content, you
build a content bundle and build the content bundle into your Edge Installer ISO. Building preloaded content into your
ISO allows you to create clusters without a connection to a Palette instance. Refer to the following guides to build
Edge Artifacts with content bundles:
content bundles:

- [Build Content Bundle](./build-content-bundle.md)

- [Build Edge Artifacts with Content Bundles](./palette-canvos/build-artifacts.md)
- [Build Content Bundle](palette-canvos/build-content-bundle.md)

The following table lists the combination of our guides you can follow to build Edge artifacts with or without preloaded
content.

| Edge Artifacts have preloaded content? | Option 1 | Option 2 |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| No | [Build Provider Images](./palette-canvos//build-provider-images.md) + [Build Installer ISO](./palette-canvos//build-installer-iso.md) | [Build Edge Artifacts](./palette-canvos/palette-canvos.md) |
| Yes | [Build Provider Images](./palette-canvos//build-provider-images.md) + [Build Installer ISO](./palette-canvos//build-installer-iso.md) + [Build Content Bundle](./build-content-bundle.md) | [Build Content Bundle](./build-content-bundle.md) + [Build Edge Artifacts with Content Bundles](./palette-canvos/build-artifacts.md) |
| Edge Artifacts have preloaded content? | Option 1 | Option 2 |
| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| No | [Build Provider Images](./palette-canvos//build-provider-images.md) + [Build Installer ISO](./palette-canvos//build-installer-iso.md) | [Build Edge Artifacts](./palette-canvos/palette-canvos.md) |
| Yes | [Build Provider Images](./palette-canvos//build-provider-images.md) + [Build Installer ISO](./palette-canvos//build-installer-iso.md) + [Build Content Bundle](./palette-canvos/build-content-bundle.md) | |

## Edge Artifacts

Expand Down Expand Up @@ -85,7 +83,7 @@ Palette provides these artifacts out-of-the-box. All the container images are ho
registries, or a private self-hosted OCI registry and automatically downloaded during installation. You can use the
default Palette container registries to familiarize yourself with the installation process. However, in a typical
production scenario, you would need to customize these artifacts to suit your specific needs or perform some
[content bundle](../edgeforge-workflow/build-content-bundle.md) optimization.
[content bundle](../edgeforge-workflow/palette-canvos/build-content-bundle.md) optimization.

![A diagram breaking up the internal components of the Edge Provider container images](/clusters_edge_edgeforge-workflow_provider-diagram.webp)

Expand All @@ -106,9 +104,9 @@ the Edge Installer ISO during EdgeForge. This allows the Edge host to provision
external image registry. Refer to the following guides on how to build a content bundle and how to use them during the
EdgeForge process:

- [Build Content Bundle](./build-content-bundle.md)
- [Build Content Bundle](./palette-canvos/build-content-bundle.md)

- [Build Edge Artifacts with Content Bundles](./palette-canvos/build-artifacts.md)
- [Build Installer ISO with Content Bundle](./palette-canvos/build-installer-iso.md#build-content-bundle)

## Deployment Scenarios

Expand Down Expand Up @@ -141,14 +139,12 @@ scenario, use the CLIs to help you with the customization.

## Resources

- [Build Preloaded Content Bundles](build-content-bundle.md)
- [Build Preloaded Content Bundles](./palette-canvos/build-content-bundle.md)
lennessyy marked this conversation as resolved.
Show resolved Hide resolved

- [Build Edge Installer ISO](./palette-canvos/build-installer-iso.md)

- [Build Provider Images](./palette-canvos/build-provider-images.md)

- [Build Edge Artifacts](./palette-canvos/palette-canvos.md)

- [Build Edge Artifacts using a Content Bundle](./palette-canvos/build-artifacts.md)

- [Prepare User Data](prepare-user-data.md)
Loading