Commit Graph

116 Commits

Author SHA1 Message Date
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
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
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
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