Commit Graph

463 Commits

Author SHA1 Message Date
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
Eric Ernst
85ddb9addc virtiofs: simplify kata + virtio fs doc
- Add more motivation, background on filesystem sharing
- simplify configuration, installation by utilizing kata deploy

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-05-15 17:24:59 -07:00
Ganesh Maharaj Mahalingam
81b8044716 how-to: virtio-fs initial documentation
virtio-fs has landed as an experimental feature in kata. This patch
enable the basic how-to for this feature.

Fixes: #468
Signed-off-by: Ganesh Maharaj Mahalingam <ganesh.mahalingam@intel.com>
2019-05-15 12:04:19 -07:00
Graham Whaley
82dc91481d
Merge pull request #463 from devimc/topic/howto/fixContainerdWithCri
how-to: Fix `Install containerd with cri plugin` note
2019-05-09 14:29:40 +01:00
Julio Montes
3b29f8fbb3 how-to: Fix Install containerd with cri plugin note
It's a little complicated to understand the note of the section
Install containerd with cri plugin, that says Just check if the cri plugin has
been disabled in the containerd configuration file but if it's disabled
containerd + the runtime class won't work.

fixes #462

Signed-off-by: Julio Montes <julio.montes@intel.com>
2019-05-09 08:21:55 -05:00
James O. D. Hunt
c90341de69
Merge pull request #461 from devimc/topic/howto/fixKubeadmCmd
how-to: fix kubadm command
2019-05-09 08:36:32 +01:00
Hui Zhu
67c64419d0
Merge pull request #459 from jodh-intel/improve-doc-requirements
Improve doc requirements
2019-05-09 10:21:07 +08:00
Julio Montes
61cfb9c9f1 how-to: fix kubadm command
remove --skip-preflight-checks option since it has been deprecated

fixes #460

Signed-off-by: Julio Montes <julio.montes@intel.com>
2019-05-08 14:44:29 -05:00
James O. D. Hunt
ad87c6cc64 docs: Add linking advice section
Add a new "Linking advice" section to the documentation requirements
document.

Fixes: #458.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-08 10:30:49 +01:00
James O. D. Hunt
b5931eb0d6 docs: Add TOC requirement
State that all documents should contain a table of contents.

Partially fixes: #458.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-08 09:49:45 +01:00
James O. D. Hunt
dd69931a4c docs: Tighten up general requirements list
Simplify the bullet list of general requirements in the documentation
requirements document at the same time as making the wording
unambiguous.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-08 09:37:20 +01:00
Salvador Fuentes
517cd3573d
Merge pull request #457 from jodh-intel/fix-more-markdown
docs: Fix incorrect link in limitations TOC
2019-05-07 07:49:17 -05:00
James O. D. Hunt
b0bcb1b4f8 docs: Fix incorrect link in limitations TOC
Fixed typo in table of contents link name which broke the link.

Fixes #456.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-07 11:49:09 +01:00
James O. D. Hunt
82afd0a6dc
Merge pull request #452 from leoluk/patch-1
docs: Clarify security boundaries in privileged mode
2019-05-07 08:55:09 +01:00
Salvador Fuentes
95af6edb1a
Merge pull request #434 from jodh-intel/fix-markdown
docs: Fix markdown
2019-05-03 11:53:47 -05:00
James O. D. Hunt
b1af8deaec docs: Rename conduit to linkerd
The conduit project seems to have renamed itself to linkerd so update
the service mesh document to reflect that.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-03 14:43:26 +01:00
James O. D. Hunt
9a99899861 docs: Fix markdown
Resolve issues in the markdown files in this repo.

Fixes #433.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-05-03 14:43:24 +01:00
Graham Whaley
67e925390b
Merge pull request #454 from wdavidw/patch-2
Typo in the installation user guides README
2019-05-02 14:21:18 +01:00