Commit Graph

496 Commits

Author SHA1 Message Date
Jose Carlos Venegas Munoz
2255b36a82 docs: Add documentation about host cgroup management
Document how cgroups are done today and what is expected
for the upcoming SandboxCgroupOnly option.

Prior cgroup documentation are no longer accurate. Removing the cgroup
discussion from the cpu sizing discussion. Updating the
cpu-constraints.md file name to reflect this.

Fixes: #542

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
2019-09-06 16:11:37 -07:00
Graham Whaley
3ed59ee50e
Merge pull request #537 from amshinde/add-instruction-pull-image
shimv2: Add instruction to pull image first
2019-08-21 09:13:02 +01:00
Archana Shinde
0ad8270772 shimv2: Add instruction to pull image first
Running the container with `ctr` when the image is not present
on the system gives an error.

Fixes #536

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2019-08-20 16:02:33 -07:00
Marco Vedovati
66b3590533
Merge pull request #534 from marcov/revamp-install-readme
install: refresh installation guide README
2019-08-19 18:34:54 +02:00
Marco Vedovati
c704edbff6 install: refresh installation guide README
Refresh installation guide README with a clearer structure, and provide
a list of distribution with official Kata packages. This also updates
the openSUSE Leap versions supported to 15 and 15.1.

Fixes: #533

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2019-08-19 17:32:30 +02:00
Salvador Fuentes
3dadaf64c5
Merge pull request #532 from gabibeyer/updateDocs
Update fedora version support
2019-08-16 07:59:51 -05:00
gabi beyer
6870294a12 install: update fedora version support
Remove support/installation information for fedora 27, and
add fedora 30.

Fixes: #528

Signed-off-by: gabi beyer <gabrielle.n.beyer@intel.com>
2019-08-16 02:01:52 +00:00
James O. D. Hunt
60d0850e07
Merge pull request #531 from grahamwhaley/20190813_docker_compose
Limitations: docker compose: note it has issues
2019-08-15 11:04:15 +01:00
Graham Whaley
f1b9c23040 Limitations: docker compose: note it has issues
Note that docker compose has similar issues to docker swarm
when under Kata.

Fixes: #530

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-08-13 17:51:11 +01:00
GabyCT
f8873a088f
Merge pull request #527 from grahamwhaley/20190801_minikube_fc
minikube: note kata-fc does not function under minikube
2019-08-05 10:32:09 -05:00
Graham Whaley
675f221bbd minikube: note kata-fc does not function under minikube
`kata-fc` does not presently function under `minikube` due to
lack of block based storage. Make that clear in the installation
documents, to help prevent users going through the whole install
process, only to be disappointed when they find ti does not work.

Fixes: #526

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-08-02 10:49:41 +01:00
James O. D. Hunt
1aec41a28d
Merge pull request #512 from GabyCT/topic/fixdebiandoc
docs: Fix debian installation guide
2019-08-01 09:34:38 +01:00
Eric Ernst
1e66d93d21
Merge pull request #514 from cgxu519/doc-fix-1
docs: Fix workaround solution for ConfigPath
2019-07-29 19:41:00 -07:00
GabyCT
e9cb861fca
Merge pull request #519 from nitkon/patch-4
architecture.md: Fix networking info
2019-07-24 12:36:05 -05:00
GabyCT
ea8e48d079
Merge pull request #522 from nitkon/patch-5
architecture.md: Fix broken CRI link
2019-07-24 12:30:03 -05:00
nitkon
73aa0977ac
architecture.md: Fix broken CRI link
Fix broken CRI Link. 

Fixes:  #521

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-07-24 22:24:13 +05:30
nitkon
3c250509d1
architecture.md: Fix networking info
The networking part of the doc talks about the 
two ends of the veth pair. One end is in the container
networking namespace and the other one should
be in the host networking namespace. Fix this info.

Fixes: #518

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-07-24 20:21:46 +05:30
Eric Ernst
3655b4c197
Merge pull request #445 from grahamwhaley/20190424_minikube_docs
install: Add minikube instructions
2019-07-19 17:11:16 -05:00
Graham Whaley
8e29464b46 install: README: add Minikube entry
Add Minikube to the list of 'cloud' providers installation instructions.
Whilst there, order the list alphabetically.

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-07-18 13:28:55 +00:00
Graham Whaley
f97fe323a1 install: add Minikube installation instructions
Add instructions of how to setup and install Kata under
Minikue.

Fixes: #444

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-07-18 13:28:55 +00:00
Chengguang Xu
097156d837 docs: Fix workaround solution for ConfigPath
In the workaround solution of ConfigPath, there is a '$@'
missing in the script, so add it.

Fixes: #515

Signed-off-by: Chengguang Xu <cgxu519@zoho.com.cn>
2019-07-18 20:20:12 +08:00
James O. D. Hunt
dfda61c681
Merge pull request #510 from eadamsintel/qat-with-kata
QAT: Add initial Intel QAT Kata instructions
2019-07-18 09:14:44 +01:00
Eric Adams
0402d41ca3 QAT: Add initial Intel QAT Kata instructions
These instructions cover how to install the out of tree
QAT drivers to the host, build a custom kata kernel and
rootfs, and build a QAT accelerated OpenSSL container
image.

Fixes: #509

Signed-off-by: <eric.adams@intel.com>
2019-07-17 15:25:32 -07:00
Gabriela Cervantes
ed31473019 docs: Fix debian installation guide
Once that https://github.com/kata-containers/tests/pull/1767 lands,
we can remove from the installation guide the steps of adding the
librbd1 repository.

