diff --git a/README.md b/README.md index 7066eb9fa3..7f57462608 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,6 @@ releases. If you want to learn about Kata Containers, visit the main [Kata Containers website](https://katacontainers.io). -For further details on the older (first generation) Kata Containers 1.x -versions, see the -[Kata Containers 1.x components](#kata-containers-1x-components) -section. - ## Introduction Kata Containers is an open source project and community working to build a @@ -51,69 +46,34 @@ Please raise an issue > **Note:** > If you are reporting a security issue, please follow the [vulnerability reporting process](https://github.com/kata-containers/community#vulnerability-handling) -#### Kata Containers 1.x versions - -For older Kata Containers 1.x releases, please raise an issue in the -[Kata Containers 1.x component repository](#kata-containers-1x-components) -that seems most appropriate. - -If in doubt, raise an issue -[in the Kata Containers 1.x runtime repository](https://github.com/kata-containers/runtime/issues). - ## Developers ### Components +### Main components + +The table below lists the core parts of the project: + | Component | Type | Description | |-|-|-| -| [agent-ctl](tools/agent-ctl) | utility | Tool that provides low-level access for testing the agent. | +| [runtime](src/runtime) | core | Main component run by a container manager and providing a containerd shimv2 runtime implementation. | | [agent](src/agent) | core | Management process running inside the virtual machine / POD that sets up the container environment. | | [documentation](docs) | documentation | Documentation common to all components (such as design and install documentation). | -| [osbuilder](tools/osbuilder) | infrastructure | Tool to create "mini O/S" rootfs and initrd images for the hypervisor. | -| [packaging](tools/packaging) | infrastructure | Scripts and metadata for producing packaged binaries
(components, hypervisors, kernel and rootfs). | -| [runtime](src/runtime) | core | Main component run by a container manager and providing a containerd shimv2 runtime implementation. | -| [trace-forwarder](src/trace-forwarder) | utility | Agent tracing helper. | +| [tests](https://github.com/kata-containers/tests) | tests | Excludes unit tests which live with the main code. | -#### Kata Containers 1.x components +### Additional components -For the first generation of Kata Containers (1.x versions), each component was -kept in a separate repository. - -For information on the Kata Containers 1.x releases, see the -[Kata Containers 1.x releases page](https://github.com/kata-containers/runtime/releases). - -For further information on particular Kata Containers 1.x components, see the -individual component repositories: +The table below lists the remaining parts of the project: | Component | Type | Description | |-|-|-| -| [agent](https://github.com/kata-containers/agent) | core | See [components](#components). | -| [documentation](https://github.com/kata-containers/documentation) | documentation | | -| [KSM throttler](https://github.com/kata-containers/ksm-throttler) | optional core | Daemon that monitors containers and deduplicates memory to maximize container density on the host. | -| [osbuilder](https://github.com/kata-containers/osbuilder) | infrastructure | See [components](#components). | -| [packaging](https://github.com/kata-containers/packaging) | infrastructure | See [components](#components). | -| [proxy](https://github.com/kata-containers/proxy) | core | Multiplexes communications between the shims, agent and runtime. | -| [runtime](https://github.com/kata-containers/runtime) | core | See [components](#components). | -| [shim](https://github.com/kata-containers/shim) | core | Handles standard I/O and signals on behalf of the container process. | - -> **Note:** -> -> - There are more components for the original Kata Containers 1.x implementation. -> - The current implementation simplifies the design significantly: -> compare the [current](docs/design/architecture.md) and -> [previous generation](https://github.com/kata-containers/documentation/blob/master/design/architecture.md) -> designs. - -### Common repositories - -The following repositories are used by both the current and first generation Kata Containers implementations: - -| Component | Description | Current | First generation | Notes | -|-|-|-|-|-| -| CI | Continuous Integration configuration files and scripts. | [Kata 2.x](https://github.com/kata-containers/ci/tree/master) | [Kata 1.x](https://github.com/kata-containers/ci/tree/master) | | -| kernel | The Linux kernel used by the hypervisor to boot the guest image. | [Kata 2.x][kernel] | [Kata 1.x][kernel] | Patches are stored in the packaging component. | -| tests | Test code. | [Kata 2.x](https://github.com/kata-containers/tests/tree/main) | [Kata 1.x](https://github.com/kata-containers/tests/tree/main) | Excludes unit tests which live with the main code. | -| www.katacontainers.io | Contains the source for the [main web site](https://www.katacontainers.io). | [Kata 2.x][github-katacontainers.io] | [Kata 1.x][github-katacontainers.io] | | | +| [packaging](tools/packaging) | infrastructure | Scripts and metadata for producing packaged binaries
(components, hypervisors, kernel and rootfs). | +| [kernel](https://www.kernel.org) | kernel | Linux kernel used by the hypervisor to boot the guest image. Patches are stored [here](tools/packaging/kernel). | +| [osbuilder](tools/osbuilder) | infrastructure | Tool to create "mini O/S" rootfs and initrd images and kernel for the hypervisor. | +| [`agent-ctl`](tools/agent-ctl) | utility | Tool that provides low-level access for testing the agent. | +| [`trace-forwarder`](src/trace-forwarder) | utility | Agent tracing helper. | +| [`ci`](https://github.com/kata-containers/ci) | CI | Continuous Integration configuration files and scripts. | +| [`katacontainers.io`](https://github.com/kata-containers/www.katacontainers.io) | Source for the [`katacontainers.io`](https://www.katacontainers.io) site. | ### Packaging and releases diff --git a/docs/install/README.md b/docs/install/README.md index e1ddca218e..40baec9169 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -10,11 +10,6 @@ See the [hardware requirements](/src/runtime/README.md#hardware-requirements) to see if your system is capable of running Kata Containers. -## Legacy installation - -If you wish to install a legacy 1.x version of Kata Containers, see -[the Kata Containers 1.x installation documentation](https://github.com/kata-containers/documentation/tree/master/install/). - ## Packaged installation methods > **Notes:**