Commit Graph

242 Commits

Author SHA1 Message Date
Jon Olson
04dfaece9b docs: Add GCE installation guide.
This covers the GCP portion of #130.

Introduces a guide to configuring a VM image with nested virtualization. The
primary focus of the guide is the set of commands required for creating and
managing nested VMX GCE images. For Kata installation itself the guide defers
to the distribution-specific Kata documentation for actually installing Kata.
The upside is that it needn't be updated every time the instructions for a
given distribution change. The downside is that it is not a standalone
artifact.

Fixes: #155.

Signed-off-by: Jon Olson <jonolson@google.com>
2018-06-19 10:42:07 -07:00
Graham Whaley
bf68be0c05
Merge pull request #159 from nitkon/patch-1
developer-guide: use the correct kernel config file name
2018-06-15 13:53:19 +01:00
James O. D. Hunt
0de5e4741c
Merge pull request #153 from GabyCT/topic/addrhel
docs: Add RHEL installation guide.
2018-06-15 08:41:48 +01:00
nitkon
90c4d75c6c
developer-guide: use the correct kernel config file name
kernel_arch was being set to amd64 instead of x86_64
on intel. The kernel config file name starts with
x86_64 and hence this needs to be fixed.

Fixes:  #158

Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>
2018-06-14 20:30:22 +05:30
Gabriela Cervantes
8bc69ec8cf docs: Add RHEL installation guide.
This will add the RHEL installation guide for the OBS packages for
kata runtime.

Fixes #86

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-06-14 05:40:11 -05:00
James O. D. Hunt
a0a0a7b4ac
Merge pull request #145 from jodh-intel/install-guides-move-docker
docs: Split docker install into separate docs
2018-06-13 10:50:29 +01:00
James O. D. Hunt
ce077f0b96 docs: Split docker install into separate docs
The install guides assumed that users wanted to install Docker. Since
there are other container managers, split the Docker-specific
instructions into separate documents (with backlinks) and allow the
user to choose between Docker or Kubernetes from the install guides.

Fixes #144.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-13 10:47:30 +01:00
James O. D. Hunt
967f03aa01 docs: Properly format distro names
Ensure the first mention of all the distro names in the install guides:

- Have the required asterisk after the name.
- Have a link to the website.

Also folded the overly long lines.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-13 10:47:30 +01:00
James O. D. Hunt
26b67468dd
Merge pull request #152 from nitkon/master
docs: Make "Install guest kernel images" arch-sensitive
2018-06-13 09:20:37 +01:00
Nitesh Konkar
a47e243e10 docs: Make "Install guest kernel images" arch-sensitive
Make "Install guest kernel images" in Developer-Guide
arch specific.

Fixes: #140

Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>
2018-06-12 16:15:09 +05:30
James O. D. Hunt
b71e2f389d
Merge pull request #147 from grahamwhaley/20180806_move_zun
Zun: Move to subdir and add to README
2018-06-12 10:57:16 +01:00
Graham Whaley
5d413bc5ac limitations: update URL for CPU constraints
We have new CPU constraints docs, now in this repo. Update the
Limitations document to reflect that.

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2018-06-12 10:38:47 +01:00
Graham Whaley
e600be9646 Zun: Move to subdir and add to README
Move all the Zun docs into their own subdir, and add a
Zun reference and link to the top level README index.

Fixes: #131

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2018-06-12 10:36:45 +01:00
Graham Whaley
8120500b0c
Merge pull request #64 from devimc/doc/cpu
constraints: document CPU constraints
2018-06-12 10:36:15 +01:00
Archana Shinde
bcc282b4a1
Merge pull request #148 from grahamwhaley/20180806_arch_index
README: Update documentation indexes
2018-06-11 17:58:10 -07:00
Eric Ernst
46947cb4e2
Merge pull request #150 from jodh-intel/fix-doc-urls
docs: Fix invalid URLs
2018-06-11 09:32:31 -07:00
Eric Ernst
3fc23640d1
Merge pull request #151 from annabellebertooch/add-hardware-reqs-to-install-guide
docs: Adds hardware requirements to Install Guide
2018-06-08 15:52:46 -07:00
Anne Bertucio
9515de77ae docs: Adds hardware requirements to Install Guide
Puts the nested virt/bare metal requirement in the top line
of the Install Guide and references the Kata hardware
check.

Signed-off-by: Anne Bertucio <anne@openstack.org>
2018-06-08 15:27:06 -07:00
James O. D. Hunt
640e4e6eb4 docs: Fix invalid URLs
Correct invalid document URLs.

Fixes #149.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-08 17:02:39 +01:00
Graham Whaley
86b33afb7c design: Update the index and add some links
The design subdir README index was a little slim and
potentially out of date, and was missing hotlinks to
some documents that did exist.

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2018-06-08 11:43:33 +01:00
Graham Whaley
1dd26540bc README: Add all docs to the index
The top level README.md index for the repository was a bit
slim on entries.
Add all the other docs in this repo to the index, and sort them
alphabetically by symbolic name (which may be slightly different
from the filename itself).

Fixes: #146

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2018-06-08 11:34:26 +01:00
James O. D. Hunt
08a0316c08
Merge pull request #141 from jodh-intel/ci-test-install-guides
CI: test installation guides
2018-06-07 07:55:32 +01:00
Eric Ernst
837481215f
Merge pull request #135 from sboeuf/update_docs
docs: Update documentation to provide Kubernetes alternative to Docker
2018-06-06 09:25:12 -07:00
Sebastien Boeuf
7536f77546 docs: Add a disclaimer about Kubernetes installation
This commit updates all 3 installation instructions related to
Ubuntu, Fedora and Centos, providing a disclaimer about the k8s
installation. Particularly, it says that those docs are only
explaining how to run Kata Containers with Docker, and that the
user should refer to the developer documentation to read how
to install Kata for k8s.

