aljaz/kata-containers
1
0
Fork 0
mirror of https://github.com/aljazceru/kata-containers.git synced 2026-02-23 07:24:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Improve table in install README

Browse Source 
Improvements to the table in the installation README:

- Fix the invalid link for the "Build from sources" option.

- Add column for "Packaged install" to make it clearer which
  options result in a distro-packed install.

- Tweaked the "Suggested for" column to make the use-case options
  clearer.

- Added detail for each use-case in a "Description" column.

Fixes #276.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt
2018-10-18 15:28:36 +01:00
parent 30f2fbfb73
commit 16379e3bc7
1 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
install/README.md
View File

@@ -19,12 +19,22 @@ to see if your system is capable of running Kata Containers.
The following is an overview of the different installation methods available. All of these methods equally result
in a system configured to run Kata Containers.
|Installation method |Suggested for |Supported on |
|-----------------------------------------------------------|-----------------------------------------|-----------------------------------------|
|[Automatic](#automatic-installation) |Quick installation; new users |[distros list](#supported-distributions) |
|[Scripted](#scripted-installation) |Generating installation scripts |[distros list](#supported-distributions) |
|[Manual](#manual-installation) |Full control over each installation step |[distros list](#supported-distributions) |
|[Build from sources](#../Developer-Guide.md#initial-setup) |Developers and hackers |any distro |
| Installation method | Suggested for | Description | Packaged install | Distributions supported |
|------------------------------------------------------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|------------------|---------------------------------------|
| [Automatic](#automatic-installation) | Quick start for new users | Run a single command to install a full system. | yes | [see table](#supported-distributions) |
| [Manual](#manual-installation) | Self paced user install | Allows the user to read a brief document and exectute the specified commands step-by-step. | yes | [see table](#supported-distributions) |
| [Scripted](#scripted-installation) | Administrators | Generates an installation script which will result in a working system when executed. | yes | [see table](#supported-distributions) |
| [Build from sources](../Developer-Guide.md#initial-setup) | Developers and hackers only | Allows power users who are comfortable building software from source to use the latest component versions. Not recommended for normal users. | no | any distro |
> **Notes:**
>
> - The "Packaged install" column shows if the resulting installation
> uses your distribution's native package format (such as RPM or DEB).
>
> - Power users who decide to build from sources should be aware of the
> implications of using an unpackaged system which will not be automatically
> updated as new [releases](../Releases.md) are made available.
### Automatic Installation
[Use kata-manager](installing-with-kata-manager.md) to automatically install Kata packages.