Skip to content

Latest commit

 

History

History
78 lines (49 loc) · 3.5 KB

README.md

File metadata and controls

78 lines (49 loc) · 3.5 KB
Raw




Create Decentralized Kubernetes clusters


Kubernetes-focused Linux OS - Automatic Node discovery - Automatic VPN - K3s

C3OS is a lightweight Kubernetes-focused GNU/Linux derivative built with Elemental-toolkit that optionally supports automatic node discovery, automatic role assignment and optionally VPN out of the box with no kubernetes networking configuration required.

C3OS can also create multi-nodes Kubernetes cluster with k3s that connects autonomously in a hybrid P2P mesh VPN which bridges nodes without any central server, also behind nat, or it can be just used standalone as a k3s server.

C3OS is entirely backed up by community, It's Free and Open Source, under the Apache 2.0 License. Feel free to open issues or contribute with PRs!

  • No infrastructure is required. C3OS can be used to bootstrap a cluster entirely from the ground-up.
  • LAN, remote networks, multi-region/zones, NAT - No network configuration or opening port outside is required. Nodes will connect each other via holepunching and using hops wherever necessary.
  • Zero kubernetes configuration - Nodes autonomously discover and configure themselves to form a Kubernetes cluster. The same configuration/bootstrapping process applies wether creating new clusters or joining nodes to existing one.
  • Secure P2P Remote recovery to restore failed nodes or lost credentials
  • Hybrid P2P mesh between nodes (optional)

It comes in two variants, based on openSUSE and Alpine.

Documentation available here.

Run c3os

Download the ISO or the image from the latest releases.

You can just use BalenaEtcher or just dd the ISO/image to the disk.

Automated installation

Boot the ISO and follow the instructions on screen. c3os supports automatic peer discovery and device pairing.

QR Code installation

By default the ISO will boot in device pairing mode, which will present a QR code that can be used to drive the installation.

By having the QR visible at screen, use the c3os CLI to register the node, for example:

$ c3os register --config config.yaml --device /dev/sda --reboot --log-level debug
# Or, with an image screenshot of the QR code:
$ c3os register --config config.yaml --device /dev/sda ~/path/to/image.png

Check out the documentation.

Manual Installation

After booting, it is possible to install c3os manually with c3os interactive-install.

The default user pass is c3os:c3os on LiveCD mediums. See Docs.

Upgrades

Upgrades can be triggered with Kubernetes or manually with c3os upgrade. See Docs.

Building c3os

Requirements: Needs only docker.

Run build.sh, should produce a docker image along with a working ISO