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.

Sign up for GitHub

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: change from provider images to edgeforge #5323

Merged
merged 2 commits into from
Jan 9, 2025
Merged

docs: change from provider images to edgeforge #5323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef89f91
docs: change from provider images to edgeforge
benradstone Jan 9, 2025
8e70754
docs: minor word removal
benradstone Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/docs-content/clusters/public-cloud/aws/eks-hybrid-nodes/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,9 @@ If you want to use your edge hosts as Amazon EKS Hybrid Nodes, they must have be
methods:

- [Agent Mode](../../../../deployment-modes/agent-mode/agent-mode.md)
- [Provider images](../../../edge/edgeforge-workflow/palette-canvos/build-provider-images.md)
- Provider images are [Kairos-based images](https://kairos.io/) containing the OS and the desired Kubernetes versions.
- [EdgeForge Workflow](../../../edge/edgeforge-workflow/edgeforge-workflow.md)
- Part of the EdgeForge Workflow is to create [Kairos-based images](https://kairos.io/) containing the OS and the
desired Kubernetes versions. These are named provider images.
Comment on lines +123 to +124
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still need this sentence? :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@caroldelwing Tyler specifically wanted me to mention that we support Kairos-based images in the architecture. I think it's to ensure that users understand what is supported upfront (and in case it changes in the future).


:::warning

Expand All @@ -140,8 +141,8 @@ Adjust to your operating system and package manager on your edge hosts.

### Build Provider Images with Specific Arguments

If using provider images, you must include the following in your `.arg` file during the
[build steps](../../../edge/edgeforge-workflow/palette-canvos/build-provider-images.md#build-provider-images).
If using the EdgeForge Workflow, you must include the following in your `.arg` file during the
[build steps for provider images](../../../edge/edgeforge-workflow/palette-canvos/build-provider-images.md#build-provider-images).

```shell
K8S_DISTRIBUTION=nodeadm
Expand Down
12 changes: 7 additions & 5 deletions ...-content/clusters/public-cloud/aws/eks-hybrid-nodes/create-hybrid-node-pools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You must then configure your networking to allow traffic to reach the pods on yo
6. Select your base OS pack depending on how you will register your edge hosts.

- For Agent Mode, select **BYOS - Agent Mode**.
- For provider images, select **BYOS - Edge OS**.
- For EdgeForge Workflow, select **BYOS - Edge OS**.

7. If selecting **BYOS - Agent Mode**, on the **Configure Pack** page, click **Values** under **Pack Details**. Then,
click on **Presets** on the right-hand side, and select **Agent Mode**.
Expand Down Expand Up @@ -98,13 +98,13 @@ Your cluster profile for hybrid nodes is now created and can be used in the
[Import EKS Cluster and Enable Hybrid Mode](./import-eks-cluster-enable-hybrid-mode.md) for guidance.

- Edge hosts have been registered with Palette through
[Agent Mode](../../../../deployment-modes/agent-mode/agent-mode.md) or by using
[provider images](../../../edge/edgeforge-workflow/palette-canvos/build-provider-images.md).
[Agent Mode](../../../../deployment-modes/agent-mode/agent-mode.md) or
[EdgeForge Workflow](../../../edge/edgeforge-workflow/edgeforge-workflow.md).

:::warning

If using provider images, you must include the following in your `.arg` file during the
[build steps](../../../edge/edgeforge-workflow/palette-canvos/build-provider-images.md#build-provider-images).
If using the EdgeForge Workflow, you must include the following in your `.arg` file during the
[build steps for provider images](../../../edge/edgeforge-workflow/palette-canvos/build-provider-images.md#build-provider-images).

```shell
K8S_DISTRIBUTION=nodeadm
Expand Down Expand Up @@ -394,6 +394,8 @@ The hybrid node pool repave will now complete. This can take up to one hour.

- [Agent Mode](../../../../deployment-modes/agent-mode/agent-mode.md)

- [EdgeForge Workflow](../../../edge/edgeforge-workflow/edgeforge-workflow.md)

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

- [Worker Node Pool](../../../cluster-management/node-pool.md#worker-node-pool)
Expand Down
Loading