Fixes #511

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2019-06-25 04:21:37 -05:00
James O. D. Hunt
d052d6d4fd
Merge pull request #506 from jodh-intel/update-doc-reqs-doc-for-spell-checker
docs: Update doc requirements doc for spell checker
2019-06-21 08:38:06 +01:00
GabyCT
0ddf25e11e
Merge pull request #508 from nitkon/patch-3
docs: Use kernel build script for building kernel in developer guide
2019-06-20 14:47:41 -05:00
James O. D. Hunt
12a8fdd921 docs: Update doc requirements doc for spell checker
Add further advice to the documentation requirements document to make it
easier for the spell checker to accept a document.

Fixes: #501.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-06-20 12:59:12 +01:00
James O. D. Hunt
8f2561a52d docs: All docs should be in English
Explain that all documentation must be written in English.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-06-20 12:59:12 +01:00
James O. D. Hunt
d6fbc929a1 CI: Fix Travis and CI setup
Make the CI setup script call the "master" `setup.sh` script (in the
`tests` repo) and update the Travis config accordingly to ensure that
both setup and static checks are run.

Also updated Travis to use Ubuntu 16.04 LTS (Xenial).

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-06-20 12:59:09 +01:00
Graham Whaley
de3627814b
Merge pull request #503 from nitkon/patch-2
Dev Guide: Update with debug console for initrd
2019-06-19 16:00:16 +01:00
nitkon
6c2209addd docs: Update with debug console for initrd
Update the developer guide with instructions to
attach to the debug console of a initrd rootfs based
VM.

Fixes:  #502

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-06-19 20:00:22 +05:30
Nitesh Konkar
21eaa73c62 docs: Use kernel build script for building kernel
Use kernel build script for building kernel

Fixes: #507

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-06-19 15:35:28 +05:30
Graham Whaley
2b5b52d28c
Merge pull request #505 from jodh-intel/fix-formatting
docs: Fix formatting
2019-06-17 10:05:27 +01:00
James O. D. Hunt
28da40a4e7 docs: Fix formatting
Ensure all non-dictionary words are in backticks.

Fixes: #504.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-06-14 17:39:11 +01:00
Eric Ernst
851c9d5994
Merge pull request #500 from jodh-intel/fix-typos-and-formatting
docs: Fix typos and formatting
2019-06-13 11:50:17 -07:00
James O. D. Hunt
65ee6bec86 docs: Fix typos and formatting
Correct spelling mistakes and formatting issues.

Fixes: #499.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-06-13 09:29:36 +01:00
Eric Ernst
da47d1b0d6
Merge pull request #498 from jodh-intel/add-link-to-website-source
docs: Add link to website source repo
2019-06-12 06:36:50 -07:00
James O. D. Hunt
5d79133ec7 docs: Add link to website source repo
Add a link to the newly-discovered source repository [1] for the Kata
website [2] to allow users to raise issues and PRs on the website
itself.

---
[1] - https://github.com/OpenStackweb/kata-netlify-refresh
[2] - https://katacontainers.io

Fixes: #497.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-06-12 11:39:03 +01:00
Julio Montes
28df7a4ca5
Merge pull request #495 from jcvenegas/vcpu-calculation-fix
docs: cpu: resources: fix vcpu calculation formula
2019-06-11 13:36:11 -05:00
Jose Carlos Venegas Munoz
3fe8660a9a docs: cpu: resources: fix vcpu calculation formula
The formula is not updated according on
how is done in kata-runtime.

Fixes: #489

Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
2019-06-11 13:12:23 -05:00
GabyCT
16efde2004
Merge pull request #491 from amshinde/add-coreutils-debug-console
debug: Add coreutils to the list of packages for debug console.
2019-06-10 14:08:23 -05:00
Archana Shinde
80a7c66e9c debug: Add coreutils to the list of packages for debug console.
This package is not installed with systemd in Clear. Add this
as an additional package requirement for debug console to make it
possible to debug.
This package contains utilties like `cat`, `ls`, `echo` etc required
for a useful debug.

Fixes #492

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2019-06-10 10:12:29 -07:00
Eric Ernst
8d5f2f0783
Merge pull request #488 from jodh-intel/doc-fixes
docs: Fix typos and formatting
2019-06-07 08:33:44 -07:00
James O. D. Hunt
87cc770855 docs: Fix typos and formatting
Tidy up docs by resolving spelling mistakes and fixing
bad formatting.

Fixes: #487.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-06-07 14:22:50 +01:00
Archana Shinde
b85935b33d
Merge pull request #484 from marcov/opensuse-install
install: better support for all openSUSE distros
2019-05-28 08:47:45 -07:00
Marco Vedovati
72b296d319 install: improve Docker installation for openSUSE
Editing systemd unit files to customize Docker for Kata may generate conflicts
with what's specified in /etc/sysconfig/docker, so use that file directly.

Also, libcgroup1 dependency is wrong for newer distros, and should be
pulled automatically for older ones.

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2019-05-28 10:04:21 +02:00
Marco Vedovati
b2c002415c install: better support for all openSUSE distros
Support installing kata packages on all openSUSE distros.

Fixes: #483

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2019-05-24 17:45:53 +02:00
Julio Montes
8ac4f61172
Merge pull request #482 from jodh-intel/add-missing-doc-link
docs: Added missing doc link
2019-05-20 07:25:31 -05:00
James O. D. Hunt
5c5b5185c2 docs: Added missing doc link
Added a link to the existing `how-to-use-virtio-fs-with-kata.md`.

Fixes #481.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-20 11:51:54 +01:00
James O. D. Hunt
09715c13d2 docs: Add missing newline at EOF
Add a newline at the end of the document, presumably missed off by
Emacs.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-20 11:48:54 +01:00