diff --git a/images/kos/README.md b/images/kos/README.md index 741eb9f053add880ee349068c86fcc1bb7b25c83..0f3df2cf82720d0797bfbc8cb94f4ade28316984 100644 --- a/images/kos/README.md +++ b/images/kos/README.md @@ -3,6 +3,20 @@ kOS kOS (read 'chaos') is a simple OS based on CoreOS with the applied modifications for this repositories needs. It'll provide an easy way to reliably update the base OS of the cluster. +Usage +--- + +To install kOS, it's currently mandatory to install a regular CoreOS machine first. Then run the following command: + +```shell +sudo rpm-ostree rebase --experimental ostree-unverified-registry:quay.io/shivering-isles/kos:stable +sudo systemctl reboot +``` + +This will download the latest images version and rebase the existing system to this customised image. + +For updates, just run the regular `rpm-ostree upgrade`. + Concept ---