diff --git a/README.md b/README.md index bb8342b769..0cc1fa6a9f 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,13 @@ For details of the other Kata Containers repositories, see the * [Community](#community) * [Contact](#contact) * [Further information](#further-information) +* [Additional packages](#additional-packages) ## Introduction `kata-runtime`, referred to as "the runtime", is the Command-Line Interface (CLI) part of the Kata Containers runtime component. It leverages the -[virtcontainers](https://github.com/kata-containers/runtime/tree/master/virtcontainers) +[virtcontainers](virtcontainers) package to provide a high-performance standards-compliant runtime that creates hardware-virtualized containers. @@ -170,3 +171,8 @@ See the [project table of contents](https://github.com/kata-containers/kata-containers) and the [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). diff --git a/pkg/README.md b/pkg/README.md new file mode 100644 index 0000000000..b5b0d07d32 --- /dev/null +++ b/pkg/README.md @@ -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. | diff --git a/pkg/katautils/README.md b/pkg/katautils/README.md new file mode 100644 index 0000000000..36481cdba9 --- /dev/null +++ b/pkg/katautils/README.md @@ -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. diff --git a/pkg/signals/README.md b/pkg/signals/README.md new file mode 100644 index 0000000000..87a79d8c38 --- /dev/null +++ b/pkg/signals/README.md @@ -0,0 +1,4 @@ +# Signals package + +The `signals` package contains common signal handling functions that are shared by +the binaries built in this repository. diff --git a/virtcontainers/README.md b/virtcontainers/README.md index a2778971f6..4294e4b56d 100644 --- a/virtcontainers/README.md +++ b/virtcontainers/README.md @@ -21,6 +21,8 @@ Table of Contents * [Devices](#devices) * [How to pass a device using VFIO-passthrough](#how-to-pass-a-device-using-vfio-passthrough) * [Developers](#developers) + * [Persistent storage plugin support](#persistent-storage-plugin-support) + * [Experimental features](#experimental-features) # 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. +For further details, see the [API documentation](documentation/api/1.0/api.md). + # Networking `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 [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).