Commit Graph

66 Commits

Author SHA1 Message Date
Xu Wang
2bb23519f7 install: mention shimv2 for the manual installation instruction
- mentioned shimv2 in the configuration part of manual installation
- reference the link of shim v2 api and the k8s containerd howto

Signed-off-by: Xu Wang <xu@hyper.sh>
2019-01-22 15:39:05 +08:00
Julio Montes
d3bdfa306d install: add snap installation to installing table
Add snap installation to "Installing on a Linux System" table

Signed-off-by: Julio Montes <julio.montes@intel.com>
2018-12-05 09:45:00 -06:00
Julio Montes
3440caeda5 install: add snap installation guide
Add snap installation guide

fixes #274

Signed-off-by: Julio Montes <julio.montes@intel.com>
2018-12-05 09:45:00 -06:00
Graham Whaley
d7d5d0bdd2 Merge pull request #313 from egernst/azure-install-guide
Azure install guide
2018-11-27 19:30:38 +00:00
Eric Ernst
584bc5d232 docs: update azure install guide
Add link to distribution specific guides, and reference
azure document from install README.

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-11-27 11:31:36 -08:00
Graham Whaley
4bfed86116 cloud: vexx: fix wrong style type of vexx title
The vexx got added as a '#' top level item instead of a
'*' bullet entry. Fix it...

Fixes: #316

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2018-11-27 10:24:10 +00:00
Mohammed Naser
03758b1ce1 vexxhost: add quickstart docs
Created a new installation guide for installing Kata on
https://vexxhost.com.

Fixes #315.

Signed-off-by: Mohammed Naser <mnaser@vexxhost.com>
2018-11-26 15:28:55 -08:00
Sarah
2c6800eb3e docs: Creating placeholder for Azure get started guide
Simple starter template to get URLs in shape.  Content pending.

Fixes: #130

Signed-off-by: scooley@microsoft.com
Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-11-26 08:47:55 -08:00
Alex Yang
b78fe831ec docs: fix a link in installing-with-kata-manager.md
Fix the link from #install-kata-packages-only to #install-the-kata-packages-only

Fixes #295

Signed-off-by: Alex Yang <yangyang1@zte.com.cn>
2018-11-07 10:13:37 +08:00
Eric Ernst
a184f98cc9 Merge pull request #272 from raravena80/master
install: Add AWS installation guide
2018-10-26 04:51:14 +01:00
Ricardo Aravena
942d5344e0 install: Add AWS installation guide
Fixes #273

Installation guide for AWS.

Signed-off-by: Ricardo Aravena <raravena@branch.io>
2018-10-25 08:49:59 -07:00
James O. D. Hunt
7dba230a1c docs: Add instructions to run the kata-doc-to-script generated scripts
Update the `kata-doc-to-script` install document to actually execute the
generated scripts, allowing the entire installation to be tested by the CI.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-10-25 16:28:19 +01:00
James O. D. Hunt
67982e7a0f docs: Make "Scripted" installation method executable
Converted the plain code blocks in
`install/installing-with-kata-doc-to-script.md` to bash code blocks so
that they are executable by... `kata-doc-to-script.sh`.

Also, removed the backslashes to let github render scroll bars for
consistency with other docs.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-10-24 09:19:03 +01:00
James O. D. Hunt
2a54ac9830 Merge pull request #277 from jodh-intel/improve-readme
docs: Improve table in install README
2018-10-23 15:38:31 +01:00
Marco Vedovati
08d233e4f1 install: clean instructions for kata-manager
Use a one-line code block for the installation command, and document the
dry run option.

Fixes: #275

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-10-19 19:50:55 +02:00
James O. D. Hunt
16379e3bc7 docs: Improve table in install README
Improvements to the table in the installation README:

- Fix the invalid link for the "Build from sources" option.

- Add column for "Packaged install" to make it clearer which
  options result in a distro-packed install.

- Tweaked the "Suggested for" column to make the use-case options
  clearer.

- Added detail for each use-case in a "Description" column.

Fixes #276.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-10-19 17:28:07 +01:00
James O. D. Hunt
30f2fbfb73 docs: Add more details to scripted install section
Add a little more information on the "Scripted Installation" section of
the install README.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-10-19 17:28:02 +01:00
James O. D. Hunt
c4fb842b8b docs: Fix install key URL
The URL for the public key used for package signing was incorrect.

See: https://github.com/kata-containers/tests/pull/825

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-10-19 16:31:26 +01:00
Marco Vedovati
cc046495e5 install: Refactor installation instructions
Refactor installation instruction to minimize duplicate content,
to document package source verification process, and to remove
some of the typos.

Fixes: #263

Signed-off-by: Marco Vedovati <mvedovati@suse.com>
2018-10-12 15:30:16 +02: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
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
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
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
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
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
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
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
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
Eric Ernst
596bf31bdf Merge pull request #195 from morph027/docker-daemon-json
docs: add kata-runtime to Docker daemon.json
2018-07-27 19:19:02 -07:00
morph027
6ef28deb96 docs: add kata-runtime to Docker daemon.json
Fixes: #484

Signed-off-by: Stefan Heitmüller <morphsen@gmx.com>
2018-07-27 12:20:20 +02:00
Eric Ernst
443d7d9160 install: gce: show should be describe for image inspection
s/show/describe

Fixes: #197

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-07-25 10:59:07 -07:00
Sarah
748acc6683 docs: update kube anchor in distro install guides.
Fixes: #184

Signed-off-by: Sarah <scooley@microsoft.com>
2018-07-11 12:57:00 -07:00
James O. D. Hunt
baf66c743d docs: Remove double "the" in README
Excised an extraneous definite article in the install README.

How did we miss this in the review phase I wonder?

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 15:22:24 +01:00
James O. D. Hunt
84e2622f94 docs: Add TOC to GCE guide
Add a table of contents to the Google Compute Engine install guide.

Fixes #173.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 15:22:24 +01:00
James O. D. Hunt
062fef460d docs: Add GCE install guide to install README
Add the new Google Compute Engine installation guide to the
installation README, reworking this doc to add in a table of contents
and a new "Cloud services" section.

Fixes #173.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 15:22:22 +01:00
James O. D. Hunt
f96f7ea2d3 docs: Use relative links in install README
Simplify the installation README by using relative URLs - let github
expand them automatically for readers.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 15:22:22 +01:00
James O. D. Hunt
81c7f9ec01 docs: Remove "-ti" from docker invocations
The docker install guides end with a call to `docker run`. However, they
all specify `-ti` which is causing our CI to fail.

Remove the `-ti` so that the command works both under the CI and as
expected for the user.

Fixes #175.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 14:44:21 +01:00
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
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
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
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
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
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