philipp/uncloud
1
0
Fork 0
mirror of https://github.com/psviderski/uncloud.git synced 2026-08-26 11:03:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: collapse how it works section in readme

Browse Source
This commit is contained in:
Pavel Sviderski
2025-05-06 19:00:54 +10:00
parent 3648187219
commit f7b079c4f2
1 changed files with 6 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -9
View File
@@ -13,7 +13,7 @@ Unlike traditional orchestrators, there's no central control plane and quorum to
synchronized copy of the cluster state through peer-to-peer communication, keeping cluster operations functional even if synchronized copy of the cluster state through peer-to-peer communication, keeping cluster operations functional even if
some machines go offline. some machines go offline.
Uncloud aims to be the solution for developers who want the flexibility of self-hosted infrastructure without the Uncloud is the solution for developers who want the flexibility of self-hosted infrastructure without the
operational complexity of Kubernetes. operational complexity of Kubernetes.
## 🎬 Quick demo ## 🎬 Quick demo
@@ -46,12 +46,6 @@ Deploy a highly available web app with automatic HTTPS across multiple regions a
* **Docker-like CLI**: Familiar commands for managing both infrastructure and applications. * **Docker-like CLI**: Familiar commands for managing both infrastructure and applications.
* **Remote management**: Control your entire infrastructure through SSH access to any single machine in the cluster. * **Remote management**: Control your entire infrastructure through SSH access to any single machine in the cluster.
Coming soon:
* Project isolation through environments/namespaces
* Configs and secrets management using providers such as HashiCorp Vault and 1Password
* Monitoring and log aggregation
Here is a diagram of an Uncloud multi-provider cluster of 3 machines: Here is a diagram of an Uncloud multi-provider cluster of 3 machines:
![Diagram: multi-provider cluster of 3 machines](website/images/diagram.webp) ![Diagram: multi-provider cluster of 3 machines](website/images/diagram.webp)
@@ -120,8 +114,10 @@ View the [user guide](docs/user_guide.md) for more information.
## ⚙️ How it works ## ⚙️ How it works
Check out the [design document](docs/design.md) to understand Uncloud's design philosophy and goals. Here, let's peek Check out the [design document](docs/design.md) to understand Uncloud's design philosophy and goals.
under the hood to see what happens when you run certain commands.
<details>
<summary>Here, let's peek under the hood to see what happens when you run certain commands.</summary>
**When you initialize a new cluster on a machine:** **When you initialize a new cluster on a machine:**
@@ -256,6 +252,7 @@ Look ma, no control plane or master nodes to maintain! Just a simple overlay net
sync that lets machines work together. Want to check on things or make changes? Connect to any machine either implicitly sync that lets machines work together. Want to check on things or make changes? Connect to any machine either implicitly
using the CLI or directly over SSH. They all have the complete cluster state and can control everything. It's like each using the CLI or directly over SSH. They all have the complete cluster state and can control everything. It's like each
machine is a full backup of your control plane. machine is a full backup of your control plane.
</details>
## 🏗 Project status ## 🏗 Project status