Commit Graph

401 Commits

Author SHA1 Message Date
James O. D. Hunt
adb1ca046f docs: Make SLES docker guide consistent
Fix wording to make the SUSE SLES docker install guide consistent with
the others.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-04-26 11:02:56 +01:00
James O. D. Hunt
2d76821f42 docs: Make CentOS docker guide consistent
Fix wording in CentOS docker install guide to make it consistent with
the others.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-04-26 11:02:38 +01:00
Graham Whaley
df57d05865
Merge pull request #441 from Remy-xl/doc-link
Docs: Update link in containerd-kata.md
2019-04-24 10:33:05 +01:00
Graham Whaley
d8c7a9629f
Merge pull request #438 from Remy-xl/master
Docs: update Build-a-custom-QEMU in Developer-Guide
2019-04-24 10:17:57 +01:00
xulei
32cbce67c9 Docs: Update link in containerd-kata.md
update the link of shimv2.svg

Fixes: #440

Signed-off-by: Lei Xu <xulei@cmss.chinamobile.com>
2019-04-24 13:54:56 +08:00
Salvador Fuentes
b162a1da3b
Merge pull request #426 from GabyCT/topic/fixsles
doc: Update SLES installation documentation
2019-04-23 12:46:45 -05:00
Remy-xl
5095be72fa Docs: update Build-a-custom-QEMU in Developer-Guide
Add how to get kata-containers/qemu and checkout to a proper version in developer-guide

Fixes: #437

Signed-off-by: Lei Xu <xulei@cmss.chinamobile.com>
2019-04-19 23:47:32 +08:00
Hui Zhu
ae40622f60
Merge pull request #435 from yuwang888/master
README: Update README.md for link of VM Templating
2019-04-19 14:50:05 +08:00
WangYu
a83849e8b9 README: Update README.md for link of VM Templating
correct the link of VM Templating
Fixes: #436

Signed-off-by: WangYu <WangYu@linux.alibaba.com>
2019-04-19 14:23:44 +08:00
Xu Wang
ed0dfa37a4
Merge pull request #432 from Remy-xl/master
Update README.md for GPU-Passthrough-with-Kata
2019-04-18 18:00:36 +08:00
Remy-xl
17e0919a2b README: Update README.md for GPU-Passthrough-with-Kata
Fixes: #431

GPU-Passthrough-with-Kata link to a error address.

Signed-off-by: Lei Xu <xulei@cmss.chinamobile.com>
2019-04-18 17:50:26 +08:00
Xu Wang
9dc2191451
Merge pull request #430 from Remy-xl/master
Zun: add zun-ui plugin for devstack
2019-04-18 15:21:39 +08:00
Remy-xl
9c8a087a58 Zun: add zun-ui plugin for devstack
Fixes: #429

Add zun-ui plugin for devstack when intergrated with zun.

Depends-on:github.com/kata-containers/tests#1484

Signed-off-by: Lei Xu <xulei@cmss.chinamobile.com>
2019-04-18 15:12:29 +08:00
Gabriela Cervantes
9071ffc8be doc: Update SLES installation documentation
Remove the warning as a CI of SLES in available
https://github.com/kata-containers/ci/pull/142.

Fixes #425

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2019-04-10 04:35:31 -05:00
Graham Whaley
4470e322e9
Merge pull request #424 from jcvenegas/master
install: Allow define kata branch.
2019-04-09 14:55:02 +01:00
Jose Carlos Venegas Munoz
9f12577be2 install: Allow define kata branch.
Kata OBS repositories provide multiple branch support.

Let define a variable to allow users define kata branch to use.

Fixes: #423

Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
2019-04-08 11:13:04 -05:00
Eric Ernst
2ee437f171
Merge pull request #420 from gabibeyer/updatedocs
doc: update architecture.md link
2019-04-02 21:04:18 -07:00
Gabi Beyer
a11768e1b7 doc: update architecture.md link
update architecture.md link, since it has moved to within the
design/ directory.

Fixes: #417

Signed-off-by: Gabi Beyer <Gabrielle.n.beyer@intel.com>
2019-04-02 21:04:32 -07:00
GabyCT
b09a469097
Merge pull request #418 from egernst/docs-cleanup
Docs cleanup
2019-03-29 16:13:24 -06:00
Eric Ernst
152330a4fd docs: Use relative paths for URLs which are part of this repo
Let's make our static testers happy.

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-03-29 14:17:54 -07:00
Eric Ernst
51f12efae9 arch: fix dead link
api.proto moved, resulting in a broken link. The original link wasn't
very useful in the first place, so simply remove.

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-03-29 14:03:59 -07:00
Eric Ernst
daef1791ff arch: move architecture.md to the design directory
Fixes: #417

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-03-29 11:04:34 -07:00
Eric Ernst
c0d63796a2 constraints: add as part of design documents
Let's keep all design documents in the same logical location. Updating
the file to be called 'cpu-constraints', though we may want to expand to
resource constraints going forward.

Fixes: #417

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-03-29 10:16:49 -07:00
Eric Ernst
353b2ecf9f vsocks: move to design directory
Let's keep all design documents in the design directory

