mirror of
https://github.com/kairos-io/provider-kairos.git
synced 2025-04-27 19:35:36 +00:00
43e7222cbc
Remove left-overs from when we used this repo to release "standard" images. --------- Signed-off-by: Dimitris Karakasilis <dimitris@karakasilis.me>
78 lines
3.2 KiB
Markdown
78 lines
3.2 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
<img width="184" alt="kairos-white-column 5bc2fe34" src="https://user-images.githubusercontent.com/2420543/193010398-72d4ba6e-7efe-4c2e-b7ba-d3a826a55b7d.png"><br>
|
|
Kairos standard provider
|
|
<br>
|
|
</h1>
|
|
|
|
<h3 align="center">Kairos standard provider</h3>
|
|
<p align="center">
|
|
<a href="https://opensource.org/licenses/">
|
|
<img src="https://img.shields.io/badge/licence-APL2-brightgreen"
|
|
alt="license">
|
|
</a>
|
|
<a href="https://github.com/kairos-io/provider-kairos/issues"><img src="https://img.shields.io/github/issues/kairos-io/provider-kairos"></a>
|
|
<a href="https://kairos.io/docs/" target=_blank> <img src="https://img.shields.io/badge/Documentation-blue"
|
|
alt="docs"></a>
|
|
<img src="https://img.shields.io/badge/made%20with-Go-blue">
|
|
<img src="https://goreportcard.com/badge/github.com/kairos-io/provider-kairos" alt="go report card" />
|
|
</p>
|
|
|
|
|
|
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.
|
|
|
|
|
|
<table>
|
|
<tr>
|
|
<th align="center">
|
|
<img width="640" height="1px">
|
|
<p>
|
|
<small>
|
|
Documentation
|
|
</small>
|
|
</p>
|
|
</th>
|
|
<th align="center">
|
|
<img width="640" height="1">
|
|
<p>
|
|
<small>
|
|
Contribute
|
|
</small>
|
|
</p>
|
|
</th>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
|
|
📚 [Getting started with Kairos](https://kairos.io/docs/getting-started) <br> :bulb: [Examples](https://kairos.io/docs/examples) <br> :movie_camera: [Video](https://kairos.io/docs/media/) <br> :open_hands:[Engage with the Community](https://kairos.io/community/)
|
|
|
|
</td>
|
|
<td>
|
|
|
|
🙌[ CONTRIBUTING.md ]( https://github.com/kairos-io/kairos/blob/master/CONTRIBUTING.md ) <br> :raising_hand: [ GOVERNANCE ]( https://github.com/kairos-io/kairos/blob/master/GOVERNANCE.md ) <br>:construction_worker:[Code of conduct](https://github.com/kairos-io/kairos/blob/master/CODE_OF_CONDUCT.md)
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
## Provider kairos
|
|
|
|
This repository hosts the code for provider binary used in Kairos "standard" images which offer full-mesh support.
|
|
full-mesh support currently is available only with k3s, and the provider follows strictly k3s releases.
|
|
|
|
> [!NOTE]
|
|
> The provider-kairos release pipelines have been merged with the kairos ones from version `2.4.0` onward. All image artifacts are released from the kairos repository, both core images and standard images (those with the provider).
|
|
|
|
To use Kairos with mesh support, download the bootable medium form the [kairos releases](https://github.com/kairos-io/kairos/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
|
|
|
|
Upgrading can be done either via Kubernetes or manually with `kairos-agent upgrade --image <image>`, or you can list available versions with `kairos-agent upgrade list-releases`.
|
|
|
|
Container images available for upgrades are pushed to quay, you can check out the [image matrix in our documentation](https://kairos.io/docs/reference/image_matrix/).
|