Commit Graph

30 Commits

Author SHA1 Message Date
nitkon
90c4d75c6c developer-guide: use the correct kernel config file name
kernel_arch was being set to amd64 instead of x86_64
on intel. The kernel config file name starts with
x86_64 and hence this needs to be fixed.

Fixes:  #158

Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>
2018-06-14 20:30:22 +05:30
Nitesh Konkar
a47e243e10 docs: Make "Install guest kernel images" arch-sensitive
Make "Install guest kernel images" in Developer-Guide
arch specific.

Fixes: #140

Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>
2018-06-12 16:15:09 +05:30
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
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
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
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
6ae6e1ee1e Merge pull request #66 from devimc/update/developer
developer-guide: update guest kernel image section
2018-05-17 07:12:38 +01: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
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