Skip to content

Commit

Permalink
docs: add steps for new edge cli command (#2918)
Browse files Browse the repository at this point in the history 
* docs: add steps for new edge cli command

* fix broken links

* docs: add redirects

* fix broken links

* docs: address vale comments

* docs: move page to deprecated

* docs: swap api file

* docs: fix layout issue

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: fix typo

* docs: address feedback

* docs: add validate section

* docs: add paragraph about duplicate packs

* docs: fix typo

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
  • Loading branch information
@lennessyy @karl-cardenas-coding
3 people authored Jun 5, 2024
1 parent de77032 commit 19754ce
Show file tree
Hide file tree
Showing 13 changed files with 498 additions and 421 deletions.
0 ...dgeforge-workflow/build-content-bundle.md → ...dge/edgeforge-workflow/build-artifacts.md
View file
File renamed without changes.
24 changes: 10 additions & 14 deletions docs/docs-content/clusters/edge/edgeforge-workflow/edgeforge-workflow.md
View file
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)

- [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

0 comments on commit 19754ce

Please sign in to comment.