The install guides assumed that users wanted to install Docker. Since
there are other container managers, split the Docker-specific
instructions into separate documents (with backlinks) and allow the
user to choose between Docker or Kubernetes from the install guides.
Fixes#144.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Ensure the first mention of all the distro names in the install guides:
- Have the required asterisk after the name.
- Have a link to the website.
Also folded the overly long lines.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
For now, mirrorlist doesn't support non-x86_64 arch, so we need
create baseurl for arm64. Furthermore, we also need to offer
arm64-specific gpg keys along with the regular key.
Fixes: #111
Signed-off-by: Penny Zheng <penny.zheng@arm.com>
We have new CPU constraints docs, now in this repo. Update the
Limitations document to reflect that.
Signed-off-by: Graham Whaley <graham.whaley@intel.com>
Move all the Zun docs into their own subdir, and add a
Zun reference and link to the top level README index.
Fixes: #131
Signed-off-by: Graham Whaley <graham.whaley@intel.com>
If we set env USE_DOCKER true, we will use container as development
environment. After docker run command, this temporary container
would be no use. we could add -rm flag to automatically delete
intermediate container.
Fixes: #115
Signed-off-by: Penny Zheng <penny.zheng@arm.com>
This commit checks the size of "/dev/shm" for the sandbox container
which is then used to create the shared memory inside the guest.
kata agent then uses this size to set up a sandbox level ephemeral
storage for shm. The containers then simply bind mount this sandbox level
shm.
With this, we will now be able to support docker --shm-size option
as well have a shared shm within containers in a pod, since they are
supposed to be in the same IPC namespace.
Fixes#356
Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
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>
Correct the document URLs which have gone stale.
The virtcontainers build status links have been moved to the top-level
README.
Fixes#376.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
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>
CentOS and some versions of Ubuntu do not provide
bats in their default repository. This change installs
bats from sources.
Signed-off-by: Salvador Fuentes <salvador.fuentes@intel.com>