Fixes #134

Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
2018-06-06 09:09:56 -07:00
Sebastien Boeuf
31243dfade docs: Update developer documentation to run k8s on Kata Containers
This documentation update purpose is to propose an alternative to the
default Docker usage that was described. The developer wanting to
interact with Kubernetes will have the proper information to start.

Fixes #134

Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
2018-06-06 09:05:03 -07:00
Sebastien Boeuf
e77389dfb9 docs: Fix a few details in developer documentation
A few assumption were made, making the steps not working directly on
a clean system.

Fixes #134

Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
2018-06-06 09:03:57 -07:00
James O. D. Hunt
4e843139ec CI: test installation guides
Moved static tests to CI setup script and added a new CI test to
execute all install guides if any one changes.

Fixes #132.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-06 15:59:03 +01:00
James O. D. Hunt
1b7a9e3dca
Merge pull request #137 from JerryOpenix/master
Ubunut/Kata: upgrade from clear container to kata container
2018-06-05 15:12:52 +01:00
Liu Changcheng
1feace892f docs: Remove throttler in upgrading doc
Updated the `Upgrading.md` document to ensure users remove the Clear
Containers throttler package to avoid conflicts with the Kata Container
equivalent.

Fixes #138.

Signed-off-by: Liu Changcheng <changcheng.liu@intel.com>
2018-06-05 17:21:03 +08:00
Julio Montes
6a316fe5d5 constraints: document CPU constraints
Add CPU constraints documentation

fixes #136

Signed-off-by: Julio Montes <julio.montes@intel.com>
2018-06-04 09:51:19 -05:00
Archana Shinde
8e3bc751c9
Merge pull request #126 from jodh-intel/more-doc-requirements
docs: Add notes to doc requirements
2018-05-29 13:53:29 -07:00
James O. D. Hunt
3af75af484 docs: Add notes to doc requirements
Add details to documentation requirements document explaining how we use
and format notes.

Fixes #125.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-25 09:28:42 +01:00
James O. D. Hunt
9664caf7f4
Merge pull request #120 from jodh-intel/add-links-to-upgrade-doc
Add links to upgrade doc
2018-05-24 16:14:38 +01:00
James O. D. Hunt
ef3b0e5f9d
Merge pull request #98 from bergwolf/runv-upgrade
upgrade: add runv upgrade guide
2018-05-24 16:13:19 +01:00
Peng Tao
ca460f39ce upgrade: add runv upgrade guide
runV and Kata Containers can live together but we need to make it clear
in the doc.

Fixes: #97

Signed-off-by: Peng Tao <bergwolf@gmail.com>
2018-05-23 23:13:57 +08:00
James O. D. Hunt
28b94b72bf docs: Add missing periods
Add fullstops at the of bullets in install README.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-23 15:52:48 +01:00
James O. D. Hunt
3e50bfc9eb docs: Add links to upgrade doc
Update the install README and the install guides to point to the
upgrading document.

Fixes #119.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-23 15:52:48 +01:00
James O. D. Hunt
62459fe591 docs: Explain packages are x86_only currently
Update the install guides to explain that packages are currently only
available on x86_64.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-23 15:52:48 +01:00
James O. D. Hunt
2ac2f41c22 docs: Apply standard formatting for Note
Make the leading Note in the install guides use the standard
note formatting.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-23 15:52:45 +01:00
James O. D. Hunt
169f7d7965
Merge pull request #100 from jodh-intel/add-doc-requirements
docs: Add a doc requirements doc
2018-05-23 11:18:44 +01:00
James O. D. Hunt
928640fe37 docs: Add a doc requirements doc
Add a document that explains the expectations for project
documentation.

Fixes #99.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-23 11:15:49 +01:00
Jose Carlos Venegas Munoz
68f91f3f59
Merge pull request #88 from jcvenegas/k8s-cri-contaienrd
how-to: Use K8s "cri"  containerd  plugin and kata.
2018-05-22 13:25:16 -05:00
Jose Carlos Venegas Munoz
093243a4bc how-to: Use k8s + cri + kata.
Add document to describe to to setup kubernetes and "cri" containerd

Fixes: #87

Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
2018-05-22 13:21:01 -05:00
James O. D. Hunt
f313ac18a9
Merge pull request #115 from jodh-intel/fix-centos-install-doc
docs: Fix CentOS install guide
2018-05-22 17:50:12 +01:00
James O. D. Hunt
1089b85b35
Merge pull request #118 from jodh-intel/dev-guide-refer-to-install-readme
docs: Make devguide refer to install README
2018-05-22 17:49:58 +01:00
James O. D. Hunt
b2867914f8 docs: Make devguide refer to install README
Now that we have a README for the installation guides, update the
developer guide to refer to that page, to avoid hard-coding links to
(some of) the installation guides.

Fixes #117.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-22 17:01:24 +01:00
James O. D. Hunt
d89d199cdf docs: Fix CentOS install guide
The CentOS install guide was referencing an invalid package
(`dnf-plugins-core`) so update for the yum equivalent.

Fixes #329.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-22 09:59:20 +01:00
Sebastien Boeuf
ade2da86ca
Merge pull request #20 from eadamsintel/zun
Add POC documentation of Kata working with OpenStack Zun
2018-05-21 17:47:38 -07:00
Eric Adams
ef9e72319f Add POC documentation of Kata working with OpenStack Zun
Signed-off-by: Eric Adams <eric.adams@intel.com>
2018-05-21 17:39:40 -07:00
Eric Ernst
c7523884f1
Merge pull request #113 from chavafg/topic/fix-centos-url
install: Fix centos obs url
2018-05-21 14:28:29 -07:00