github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-07-02 02:02:24 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #277 from jodh-intel/improve-readme

Browse Source 
docs: Improve table in install README
This commit is contained in:
James O. D. Hunt 2018-10-23 15:38:31 +01:00 committed by GitHub
commit 2a54ac9830
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
install/README.md
View File

@ -19,18 +19,28 @@ 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 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. in a system configured to run Kata Containers.
|Installation method |Suggested for |Supported on |
|-----------------------------------------------------------|-----------------------------------------|-----------------------------------------| | Installation method | Suggested for | Description | Packaged install | Distributions supported |
|[Automatic](#automatic-installation) |Quick installation; new users |[distros list](#supported-distributions) | |------------------------------------------------------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|------------------|---------------------------------------|
|[Scripted](#scripted-installation) |Generating installation scripts |[distros list](#supported-distributions) | | [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) |Full control over each installation step |[distros list](#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) |
|[Build from sources](#../Developer-Guide.md#initial-setup) |Developers and hackers |any distro | | [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 ### Automatic Installation
[Use kata-manager](installing-with-kata-manager.md) to automatically install Kata packages. [Use kata-manager](installing-with-kata-manager.md) to automatically install Kata packages.
### Scripted Installation ### Scripted Installation
[Use kata-doc-to-script](installing-with-kata-doc-to-script.md) to generate installation scripts. [Use kata-doc-to-script](installing-with-kata-doc-to-script.md) to generate installation scripts that can be reviewed before they are executed.
### Manual Installation ### Manual Installation
Manual installation instructions are available for [these distributions](#supported-distributions) and document how to: Manual installation instructions are available for [these distributions](#supported-distributions) and document how to:
@ -57,7 +67,7 @@ Manual installation instructions are available for [these distributions](#suppor
> **Notes on packages source verification**: > **Notes on packages source verification**:
> - The Kata packages hosted on the download server are signed with GPG to ensure integrity and authenticity. > - The Kata packages hosted on the download server are signed with GPG to ensure integrity and authenticity.
> >
> - The public key used to sign packages is available [at this link](https://github.com/kata-containers/tests/data/rpm-signkey.pub); the fingerprint is `9FDC0CB6 3708CF80 3696E2DC D0B37B82 6063F3ED`. > - The public key used to sign packages is available [at this link](https://raw.githubusercontent.com/kata-containers/tests/master/data/rpm-signkey.pub); the fingerprint is `9FDC0CB6 3708CF80 3696E2DC D0B37B82 6063F3ED`.
> >
> - Only trust the signing key and fingerprint listed in the previous bullet point. Do not disable GPG checks, > - Only trust the signing key and fingerprint listed in the previous bullet point. Do not disable GPG checks,
> otherwise packages source and authenticity is not guaranteed. > otherwise packages source and authenticity is not guaranteed.