Commit Graph

530 Commits

Author SHA1 Message Date
James O. D. Hunt
0ce16deab3
Merge pull request #261 from amshinde/intel-gpu-use-case
use-cases: Add documentation for using Intel GPU with Kata
2018-10-09 09:31:31 +01:00
Archana Shinde
15d38d390f use-cases: Add documentation for using Intel GPU with Kata
This document decsribes how an Intel GPU can be used with
Kata Containers in GVT-g and GVT-d mode.
An example of an actual workload will be added in the future.

Fixes #260

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2018-10-08 10:20:24 -07:00
GabyCT
07af37e07d
Merge pull request #253 from grahamwhaley/20180925_selinux_limitation
Limitations: add selinux support limitation
2018-10-04 12:01:03 -05:00
Graham Whaley
ec9f9d428e
Merge pull request #251 from jodh-intel/improve-k8s+cri-containerd-howto
docs: Clean up k8s with cri-containerd howto
2018-10-04 13:23:41 +01:00
James O. D. Hunt
ca6f9dd851
Merge pull request #258 from devimc/topic/addSnapReleaseChecklist
checklist: add snap packages to the release checklist
2018-10-02 09:07:45 +01:00
Graham Whaley
38a06cadee Limitations: add selinux support limitation
We do not currently support enablement of `selinux` in the
dockerd config. Document that.

Fixes: #252

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2018-10-01 16:31:39 +01:00
Graham Whaley
61c1c44127
Merge pull request #256 from marcov/fix-urls
install: have URLs point to the latest version on OBS
2018-10-01 14:40:05 +01:00
Marco Vedovati
795400525c install: have URLs point to the latest version on OBS
The repository URLs in the installation guides needs to point to the
latest release version.
This impact tests execution too (kata-manager uses this guides as
installation recipes).

Fixes: #255

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-10-01 11:09:38 +02:00
James O. D. Hunt
4cc9efedc0 docs: Clean up k8s with cri-containerd howto
This PR is based on #124 but has been reworked and updated to take into
account review feedback and extra cleanups to bring this howto in line
with the latest documentation requirements.

Fixes #127.

Signed-off-by: T. Nichole Williams <tribecca@tribecc.us>
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-10-01 08:35:13 +01:00
Julio Montes
d47e66a9c5 checklist: add snap packages to the release checklist
add snap packages to the release checklist

fixes #257

Signed-off-by: Julio Montes <julio.montes@intel.com>
2018-09-28 09:32:26 -05:00
James O. D. Hunt
4eeae1d4d3
Merge pull request #221 from bergwolf/network
architecture.md: add network hotplug diagram
2018-09-25 09:13:51 +01:00
Peng Tao
6b450c0bb8 uml: add txt source of network hotplug uml
So that anyone can paste it into https://www.planttext.com/ to
modify the png file.

Signed-off-by: Peng Tao <bergwolf@gmail.com>
2018-09-25 15:24:14 +08:00
Peng Tao
b14dec08f2 api: update kata api design doc
To match the storage and network hotplug APIs we actually implemented.

Signed-off-by: Peng Tao <bergwolf@gmail.com>
2018-09-25 15:24:14 +08:00
Peng Tao
4928041943 architecture.md: add network hotplug diagram
To document the design we have agreed on network hotplug support.

Fixes: #220

Signed-off-by: Peng Tao <bergwolf@gmail.com>
2018-09-25 15:24:14 +08:00
James O. D. Hunt
a64fccf3f1
Merge pull request #249 from devimc/topic/updateCommand
Limitations: update 'update command' section
2018-09-20 08:56:20 +01:00
Julio Montes
334bbe0f24 Limitations: update 'update command' section
update 'update command' section

fixes #248

Signed-off-by: Julio Montes <julio.montes@intel.com>
2018-09-19 15:44:55 -05:00
James O. D. Hunt
13aed3a3bc
Merge pull request #238 from egernst/stable-documentation
stable: initial stable-branching documentation
2018-09-18 15:31:40 +01:00
Eric Ernst
2594c907a8 stable: initial stable-branching documentation
It is expected that this document will change over time. This
represents an initial starting point as we create and release
our stable branches.

Fixes: #237

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-09-18 07:25:10 -07:00
Eric Ernst
209433c799
Merge pull request #245 from gnawux/readme-organize
README.md: update the README of the documentation repo
2018-09-13 15:17:45 -04:00
Xu Wang
0a4342e7a6
README.md: update the README of the documentation repo
Ship more information of the documents.

Fixes: #244
Signed-off-by: Xu Wang <xu@hyper.sh>
2018-09-12 16:41:47 +08:00
Xu Wang
ac8f66870e
Merge pull request #242 from nitkon/master
Limitation: Document docker --security-opt option not supported
2018-09-12 15:38:21 +08:00
Nitesh Konkar
e5b29318ae Limitation: Document docker --security-opt option partially supported
Fixes: #241

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2018-09-07 20:59:58 +05:30
James O. D. Hunt
d10bf8b3ef
Merge pull request #240 from devimc/topic/updateKernelMem
limitations: remove 'docker run and kernel memory' section
2018-09-07 08:13:46 +01:00
Julio Montes
52aec3af15 limitations: remove 'docker run and kernel memory' section
issue https://github.com/kata-containers/runtime/issues/187 was fixed

fixes #239

Signed-off-by: Julio Montes <julio.montes@intel.com>
2018-09-05 12:15:29 -05:00
Eric Ernst
9bd2edd4bc
Merge pull request #235 from amshinde/remove-cni-flow
docs: Remove incorrect CNI flow
2018-08-30 15:37:50 -07:00
Archana Shinde
dc0c7063dd docs: Remove incorrect CNI flow
We need to update the way CNI is handled which is
mostly how CNM is taken care of. Start of by removing
the incorrect steps documented for CNI.

