diff --git a/README.md b/README.md index b14e1c0..74b6287 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,71 @@


- kairos-white-column 5bc2fe34 -
+ kairos-white-column 5bc2fe34
+ Kairos standard provider

+

Kairos standard provider

+

+ + license + + + docs + + go report card +

+ + With Kairos you can build immutable, bootable Kubernetes and OS images for your edge devices as easily as writing a Dockerfile. Optional P2P mesh with distributed ledger automates node bootstrapping and coordination. Updating nodes is as easy as CI/CD: push a new image to your container registry and let secure, risk-free A/B atomic upgrades do the rest. -

Kairos full-mesh support

+ + + + + + + + + + +
+ +

+ +Documentation + +

+
+ +

+ +Contribute + +

+
+ + 📚 [Getting started with Kairos](https://kairos.io/docs/getting-started)
:bulb: [Examples](https://kairos.io/docs/examples)
:movie_camera: [Video](https://kairos.io/docs/media/)
:open_hands:[Engage with the Community](https://kairos.io/community/) + +
+ +🙌[ CONTRIBUTING.md ]( https://github.com/kairos-io/kairos/blob/master/CONTRIBUTING.md )
:raising_hand: [ GOVERNANCE ]( https://github.com/kairos-io/kairos/blob/master/GOVERNANCE.md )
:construction_worker:[Code of conduct](https://github.com/kairos-io/kairos/blob/master/CODE_OF_CONDUCT.md) + +
+ +## Provider kairos This repository generates Kairos images with full-mesh support. full-mesh support currently is available only with k3s, and the provider follows strictly k3s releases. -To use Kairos with mesh support, either download the bootable medium in the releases, or either use kairos core with the provider-kairos bundles, during configuration like so: -```yaml -#node-config -install: - bundles: - - .... -``` +To use Kairos with mesh support, either download the bootable medium in the releases. + +Follow up the examples in our documentation on how to get started: +- https://kairos.io/docs/examples/single-node/ +- https://kairos.io/docs/examples/multi-node/ +- https://kairos.io/docs/examples/multi-node-p2p-ha-kubevip/ + ## Upgrades