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: agent mode / deployment modes #4099

Merged
merged 42 commits into from
Oct 11, 2024
Merged
Show file tree
Hide file tree
Changes from 41 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
d7ea507
docs: start first page
lennessyy Sep 26, 2024
b63895f
docs: add category.json
lennessyy Sep 26, 2024
3d85600
docs: rough outline
lennessyy Sep 26, 2024
f0e91ef
docs: add more disposition and place holder text
lennessyy Sep 26, 2024
f795e5d
docs: add more placeholders
caroldelwing Sep 27, 2024
ca8c34f
docs: brief descriptions
lennessyy Oct 3, 2024
b0a8725
docs: add diagrams
lennessyy Oct 4, 2024
6b10861
docs: convert to webp
lennessyy Oct 4, 2024
86f2f8b
docs: index page draft
lennessyy Oct 4, 2024
0a5e80b
docs: add agent mode content
lennessyy Oct 7, 2024
2f65d40
docs: add agent mode info
lennessyy Oct 7, 2024
be069f9
docs: Agent Mode installation guide (#4198)
caroldelwing Oct 7, 2024
3ee1037
Merge branch 'agent-mode' of https://github.com/spectrocloud/librariu…
lennessyy Oct 7, 2024
f981f47
docs: add appliance mode info
lennessyy Oct 8, 2024
2b5dc9a
docs: fix broken link
lennessyy Oct 8, 2024
f746e82
docs: remove image from index page
lennessyy Oct 8, 2024
f122d6d
docs: add diagrams
lennessyy Oct 8, 2024
d216d4d
docs: add link to github repo, review prereqs
caroldelwing Oct 8, 2024
f2865d3
docs: add local ui theming guide
lennessyy Oct 8, 2024
26bbb83
Merge branch 'agent-mode' of https://github.com/spectrocloud/librariu…
lennessyy Oct 8, 2024
75f8bd2
docs: update BYOS pack
caroldelwing Oct 9, 2024
33bede1
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Oct 9, 2024
f1b3725
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Oct 9, 2024
49aee2d
docs: add deployment modes icon
caroldelwing Oct 9, 2024
6e0c095
docs: review grammar
caroldelwing Oct 9, 2024
ce71ab0
docs: add instructions for airgap
lennessyy Oct 10, 2024
3bf74af
docs: fix broken tab, add main diagram
caroldelwing Oct 10, 2024
1ff477f
docs: replace gif bc it was not looping
caroldelwing Oct 10, 2024
9673b82
docs: comment out airgap
lennessyy Oct 10, 2024
8a59936
docs: minor copy edit
lennessyy Oct 10, 2024
3f91d89
docs: add supported k8s distros
lennessyy Oct 10, 2024
257fd2d
docs: remove CPU model restrictions
lennessyy Oct 10, 2024
dad75a7
docs: add airgap steps
lennessyy Oct 10, 2024
bcb8ba4
Apply suggestions from code review
lennessyy Oct 10, 2024
f521408
docs: address review comments
lennessyy Oct 10, 2024
2dc2607
docs: add local ui link
lennessyy Oct 10, 2024
e4d2123
docs: address vale comments
lennessyy Oct 10, 2024
630263d
docs: fix grouptab, replace download script command
caroldelwing Oct 11, 2024
230ecfb
docs: modify version number
lennessyy Oct 11, 2024
82bb372
docs: change docker to crane
lennessyy Oct 11, 2024
a43c663
docs: add warning for docker
lennessyy Oct 11, 2024
173a3bc
docs: add flannel limitation
lennessyy Oct 11, 2024
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
3 changes: 3 additions & 0 deletions docs/docs-content/deployment-modes/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"position": 50
}
3 changes: 3 additions & 0 deletions docs/docs-content/deployment-modes/agent-mode/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"position": 20
}
65 changes: 65 additions & 0 deletions docs/docs-content/deployment-modes/agent-mode/agent-mode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
sidebar_label: "Agent Mode"
title: "Agent Mode"
description: "Learn about agent mode, its use cases, and how to deploy a cluster in agent mode. "
hide_table_of_contents: false
sidebar_position: 20
tags: ["edge"]
---

