github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-29 16:57:18 +00:00
Code Issues Projects Releases Wiki Activity

docs: Add missing docs

Browse Source 
Add a few minimal documents to allow all the documentation in this
repository to be navigated from the top-level README.

Fixes #1681.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2019-05-15 16:21:34 +01:00
parent 1563263c0d
commit da2749c44d
5 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -25,6 +25,7 @@ For details of the other Kata Containers repositories, see the
* [Community](#community) * [Community](#community)
* [Contact](#contact) * [Contact](#contact)
* [Further information](#further-information) * [Further information](#further-information)
* [Additional packages](#additional-packages)
## Introduction ## Introduction
@ -170,3 +171,8 @@ See the
[project table of contents](https://github.com/kata-containers/kata-containers) [project table of contents](https://github.com/kata-containers/kata-containers)
and the and the
[documentation repository](https://github.com/kata-containers/documentation). [documentation repository](https://github.com/kata-containers/documentation).
## Additional packages
For details of the other packages contained in this repository, see the
[package documentation](pkg).

10
pkg/README.md Normal file
View File

@ -0,0 +1,10 @@
# Kata golang packages
This repository contains a number of packages in addition to the
[`virtcontainers`](../virtcontainers) package:
| Package name | Description |
|-|-|
| [`katatestutils`](katatestutils) | Unit test utilities. |
| [`katautils`](katautils) | Utilities. |
| [`signals`](signals) | Signal handling functions. |

4
pkg/katautils/README.md Normal file
View File

@ -0,0 +1,4 @@
# Kata utilities packages
The `katautils` package contains useful functions that are shared by various
parts of the codebase, including the runtime and the container v2 shim.

4
pkg/signals/README.md Normal file
View File

@ -0,0 +1,4 @@
# Signals package
The `signals` package contains common signal handling functions that are shared by
the binaries built in this repository.

12
virtcontainers/README.md
View File

@ -21,6 +21,8 @@ Table of Contents
* [Devices](#devices) * [Devices](#devices)
* [How to pass a device using VFIO-passthrough](#how-to-pass-a-device-using-vfio-passthrough) * [How to pass a device using VFIO-passthrough](#how-to-pass-a-device-using-vfio-passthrough)
* [Developers](#developers) * [Developers](#developers)
* [Persistent storage plugin support](#persistent-storage-plugin-support)
* [Experimental features](#experimental-features)
# What is it ? # What is it ?
@ -153,6 +155,8 @@ The Sandbox has to be running.
An example tool using the `virtcontainers` API is provided in the `hack/virtc` package. An example tool using the `virtcontainers` API is provided in the `hack/virtc` package.
For further details, see the [API documentation](documentation/api/1.0/api.md).
# Networking # Networking
`virtcontainers` supports the 2 major container networking models: the [Container Network Model (CNM)][cnm] and the [Container Network Interface (CNI)][cni]. `virtcontainers` supports the 2 major container networking models: the [Container Network Model (CNM)][cnm] and the [Container Network Interface (CNI)][cni].
@ -324,3 +328,11 @@ tooling.
For information on how to build, develop and test `virtcontainers`, see the For information on how to build, develop and test `virtcontainers`, see the
[developer documentation](documentation/Developers.md). [developer documentation](documentation/Developers.md).
# Persistent storage plugin support
See the [persistent storage plugin documentation](persist/plugin).
# Experimental features
See the [experimental features documenation](experimental).