Skip to content

docs(install): add documentation for generic Kubernetes deployment #408

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

Draft
lexfrei wants to merge 8 commits into
base: main
Choose a base branch
from
+516 −5
Draft

docs(install): add documentation for generic Kubernetes deployment #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ae90b3d
docs(install): add documentation for generic Kubernetes deployment
lexfrei Feb 2, 2026
7d8260e
docs(generic): clarify CIDR configuration per distribution
lexfrei Feb 2, 2026
ddaa642
docs: fix style issues from CodeRabbit review
lexfrei Feb 2, 2026
500ba85
[docs] Add cozystack-operator-config ConfigMap step to generic instal…
lexfrei Feb 9, 2026
d35d7ae
[docs] Use industry-standard inotify limits in generic install guide
lexfrei Feb 9, 2026
78e3fa4
fix(docs): add missing sysctl values to Ansible playbook example
lexfrei Feb 9, 2026
5bf19d4
fix(docs): add missing Platform Package creation step
lexfrei Feb 9, 2026
2c46296
fix(docs): add --disable=metrics-server to k3s configuration
lexfrei Feb 9, 2026
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
20 changes: 15 additions & 5 deletions content/en/docs/install/kubernetes/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Installing and Configuring Kubernetes Cluster on Talos Linux"
title: "Installing and Configuring Kubernetes Cluster"
linkTitle: "2. Install Kubernetes"
description: "Step 2: Installing and configuring a Kubernetes cluster on Talos Linux nodes, ready for Cozystack installation."
description: "Step 2: Installing and configuring a Kubernetes cluster ready for Cozystack installation."
weight: 20
aliases:
- /docs/operations/talos/configuration
Expand All @@ -10,21 +10,31 @@ aliases:
---


**The second step** in deploying a Cozystack cluster is to install and configure a Kubernetes cluster on Talos Linux nodes.
A prerequisite to this step is having [installed Talos Linux]({{% ref "/docs/install/talos" %}}).
**The second step** in deploying a Cozystack cluster is to install and configure a Kubernetes cluster.
The result is a Kubernetes cluster installed, configured, and ready to install Cozystack.

If this is your first time installing Cozystack, [start with the Cozystack tutorial]({{% ref "/docs/getting-started" %}}).

## Installation Options

### Talos Linux (Recommended)

For production deployments, Cozystack recommends [Talos Linux]({{% ref "/docs/guides/talos" %}}) as the underlying operating system.
A prerequisite to using these methods is having [installed Talos Linux]({{% ref "/docs/install/talos" %}}).

There are several methods to configure Talos nodes and bootstrap a Kubernetes cluster:

- **Recommended**: [using Talm]({{% ref "./talm" %}}), a declarative CLI tool, which has ready presets for Cozystack and uses the power of Talos API under the hood.
- [Using `talos-bootstrap`]({{% ref "./talos-bootstrap" %}}), an interactive script for bootstrapping Kubernetes clusters on Talos OS.
- [Using talosctl]({{% ref "./talosctl" %}}), a specialized command line tool for managing Talos.
- [Using talosctl]({{% ref "./talosctl" %}}), a specialized command-line tool for managing Talos.
- [Air-gapped installation]({{% ref "./air-gapped" %}}) is possible with Talm or talosctl.

### Generic Kubernetes

Cozystack can also be deployed on other Kubernetes distributions:

- [Generic Kubernetes]({{% ref "./generic" %}}) — deploy Cozystack on k3s, kubeadm, RKE2, or other distributions.

If you encounter problems with installation, refer to the [Troubleshooting section]({{% ref "./troubleshooting" %}}).

## Further Steps
Expand Down
Loading