Commit Graph

152 Commits

Author SHA1 Message Date
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
Eric Ernst
79dd45a39c
Merge pull request #110 from jodh-intel/undo-create-container-bash-block
docs: Ensure install doc bash commands are non-interactive
2018-05-21 14:27:50 -07:00
Salvador Fuentes
b667ac0ec7 install: Fix centos obs url
Remove backslash from centos url that was
preventing the $VERSION_ID to take its correct value.

Fixes: #112.

Signed-off-by: Salvador Fuentes <salvador.fuentes@intel.com>
2018-05-21 13:51:04 -05:00
Eric Ernst
5d23a93a28
Merge pull request #111 from GabyCT/topic/addcentos
docs: Add CentOS installation guide
2018-05-21 10:10:47 -07:00
Eric Ernst
fdacf89a41
Merge pull request #106 from jodh-intel/update-install-README
Update install readme
2018-05-21 08:45:10 -07:00
James O. D. Hunt
08288d9808 docs: Add further links to install README
Add developer guide and runtime repo links to the installation README.

Fixes #105.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-21 16:26:03 +01:00
James O. D. Hunt
9d37c48088 docs: Add detail to install README
Add a sentence introducing the install guides in the installation
README.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-21 16:26:03 +01:00
James O. D. Hunt
54be6c69d1 docs: Add bullets to install README
Format the list of install guides as a bullet list in the installation
README.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-21 16:26:03 +01:00
Eric Ernst
28a7921664
Merge pull request #104 from jshachm/events-limit
doc: change limitation doc for cli events
2018-05-21 08:15:55 -07:00
James O. D. Hunt
6e83bdbd75 docs: Ensure install doc bash commands are non-interactive
Remove the `bash` tag from the last command in the install guides where
we show the user how to create a container with a busybox shell. This
doesn't change the content of the document but it ensures that all bash
blocks can be run non-interactively (by the `kata-doc-to-script.sh`
script in the tests repo).

Fixes #109.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-21 16:13:02 +01:00
Eric Ernst
9c88bdf0d2
Merge pull request #108 from jodh-intel/make-ubuntu-install-idempotent
docs: Make Ubuntu install idempotent
2018-05-21 07:53:52 -07:00
Eric Ernst
fce60cd1b6
Merge pull request #102 from jodh-intel/add-ci-scripts
CI: Add CI scripts
2018-05-21 07:44:44 -07:00
c00416947
b5e23cea51 doc: change limitation doc for cli events
cli events is now partly supported.It returns
the stats of a certain container.

OOM notification and Intel RDT stats are not supproted
as what runc does

Fixes: #103

Signed-off-by: Haomin <caihaomin@huawei.com>
2018-05-21 18:57:27 +08:00
James O. D. Hunt
ce5c2bbc8c docs: Make Ubuntu install idempotent
Don't append to Kata-specific apt sources file to avoid apt warnings
and make the install idempotent.

Fixes #107.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-21 11:41:08 +01:00
Gabriela Cervantes
7c895cdfaf docs: Add CentOS installation guide
This will add the installation guide for CentOS.

Fixes #84

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-05-21 03:25:25 -05:00
Eric Ernst
a01957472e
Merge pull request #83 from jcvenegas/fix-ubuntu-docs
install: Fix kata installation steps.
2018-05-18 21:45:32 -07:00
Jose Carlos Venegas Munoz
f39dc40b5d install: fix ubuntu docs.
obs provides ubuntu packages by http not https.

Fixes: #81

Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
2018-05-18 14:30:11 -05:00
James O. D. Hunt
811a5437a4 CI: Add CI scripts
Create a basic set of CI scripts that just run the static checks for
now.

