Commit Graph

85 Commits

Author SHA1 Message Date
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
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
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
Eric Ernst
a7018665a7 Adding OCI created images, some minor cleanup
Will refactor history, but looking to have this as
a starting baseline to merge.

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-05-14 10:15:26 -07:00
James O. D. Hunt
3b1eed3460
Merge pull request #63 from GabyCT/topic/fedorainstall
docs: Add fedora installation guide.
2018-05-14 18:01:07 +01:00
James O. D. Hunt
9a945c68b5 docs: Fix release checklist link in releases doc
The link to the release checklist in the Releases document was linking
to the parent document, not the separate checklist document.

Fixes #73.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-05-14 16:27:43 +01:00
Gabriela Cervantes
872fe597a2 docs: Add ubuntu installation guide
Add ubuntu installation guide for kata containers packages.

Fixes #60

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-05-11 01:59:36 -05:00
Eric Ernst
03e93cd55a cleanup per jodh's feedback
Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-05-09 15:00:22 -07:00
Gabriela Cervantes
bdb1b2d44f docs: Add fedora installation guide.
This will add fedora installation guide for kata containers packages.

Fixes #62

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-05-09 03:10:19 -05:00
Eric Ernst
eb035e167f architecture: add OCI cmd diagrams
Create docker example UML flows.

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-05-07 20:44:05 -07:00
Eric Ernst
4602ef5a60 Clean up architecture .md
Remove more references to Clear in the images as well as text.

Reworked some sections for grammar/flow.

Immediate next steps:
1. At least the delete/kill command section needs to be cleaned
 up/clarified
2. Move CRI-O UML flow example to its own section, or subection of CRI-O
3. Carve up UML diagram for basic docker example case.
4. Add section describing initrd configuration
5. Add section detailing the gRPC protocol
6. Agent section needs cleaning around gRPC description.

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-05-07 07:35:09 -07:00
Eric Ernst
e04609b1cf initial architecture documentation
There is still a lot in progress, but sharing a first pass.

To do includes:
-need updated pngs (s/cc/kata)
-'signifcant' cmd section could use (simple) UML
-Need better location, and possible split up the CRI UML example
-need description of CRI-containerd
-Missing API extensions and description

Should likely carve this up into smaller .mds, as no one should read
that much text, and I don't want to get more than 200 review comments.

Contributed to by: Julio Montes, Archana Shinde, Sebastien Boeuf, and
the original CC-3.0 doc.

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-05-07 07:33:04 -07:00
Eric Ernst
2b47961105
Merge pull request #56 from jodh-intel/add-release-process
docs: Add Release process docs
2018-04-24 08:14:37 -07:00
James O. D. Hunt
a070f18c2e docs: Add Release process docs
Add a document providing an overview of releases along with the
all-important release checklist.

Fixes #32.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-04-23 09:04:03 +01:00
Archana Shinde
c7ff8ccac7
Merge pull request #59 from jodh-intel/add-licensing-doc
docs: Add license strategy doc
2018-04-20 09:39:36 -07:00
Eric Ernst
9b36fa3cf5
Merge pull request #48 from jodh-intel/add-limitations-doc
Add limitations doc
2018-04-20 09:08:55 -07:00
James O. D. Hunt
d35843d190 docs: Add license strategy doc
Add a brief document explaining that the project uses SPDX license
identifiers.

Fixes #58.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-04-19 17:40:03 +01:00
James O. D. Hunt
3e8400eee9 docs: Remove spec command limitation
Update the limitations document to remove the `spec` command limitation
(implemented on https://github.com/kata-containers/runtime/pull/196).

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-04-18 11:49:04 +01:00
James O. D. Hunt
4aa57d2e2c docs: Add links to README
Add links for the dev guide and limitations doc to the `README`.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-04-18 11:49:04 +01:00
James O. D. Hunt
6200d14e4a docs: Add limitations doc
Add the list of known limitations.

Fixes #31.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-04-18 11:49:01 +01:00