Commit Graph

551 Commits

Author SHA1 Message Date
Xu Wang
419d9791c7
Merge pull request #393 from teawater/vmcache
howto: Add VMCache introduction and guide
2019-03-13 00:21:40 +08:00
Hui Zhu
7b94750180 howto: Add VMCache introduction and guide
Add "What Is VMCache and How To Enable It" to howto.

Fixes: #392

Signed-off-by: Hui Zhu <teawater@hyper.sh>
2019-03-12 21:02:03 +08:00
James O. D. Hunt
3124131816 docs: Add RHEL and SLES install warning
Unfortunately, at present we have no way of testing Kata packages for
Red Hat Enterprise Linux (RHEL) or SUSE Linux Enterprise (SLES).

Add warnings to the RHEL and SLES install guides explaining this and
advising users to exercise caution. Hopefully, we will be able to drop
this warning soon (either when we have the ability to test on RHEL/SLES
or when Kata packages are available in RHEL/SLES).

Fixes #396.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-03-11 09:05:55 +00:00
James O. D. Hunt
ff67e32d30
Merge pull request #395 from grahamwhaley/20190307_CODEOWNERS
ci: add a CODEOWNERS file to cover .md files
2019-03-08 08:36:38 +00:00
Graham Whaley
0f45a33684 ci: add a CODEOWNERS file to cover .md files
Add a CODEOWNERS file so we get auto-review requests from github
for any .md file changes.

Fixes: #394

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-03-07 11:09:47 +00:00
Eric Ernst
a2fe01131d
Merge pull request #374 from jodh-intel/pin-docker-to-version-18.06
docs: Pin docker to version 18.06
2019-03-04 10:43:20 -08:00
James O. D. Hunt
5524fc39e5 docs: Clarified docker install note
Improved wording in docker installation Note based on review feedback.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-03-01 11:24:58 +00:00
GabyCT
b702f5028d
Merge pull request #387 from devimc/topic/cpuCgroups
constraints: add cpu cgroups documentation
2019-02-28 11:48:32 -06:00
Julio Montes
1e1a735796 constraints: add cpu cgroups documentation
Explain cpu cgroups are implemented in kata containers

fixes #386

Signed-off-by: Julio Montes <julio.montes@intel.com>
2019-02-27 11:57:17 -06:00
Julio Montes
3fa6a83d4d
Merge pull request #384 from liubin/master
docs: fix broken links in architecture.md
2019-02-21 08:22:27 -06:00
bin liu
0a643e9a56 docs: fix broken links in architecture.md
Two links to `how-to` file is broken.

Fixes: #383

Signed-off-by: bin liu <liubin0329@gmail.com>
2019-02-21 15:15:01 +08:00
James O. D. Hunt
ceae7b48e0 docs: Pin docker to version 18.06
Docker 18.09 removed devicemapper support but did not provide an
alternative. This can cause problems for users so update the install
docs to install Docker at version 18.06 (the last version that supports
devicemapper).

This is a temporary solution until either docker provide an alternative
or we find a way to work around the Docker feature being removed.

Note the extra logic required for Fedora since 18.06 is not available
for that release.

Fixes #373.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-02-18 08:55:41 +00:00
James O. D. Hunt
4c71475122
Merge pull request #372 from marcov/zun-kata-install
zun: update kata install instructions
2019-02-18 08:48:19 +00:00
Marco Vedovati
f39a73ea0c zun: update kata install instructions
Update zun guide to point to the kata installation instructions for
Ubuntu.

Fixes: #371

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2019-02-13 13:09:52 +01:00
Graham Whaley
5b483f289a
Merge pull request #380 from nitkon/patch-1
docs: Fix a typo in how-to docs
2019-02-11 10:23:02 +00:00
nitkon
bc7d96998d
docs: Fix a typo in how-to docs
Fix Typo

Fixes: #379

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-02-11 01:05:11 +05:30
GabyCT
1f87f86812
Merge pull request #377 from grahamwhaley/20190206_remove_pullapprove
pullapprove: remove config file
2019-02-07 10:26:30 -06:00
Graham Whaley
d53675125b pullapprove: remove config file
We are moving off pullapprove. Remove its config file.