Fixes #101.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-18 15:59:58 +01:00
Sebastien Boeuf
1ca427d2ea
Merge pull request #96 from kata-containers/readme-updates
install: add installation readme
2018-05-17 12:39:35 -07:00
Eric Ernst
e462e2c157 install: add installation readme
Fixes: #95

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-05-17 11:43:02 -07:00
James O. D. Hunt
07626c6b3a
Merge pull request #93 from jodh-intel/convert-cmds-to-bash-blocks
docs: Change install guides to use bash code blocks
2018-05-17 17:28:54 +01:00
James O. D. Hunt
c823f3cdb0
Merge pull request #79 from jodh-intel/add-upgrade-doc
docs: Add upgrading doc
2018-05-17 17:12:46 +01:00
Eric Ernst
561fead334
Merge pull request #74 from jodh-intel/dev-guide-debug-console
docs: Add debug console to dev guide
2018-05-17 07:33:56 -07:00
Eric Ernst
86cf9cab8f
Merge pull request #82 from jodh-intel/dev-guide-initial-setup-section
docs: Update dev guide for OBS packages
2018-05-17 07:32:05 -07:00
James O. D. Hunt
f3e454560e docs: Change install guides to use bash code blocks
Change the installation guides so that all commands the user must type
use an explicit bash code block rather than a standard code block.

This adds meaning to the documents and will then allow us to extract
the commands and run them for testing purposes.

Fixes #92.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-17 15:21:06 +01:00
James O. D. Hunt
3347bd769c docs: Mention versions database for golang in dev guide
Provide a pointer to the versions database to allow developers
to see the range of golang versions known to work.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-17 14:06:24 +01:00
James O. D. Hunt
244e50e3e4 docs: Update dev guide for OBS packages
Add details of how to install the packaged components to start off with
a working system. This involved splitting out part of the "Assumptions"
section into a new "Initial setup" section.

Fixes #80.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-17 14:06:20 +01:00
James O. D. Hunt
d4006d8ddd docs: Make dev guide warning clearer
Add some extra words to make the warning about the dev guide audience
clearer.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-17 13:59:44 +01:00
James O. D. Hunt
36e974b3e2 docs: Add debug console to dev guide
Add an appendix explaining how to setup a debug console to login to the
virtual machine for debugging.

Fixes #72.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-17 11:36:22 +01:00
James O. D. Hunt
b94fbf706f docs: Use sudo to remove old rootfs in dev guide
You cannot remove an existing rootfs directory without being `root`,
so use `sudo(8)` in the developer guide.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-17 07:51:35 +01:00
James O. D. Hunt
603a40a826 docs: Add upgrading doc
Add a document explaining how to upgrade a system:

- Running Clear Containers.
- Already installed with Kata Containers binaries.

Also, include details of assets and how and when the are updated.

Fixes #69, fixes #78.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-17 07:40:36 +01:00
James O. D. Hunt
6ae6e1ee1e
Merge pull request #66 from devimc/update/developer
developer-guide: update guest kernel image section
2018-05-17 07:12:38 +01:00
James O. D. Hunt
dd3e2e3f2c
Merge pull request #76 from raravena80/patch-1
Added more details to the Containerd CRI Plugin
2018-05-17 07:10:23 +01:00
Ricardo Aravena
ad4be60209
docs: Update arch doc for containerd
Added more details to the Containerd CRI Plugin.

Fixes #77

Signed-off-by: Ricardo Aravena <raravena@branch.io>
2018-05-16 11:01:52 -07:00
Eric Ernst
8876d423df
Merge pull request #71 from jodh-intel/add-sigusr1-to-dev-guide
docs: Explain SIGUSR1 usage in dev guide
2018-05-16 10:45:59 -07:00
Julio Montes
7916e21edd developer-guide: update guest kernel image section
add steps to build kata kernel from source

Signed-off-by: Julio Montes <julio.montes@intel.com>
2018-05-15 09:08:23 -05:00
James O. D. Hunt
317b701499 docs: Explain SIGUSR1 usage in dev guide
Add details to the developer guide of how to obtain a backtrace by
sending a `SIGUSR1` signal to the component.

Fixes #70.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-15 09:32:21 +01:00
James O. D. Hunt
1a966503e5 docs: More log-parser detail in dev guide
Add brief details to the developer guide explaining that the
log parser can convert the format of the logs.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-15 09:32:18 +01:00
Eric Ernst
be388761a7
Merge pull request #75 from jodh-intel/fix-release-checklist-link
docs: Fix release checklist link in releases doc
2018-05-14 21:13:19 -07:00
Sebastien Boeuf
8638297cae
Merge pull request #65 from egernst/architecture-docs
add initial kata architecture docs
2018-05-14 11:52:30 -07:00
Eric Ernst
4144a4ceea
Merge pull request #61 from GabyCT/topic/ubuntuinstall
docs: Add ubuntu installation guide
2018-05-14 11:25:24 -07:00