In agent mode, you bring your own host, which can be any host that meets the minimum hardware requirements, regardless
of the environment. This includes options like an AWS EC2 instance or a Raspberry Pi in your own home. All you need to
do to have Palette manage your host is to [download and install the Palette agent](./install-agent-host.md).

:::preview

:::

The diagram below illustrates the agent mode cluster provisioning workflow.

![Architecture Diagram for Agent Mode](/deployment-modes_agent-mode.webp)
Copy link
Contributor

Choose a reason for hiding this comment

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

It would help if we explain the order of operations in this diagram. Think 1, 2, 3 .. and for each step add a short description. Otherwise it's a bit challenging for a reader to understand the flow.

Copy link
Contributor Author

@lennessyy lennessyy Oct 10, 2024

Choose a reason for hiding this comment

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

I don't know if adding the sequence directly in the diagram will be helpful in this case. Some of the steps are not sequential - the diagram covers two workflows between Palette management plane and Local UI. I can add a list to summarize the order of operations below the diagram. Let me know if you think this helps

Copy link
Contributor

Choose a reason for hiding this comment

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

This is great @lennessyy


The order of operations can be summarized as follows:

1. You provide a host as well as an Operating System (OS) that will operate on your host.

2. You install the Palette agent on your host. Alternatively, you may build the Palette agent into your OS image.

3. You create a cluster profile in Palette. The profile contains the Kubernetes distribution, the Container Network
Interface (CNI), the Container Storage Interface (CSI) as well as any other applications.

4. If the agent is installed on your host in connected mode, it will register the host with Palette.

If the agent is installed on your host in airgap mode, you will need to export the cluster profile. Depending on
whether your host has access to image registries, you may also need to build a content bundle.

5. If the agent is installed on your host in connected mode, you can use the registered host to provision a cluster with
your cluster profile.

If the agent is installed on your host in airgap mode, you can use the exported cluster profile to provision a
cluster from Local UI.

## Use Cases

Agent mode is designed to work across a variety of environments, including public clouds, on-prem data centers, and Edge
locations. Currently, the validated use case for agent mode includes [Edge](../../clusters/edge/edge.md).

| Use Case | Supported Environments |
| -------- | ----------------------------------------------------------------------------------------------------------------------- |
| **Edge** | [VMware vSphere](../../clusters/edge/site-deployment/virtual-deployment/virtual-deployment.md)<br />Bare metal machines |

## Next Steps

Review the architecture and basic hardware requirements for operating clusters in agent mode in
[Architecture](./architecture.md).

Follow the instructions in [Install Palette Agent](install-agent-host.md) to install the agent on your host and deploy
your first agent-mode cluster.

## Resources

- [Architecture](./architecture.md)

- [Install Palette Agent](install-agent-host.md)

- [Manage Hosts in Agent Mode](./manage-agent/manage-agent.md)
41 changes: 41 additions & 0 deletions docs/docs-content/deployment-modes/agent-mode/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebar_label: "Architecture"
title: "Agent Mode Architecture"
description: "Learn about the architecture of agent mode and its minimal hardware requirements."
hide_table_of_contents: false
sidebar_position: 20
tags: ["edge"]
---

The following are architectural highlights of clusters deployed using agent mode.

- You can bring an existing host with an Operating System (OS) of your choice.

- You may also build the Palette agent into your OS image to have the agent natively installed on your host.

- Support for bare metal, public clouds, data centers, and Edge devices.

- Support for single-node and multi-node deployments.

- Customizable site properties such as network proxies and certificates for Edge deployments.

- Configurable Kubernetes API servers to work with virtual IP address (VIP) or Dynamic DNS.

![Architecture Diagram for Agent Mode](/deployment-modes_agent-mode.webp)

## Supported Kubernetes Distributions

| Distribution | Versions |
| ------------ | ----------------------- |
| PXK-E | 1.28.13, 1.28.9, 1.30.5 |
| K3s | 1.28.14, 1.28.9, 1.30.5 |

## Minimum Device Requirements

Agent mode deployments support both AMD64 and ARM64 architectures.

| Component | Requirement |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CPU Core | Minimum two cores. |
| Memory | Minimum 8 GB. |
| Storage | Main drive requires a minimum of 100 GB storage to accommodate the Operating System (OS), Kubernetes, and workloads. The main drive must be an SSD drive. |
Loading
Loading