Commit Graph

562 Commits

Author SHA1 Message Date
Salvador Fuentes
7d5cac092d
Merge pull request #608 from Amulyam24/fix-documentation
docs: Change in setting up a debug console
2020-03-17 10:39:14 -06:00
Amulya Meka
80702f6dd7 docs: Change in setting up the debug console
The debug console can be set up with the help of both rootfs or initrd image.

Fixes: #609

Signed-off-by: Amulya Meka <amulmek1@in.ibm.com>
2020-03-16 09:29:08 +05:30
Julio Montes
2fc36daef4
Merge pull request #613 from eadamsintel/qat_update
subsystem: Update QAT instructions to support 5.4 kernel
2020-03-11 09:00:24 -06:00
Adams, Eric
fa837917e9 subsystem: Update QAT instructions to support 5.4 kernel
The QAT instructions was broken after moving to a newer 4.19 kernel. Now
that the new 5.4 kernel is out, these instructions fix that.

Fixes #612

Signed-off-by: eric.adams@intel.com
2020-03-10 15:14:01 -07:00
GabyCT
2391118363
Merge pull request #607 from grahamwhaley/20200305_v2_debug
Dev: shimv2 logs: Elaborate on shimv2 log enabling
2020-03-06 10:57:41 -06:00
Graham Whaley
bce991b505 Dev: shimv2 logs: Elaborate on shimv2 log enabling
There are two 'debug' settings in the containerd config file that
affect the shimv2 runtime log output. Add the other method to the
existing documentation, and also note that enabling full containerd
debug also affects all of containerd.

The commit also re-generates the TOC, which seems to correct a
few anomolies there.

Fixes: #596

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2020-03-05 14:05:49 +00:00
GabyCT
cc2583abdb
Merge pull request #605 from amshinde/update-releases-doc
Update releases documents
2020-03-02 16:29:44 -06:00
Archana Shinde
0067551e09 release: Fix any references to deleted docs.
Replace reference to Releases.md by Stable-Branch-Strategy.md

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2020-02-28 17:49:52 -08:00
Archana Shinde
ffb6c80cf7 release: Add a document to describe steps for making a release
Much of the information is from the release docs from packaging repo.
Plan is to maintain all the release information in this repo.

Fixes #600

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2020-02-28 17:49:52 -08:00
Archana Shinde
56606b9dec release: Merge Releases.md into Stable-Branch-Strategy.md
Some of the information in this doc has gone stale.
Move the relevant information over to Stable-Branch-Strategy.md.
It is a good idea to not have information dispersed accross
too many docs.

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2020-02-28 10:47:59 -08:00
James O. D. Hunt
89b5ee68c5
Merge pull request #602 from grahamwhaley/20200218_fluentd_logging
howto: import kata logs with fluentd
2020-02-28 11:38:41 +00:00
Graham Whaley
5e7742fbc3 howto: add index for fluentd doc
Add a link to the new fluentd document.

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2020-02-28 10:11:09 +00:00
Julio Montes
74ebc0945e
Merge pull request #604 from devimc/topic/design/cgroups
design: document cgroups v1 and v2
2020-02-27 06:54:47 -06:00
Graham Whaley
decb62bf28 howto: import kata logs with fluentd
Document examples of how to import Kata logs with `fluentd`.
Show examples both from the systemd/logfmt method and the
file/JSON method.

Fixes: #601

Depends-on:github.com/kata-containers/tests/pull/2334

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2020-02-27 11:49:35 +00:00
Archana Shinde
94dd708421
Merge pull request #594 from grahamwhaley/20200213_kernel_boot
Developer: document how to get kernel boot messages
2020-02-26 10:34:57 -08:00
Julio Montes
28e5834c74 design: document cgroups v1 and v2
document what cgroups are supported and what changes are needed in the
configuration file to support them.

fixes #603

Signed-off-by: Julio Montes <julio.montes@intel.com>
2020-02-26 15:27:06 +00:00
Graham Whaley
7ff8c4a422 Developer: document how to get kernel boot messages
Add a section detailing the minimum debug you need to configure in
order to capture the kernel boot messages in the system journal.

Fixes: #593

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2020-02-25 14:59:39 +00:00
Archana Shinde
079b5883c8 release: This checklist is no longer relevant
We have automated most of the steps and follow
a different process now.

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2020-02-21 15:40:28 -08:00
Xu Wang
2a53993a69
Merge pull request #592 from teawater/vm
how-to: Add how-to for Kata Containers with virtio-mem
2020-02-21 15:01:04 +08:00
GabyCT
17a9857ac6
Merge pull request #599 from amshinde/update-release-cadence
Update release cadence in our release docs
2020-02-20 10:00:52 -06:00
Archana Shinde
946fdb7d23 release: Add documentation mentioning alpha releases
We now make alpha releases before making a release candidate release.
Mention this in the docs.

Fixes #598

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2020-02-19 18:10:27 -08:00
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
Hui Zhu
96518f220b how-to: Add how-to for Kata Containers with virtio-mem
Add how-to for Kata Containers with virtio-mem.

Fixes: #591

Signed-off-by: Hui Zhu <teawater@antfin.com>
2020-02-07 17:47:05 +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