Commit Graph

530 Commits

Author SHA1 Message Date
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
Worms David
072be82400 install: typo in the installation user guides README
This is a quick typo correction.
Fixes: #455
Signed-off-by: david@adaltas.com
2019-05-02 16:01:43 +03:00
Leopold Schabel
0721b6a2e9 docs: Clarify security boundaries in privileged mode
See https://github.com/kata-containers/runtime/issues/1568

Fixes #453

Signed-off-by: Leopold Schabel <mail@leoschabel.de>
2019-05-02 11:33:05 +00:00
Leopold Schabel
adc0462a88 docs: Fix typo in "Definition of a limitation" header
This commit fixes a typo in Limitations.md

Signed-off-by: Leopold Schabel <mail@leoschabel.de>
2019-05-02 11:32:46 +00:00
Marco Vedovati
1710157296
Merge pull request #449 from GabyCT/topic/removeps
docs: Remove ps command from Limitations
2019-04-30 15:00:01 +02:00
Gabriela Cervantes
48c0343c4f docs: Remove ps command from Limitations
Remove the link of ps command from Limitations document.

Fixes #324

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2019-04-29 03:22:32 -05:00
Salvador Fuentes
5404d4e846
Merge pull request #439 from GabyCT/topic/updatedocrhel
docs: Update RHEL documentation
2019-04-26 14:09:36 -05:00
GabyCT
1deb4d2d80
Merge pull request #447 from jodh-intel/fix-debian-docker-install
Fix debian docker install
2019-04-26 08:53:59 -05:00
James O. D. Hunt
2f3a8f51f7 docs: Fix outdent in Debian install guide
Remove the outdent in the Debian install guide.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-04-26 11:07:19 +01:00
James O. D. Hunt
b3a74db28f docs: Fix whitespace in Ubuntu install guide
Fix missing newline.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-04-26 11:06:53 +01:00
James O. D. Hunt
a943be8da1 docs: Fix indent in docker install guides
Don't indent unnecessarily.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-04-26 11:02:56 +01:00
James O. D. Hunt
74bbd537d9 docs: Fix debian docker install
Fix installing docker on Debian by changing the docker install guide to
ensure that only the `kata-containers.conf` systemd service snippet is
created. Previously, both the snippet and the `daemon.json` Docker
config files were being updated because the latter also specified a bash
code block.

Note that the `daemon.json` section is now consistent with the other
install guides - it just displays the JSON code to add rather than
trying to set it.

Also, added missing shell prompts, changed code blocks into shell (but
not bash) code blocks and fixed a few minor grammar and whitespace
issues.

For further details, see:

- https://github.com/kata-containers/documentation/blob/master/Documentation-Requirements.md
- https://github.com/kata-containers/tests/tree/master/cmd/kata-manager

Fixes #442.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-04-26 11:02:56 +01:00
James O. D. Hunt
adb1ca046f docs: Make SLES docker guide consistent
Fix wording to make the SUSE SLES docker install guide consistent with
the others.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-04-26 11:02:56 +01:00
James O. D. Hunt
2d76821f42 docs: Make CentOS docker guide consistent
Fix wording in CentOS docker install guide to make it consistent with
the others.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-04-26 11:02:38 +01:00
Graham Whaley
df57d05865
Merge pull request #441 from Remy-xl/doc-link
Docs: Update link in containerd-kata.md
2019-04-24 10:33:05 +01:00
Graham Whaley
d8c7a9629f
Merge pull request #438 from Remy-xl/master
Docs: update Build-a-custom-QEMU in Developer-Guide
2019-04-24 10:17:57 +01:00
xulei
32cbce67c9 Docs: Update link in containerd-kata.md
update the link of shimv2.svg

Fixes: #440

Signed-off-by: Lei Xu <xulei@cmss.chinamobile.com>
2019-04-24 13:54:56 +08:00
Salvador Fuentes
b162a1da3b
Merge pull request #426 from GabyCT/topic/fixsles
doc: Update SLES installation documentation
2019-04-23 12:46:45 -05:00
Gabriela Cervantes
40b040b26e docs: Update RHEL documentation
RHEL now is being part of the CI.

Fixes #415

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2019-04-23 05:54:23 -05:00
Remy-xl
5095be72fa Docs: update Build-a-custom-QEMU in Developer-Guide
Add how to get kata-containers/qemu and checkout to a proper version in developer-guide

Fixes: #437

Signed-off-by: Lei Xu <xulei@cmss.chinamobile.com>
2019-04-19 23:47:32 +08:00
Hui Zhu
ae40622f60
Merge pull request #435 from yuwang888/master
README: Update README.md for link of VM Templating
2019-04-19 14:50:05 +08:00
WangYu
a83849e8b9 README: Update README.md for link of VM Templating
correct the link of VM Templating
Fixes: #436

Signed-off-by: WangYu <WangYu@linux.alibaba.com>
2019-04-19 14:23:44 +08:00
Xu Wang
ed0dfa37a4
Merge pull request #432 from Remy-xl/master
Update README.md for GPU-Passthrough-with-Kata
2019-04-18 18:00:36 +08:00
Remy-xl
17e0919a2b README: Update README.md for GPU-Passthrough-with-Kata
Fixes: #431

GPU-Passthrough-with-Kata link to a error address.

Signed-off-by: Lei Xu <xulei@cmss.chinamobile.com>
2019-04-18 17:50:26 +08:00
Xu Wang
9dc2191451
Merge pull request #430 from Remy-xl/master
Zun: add zun-ui plugin for devstack
2019-04-18 15:21:39 +08:00
Remy-xl
9c8a087a58 Zun: add zun-ui plugin for devstack
Fixes: #429

Add zun-ui plugin for devstack when intergrated with zun.

Depends-on:github.com/kata-containers/tests#1484

Signed-off-by: Lei Xu <xulei@cmss.chinamobile.com>
2019-04-18 15:12:29 +08:00
Gabriela Cervantes
9071ffc8be doc: Update SLES installation documentation
Remove the warning as a CI of SLES in available
https://github.com/kata-containers/ci/pull/142.

Fixes #425

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2019-04-10 04:35:31 -05:00
Graham Whaley
4470e322e9
Merge pull request #424 from jcvenegas/master
install: Allow define kata branch.
2019-04-09 14:55:02 +01:00
Jose Carlos Venegas Munoz
9f12577be2 install: Allow define kata branch.
Kata OBS repositories provide multiple branch support.

Let define a variable to allow users define kata branch to use.

Fixes: #423

Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
2019-04-08 11:13:04 -05:00
Eric Ernst
2ee437f171
Merge pull request #420 from gabibeyer/updatedocs
doc: update architecture.md link
2019-04-02 21:04:18 -07:00
Gabi Beyer
a11768e1b7 doc: update architecture.md link
update architecture.md link, since it has moved to within the
design/ directory.

Fixes: #417

Signed-off-by: Gabi Beyer <Gabrielle.n.beyer@intel.com>
2019-04-02 21:04:32 -07:00
GabyCT
b09a469097
Merge pull request #418 from egernst/docs-cleanup
Docs cleanup
2019-03-29 16:13:24 -06:00
Eric Ernst
152330a4fd docs: Use relative paths for URLs which are part of this repo
Let's make our static testers happy.

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-03-29 14:17:54 -07:00
Eric Ernst
51f12efae9 arch: fix dead link
api.proto moved, resulting in a broken link. The original link wasn't
very useful in the first place, so simply remove.

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-03-29 14:03:59 -07:00