Commit Graph

530 Commits

Author SHA1 Message Date
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
Graham Whaley
069987acd5
Merge pull request #342 from nitkon/patch-3
Limitations: Remove seccomp limitation.
2019-01-07 11:15:30 +00:00
Nitesh Konkar
4078d0aa14 Limitations: Remove seccomp limitation.
Document that seccomp support is now available.

FIxes: #341

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-01-07 14:29:52 +05:30
GabyCT
66ee0e480d
Merge pull request #338 from egernst/update-frequency
stable-branching: update frequency, reference schedule
2019-01-04 12:28:44 -06:00
Eric Ernst
a31c1b99d0 stable-branching: update frequency, reference schedule
Add a reference to the release rotation wiki, and clarify that
the current stable release schedule is every-other-week.

Fixes: #337

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-01-04 08:47:09 -08:00
Xu Wang
0d215b7439
Merge pull request #306 from zeigerpuppy/zeigerpuppy-patch-1
Patch for debian install instructions docs
2018-12-30 17:52:26 +08:00
Xu Wang
8a9e40451b
arch-images: add a figure for shimv2
The comparison w/ or w/o shimv2

Signed-off-by: Xu Wang <xu@hyper.sh>
2018-12-30 14:42:04 +08:00
zeigerpuppy
e9ca4d8d60 docs: Add Debian installation guides
Fixes #310.

These install instructions are based on the katacontainers repository for Debian.  For installation, a newer version of `librbd1` is required.  This is available from the `unstable` repo.

Tested only on Debian 9 - Stretch (x86_64).
- tested with `docker-ce=17.12.0~ce-0~debian`

Signed-off-by: zeigerpuppy <zeigerpuppy@users.noreply.github.com>
2018-12-29 14:45:33 +11:00
Eric Ernst
fc90bdad22
Merge pull request #329 from kata-containers/fix-ubuntu-guide
install: use stable instead of master for docs
2018-12-27 10:22:31 -08:00
Eric Ernst
808d85b467 install: use stable instead of master for docs
1.5.0-rc2 packages for linux-container fail for Ubuntu.  Let's use 1.4-stable instead of master for now.

Fixes #325

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-12-27 17:23:32 +00:00
James O. D. Hunt
4265ca9e12
Merge pull request #321 from Pennyzct/qemu-section
qemu: add 'Build a custom qemu-system-aarch64' section
2018-12-24 09:02:50 +00:00
Penny Zheng
cc530e7e77 qemu: add 'Build a custom qemu-system-aarch64' section
Since aarch64 need custom QEMU binary and doesn't support OBS
packaging for now, we add this section to lead developers to build
required qemu-system-aarch64 binary.

Fixes: #320

Signed-off-by: Penny Zheng <penny.zheng@arm.com>
2018-12-20 17:58:53 +08:00
Marco Vedovati
59ce0b3d4e dev-guide: detect & use existing docker unit file
Only create a new docker unit file if no other existing unit files
are detected. Creating a new docker file when not necessary may mask out
existing docker daemon configurations.

Fixes: #300

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-12-14 18:34:29 +01:00
James O. D. Hunt
4cd5f2cbb8
Merge pull request #318 from devimc/topic/snap-installation
install: add snap installation guide
2018-12-11 12:04:22 +00:00
Julio Montes
d3bdfa306d install: add snap installation to installing table
Add snap installation to "Installing on a Linux System" table

Signed-off-by: Julio Montes <julio.montes@intel.com>
2018-12-05 09:45:00 -06:00
Julio Montes
3440caeda5 install: add snap installation guide
Add snap installation guide

fixes #274

Signed-off-by: Julio Montes <julio.montes@intel.com>
2018-12-05 09:45:00 -06:00
James O. D. Hunt
7c44129614
Merge pull request #308 from jodh-intel/mention-warnings
docs: Add warnings to doc requirements doc
2018-11-28 08:48:12 +00:00
Graham Whaley
d7d5d0bdd2
Merge pull request #313 from egernst/azure-install-guide
Azure install guide
2018-11-27 19:30:38 +00:00
Eric Ernst
584bc5d232 docs: update azure install guide
Add link to distribution specific guides, and reference
azure document from install README.

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-11-27 11:31:36 -08:00
James O. D. Hunt
342a8a6cf6
Merge pull request #317 from grahamwhaley/20181127_vexx_docfix
cloud: vexx: fix wrong style type of vexx title
2018-11-27 10:47:04 +00:00
Graham Whaley
4bfed86116 cloud: vexx: fix wrong style type of vexx title
The vexx got added as a '#' top level item instead of a
'*' bullet entry. Fix it...

Fixes: #316

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2018-11-27 10:24:10 +00:00
Graham Whaley
d45863a2a4
Merge pull request #309 from hejianet/master_my
docs: Improve Developer-Guide and SRIOV doc on arm64
2018-11-27 09:58:54 +00:00