Skip to content

Commit

Permalink
docs: edge artifacts build guide
Browse files Browse the repository at this point in the history
* docs: improve the intro

* Optimised images with calibre/image-actions

* Apply suggestions from code review round 1 - part 1

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

* docs: apply suggestions from code review round 1

* docs: typo

* docs: add basic and advanced

* docs: add Dockerfile customization

* docs:typo

* docs:typo again

* docs: add docker push

* docs: remove color highlight

* docs: language cleanup

* Apply suggestions from code review round 2

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

* docs: address feedback suggestions

* docs: add docker hub prereq

* Apply suggestions from code review round 3

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

* docs: apply feedback suggestions

* docs: update arguments

* docs: finishing touch

* docs: language cleanup

* docs: minor language fixes and updated URLs

* docs: update image and URL

* Optimised images with calibre/image-actions

* docs: minor Edge fixes

* docs: fixed indentation on advanced section #12

* docs: address bug-bash-session feedback

* docs: grammar fix

* Optimised images with calibre/image-actions

* docs: update metadescription

* docs: remove vi

* Optimised images with calibre/image-actions

* docs: language clean up

* docs:typo

* Apply suggestions from code review

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

* docs: add suggestions from review

* docs: fix conflict and change tabs

* docs: update the diagram

* Optimised images with calibre/image-actions

