Skip to content

(chore) update README #1821

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

Merged
gianlucam76 merged 1 commit into from
Jun 4, 2026
Merged

(chore) update README #1821

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,11 @@ Sveltos can automatically detect drift between the desired state, defined in the
<img alt="Configuration drift recovery" src="https://github.com/projectsveltos/demos/blob/main/configuration_drift/reconcile_configuration_drift.gif" width="600"/>
</p>

## Pull Mode: Air-Gapped and Edge Clusters

Sveltos supports a pull mode for environments where managed clusters cannot accept inbound connections — air-gapped networks, edge deployments, or clusters behind firewalls.

In pull mode, a lightweight agent on the managed cluster initiates outbound connections to the management cluster to fetch its desired state. No inbound ports need to be open on the managed cluster, reducing attack surface and removing the need for VPN tunnels or firewall rules. It also handles intermittent connectivity, making it suitable for edge deployments.

[![Projectsveltos intro](https://img.youtube.com/vi/bsWEo79w09c/0.jpg)](https://www.youtube.com/watch?v=bsWEo79w09c)
[![Projectsveltos event driven framework](https://img.youtube.com/vi/4mOWuOF0gWY/0.jpg)](https://www.youtube.com/watch?v=4mOWuOF0gWY)
Expand All @@ -174,7 +179,15 @@ Sveltos can automatically detect drift between the desired state, defined in the

## Quick Start

💡 🏃‍♂️ To try projectsveltos on a test cluster, follow these [instructions](https://projectsveltos.github.io/sveltos/getting_started/install/quick_start/)
The fastest way to try Sveltos locally — no cloud account needed:

```sh
make quickstart
```

This creates a kind cluster with Sveltos and ClusterAPI, then provisions a workload cluster using Docker as the infrastructure provider. You get the full fleet management flow on your laptop in a few minutes.

For other installation options, see the [Quick Start guide](https://projectsveltos.github.io/sveltos/getting_started/install/quick_start/).

## Sveltos in action

Expand All @@ -185,7 +198,6 @@ To see the full demo, have a look at this [youtube video](https://youtu.be/Ai5Mr
# Useful links

- Projectsveltos [documentation](https://projectsveltos.github.io/sveltos/)
- [Quick Start](https://projectsveltos.io/main/getting_started/install/quick_start/)

## Contributing

Expand Down