Commit Graph

530 Commits

Author SHA1 Message Date
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
Xu Wang
419d9791c7
Merge pull request #393 from teawater/vmcache
howto: Add VMCache introduction and guide
2019-03-13 00:21:40 +08:00
Hui Zhu
7b94750180 howto: Add VMCache introduction and guide
Add "What Is VMCache and How To Enable It" to howto.

Fixes: #392

Signed-off-by: Hui Zhu <teawater@hyper.sh>
2019-03-12 21:02:03 +08:00
James O. D. Hunt
3124131816 docs: Add RHEL and SLES install warning
Unfortunately, at present we have no way of testing Kata packages for
Red Hat Enterprise Linux (RHEL) or SUSE Linux Enterprise (SLES).

Add warnings to the RHEL and SLES install guides explaining this and
advising users to exercise caution. Hopefully, we will be able to drop
this warning soon (either when we have the ability to test on RHEL/SLES
or when Kata packages are available in RHEL/SLES).

Fixes #396.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-03-11 09:05:55 +00:00
James O. D. Hunt
ff67e32d30
Merge pull request #395 from grahamwhaley/20190307_CODEOWNERS
ci: add a CODEOWNERS file to cover .md files
2019-03-08 08:36:38 +00:00
Graham Whaley
0f45a33684 ci: add a CODEOWNERS file to cover .md files
Add a CODEOWNERS file so we get auto-review requests from github
for any .md file changes.

Fixes: #394

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-03-07 11:09:47 +00:00
Eric Ernst
a2fe01131d
Merge pull request #374 from jodh-intel/pin-docker-to-version-18.06
docs: Pin docker to version 18.06
2019-03-04 10:43:20 -08:00
James O. D. Hunt
5524fc39e5 docs: Clarified docker install note
Improved wording in docker installation Note based on review feedback.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-03-01 11:24:58 +00:00
GabyCT
b702f5028d
Merge pull request #387 from devimc/topic/cpuCgroups
constraints: add cpu cgroups documentation
2019-02-28 11:48:32 -06:00
Julio Montes
1e1a735796 constraints: add cpu cgroups documentation
Explain cpu cgroups are implemented in kata containers

fixes #386

Signed-off-by: Julio Montes <julio.montes@intel.com>
2019-02-27 11:57:17 -06:00
Julio Montes
3fa6a83d4d
Merge pull request #384 from liubin/master
docs: fix broken links in architecture.md
2019-02-21 08:22:27 -06:00
bin liu
0a643e9a56 docs: fix broken links in architecture.md
Two links to `how-to` file is broken.

Fixes: #383

Signed-off-by: bin liu <liubin0329@gmail.com>
2019-02-21 15:15:01 +08:00
James O. D. Hunt
ceae7b48e0 docs: Pin docker to version 18.06
Docker 18.09 removed devicemapper support but did not provide an
alternative. This can cause problems for users so update the install
docs to install Docker at version 18.06 (the last version that supports
devicemapper).

This is a temporary solution until either docker provide an alternative
or we find a way to work around the Docker feature being removed.

Note the extra logic required for Fedora since 18.06 is not available
for that release.

Fixes #373.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2019-02-18 08:55:41 +00:00
James O. D. Hunt
4c71475122
Merge pull request #372 from marcov/zun-kata-install
zun: update kata install instructions
2019-02-18 08:48:19 +00:00
Marco Vedovati
f39a73ea0c zun: update kata install instructions
Update zun guide to point to the kata installation instructions for
Ubuntu.

Fixes: #371

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2019-02-13 13:09:52 +01:00
Graham Whaley
5b483f289a
Merge pull request #380 from nitkon/patch-1
docs: Fix a typo in how-to docs
2019-02-11 10:23:02 +00:00
nitkon
bc7d96998d
docs: Fix a typo in how-to docs
Fix Typo

Fixes: #379

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2019-02-11 01:05:11 +05:30
GabyCT
1f87f86812
Merge pull request #377 from grahamwhaley/20190206_remove_pullapprove
pullapprove: remove config file
2019-02-07 10:26:30 -06:00
Graham Whaley
d53675125b pullapprove: remove config file
We are moving off pullapprove. Remove its config file.

Fixes: #376

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2019-02-06 15:55:28 +00:00
GabyCT
bbc3ce9edb
Merge pull request #370 from devimc/topic/snap-installation
snap: add snap store banner
2019-01-31 08:52:59 -06:00
Julio Montes
7722faf104 snap: add snap store banner
add snap store banner

fixes #369

Signed-off-by: Julio Montes <julio.montes@intel.com>
2019-01-31 08:32:25 -06:00
Frank Cao
7cf81c47af
Merge pull request #368 from grahamwhaley/20190130_fc_link
docs: firecracker: add top level link off to fc wiki page
2019-01-31 14:15:16 +08:00