mirror of
https://github.com/aljazceru/kata-containers.git
synced 2025-12-29 03:54:27 +01:00
87d9ebc14c
We have some initial Firecracker/Kata documentaiton, but for now it lives in the wiki. Link off to it from the top level docs README to make it more obvious and easier to find. Fixes: #367 Signed-off-by: Graham Whaley <graham.whaley@intel.com>
51 lines
2.1 KiB
Markdown
51 lines
2.1 KiB
Markdown
# Documentation
|
|
|
|
The [Kata Containers](https://github.com/kata-containers)
|
|
documentation repository hosts overall system documentation, with information
|
|
common to multiple components.
|
|
|
|
For details of the other Kata Containers repositories, see the
|
|
[repository summary](https://github.com/kata-containers/kata-containers).
|
|
|
|
## Getting Started
|
|
|
|
* [Installation guides](./install/README.md): Install and run Kata Containers with Docker or Kubernetes
|
|
|
|
## More User Guides
|
|
|
|
* [Upgrading](Upgrading.md): how to upgrade from [Clear Containers](https://github.com/clearcontainers) and [runV](https://github.com/hyperhq/runv) to [Kata Containers](https://github.com/kata-containers) and how to upgrade an existing Kata Containers system to the latest version.
|
|
* [Limitations](Limitations.md): differences and limitations compared with the default [Docker](https://www.docker.com/) runtime,
|
|
[`runc`](https://github.com/opencontainers/runc).
|
|
|
|
* HOWTO: [Kata Containers with k8s and cri-containerd](./how-to/how-to-use-k8s-with-cri-containerd-and-kata.md)
|
|
* HOWTO: [OpenStack Zun with Kata Containers](zun/zun_kata.md)
|
|
* HOWTO: [Kata Containers with Firecracker](https://github.com/kata-containers/documentation/wiki/Initial-release-of-Kata-Containers-with-Firecracker-support)
|
|
|
|
## Developer Guide
|
|
|
|
Documents that help to understand and contribute to Kata Containers.
|
|
|
|
### Design and Implementations
|
|
|
|
* [Kata Containers Architecture](architecture.md): Architectural overview of Kata Containers
|
|
* [Kata Containers design](./design/README.md): More Kata Containers design documents
|
|
|
|
### How to Contribute
|
|
|
|
* [Developer Guide](Developer-Guide.md): Setup the Kata Containers developing environments
|
|
* [How to contribute to Kata Containers](https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md)
|
|
* [Code of Conduct](CODE_OF_CONDUCT.md)
|
|
|
|
### Code Licensing
|
|
|
|
* [Licensing](Licensing-strategy.md): About the licensing strategy of Kata Containers.
|
|
|
|
### The Release Process
|
|
|
|
* [Release strategy](Releases.md)
|
|
* [Release Checklist](Release-Checklist.md)
|
|
|
|
## Help Improving the Documents
|
|
|
|
* [Documentation Requirements](Documentation-Requirements.md)
|