Commit Graph

520 Commits

Author SHA1 Message Date
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
gabi beyer
6870294a12 install: update fedora version support
Remove support/installation information for fedora 27, and
add fedora 30.

Fixes: #528

Signed-off-by: gabi beyer <gabrielle.n.beyer@intel.com>
2019-08-16 02:01:52 +00:00
James O. D. Hunt
60d0850e07
Merge pull request #531 from grahamwhaley/20190813_docker_compose
Limitations: docker compose: note it has issues
2019-08-15 11:04:15 +01:00
Graham Whaley
f1b9c23040 Limitations: docker compose: note it has issues
Note that docker compose has similar issues to docker swarm
when under Kata.

Fixes: #530

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-08-13 17:51:11 +01:00
GabyCT
f8873a088f
Merge pull request #527 from grahamwhaley/20190801_minikube_fc
minikube: note kata-fc does not function under minikube
2019-08-05 10:32:09 -05:00
Graham Whaley
675f221bbd minikube: note kata-fc does not function under minikube
`kata-fc` does not presently function under `minikube` due to
lack of block based storage. Make that clear in the installation
documents, to help prevent users going through the whole install
process, only to be disappointed when they find ti does not work.

Fixes: #526

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-08-02 10:49:41 +01:00
James O. D. Hunt
1aec41a28d
Merge pull request #512 from GabyCT/topic/fixdebiandoc
docs: Fix debian installation guide
2019-08-01 09:34:38 +01:00
Eric Ernst
1e66d93d21
Merge pull request #514 from cgxu519/doc-fix-1
docs: Fix workaround solution for ConfigPath
2019-07-29 19:41:00 -07:00
GabyCT
e9cb861fca
Merge pull request #519 from nitkon/patch-4
architecture.md: Fix networking info
2019-07-24 12:36:05 -05:00
GabyCT
ea8e48d079
Merge pull request #522 from nitkon/patch-5
architecture.md: Fix broken CRI link
2019-07-24 12:30:03 -05:00
nitkon
73aa0977ac
architecture.md: Fix broken CRI link
Fix broken CRI Link. 

Fixes:  #521

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-07-24 22:24:13 +05:30
nitkon
3c250509d1
architecture.md: Fix networking info
The networking part of the doc talks about the 
two ends of the veth pair. One end is in the container
networking namespace and the other one should
be in the host networking namespace. Fix this info.

Fixes: #518

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-07-24 20:21:46 +05:30
Eric Ernst
3655b4c197
Merge pull request #445 from grahamwhaley/20190424_minikube_docs
install: Add minikube instructions
2019-07-19 17:11:16 -05:00
Graham Whaley
8e29464b46 install: README: add Minikube entry
Add Minikube to the list of 'cloud' providers installation instructions.
Whilst there, order the list alphabetically.

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-07-18 13:28:55 +00:00
Graham Whaley
f97fe323a1 install: add Minikube installation instructions
Add instructions of how to setup and install Kata under
Minikue.

Fixes: #444

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-07-18 13:28:55 +00:00
Chengguang Xu
097156d837 docs: Fix workaround solution for ConfigPath
In the workaround solution of ConfigPath, there is a '$@'
missing in the script, so add it.

Fixes: #515

Signed-off-by: Chengguang Xu <cgxu519@zoho.com.cn>
2019-07-18 20:20:12 +08:00
James O. D. Hunt
dfda61c681
Merge pull request #510 from eadamsintel/qat-with-kata
QAT: Add initial Intel QAT Kata instructions
2019-07-18 09:14:44 +01:00
Eric Adams
0402d41ca3 QAT: Add initial Intel QAT Kata instructions
These instructions cover how to install the out of tree
QAT drivers to the host, build a custom kata kernel and
rootfs, and build a QAT accelerated OpenSSL container
image.

Fixes: #509

Signed-off-by: <eric.adams@intel.com>
2019-07-17 15:25:32 -07:00
Gabriela Cervantes
ed31473019 docs: Fix debian installation guide
Once that https://github.com/kata-containers/tests/pull/1767 lands,
we can remove from the installation guide the steps of adding the
librbd1 repository.

Fixes #511

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2019-06-25 04:21:37 -05:00
James O. D. Hunt
d052d6d4fd
Merge pull request #506 from jodh-intel/update-doc-reqs-doc-for-spell-checker
docs: Update doc requirements doc for spell checker
2019-06-21 08:38:06 +01:00
GabyCT
0ddf25e11e
Merge pull request #508 from nitkon/patch-3
docs: Use kernel build script for building kernel in developer guide
2019-06-20 14:47:41 -05:00