mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-05-02 13:44:33 +00:00
a196c85e04
Generated by git subtree add --prefix=docs git@github.com:kata-containers/documentation.git master git-subtree-dir: docs git-subtree-mainline:ec146a1b39git-subtree-split:510287204bFixes: #329 Signed-off-by: Peng Tao <bergwolf@hyper.sh>
77 lines
2.9 KiB
Markdown
77 lines
2.9 KiB
Markdown
# Documentation
|
|
|
|
* [Getting Started](#getting-started)
|
|
* [More User Guides](#more-user-guides)
|
|
* [Kata Use-Cases](#kata-use-cases)
|
|
* [Developer Guide](#developer-guide)
|
|
* [Design and Implementations](#design-and-implementations)
|
|
* [How to Contribute](#how-to-contribute)
|
|
* [Code Licensing](#code-licensing)
|
|
* [The Release Process](#the-release-process)
|
|
* [Help Improving the Documents](#help-improving-the-documents)
|
|
* [Website Changes](#website-changes)
|
|
|
|
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 guides
|
|
|
|
See the [howto documentation](how-to).
|
|
|
|
## Kata Use-Cases
|
|
|
|
* [GPU Passthrough with Kata](./use-cases/GPU-passthrough-and-Kata.md)
|
|
* [OpenStack Zun with Kata Containers](./use-cases/zun_kata.md)
|
|
* [SR-IOV with Kata](./use-cases/using-SRIOV-and-kata.md)
|
|
* [Intel QAT with Kata](./use-cases/using-Intel-QAT-and-kata.md)
|
|
* [VPP with Kata](./use-cases/using-vpp-and-kata.md)
|
|
* [SPDK vhost-user with Kata](./use-cases/using-SPDK-vhostuser-and-kata.md)
|
|
|
|
## Developer Guide
|
|
|
|
Documents that help to understand and contribute to Kata Containers.
|
|
|
|
### Design and Implementations
|
|
|
|
* [Kata Containers Architecture](design/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](Stable-Branch-Strategy.md)
|
|
* [Release Process](Release-Process.md)
|
|
|
|
## Help Improving the Documents
|
|
|
|
* [Documentation Requirements](Documentation-Requirements.md)
|
|
|
|
## Website Changes
|
|
|
|
If you have a suggestion for how we can improve the
|
|
[website](https://katacontainers.io), please raise an issue (or a PR) on
|
|
[the repository that holds the source for the website](https://github.com/OpenStackweb/kata-netlify-refresh).
|