Skip to content

Commit 7d04f1d

Browse files
authored
Bump cOS to 0.6.0 (#446)
* Bump cOS to 0.6.0 Signed-off-by: Ettore Di Giacinto <[email protected]> * Update README by pointing to docs Signed-off-by: Ettore Di Giacinto <[email protected]> * Bump cloud-config Signed-off-by: Ettore Di Giacinto <[email protected]>
1 parent 477252c commit 7d04f1d

File tree

5 files changed

+11
-79
lines changed

5 files changed

+11
-79
lines changed

README.md

Lines changed: 5 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,10 @@
1-
# containerOS toolkit
1+
# [![Build cOS master](https://github.com/rancher-sandbox/cOS-toolkit/actions/workflows/build-master.yaml/badge.svg)](https://github.com/rancher-sandbox/cOS-toolkit/actions/workflows/build-master.yaml) containerOS toolkit
22

3-
containerOS (**cOS**) is a toolkit to build, ship and maintain cloud-init driven Linux derivatives based on container images with a common featureset.
3+
containerOS (**cOS**) is a toolkit to build, ship and maintain cloud-init driven Linux derivatives based on container images with a common featureset - allows container images to be bootable in VMs, baremetals, embedded devices, and much more.
44

55
It is designed to reduce the maintenance surface, with a flexible approach to provide upgrades from container registries. It is cloud-init driven and also designed to be adaptive-first, allowing easily to build changes on top.
66

7-
[Documentation is available at https://rancher-sandbox.github.io/cos-toolkit-docs/docs](https://rancher-sandbox.github.io/cos-toolkit-docs/docs)
8-
9-
<!-- TOC -->
10-
11-
- [containerOS toolkit](#containeros-toolkit)
12-
- [In a nutshell](#in-a-nutshell)
13-
- [Releases](#releases)
14-
- [Design goals](#design-goals)
15-
- [Build cOS Locally](#build-cos-locally)
16-
- [First steps](#first-steps)
17-
- [Samples](#samples)
18-
- [cOS development](#cos-development)
19-
- [License](#license)
20-
21-
<!-- /TOC -->
22-
23-
## In a nutshell
24-
25-
cOS derivatives are built from containers, and completely hosted on image registries. The build process results in a single container image used to deliver regular upgrades in OTA approach. Each derivative built with `cos-toolkit` inherits a default featureset.
26-
27-
cOS supports different release channels, all the final and cache images used are tagged and pushed regularly [to Quay Container Registry](https://quay.io/repository/costoolkit/releases-green) and can be pulled for inspection from the registry as well.
28-
29-
Those are exactly the same images used during upgrades, and can also be used to build Linux derivatives from cOS.
30-
31-
For example, if you want to see locally what's in a openSUSE cOS version , you can:
32-
33-
```bash
34-
$ docker run -ti --rm quay.io/costoolkit/releases-green:cos-system-$VERSION /bin/bash
35-
```
36-
37-
## Releases
38-
39-
cOS-toolkit releases consist on container images that can be used to build derived against and the cos source tree itself.
40-
41-
cOS is a manifest which assembles an OS from containers, so if you want to make substantial changes to the layout you can also fork directly cOS.
42-
43-
Currently, the toolkit supports creating derivatives from [OpenSUSE (green), Fedora (blue) and Ubuntu (orange)](https://github.com/rancher-sandbox/cOS-toolkit/tree/master/values), although it's rather simple to add support for other OS families and architecures.
44-
45-
The cOS CI generates ISO and images artifacts used for testing, so you can also try out cOS by downloading the
46-
ISO [from the Github Actions page](https://github.com/rancher-sandbox/cOS-toolkit/actions/workflows/build.yaml), to the commit you are interested into.
7+
Documentation is available at [https://rancher-sandbox.github.io/cos-toolkit-docs/docs](https://rancher-sandbox.github.io/cos-toolkit-docs/docs)
478

489
## Design goals
4910

@@ -56,38 +17,9 @@ ISO [from the Github Actions page](https://github.com/rancher-sandbox/cOS-toolki
5617
- Easy to customize
5718
- Cryptographically verified
5819

59-
### Build cOS Locally
60-
61-
The starting point to use cos-toolkit is to see it in action with our [sample repository](https://github.com/rancher-sandbox/cos-toolkit-sample-repo) or check out our `examples` folder, see also [creating bootable images](https://rancher-sandbox.github.io/cos-toolkit-docs/docs/creating-derivatives/creating_bootable_images/).
62-
63-
The only requirement to build derivatives with `cos-toolkit` is docker installed, see [Development notes](https://rancher-sandbox.github.io/cos-toolkit-docs/docs/development/) for more details on how to build `cos` instead.
64-
65-
## First steps
66-
67-
The [sample repository](https://github.com/rancher-sandbox/cos-toolkit-sample-repo) contains the definitions of a [SampleOS](https://github.com/rancher-sandbox/cos-toolkit-sample-repo/tree/master/packages/sampleOS) boilerplate, which results in an immutable single-image distro and a [simple HTTP service on top](https://github.com/rancher-sandbox/cos-toolkit-sample-repo/tree/master/packages/sampleOSService) that gets started on boot.
68-
69-
To give it a quick shot, it's as simple as cloning the [Github repository](https://github.com/rancher-sandbox/cos-toolkit-sample-repo), and running cos-build:
70-
71-
```bash
72-
$ git clone https://github.com/rancher-sandbox/cos-toolkit-sample-repo
73-
$ cd cos-toolkit-sample-repo
74-
$ source .envrc
75-
$ cos-build
76-
```
77-
78-
This command will build a container image which contains the required dependencies to build the custom OS, and will later be used to build the OS itself. The result will be a set of container images and an ISO which you can boot with your environment of choice. See [Creating derivatives](https://rancher-sandbox.github.io/cos-toolkit-docs/docs/creating-derivatives/creating_derivatives/) for more details about the process.
79-
80-
If you are looking after only generating a container image that can be used for upgrades from the cOS vanilla images, see [creating bootable images](https://rancher-sandbox.github.io/cos-toolkit-docs/docs/creating-derivatives/creating_bootable_images/) and see also [how to drive upgrades with Fleet](https://rancher-sandbox.github.io/cos-toolkit-docs/docs/tutorials/trigger_upgrades_with_fleet/).
81-
82-
83-
### Samples
84-
- [Sample repository](https://github.com/rancher-sandbox/cos-toolkit-sample-repo)
85-
- [EpinioOS sample repository](https://github.com/rancher-sandbox/epinio-appliance-demo-sample)
86-
- [Use Fleet to upgrade a cOS derivative](https://github.com/rancher-sandbox/cos-fleet-upgrades-sample)
87-
- [Deploy Fleet on a cOS vanilla image](/docs/k3s_and_fleet_on_vanilla_image_example.md)
20+
### Quick start
8821

89-
### cOS development
90-
- [Github project](https://github.com/mudler/cOS/projects/1) for a short-term Roadmap
22+
Check out our [getting-started](https://rancher-sandbox.github.io/cos-toolkit-docs/docs/getting-started/) section in the documentation.
9123

9224
## License
9325

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
name: cloud-config
22
category: system
3-
version: 0.6.2+9
3+
version: "0.7"

packages/cos/collection.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
packages:
22
- name: "cos"
33
category: "system"
4-
version: 0.5.8+6
4+
version: "0.6.0"
55
description: "cOS base image, used to build cOS live ISOs"
66
brand_name: "cOS"
77
labels:
88
autobump.revdeps: "true"
99
autobump.revbump_related: "recovery/cos-img recovery/cos-squash"
1010
- name: "cos"
1111
category: "recovery"
12-
version: 0.5.8+6
12+
version: "0.6.0"
1313
brand_name: "cOS recovery"
1414
description: "cOS recovery image, used to boot cOS for troubleshooting"
1515
labels:
1616
autobump.revdeps: "true"
1717
autobump.revbump_related: "recovery/cos-img recovery/cos-squash"
1818
- name: "cos-container"
1919
category: "system"
20-
version: 0.5.8+6
20+
version: "0.6.0"
2121
brand_name: "cOS"
2222
description: "cOS container image, used to build cOS derivatives from scratch"
2323
labels:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
name: "cos-img"
22
category: "recovery"
3-
version: 0.5.8+6
3+
version: "0.6.0"
44
brand_name: "cOS"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
name: "cos-squash"
22
category: "recovery"
3-
version: 0.5.8+6
3+
version: "0.6.0"

0 commit comments

Comments
 (0)