Commit Graph

65 Commits

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