* DOC-783 Add hideClipboard functionality (#1355)

* chore : add hideClipboard functionality

* Optimised images with calibre/image-actions

* chore : fix ci/cd

* chore : remove unsued variables in test case

* chore:fix review comments

* Optimised images with calibre/image-actions

* chore: remove white space

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs: change tabs

* docs: add hideClipboard

* docs: typo

* Apply suggestions from code review

* docs: concept clarification and language fixes

* Optimised images with calibre/image-actions

* chore: retrigger build

* docs: updates based on CanvOS changes

* docs: final update

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: Nageshwara sairam <113401242+nagesh161007@users.noreply.github.com>
  • Loading branch information
4 people committed Jun 12, 2023
1 parent ba77aec commit a9fe09e
Show file tree
Hide file tree
Showing 17 changed files with 765 additions and 61 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,13 @@ Some operating systems require credentials to download the source image, such as

<br />

Your image will be used in the [Build Images](/clusters/edge/edgeforge-workflow/build-images) step and become part of your Edge artifact. The custom OS you created will also be used in the OS layer of the cluster profile by using the [Bring Your Own OS (BYOOS)](/integrations/byoos) pack.
Your image will be used in the [Build Images](/clusters/edge/edgeforge-workflow/palette-canvos) step and become part of your Edge artifact. The custom OS you created will also be used in the OS layer of the cluster profile by using the [Bring Your Own OS (BYOOS)](/integrations/byoos) pack.
<br />


# Next Steps


Your next step is to evaluate if you need to create a content bundle. To create a content bundle, check out the [Build Content Bundle](/clusters/edge/edgeforge-workflow/build-content-bundle) guide.
Your next step is to evaluate if you need to create a content bundle. To create a content bundle, check out the [Build Content Bundle](/clusters/edge/edgeforge-workflow/palette-canvos) guide.

<br />
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,4 @@ You can validate that the ISO image has not been corrupted by attempting to flas

# Next Steps

Your next step is to build the Edge artifacts so that you can deploy an Edge host. To create an Edge artifacts, check out the [Build Images](/clusters/edge/edgeforge-workflow/build-images) guide.
Your next step is to build the Edge artifacts so that you can deploy an Edge host. To create an Edge artifacts, check out the [Build Images](/clusters/edge/edgeforge-workflow/palette-canvos) guide.
2 changes: 1 addition & 1 deletion content/docs/00-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ This release contains several security fixes and new features for Edge. The Edge

* Edge now supports the ability to load images from an external OCI registry.
* The Edge Installer can now include preloaded content bundles containing packages and artifacts. This is useful for scenarios where you work with limited internet bandwidth or want to optimize the installation process.
* Users can now [create custom Edge Installer images](/clusters/edge/edgeforge-workflow/build-images) to support advanced scenarios such as Bring Your Own Operating System (BYOOS), installing additional OS packages, preloading content into the installer, and more.
* Users can now [create custom Edge Installer images](/clusters/edge/edgeforge-workflow/palette-canvos) to support advanced scenarios such as Bring Your Own Operating System (BYOOS), installing additional OS packages, preloading content into the installer, and more.
* Support for creating Virtual Machine Disks (VMDK) from the Edge installer ISO is now available. Use this to simplify deployments into VMware-based environments.
* Support for generating random UUID values for the Edge host is now available. This addresses the issue of some devices having the same Universal Unique Identifier (UUID) due to identical device identifiers.

Expand Down
8 changes: 2 additions & 6 deletions content/docs/02-getting-started/04-onboarding-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,10 @@ import Tooltip from "shared/components/ui/Tooltip";

# Palette Onboarding Workflow

Palette has a well-organized product onboarding process to streamline user-product adoption. The two significant steps of our onboarding workflow are:

* Product Tour

* Palette Experience
Palette offers a product tour to help you get familiar with the console and many of its key components.

## Product Tour
Upon a successful sign in to our platform, we start the onboarding process with a product tour—an introduction to the platform, to familiarize the users with our Palette features.
Upon a successful sign-in to our platform, we start the onboarding process with a product tour—an introduction to the platform, to familiarize the users with our Palette features.


## Start your Palette Experience
Expand Down
47 changes: 15 additions & 32 deletions content/docs/04-clusters/03-edge/04-edgeforge-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,20 @@ EdgeForge contains three critical components.



Each component plays a critical role in the [lifecycle](/clusters/edge/edge-native-lifecycle) of an Edge deployment. Review the following sections to learn more about each component.
Each component plays a critical role in the [lifecycle](/clusters/edge/edge-native-lifecycle) of an Edge deployment. Review the [Edge Artifacts](/clusters/edge/edgeforge-workflow#edgeartifacts) section to learn more about each component.

![A diagram that displays the relationship between the three components and how they relate to an Edge host](/clusters_edge-forge-workflow_edgeforge-workflow_components-diagram.png)


# Get Started


To start building a custom Edge artifact, use the [Build Edge Artifacts](/clusters/edge/edgeforge-workflow/palette-canvos) guide.


<br />

# Edge Artifacts

## Edge Installer ISO

Expand All @@ -51,7 +60,7 @@ The Edge host agent container image contains the Palette Edge host agent. The ag

These are [Kairos](https://kairos.io/)-based container images for each supported Operating System (OS) and Kubernetes combination. These container images are downloaded during the installation by the Edge Installer and converted to disk images for the system to boot into.

Palette provides these artifacts out-of-the-box. All the container images are hosted in Palette's container registries 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](/clusters/edge/edgeforge-workflow/build-content-bundle) optimization.
Palette provides these artifacts out-of-the-box. All the container images are hosted in Palette's container registries 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](/clusters/edge/edgeforge-workflow/palette-canvos) optimization.


<br />
Expand All @@ -62,30 +71,13 @@ You can specify a custom registry for the Edge Installer to use during installat

</InfoBox>


# Palette Edge CLI

All organizations have unique environments and different needs. To help you successfully deploy an Edge host in your environment and create an Edge host cluster, we provide you with a CLI to help you customize the installation.



<br />

## Content Builder

You can create content bundles with the Palette Edge CLI. A content bundle is a compressed ZST file you can include with the Edge Installer for bandwidth optimization. The CLI can also build the content bundle in optical disk image (ISO) format. In ISO format, the content is not baked into the installer but can be supplied as an additional USB drive during installation.

To learn how to create content bundles, check out the [Build Content Bundle](/clusters/edge/edgeforge-workflow/build-content-bundle) guide.

<br />

## Image Builder

The Palette Edge CLI can also be used to create custom Edge artifacts. You can use the CLI to address common deployment concerns about required packages, software restrictions, bandwidth concerns, and more. By using your Edge artifacts, you gain complete control over the deployment, and you can manage the software in your Edge clusters to best suit your organization's needs.

Follow the instructions in the [Build Images](/clusters/edge/edgeforge-workflow/build-images) guide to learn more about creating custom Edge artifacts.

<br />

# Deployment Scenarios

Expand All @@ -110,23 +102,14 @@ You can embed the Edge Installer configuration user data into the Edge Installer


- **Bring Your Own OS (BYOOS)**:
Palette provides the following runtime OS out-of-the-box for all Edge Hosts. For environments that require a different runtime OS, you can specify another OS through the BYOOS option. Follow the instructions in the [Bring Your Own OS](/clusters/edge/edgeforge-workflow/build-kairos-os) guide to learn more about BYOOS.

# Build a Custom Edge Artifact



To start building a custom Edge artifact, use the following guides. You should review each guide sequentially, although some guides may not apply to your Edge deployment.
For environments that require a different runtime OS, you can specify another OS through the [BYOOS](/integrations/byoos) option. Follow the instructions in the [Build Edge Artifacts](/clusters/edge/edgeforge-workflow/palette-canvos) guide to learn more about how you can customize the OS used in an Edge deployment.

<br />

- [Bring Your Own OS](/clusters/edge/edgeforge-workflow/build-kairos-os)


- [Build Content Bundle](/clusters/edge/edgeforge-workflow/build-content-bundle)
# Resources


- [Prepare User Data](/clusters/edge/edgeforge-workflow/prepare-user-data)
- [Build Edge Artifacts](/clusters/edge/edgeforge-workflow/palette-canvos)


- [Build Images](/clusters/edge/edgeforge-workflow/build-images)
- [Prepare User Data](/clusters/edge/edgeforge-workflow/prepare-user-data)
Original file line number Diff line number Diff line change
Expand Up @@ -292,4 +292,4 @@ For your initial testing, your user data may include global settings and site-sp

# Next Steps

The last step of the EdgeForce workflow is to build the Edge artifact. Check out the [Build Images](/clusters/edge/edgeforge-workflow/build-images) guide to learn how to build your images with the Edge Installer Builder CLI and create an Edge artifact.
The last step of the EdgeForce workflow is to build the Edge artifacts. Check out the [Build Edge Artifacts](/clusters/edge/edgeforge-workflow/palette-canvos) guide to learn how to create the Edge artifacts.
Loading

0 comments on commit a9fe09e

Please sign in to comment.