Commit Graph

540 Commits

Author SHA1 Message Date
Archana Shinde
ed140f157e releases: Update release cadence
Update release doc to mention that patch releases are not made
every 3 weeks, while minor releases are made every 12 weeks now.

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2020-02-19 17:54:16 -08:00
Xu Wang
36e9ed147f
Merge pull request #597 from lifupan/master
debug: add notes about how to enable debug for shimv2
2020-02-19 18:13:37 +08:00
fupan.lfp
ba40da0df1 debug: add notes about how to enable debug for shimv2
The containerd's debug option will determine whether
the kata's log forared to containerd's log pipe or
not.

Fixes:#596

Signed-off-by: fupan.lfp <fupan.lfp@antfin.com>
2020-02-19 09:29:42 +08:00
Julio Montes
003d0d637a
Merge pull request #589 from devimc/topic/design/updateHostCgroups
design: update host-cgroups documentation according to the new changes
2020-01-24 11:56:59 -06:00
Julio Montes
1fa12cf5a2 design: update host-cgroups documentation according to the new changes
update host-cgroups documentation according to the new changes in the runtime

fixes #588

Signed-off-by: Julio Montes <julio.montes@intel.com>
2020-01-24 15:53:18 +00:00
GabyCT
a51efa9ada
Merge pull request #587 from dong-liuliu/xliu2/spdk-vhost-user
use-cases: Add initial SPDK vhost-user instructions
2020-01-23 13:35:36 -06:00
Liu Xiaodong
7f5873159a use-cases: Add initial SPDK vhost-user instructions
These instructions cover how to install and setup SPDK
vhost-user target, construct a vhost-user-blk device based
memory, configure the vhost-user-blk device to be available
for kata container, and run kata container with SPDK
vhost-user-blk device via docker.

Fixes: #586

Signed-off-by: Liu Xiaodong <xiaodong.liu@intel.com>
2020-01-21 22:34:38 -05:00
Archana Shinde
4d47c3fa8d
Merge pull request #585 from jodh-intel/add-debian-10
docs: Add Debian 10 to distro table
2020-01-21 16:56:22 -08:00
Julio Montes
ae6d43470a
Merge pull request #583 from grahamwhaley/20200115_toc_doc
docs: reqs: add link/recommendation to check-markdown
2020-01-20 08:43:10 -06:00
James O. D. Hunt
e45be66e72 docs: Add Debian 10 to distro table
Now that [1] has landed, update the list of supported distros to include
Debian 10.

[1] - https://github.com/kata-containers/packaging/issues/647

Fixes: #584.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2020-01-20 09:34:13 +00:00
Graham Whaley
1af686c18d docs: reqs: add link/recommendation to check-markdown
Recommend the use of our own check-markdown tool to generate
TOCs.

Fixes: #582

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2020-01-16 10:02:20 +00:00
Salvador Fuentes
8f5cb26eba
Merge pull request #581 from vijaydhanraj/update_kata_acrn
doc: update how-to on Kata Containers with ACRN hypervisor
2020-01-09 14:59:12 -06:00
Vijay Dhanraj
a187c3806a doc: update how-to on Kata Containers with ACRN hypervisor
Update start-up guide on setting up kata containers with ACRN hypervisor.
The udpated guide is tested using KBL-NUC and addresses 2 parts,
	1. Fixes broken links.
	2. Adds a pre-requisite to enable MACVTAP for networking
	   in the Service OS.

Fixes: #580
Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-01-09 11:10:40 -08:00
GabyCT
4084b7d130
Merge pull request #574 from amshinde/update-priv-doc-crio
privileged: Update docs for privileged mode with crio
2019-12-23 10:15:55 -06:00
Archana Shinde
47a87ceb94 privileged: Update docs for privileged mode with crio
cri-o now supports running privilged containers without passing devices
from the host to the container.

Fixes #529

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2019-12-12 09:14:54 -08:00
Jose Carlos Venegas Munoz
851db2708e
Merge pull request #575 from egernst/CLH-docs
arch: add virtualization specific document
2019-12-09 12:37:23 -06:00
Eric Ernst
952c98da81 arch: add virtualization specific document
Improve our virtualization documentation, as well as introduce
the Cloud Hypervisor VMM. This creates a virtualization specific
document, and references this from the primary architecture document.