Fixes #236

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2018-08-30 15:25:19 -07:00
Salvador Fuentes
4f79231285
Merge pull request #233 from jodh-intel/dont-hardcode-golang-version
docs: Don't hardcode minimum golang version
2018-08-27 09:02:37 -05:00
James O. D. Hunt
b47d88f2a4 docs: Don't hardcode minimum golang version
The minimum golang version should be defined *once* - in [1]. Since the
developer guide already provides a link to that human-readable file,
remove the hard-coded golang version number to avoid having to maintain
that part of the devguide.

Fixes #232.

[1] - https://github.com/kata-containers/runtime/blob/master/versions.yaml

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-08-24 14:29:03 +01:00
GabyCT
881fac25f5
Merge pull request #227 from devimc/topic/vsocks
usecases: add vsock documentation
2018-08-23 09:47:02 -05:00
Julio Montes
16c50aeb6b
Merge pull request #229 from nitkon/patch-2
documentation:install: Fix a broken link
2018-08-22 09:30:27 -05:00
Julio Montes
9948b1892a usecases: add vsock documentation
Add vsock documentation

fixes #226

Signed-off-by: Julio Montes <julio.montes@intel.com>
2018-08-22 09:27:19 -05:00
Archana Shinde
b594fd3af9
Merge pull request #25 from egernst/vpp-use-case-doc
use-cases: add VPP directions
2018-08-21 14:22:46 -07:00
Eric Ernst
1f80ea8429 use-cases: add VPP directions
create a use-cases subdirectory and add an initial use case,
booting a kata container which makes use of vpp vhost-user interface.

Fixes: #209

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-08-21 12:04:31 -07:00
Archana Shinde
b33e91e28b
Merge pull request #219 from GabyCT/topic/updatefedora
docs: Update install guide for fedora
2018-08-21 10:14:04 -07:00
nitkon
393af108b1
documentation:install: Fix a broken link
The "OpenSuse" link under "Installing Kata Containers"
is broken. Fix it.

Fixes: #228
Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2018-08-21 18:56:34 +05:30
Julio Montes
42e95dbb69
Merge pull request #217 from GabyCT/topic/removeworkaround
docs: Remove workaround on SLES install documentation
2018-08-21 07:55:11 -05:00
Graham Whaley
ad75d955f2
Merge pull request #224 from GabyCT/topic/removeubuntu
docs: Remove support of ubuntu 17.10 on installation guide
2018-08-17 14:39:15 +01:00
Gabriela Cervantes
84be074f23 docs: Remove support of ubuntu 17.10 on installation guide
Remove the support of ubuntu 17.10 as it is now end of life.

Fixes #223

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-08-17 00:13:56 -05:00
Gabriela Cervantes
e415d03214 docs: Update install guide for fedora
Update install documentation guide for fedora to include the
support for fedora 28.

Fixes #218

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-08-16 23:45:38 -05:00
Archana Shinde
d4d5a28924
Merge pull request #215 from GabyCT/topic/addubuntu
docs: Update installation guide for Ubuntu.
2018-08-16 10:29:30 -07:00
Gabriela Cervantes
10f235a603 docs: Remove workaround on SLES install documentation
Now that this issue has solved kata-containers/packaging#39,
we can remove the workaround for the proxy and the shim.

Fixes #216

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-08-16 05:38:33 -05:00
Archana Shinde
61bc5dfda8
Merge pull request #161 from GabyCT/topic/addopensuse
docs: Add OBS package installation guide for openSUSE
2018-08-15 10:15:24 -07:00
Salvador Fuentes
aa90d948aa
Merge pull request #114 from GabyCT/topic/addsles
docs: Add installation guide for SLES
2018-08-15 08:22:17 -05:00
Gabriela Cervantes
e094f6cce0 docs: Update installation guide for Ubuntu.
Include in the document the support for ubuntu 18.04.

Fixes #214

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-08-15 07:47:47 -05:00
Gabriela Cervantes
a2d83701a0 docs: Add OBS package installation guide for openSUSE
This is the installation guide for OBS packages for
openSUSE.

Fixes #160

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-08-15 03:54:15 -05:00
Archana Shinde
2b7cba2253
Merge pull request #211 from nitkon/patch-1
architecture.md: Bump Kata Version to 1.2.0, add pseries info.
2018-08-13 10:27:03 -07:00
Nitesh Konkar
25dfe4ad69 architecture.md: Bump Kata Version to 1.2.0, add pseries info.
Since there have not been any major architecture changes
in Kata Containers since 1.0 release, bump version to latest
1.2.0 release. Also, add another supported machine type
"pseries" for IBM Power Systems. A typo is also fixed in this
commit.

Fixes #210

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2018-08-13 15:07:36 +05:30
Gabriela Cervantes
2341d753e2 docs: Add installation guide for SLES
This will add the installation guide for SLES.

Fixes #85

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-08-13 02:14:52 -05:00
James O. D. Hunt
6c81e212db
Merge pull request #208 from nitkon/master
Dev-guide: Kernel build fails on ppc64le
2018-08-08 15:43:29 +01:00
Nitesh Konkar
fb6ed6961a Dev-guide: Kernel build fails on ppc64le
The kernel config file name prefix changed from
ppc64le to powerpc. This change broke the kernel
build on ppc64le. Fix the kernel build steps
accordingly.

Fixes: #207

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2018-08-07 17:55:41 +05:30