mirror of
https://github.com/kairos-io/osbuilder.git
synced 2025-04-28 03:20:18 +00:00
4aa7211f96
* Remove references to osbuilder-tools image because it has been merged with auroraboot here: https://github.com/kairos-io/AuroraBoot/pull/110 as part of https://github.com/kairos-io/kairos/issues/1633 Signed-off-by: Dimitris Karakasilis <dimitris@karakasilis.me> * WIP Signed-off-by: Dimitris Karakasilis <dimitris@karakasilis.me> * Fix test command Signed-off-by: Dimitris Karakasilis <dimitris@karakasilis.me> * go mod tidy Signed-off-by: Dimitris Karakasilis <dimitris@karakasilis.me> * Bump linting action Signed-off-by: Dimitris Karakasilis <dimitris@karakasilis.me> * Don't look for artifacts in build/ subdir because it has been fixed here: https://github.com/kairos-io/AuroraBoot/pull/115 Signed-off-by: Dimitris Karakasilis <dimitris@karakasilis.me> --------- Signed-off-by: Dimitris Karakasilis <dimitris@karakasilis.me>
88 lines
2.8 KiB
Markdown
88 lines
2.8 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>
|
|
osbuilder
|
|
<br>
|
|
</h1>
|
|
|
|
<h3 align="center">Kubernetes Native Extension to build Linux distributions artifacts from container images</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/osbuilder/issues"><img src="https://img.shields.io/github/issues/kairos-io/osbuilder"></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/osbuilder" 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>
|
|
|
|
| :exclamation: | This is experimental! |
|
|
|-|:-|
|
|
|
|
## Installation
|
|
|
|
To install, use helm:
|
|
|
|
```
|
|
# Adds the kairos repo to helm
|
|
$ helm repo add kairos https://kairos-io.github.io/helm-charts
|
|
"kairos" has been added to your repositories
|
|
$ helm repo update
|
|
Hang tight while we grab the latest from your chart repositories...
|
|
...Successfully got an update from the "kairos" chart repository
|
|
Update Complete. ⎈Happy Helming!⎈
|
|
|
|
# Install the CRD chart
|
|
$ helm install kairos-crd kairos/kairos-crds
|
|
NAME: kairos-crd
|
|
LAST DEPLOYED: Tue Sep 6 20:35:34 2022
|
|
NAMESPACE: default
|
|
STATUS: deployed
|
|
REVISION: 1
|
|
TEST SUITE: None
|
|
|
|
# Installs osbuilder
|
|
$ helm install kairos-osbuilder kairos/osbuilder
|
|
```
|
|
|
|
Documentation available at: https://kairos.io/docs/advanced/build/
|