Puts the nested virt/bare metal requirement in the top line
of the Install Guide and references the Kata hardware
check.
Signed-off-by: Anne Bertucio <anne@openstack.org>
The design subdir README index was a little slim and
potentially out of date, and was missing hotlinks to
some documents that did exist.
Signed-off-by: Graham Whaley <graham.whaley@intel.com>
The top level README.md index for the repository was a bit
slim on entries.
Add all the other docs in this repo to the index, and sort them
alphabetically by symbolic name (which may be slightly different
from the filename itself).
Fixes: #146
Signed-off-by: Graham Whaley <graham.whaley@intel.com>
This commit updates all 3 installation instructions related to
Ubuntu, Fedora and Centos, providing a disclaimer about the k8s
installation. Particularly, it says that those docs are only
explaining how to run Kata Containers with Docker, and that the
user should refer to the developer documentation to read how
to install Kata for k8s.
Fixes#134
Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
This documentation update purpose is to propose an alternative to the
default Docker usage that was described. The developer wanting to
interact with Kubernetes will have the proper information to start.
Fixes#134
Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
A few assumption were made, making the steps not working directly on
a clean system.
Fixes#134
Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
Moved static tests to CI setup script and added a new CI test to
execute all install guides if any one changes.
Fixes#132.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Updated the `Upgrading.md` document to ensure users remove the Clear
Containers throttler package to avoid conflicts with the Kata Container
equivalent.
Fixes#138.
Signed-off-by: Liu Changcheng <changcheng.liu@intel.com>
Add details to documentation requirements document explaining how we use
and format notes.
Fixes#125.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Update the install README and the install guides to point to the
upgrading document.
Fixes#119.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Add document to describe to to setup kubernetes and "cri" containerd
Fixes: #87
Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
Now that we have a README for the installation guides, update the
developer guide to refer to that page, to avoid hard-coding links to
(some of) the installation guides.
Fixes#117.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
The CentOS install guide was referencing an invalid package
(`dnf-plugins-core`) so update for the yum equivalent.
Fixes#329.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Remove backslash from centos url that was
preventing the $VERSION_ID to take its correct value.
Fixes: #112.
Signed-off-by: Salvador Fuentes <salvador.fuentes@intel.com>
Remove the `bash` tag from the last command in the install guides where
we show the user how to create a container with a busybox shell. This
doesn't change the content of the document but it ensures that all bash
blocks can be run non-interactively (by the `kata-doc-to-script.sh`
script in the tests repo).
Fixes#109.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
cli events is now partly supported.It returns
the stats of a certain container.
OOM notification and Intel RDT stats are not supproted
as what runc does
Fixes: #103
Signed-off-by: Haomin <caihaomin@huawei.com>
Don't append to Kata-specific apt sources file to avoid apt warnings
and make the install idempotent.
Fixes#107.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
