Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: link to official docs and drop docs folder #418

Merged
merged 1 commit into from
Jul 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 7 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ containerOS (**cOS**) is a toolkit to build, ship and maintain cloud-init driven

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.

[Documentation is available at https://rancher-sandbox.github.io/cos-toolkit-docs/docs](https://rancher-sandbox.github.io/cos-toolkit-docs/docs)

<!-- TOC -->

- [containerOS toolkit](#containeros-toolkit)
Expand All @@ -12,8 +14,6 @@ It is designed to reduce the maintenance surface, with a flexible approach to pr
- [Design goals](#design-goals)
- [Build cOS Locally](#build-cos-locally)
- [First steps](#first-steps)
- [References](#references)
- [Derivatives](#derivatives)
- [Samples](#samples)
- [cOS development](#cos-development)
- [License](#license)
Expand All @@ -22,7 +22,7 @@ It is designed to reduce the maintenance surface, with a flexible approach to pr

## In a nutshell

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 by default the [following featuresets](/docs/derivatives_featureset.md).
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.

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-opensuse) and can be pulled for inspection from the registry as well.

Expand Down Expand Up @@ -58,9 +58,9 @@ ISO [from the Github Actions page](https://github.com/rancher-sandbox/cOS-toolki

### Build cOS Locally

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](/docs/creating_bootable_images.md).
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/).

The only requirement to build derivatives with `cos-toolkit` is docker installed, see [Development notes](/docs/dev.md) for more details on how to build `cos` instead.
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.

## First steps

Expand All @@ -75,17 +75,10 @@ $ source .envrc
$ cos-build
```

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](/docs/creating_derivatives.md) for more details about the process.

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](/docs/creating_bootable_images.md) and see also [how to drive upgrades with Fleet](https://github.com/rancher-sandbox/cos-fleet-upgrades-sample).
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.

## References
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/).

### Derivatives
- [Creating derivatives](/docs/creating_derivatives.md)
- [Creating bootable images](/docs/creating_bootable_images.md)
- [Derivatives featureset](/docs/derivatives_featureset.md)
- [Building AMI machines in AWS](/docs/building_aws_ami.md)

### Samples
- [Sample repository](https://github.com/rancher-sandbox/cos-toolkit-sample-repo)
Expand All @@ -94,14 +87,8 @@ If you are looking after only generating a container image that can be used for
- [Deploy Fleet on a cOS vanilla image](/docs/k3s_and_fleet_on_vanilla_image_example.md)

### cOS development
- [Development notes](/docs/dev.md)
- [High Level architecture](/docs/high_level_architecture.md)
- [Github project](https://github.com/mudler/cOS/projects/1) for a short-term Roadmap

### Usage hints

- [Grub2 default boot entry setup](/docs/configure_grub.md)

## License

Copyright (c) 2020-2021 [SUSE, LLC](http://suse.com)
Expand Down
96 changes: 0 additions & 96 deletions docs/building_aws_ami.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/configure_grub.md

This file was deleted.

115 changes: 0 additions & 115 deletions docs/creating_bootable_images.md

This file was deleted.

Loading