github/kata-containers
1
0
Fork 2
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-09-17 06:48:51 +00:00
Code Issues Projects Releases Wiki Activity
54 Commits 37 Branches 137 Tags
ad4be60209a3613c565c28129440581693135d38
Commit Graph

54 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
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
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
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
James O. D. Hunt
37ab12bcb4 Merge pull request #54 from nitkon/patch-3 
dev-guide: Fix minor typos
 2018-04-16 18:46:43 +01:00
Eric Ernst
ccc949f086 Merge pull request #50 from nitkon/patch-2 
dev-guide: Conditionally add kata-runtime as suffix
 2018-04-16 08:35:14 -07:00
Nitesh Konkar
727a16d468 dev-guide: Fix minor typos 
Fix minor typos in the development guide.

Fixes #53.

Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>
 2018-04-16 20:58:22 +05:30
Eric Ernst
d03837fc9f Merge pull request #45 from bergwolf/initrd 
dev-guide: add guide to build and setup initrd image
 2018-04-16 07:12:29 -07:00
Nitesh Konkar
d99af8fbe3 dev-guide: Conditionally add kata-runtime as suffix 
If kata-runtime is already added as a runtime to
kata-containers.conf then you need not add it again.

Fixes: #49

Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>
 2018-04-10 09:26:58 +05:30
Peng Tao
988bbdec59 dev-guide: fix rootfs image rootfs dir notion 
Set ROOTFS_DIR so that we do not create distro-specific dir names.

Signed-off-by: Peng Tao <bergwolf@gmail.com>
 2018-04-09 22:13:01 +08:00
Peng Tao
d87be6c94a dev-guide: add guide to build and setup initrd image 
Optionaly, one can build an initrd image and configure kata runtime
to use it.

Fixes: #44

Signed-off-by: Peng Tao <bergwolf@gmail.com>
 2018-04-09 22:12:58 +08:00
Eric Ernst
2ac900f2d8 Merge pull request #41 from jodh-intel/fix-dev-guide-runtime-link 
docs: Fix runtime link in dev guide
 2018-03-28 11:07:39 -07:00
James O. D. Hunt
f44248c67c Merge pull request #43 from jodh-intel/dev-guide-disable-initrd 
docs: Disable initrd in dev guide
 2018-03-28 17:40:08 +01:00
James O. D. Hunt
117cb58609 docs: Disable initrd in dev guide 
Add details on how to disable the `initrd` config option to ensure the
base system as documented is functional.

Fixes #42.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
 2018-03-28 17:35:41 +01:00
Eric Ernst
a6de7edc53 Merge pull request #39 from jodh-intel/dev-guide-improve-agent-debug 
docs: Improve command to enable agent debug
 2018-03-28 08:41:02 -07:00
Eric Ernst
4d8e58e5da Merge pull request #35 from jodh-intel/dev-guide-mention-collect-script 
docs: Mention collect script in dev guide
 2018-03-28 08:37:50 -07:00
Eric Ernst
5643232ce3 Merge pull request #37 from jodh-intel/improve-readme 
docs: Embellish README
 2018-03-28 08:06:26 -07:00
James O. D. Hunt
00ed3a249d docs: Fix runtime link in dev guide 
The table of contents showed an incorrect link for building and
installing the runtime.

Fixes #40.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
 2018-03-28 10:26:35 +01:00
James O. D. Hunt
3b71b57286 docs: Improve command to enable agent debug 
Change the command to enable agent debug slightly so that even if the
config file specifies kernel parameters, the command will successfully
enable the agent debug.

Fixes #38.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
 2018-03-27 17:55:47 +01:00
James O. D. Hunt
d9a77b3de2 docs: dev guide whitespace fix 
Add a blank line to the dev guide.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
 2018-03-27 17:55:25 +01:00
James O. D. Hunt
7111e03021 docs: Mention collect script in dev guide 
Add details of the collect script in under the "Troubleshoot" section.

Fixes #34.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
 2018-03-27 17:32:48 +01:00
James O. D. Hunt
2b40a280b5 docs: Embellish README 
Add some brief explanatory text and a few pointers.

Fixes #36.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
 2018-03-27 16:08:36 +01:00
Eric Ernst
33ade410f3 Merge pull request #27 from bergwolf/api-design 
design: add api design doc
 2018-03-27 07:06:25 -07:00
Peng Tao
fa9a5b8d9e design: add api design doc 
To fulfill the kata design requirements, and based on the disscusion on
Virtcontainers API extentions, runtime API early sketch and runtime API
comparison, this commit added the high level design of the kata runtime
library API.

fixes: #26

Signed-off-by: Peng Tao <bergwolf@gmail.com>
 2018-03-24 11:30:35 +08:00
Eric Ernst
893d9d1bb1 Merge pull request #30 from jodh-intel/add-dev-guide 
docs: Add developer guide
 2018-03-21 09:59:40 -07:00
James O. D. Hunt
2ab1a3f260 docs: Add developer guide 
Move the developer guide from the wiki "in-tree".

Fixes #29.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
 2018-03-21 16:57:51 +00:00
Sebastien Boeuf
f43d4f665c Merge pull request #17 from egernst/reqts 
requirements: add initial document
 2018-03-09 10:02:28 -08:00
Eric Ernst
3839bf4e71 requirements: add initial document 
Adding initial kata requirements list, based off of discussion from
kata-containers/runtime issue #31.

Fixes: #18

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
 2018-03-08 13:01:26 -08:00
Eric Ernst
3bb70f65a9 Merge pull request #14 from gnawux/desgin 
create directory for design documents
 2018-03-06 14:57:31 -08:00
Eric Ernst
fc28cdc28d Merge pull request #12 from jodh-intel/add-coc-doc 
docs: Add code of conduct doc
 2018-02-27 08:34:37 -08:00
Wang Xu
fd579088db create directory for design documents 
Fixes #13

Signed-off-by: Wang Xu <gnawux@gmail.com>
 2018-02-26 18:24:55 +08:00
James O. D. Hunt
c08294fa0d docs: Add code of conduct doc 
Add the standard code of conduct document.

Fixes #11.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
 2018-02-06 10:39:00 +00:00
James O. D. Hunt
7f53e41fd8 Merge pull request #5 from jodh-intel/docs-require-doc-team-signoff 
CI: Require doc team signoff for doc changes
 2018-02-02 07:11:40 +00:00
James O. D. Hunt
645b4cf64d Merge pull request #9 from ydjainopensource/minimalContributing 
Docs : Add minimal contribution guidelines
 2018-01-30 17:38:53 +00:00
Yash Jain
48048056da cs : Add minimal contribution guidelines 
Fixes : #8

See : kata-containers/community#5

Signed-off-by: Yash Jain <ydjainopensource@gmail.com>
 2018-01-30 22:14:52 +05:30