Fixes: #376

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-02-06 15:55:28 +00:00
GabyCT
bbc3ce9edb
Merge pull request #370 from devimc/topic/snap-installation
snap: add snap store banner
2019-01-31 08:52:59 -06:00
Julio Montes
7722faf104 snap: add snap store banner
add snap store banner

fixes #369

Signed-off-by: Julio Montes <julio.montes@intel.com>
2019-01-31 08:32:25 -06:00
Frank Cao
7cf81c47af
Merge pull request #368 from grahamwhaley/20190130_fc_link
docs: firecracker: add top level link off to fc wiki page
2019-01-31 14:15:16 +08:00
Graham Whaley
87d9ebc14c docs: firecracker: add top level link off to fc wiki page
We have some initial Firecracker/Kata documentaiton, but for now
it lives in the wiki. Link off to it from the top level docs
README to make it more obvious and easier to find.

Fixes: #367

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-01-30 17:45:08 +00:00
James O. D. Hunt
4ba2802632
Merge pull request #359 from qzivli/master
docs: Fix typo
2019-01-29 17:58:10 +00:00
James O. D. Hunt
a9edac83a2
Merge pull request #364 from jodh-intel/fully-non-interactive-debian-install
install: Make Debian install fully non-interactive
2019-01-29 09:11:55 +00:00
James O. D. Hunt
c3184c30e7 install: Make Debian install fully non-interactive
Although the installation instructions specify `apt-get -y ...`, the
installation blocks when trying to install the Kata pages with a message
like this:

```
...

Restart services during package upgrades without asking?

<Yes>                                          <No>
```

Setting `DEBIAN_FRONTEND=noninteractive` avoids this.

Fixes #363.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-01-28 14:06:12 +00:00
Q. Ziv Li
ed7ec36325 docs: Fix typo
Fix typo: librdbd1 -> librbd1

Fixes: #359

Signed-off-by: Q. Ziv Li <qzivli@hotmail.com>
2019-01-26 17:19:50 +08:00
Archana Shinde
fe90fe053f
Merge pull request #361 from grahamwhaley/20190125_snap_docs
install: snap: add link out to config and integrate instrs
2019-01-25 15:19:24 -08:00
Graham Whaley
d90bb59a15 install: snap: add link out to config and integrate instrs
The snap install doc only told you how to install the kata snap,
and did not then go further to describe how to configure and
intergrate it. Those details are available already over in the
packaging repo, so let's link out to them.

Fixes: #360

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-01-25 11:09:36 +00:00
James O. D. Hunt
db1fb858a4
Merge pull request #349 from jjolly/opensuse-install-fix
Docs: Remove invalid option from suse guides
2019-01-24 14:27:13 +00:00
Peng Tao
c60b72f5d1
Merge pull request #332 from gnawux/shimv2
document the new introduced shimv2
2019-01-24 10:43:22 +08:00
Jose Carlos Venegas Munoz
411aefb295
Merge pull request #354 from kata-containers/fix-ubuntu-guide
install: have ubuntu install point to master for 1.5 release
2019-01-23 10:56:23 -06:00
Eric Ernst
e797606d4c install: have ubuntu install point to master for 1.5 release
Fixes: #335

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-01-23 16:42:14 +00:00
James O. D. Hunt
d97e994c47
Merge pull request #348 from bergwolf/vm-template
howto: add vm template introduction and guide
2019-01-23 11:44:41 +00:00
Peng Tao
07f6cb16e7 howto: add vm template introduction and guide
So that we have a doc to point to when people asks about VM templating.

Fixes: #347

Signed-off-by: Peng Tao <bergwolf@gmail.com>
2019-01-23 16:23:34 +08:00
Xu Wang
9343ece91e
how-to: a standalone doc for containerd integration
including shimv2 and runtime class

Fixes: 322
Signed-off-by: Xu Wang <xu@hyper.sh>
2019-01-23 14:12:40 +08:00
Xu Wang
04498bd4d2
architecture.md: update the architecture of v1.5
- shimv2 has been introduced
- vsock has been supported

