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>
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>
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>
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>
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>
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>
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>
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>
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>
Require an additional approval from a `documentation` team member for
PRs containing documentation changes.
Fixes#4.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Require two approvals from documentation team members before a PR
can land.
The configuration file is the same as those used for the other repos,
except for the approval team name.
Fixes#2.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>