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: start first page #4099

Draft
wants to merge 5 commits into
base: release-4-5
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"position": 20
}
19 changes: 19 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,19 @@
---
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 basic hardware requirements regardless of
environments, including an EC2 instance on AWS 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.

## Use Cases

You can deploy clusters in agent mode across a variety of environments, including in public cloud, on-prem data centers,
and in Edge locations.

## Resources
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_label: "Install Agent"
title: "Install Agent"
description: "Learn how to install the agent in your host."
hide_table_of_contents: false
sidebar_position: 30
tags: ["edge", "agent"]
---

## Preequisites

- Ubuntu: systemctl, jq, zstd, conntrack, rsync
- Edge Registration Token

## Install Agent

## Validate
17 changes: 17 additions & 0 deletions docs/docs-content/deployment-modes/appliance-mode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_label: "Appliance Mode"
title: "Appliance Mode"
description: "Learn about appliance mode, its use cases, and how to deploy a cluster in appliance mode. "
hide_table_of_contents: false
sidebar_position: 20
tags: ["edge"]
---

In appliance mode, you bring your own host, which can be any host that meets the basic hardware requirements regardless
of environments, including an EC2 instance on AWS or an Edge host in your own home. Unlike agent mode, instead of
bringing Operating Systems (OS) from your organization, you would build secure, immutable images that combine the OS and
the Kubernetes distribution for your host.

## Use Cases

## Resources
20 changes: 20 additions & 0 deletions docs/docs-content/deployment-modes/controller-mode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
sidebar_label: "Controller Mode"
title: "Controller Mode"
description: "Learn about the controller deployment mode and its use cases."
hide_table_of_contents: false
sidebar_position: 30
tags: ["CAPI"]
---

In controller mode, Palette provisions Kubernetes clusters and their infrastructure resources using
[Cluster API](https://cluster-api.sigs.k8s.io/). Cluster API is a Kubernetes sub-project focused on providing
declarative APIs and tooling to automate cluster lifecycle management for platform operations. It ensures a consistent
experience in cluster deployment across different infrastructure environments.

## Use Cases

You can deploy clusters in controller mode across a variety of environments, including public clouds and on-prem data
centers.

## Resources
22 changes: 22 additions & 0 deletions docs/docs-content/deployment-modes/deployment-modes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_label: "Deployment Modes"
title: "Deployment Modes"
description: "Learn about the different deployment modes available to deploy your Kubernetes cluster with Palette."
hide_table_of_contents: false
sidebar_position: 20
tags: ["edge"]
---

Real-life applications in Kubernetes can operate in many different environments, with varying security, compliance, and
performance requirements.

Palette offers three different deployment modes that can help you meet the needs of your organization. Whether you want
to operate your cluster in public cloud, private data centers, or at the Edge, whether you want to use your own
organization's hardware and Operating Systems (OS) or build secure immutable OS to bootstrap your applications, you can
choose a solution that works for you.

To provision a Kubernetes cluster, you can choose from the following deployment modes.

- Controller mode.
- Agent mode.
- Appliance mode.