Technical Documentation: siderolabs/talos

ℹ️ Provenance: Hybrid Fusion: siderolabs/talos + siderolabs/docs · CodeWiki Reference · Recency: Active (< 180 days)

1. Project Overview & Quickstart (siderolabs/talos) Copy Chapter

Talos is a modern OS for running Kubernetes: secure, immutable, and minimal.
Talos is fully open source, production-ready, and supported by the people at Sidero Labs.
All system management is done via an API - there is no shell or interactive console.
Benefits include:

• Security: Talos reduces your attack surface: It's minimal, hardened, and immutable.
  All API access is secured with mutual TLS (mTLS) authentication.
• Predictability: Talos eliminates configuration drift, reduces unknown factors by employing immutable infrastructure ideology, and delivers atomic updates.
• Evolvability: Talos simplifies your architecture, increases your agility, and always delivers current stable Kubernetes and Linux versions.

Documentation Copy Chapter

For instructions on deploying and managing Talos, see the Documentation.

Community Copy Chapter

• Support: Questions, bugs, feature requests GitHub Discussions
• Slack: Join our slack channel. Request access via inviter.co.
• Twitter: @SideroLabs

If you're interested in this project and would like to help in engineering efforts or have general usage questions, we are happy to have you!
We hold a monthly meeting that all audiences are welcome to attend.

We would appreciate your feedback so that we can make Talos even better!
To do so, you can take our survey.

Office Hours Copy Section

• When: Second Monday of every month at 16:30 UTC.
• Where: Google Meet.

Note: You can convert the meeting hours to your local time.

Contributing Copy Chapter

Contributions are welcomed and appreciated!
See Contributing for our guidelines.

License Copy Chapter

Some software we distribute is under the General Public License family of licenses or other licenses that require we provide you with the source code.
If you would like a copy of the source code for this software, please contact us via email: info at SideroLabs.com.

2. Official Technical Reference & Guides (siderolabs/docs) Copy Chapter

SideroLabs documentation contribution guide

Welcome to the official SideroLabs documentation, we are excited that you want to contribute!

This guide walks you through how to make changes to the SideroLabs Docs, which power the documentation for Talos, Omni, and the shared Kubernetes Guides both projects rely on.

Whether you’re fixing a typo or adding a brand-new page, this document explains how to get started, how the docs are structured, and how to make sure your contribution is clear, consistent, and high-quality.

Where docs live Copy Chapter

All SideroLabs documentation is housed in a single repository, organized under the public/ folder:

public/

 ├── talos/               → Versioned Talos docs

 ├── omni/                → Unversioned Omni docs

 └── kubernetes-guides/   → Unversioned Kubernetes guides

The documentation is written in MDX format. You can learn more about MDX syntax from the Mintlify documentation and the official MDX website.

Documentation versioning policy Copy Chapter

When updating versioned documentation (for example, Talos), we generally expect changes to be applied to:

• The current version
• The previous version (if applicable)
• The upcoming version

Contributors are not expected to backport documentation changes across many older releases.

However, if you would like to update additional historical versions you are also welcome to do so.

If you are unsure which versions should be updated, please ask in the issue before opening a pull request.

Docs GitHub issues Copy Chapter

The Docs repository issues page lists known gaps or inaccuracies in the documentation. These issues are open for anyone to contribute to, whether you’re part of the SideroLabs team or a member of the community.

Sometimes, users also share doc-related feedback or questions directly in the Talos GitHub repository, usually under the Docs_improvement label.

Issues with the Docs_improvement label might be resolved in the Talos repo or migrated to the docs repo for further updates.

To understand how a Docs_improvement issue moves from open to merged, check out the Documentation Labeling and Workflow guide.

Writing and style standards Copy Chapter

Before you start writing or making any contributions, please review our Style Guide. It explains how we write, format, and structure documentation at SideroLabs.

Following the style guide helps keep every contribution consistent, clear, and approachable, no matter who wrote it.

Make a PR Copy Chapter

When you're ready to contribute, head over to our How to contribute to the SideroLabs documentation guide. It walks you through, step by step, how to create a pull request and submit your documentation changes.

--- METRICS ---

• Files Extracted: 2
• Estimated Token Budget: ~1391 tokens
• Recency Window: Active (< 180 days)
• Canonical Reference: https://codewiki.google/github.com/siderolabs/talos