Fixes: #322
Signed-off-by: Xu Wang <xu@hyper.sh>
2019-01-23 14:12:29 +08:00
Xu Wang
75501df2fa
how-to: add shimv2 as the default in the k8s and containerd howto
move the  containerd+kata parts to containerd-kata.md and make
this file simpler

Signed-off-by: Xu Wang <xu@hyper.sh>
2019-01-23 14:12:12 +08:00
Xu Wang
c06e9f241f
developer-guide: update for shimv2
- update cri-containerd to containerd with cri plugin
- suggest the shimv2 to be the preferred kubernetes integration way.

Signed-off-by: Xu Wang <xu@hyper.sh>
2019-01-23 14:11:48 +08:00
GabyCT
c9ebb56683
Merge pull request #346 from rpw/master
Fix Debian install documentation.
2019-01-22 10:35:17 -06:00
Xu Wang
2bb23519f7
install: mention shimv2 for the manual installation instruction
- mentioned shimv2 in the configuration part of manual installation
- reference the link of shim v2 api and the k8s containerd howto

Signed-off-by: Xu Wang <xu@hyper.sh>
2019-01-22 15:39:05 +08:00
Ralf-Philipp Weinmann
771b1b1869 docs: fix Debian install documentation due to OBS repo rename
As the Debian OBS repo was renamed was renamed on 20181219 the corresponding documentation
needs to be fixed. See also #306, more specifically
https://github.com/kata-containers/documentation/pull/306#discussion_r242983373

A test install using the documentation on a fresh Debian Stretch (9.5) was done
on 20190119.

Fixes #344

Signed-off-by: Ralf-Philipp Weinmann <ralf@comsecuris.com>
2019-01-19 07:23:35 +01:00
John L. Jolly
e7d2141648 Docs: Remove invalid option from suse guides
The OpenSUSE and SLES install guide for Docker used the --containerd
option. When this option is used on OpenSUSE Leap 15 or SLES 15, the
following error occurs when starting Docker:

    Failed to connect to containerd: failed to dial
        "/run/containerd/containerd.sock": context deadline exceeded

Removing the --containerd option from the configuration file allows the
Docker daemon to start successfully and a Kata container to be created.

Fixes: #350

Signed-off-by: John L. Jolly <jjolly@suse.com>
2019-01-18 12:35:47 +01:00
Graham Whaley
ab214c1378
Merge pull request #343 from abousselmi/master
Docs: remove ps and network connect limitations
2019-01-11 12:33:33 +00:00
Ayoub Bousselmi
9b9e5d63e0 Docs: network connect is no longer a limitation
Remove the `network connect` limitation from `Limitations.md` as the limitation has been removed.

Fixes #287.

Signed-off-by: Ayoub Bousselmi <abousselmi@users.noreply.github.com>
2019-01-11 12:15:20 +01:00
Ayoub Bousselmi
bb361623f6 Docs: ps is no longer a limitation
Remove the `ps` limitation from `Limitations.md` as the limitation has been removed.

Fixes #342.

Signed-off-by: Ayoub Bousselmi <abousselmi@users.noreply.github.com>
2019-01-11 12:14:57 +01:00
Xu Wang
4977445cc5
Merge pull request #327 from teawater/vmware
vsock: Add introduction about VMWare guest
2019-01-09 10:45:57 +08:00
Hui Zhu
4eee734665 vsock: Add introduction about VMWare guest
Add introduction about use Kata Containers with vsocks
in a VMWare guest environment.

Fixes: #326

Signed-off-by: Hui Zhu <teawater@hyper.sh>
2019-01-08 11:09:19 +08:00
GabyCT
f0913e2d10
Merge pull request #319 from marcov/docker-config
dev-guide: detect & use existing docker unit file
2019-01-07 13:40:43 -06:00
GabyCT
d109febe8a
Merge pull request #340 from nitkon/patch-2
Developer Guide: Update how to include seccomp in image
2019-01-07 12:29:49 -06:00
Nitesh Konkar
dab26ebf8a Developer-Guide: Update how to include seccomp in image
Update the developer guide to include documentation
for the inclusion of seccomp packages in initrd/rootfs
images.

Fixes: #339

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-01-07 20:35:46 +05:30