Fixes: #417

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-03-29 10:11:04 -07:00
Eric Ernst
8e3db7f3df zun: move to use-cases, utilize images dir
Fixes: #417

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2019-03-29 10:10:10 -07:00
GabyCT
c67e7b78fa
Merge pull request #413 from jodh-intel/debug-console-needs-systemd
docs: Explain systemd needed for debug console
2019-03-25 09:41:30 -06:00
James O. D. Hunt
17cd8e84ed docs: Explain systemd needed for debug console
Add a note to the developer guide explaining that the debug console
requires systemd support (hence nominally you cannot use alpine linux
for example as that doesn't use systemd).

Fixes #412.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-03-25 09:39:53 +00:00
James O. D. Hunt
49b3cd0c56
Merge pull request #409 from jodh-intel/undo-docker-pin
Undo docker pin
2019-03-25 08:07:26 +00:00
Graham Whaley
6301fbe458
Merge pull request #408 from amshinde/remove-privileged-limitation
Limitations: Remove privileged flag limitation
2019-03-22 17:04:52 +00:00
Archana Shinde
bf0d680f56 Limitations: Remove privileged flag limitation
Kata does support privileged flag but within the guest,
so explain how this works in the Limitations docs.

Fixes #362

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2019-03-22 09:55:46 -07:00
Archana Shinde
71a4ba11b3
Merge pull request #411 from jodh-intel/fix-debug-console-example-on-ubuntu
docs: Fix debug console for ubuntu/debian
2019-03-22 09:49:10 -07:00
James O. D. Hunt
4c19083e01 docs: Fix debug console for ubuntu/debian
Change the debug console systemd job to specify the path to bash as
`/bin/bash`, *not* `/usr/bin/bash`. This unbreaks the debug console for
Ubuntu and Debian and also works for all other distros.

Fixes #410.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-03-22 13:13:47 +00:00
James O. D. Hunt
bfbd4edcca docker: Undo docker version 18.06 pin
Don't force Docker to be kept at version 18.06 (to ensure devicemapper
is available). This feature won't be re-added by Docker and remaining on
an old version of Docker is not good from a security perspective.

Replace the pinning with a note pointing users at an issue which
provides details of alternatives to devicemapper.

Fixes #407.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-03-22 10:59:54 +00:00
James O. D. Hunt
17acacbc47 docs: Capital letter at start and period at end of sentence
Fix two nits in the Debian install guide.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-03-22 10:57:36 +00:00
James O. D. Hunt
072acea2a0
Merge pull request #358 from yyyeerbo/wip
install: VERSION_ID in buster/sid can be unset. default it to 9
2019-03-22 08:40:43 +00:00
Yang Bo
6ba8ae53dd install: Debian sid/buster has no VERSION_ID, error out.
Error out if debian has no VERSION_ID, point user to stable
packages.

Fixes: #357

Signed-off-by: Yang Bo <bo@hyper.sh>
2019-03-21 21:01:11 -07:00
GabyCT
2069a3d953
Merge pull request #406 from teawater/vmcache_vsock
howto: Remove vsock from VMCache howto
2019-03-21 10:06:38 -06:00
Hui Zhu
c3f082ccb8 howto: Remove vsock from VMCache howto
Remove vsock from VMCache howto because VMCache can work with vsock now.

Fixes: #405

Signed-off-by: Hui Zhu <teawater@hyper.sh>
2019-03-21 17:24:57 +08:00
Archana Shinde
93e59021b9
Merge pull request #404 from jodh-intel/unbreak-debug-console-instructions
Unbreak debug console instructions
2019-03-19 09:45:58 -07:00
James O. D. Hunt
b347b3302c docs: Don't modify pristine config files
Kata supports multiple configuration file locations, so update the dev
guide to tweak config settings in
`/etc/kata-containers/configuration.toml` rather than the pristine
`/usr/share/defaults/kata-containers/configuration.toml` file. The
former is read first meaning the system can be reset to a vanilla Kata
configuration by simply deleting
`/etc/kata-containers/configuration.toml`.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-03-19 11:29:58 +00:00
James O. D. Hunt
c771f76eae docs: Unbreak debug console instructions
The debug console systemd job needs to specify `PrivateDevices=no` to
ensure the job can access the *real* console. Without this, connecting
to the socket does not provide access to the main guest root context.

Fixes #403.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-03-19 11:23:24 +00:00
Xu Wang
441c51c22c
Merge pull request #402 from amshinde/add-links-to-docs
Add links to all how-to and use-case docs in README.md
2019-03-19 16:18:16 +08:00
Archana Shinde
534ac218c7 docs: Add links to use-case documents.
Fixes #401

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2019-03-18 11:35:33 -07:00
Archana Shinde
e02829b443 docs: Add link for VM templating and VM cache
Add links for these docs in REAME.md

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2019-03-18 11:30:35 -07:00
Sebastien Boeuf
4d65fb4ec4
Merge pull request #398 from amshinde/sysctl-docs
sysctsl: Add how-to doc for setting sysctls.
2019-03-15 10:18:28 -07:00
James O. D. Hunt
fd3d0651e0
Merge pull request #391 from lifupan/master
how-to: Update the how-to containerd-kata doc to support runtime option
2019-03-15 09:54:41 +00:00
fupan
1998e98f40 how-to: Update the how-to containerd-kata doc to support runtime option
Update the how-to containerd-kata doc to support runtime option, by which
we can specify kata configure file for different kata runtime.

Fixes:#390

Signed-off-by: fupan <lifupan@gmail.com>
2019-03-15 16:39:36 +08:00
Archana Shinde
19e8a5e024 docs: Add link to the sysctl how-to in README.md
Add link so that the doc is discoverable

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2019-03-13 15:11:16 -07:00
Archana Shinde
817110d652 sysctsl: Add how-to doc for setting sysctls.
Document sysctls for Docker and Kubernetes.

Fixes #399

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2019-03-13 15:11:16 -07:00
Archana Shinde
076313996c
Merge pull request #397 from jodh-intel/add-rhel-install-warning
docs: Add RHEL and SLES install warnings
2019-03-12 09:58:49 -07:00