Commit Graph

530 Commits

Author SHA1 Message Date
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
James O. D. Hunt
eb3cbdc976
Merge pull request #478 from jodh-intel/make-docs-non-interactive
docs: Advise use of non-interactive commands
2019-05-17 14:59:49 +01:00
Graham Whaley
ee0736b390
Merge pull request #480 from nitkon/master
documentation: Add travis CI for ppc64le
2019-05-17 09:56:27 +01:00
Nitesh Konkar
1b1ca703c1 documentation: Add travis CI for ppc64le
Enable travis on ppc64le

Fixes:  #479

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-05-17 10:44:24 +05:30
James O. D. Hunt
b9bc029977 docs: Advise use of non-interactive commands
If a doc contains commands, they should be non-interactive where
possible to allow for the possibility of automating the testing of the
document in the CI.

Fixes #477.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-16 17:56:31 +01:00
James O. D. Hunt
24ec560794 docs: Add whitespace
Add a blank line for greater clarity when editing the document.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-16 17:55:55 +01:00
James O. D. Hunt
134471eb40 docs: Clarity the term "prompt"
Change "prompt" to "shell prompt" for greater clarity.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-16 17:55:22 +01:00
James O. D. Hunt
6a4c7307aa
Merge pull request #476 from jodh-intel/new-docs-need-to-be-referenced
docs: Require all new docs to be referenced
2019-05-16 17:04:00 +01:00
James O. D. Hunt
6141306594
Merge pull request #474 from jodh-intel/doc-fixes
Doc fixes
2019-05-16 15:20:22 +01:00
James O. D. Hunt
1d1782f051 docs: Require all new docs to be referenced
New documentation is great, but finding it should be easy. Require that
all new docs are referenced by an existing document in the repo.

Fixes #475.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-16 13:42:37 +01:00
James O. D. Hunt
4f164da00f docs: Clean up how-to handling
- Created a how-to README.
- Moved howto links in top-level README to the how-to README.
- Moved svc-mesh how to into the how-to directory.

Fixes #473.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-16 11:27:58 +01:00
James O. D. Hunt
6d8094b716 docs: Added missing doc links
Added links to unreferenced documents to make them easier to find.

Partially fixes #473.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-16 11:27:47 +01:00
James O. D. Hunt
548f75927e docs: Removed stale list entries
Removed two list entries in the design README that don't have a
corresponding document to link to.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-16 11:25:54 +01:00
James O. D. Hunt
3dec84d198 docs: Fix partial sentence
Improve the wording in the design README to remove the partial sentence.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-16 11:25:54 +01:00
James O. D. Hunt
923c8157ce docs: Add TOC
Added a Table of Contents to the top-level README.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-16 11:25:54 +01:00
James O. D. Hunt
6ecdecd727 docs: Fix debian docker link
Fixed the Debian install guide which was pointing to the Ubuntu Docker
install guide by mistake.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-16 11:25:54 +01:00
Eric Ernst
20dffa4feb
Merge pull request #469 from ganeshmaharaj/virtiofs-doc
how-to: virtio-fs initial documentation
2019-05-15 17:19:42 -07:00