We are still limited on ACRN documentation: this should be augmented
in a follow on PR.

The PNGs included were grabbed from https://docs.google.com/presentation/d/1ZJg3w3O6F_j3ucQhdbBdj2hZUwg7L7qF347xC07L2_w

Fixes: #567

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-12-06 16:37:01 -08:00
Graham Whaley
1fd8ac65bf
Merge pull request #568 from shinebayar-g/fix/centos-docker-install
Fix centos docker installation docs.
2019-11-26 10:14:26 +00:00
Xu Wang
219ffbca05
Merge pull request #571 from egernst/update-on-vmms
architecture: update architecture docs to reflect VMM support
2019-11-13 15:03:18 +08:00
Eric Ernst
541ec4c08a architecture: update architecture docs to reflect VMM support
The existing document hasn't been updated since ~1.4. Updated to remove
references to qemu-lite, added details on Firecracker.

We still need details on ACRN added here as well.

Fixes: #570

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-11-12 20:03:43 -08:00
shinebayar-g
a0e37e1e64 docs: Update docker installation guides for /etc/docker
Added explanation that the `/etc/docker/` directory needs to be created.

Fixes: #569.

Signed-off-by: shinebayar-g <shinebayar.gansukh@gmail.com>
2019-11-12 01:19:53 +08:00
GabyCT
4a65bad291
Merge pull request #564 from devimc/topic/how-to/loadKernelModules
how-to: add how-to for loading kernel modules
2019-10-10 15:34:20 -05:00
Julio Montes
24dd673365 how-to: add how-to for loading kernel modules
Add documentation describing how to load kernel modules with kata containers

fixes #563

Signed-off-by: Julio Montes <julio.montes@intel.com>
2019-10-10 19:17:58 +00:00
GabyCT
d785f8a8b2
Merge pull request #558 from YchauWang/master
docs: Updated the network namespace default structure picture to tcfi…
2019-10-09 16:19:58 -05:00
Frank Cao
bfc8836f62
Merge pull request #557 from Kvasscn/doc-fixs-rootfsbuild
Developer-Guide.md: update rootfs build description
2019-09-25 17:23:07 +08:00
Yongchao Wang
b96bed021d docs: Updated the network namespace default structure picture to tcfilter
Updated network picture from "MACVTAP" to "tcfilter".
The latest kata network has been changed to tcfilter instead of macvtap,
and this section
https://github.com/kata-containers/documentation/blob/master/design/architecture.md#networking

Fixes: #513

Signed-off-by: Yongchao Wang <wangyongchao.bj@inspur.com>
2019-09-18 09:54:06 +08:00
James O. D. Hunt
1012c6204f
Merge pull request #554 from eadamsintel/qat-with-kata
Updated QAT instructions
2019-09-17 10:18:14 +01:00
zhanghj.lc
b9d5acd985 Developer-Guide.md: update rootfs build description
Add rootfs distro choices for debian,ubuntu, and suse.

Fixes: #556.

Signed-off-by: zhanghj.lc <zhanghj.lc@inspur.com>
2019-09-16 23:13:16 -04:00
Eric Adams
b4704fec3e subsystem: docs
Updated QAT instructions

This fixes #516

Signed-off-by: Eric Adams <eric.adams@intel.com>
2019-09-16 14:11:32 -07:00
Salvador Fuentes
85846f5acb
Merge pull request #552 from jodh-intel/show-docker-config-default
docs: Emphasise default docker config
2019-09-09 08:19:11 -05:00
James O. D. Hunt
89120e8d8a
Merge pull request #543 from jcvenegas/SandboxCgroupOnly-docs
docs: Add documentation about host cgroup management
2019-09-09 09:25:11 +01:00
Jose Carlos Venegas Munoz
2255b36a82 docs: Add documentation about host cgroup management
Document how cgroups are done today and what is expected
for the upcoming SandboxCgroupOnly option.

Prior cgroup documentation are no longer accurate. Removing the cgroup
discussion from the cpu sizing discussion. Updating the
cpu-constraints.md file name to reflect this.

Fixes: #542

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
2019-09-06 16:11:37 -07:00
James O. D. Hunt
44f67f7efc
Merge pull request #539 from vijaydhanraj/kata-acrn-doc
doc: how-to on Kata Containers with ACRN hypervisor
2019-09-05 09:53:37 +01:00
Vijay Dhanraj
4f0259424e doc: how-to on Kata Containers with ACRN hypervisor
Start-up guide on setting up kata containers
with ACRN hypervisor.

Fixes: #535

Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2019-09-04 09:27:43 -07:00
James O. D. Hunt
52690de805 docs: Emphasise default docker config
Improved the Docker installation instructions by making it clear *which*
of the multiple ways of configuration Docker for Kata is the default,
and that it is not necessary to do anything further if users select the
automatic installation method.

Fixes: #551.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-09-04 10:49:17 +01:00
GabyCT
d0cf1cd73f
Merge pull request #549 from kata-containers/nitkon-patch-1
architecture.md: Update initrd placeholder
2019-09-03 10:20:09 -05:00
GabyCT
c017e2519d
Merge pull request #541 from marcov/howto-move
how-to: move k8s guide into a dedicate how-to md
2019-09-03 10:19:00 -05:00
nitkon
6ce8b159c5
architecture.md: Update initrd placeholder
Update initrd placeholder. 

Fixes: #548

Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>
2019-09-02 22:03:51 +05:30
James O. D. Hunt
95072b7d64
Merge pull request #538 from awprice/privileged-documentation
docs: add documentation for privileged and host devices
2019-09-02 11:42:04 +01:00
James O. D. Hunt
d89db17407
Merge pull request #545 from stefanha/virtio-fs-no-hugepages
virtiofs: hugepages is no longer required since Kata 1.8
2019-08-28 15:27:46 +01:00
Stefan Hajnoczi
6e9cc36cd3 virtiofs: hugepages is no longer required since Kata 1.8
The documentation says hugepages are required for virtio-fs.  This
limitation was removed in Kata 1.8 in kata-runtime commit
a41894da18 ("runtime: Enable file based
backend").

Fixes: #544
Signed-off-by: Stefan Hajnoczi <stefanha@gmail.com>
2019-08-28 14:48:40 +01:00
Marco Vedovati
ceb8600814 how-to: k8s: rewrite intro, add cri-o RuntimeClass
Update the k8s Kata guide introduction, and specify RuntimeClass option
for CRI-O 1.12+.

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2019-08-27 16:06:12 +02:00
Marco Vedovati
4d66559738 how-to: improve landing README.md
Improve landing README.md by categorizing howto guides.

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2019-08-27 13:42:00 +02:00
Marco Vedovati
f91f0cc83b how-to: move k8s guide into a dedicate how-to md
Create a dedicate how-to guide for running Kata with k8s, and link to it
from the original guide location inside the Developer Guide.

Fixes: #333

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2019-08-27 13:42:00 +02:00
Alex Price
841ac8318a docs: add documentation for privileged and host devices
This commit adds documentation for privileged containers and the mounting of host devices
when privileged is used. It has instructions for disabling this functionality when using
Containerd and CRI.

Fixes #529

Signed-off-by: Alex Price <aprice@atlassian.com>
2019-08-27 08:45:39 +10:00
Graham Whaley
3ed59ee50e
Merge pull request #537 from amshinde/add-instruction-pull-image
shimv2: Add instruction to pull image first
2019-08-21 09:13:02 +01:00
Archana Shinde
0ad8270772 shimv2: Add instruction to pull image first
Running the container with `ctr` when the image is not present
on the system gives an error.

Fixes #536

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2019-08-20 16:02:33 -07:00
Marco Vedovati
66b3590533
Merge pull request #534 from marcov/revamp-install-readme
install: refresh installation guide README
2019-08-19 18:34:54 +02:00
Marco Vedovati
c704edbff6 install: refresh installation guide README
Refresh installation guide README with a clearer structure, and provide
a list of distribution with official Kata packages. This also updates
the openSUSE Leap versions supported to 15 and 15.1.

Fixes: #533

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2019-08-19 17:32:30 +02:00
Salvador Fuentes
3dadaf64c5
Merge pull request #532 from gabibeyer/updateDocs
Update fedora version support
2019-08-16 07:59:51 -05:00