Commit Graph

434 Commits

Author SHA1 Message Date
Nitesh Konkar
25dfe4ad69 architecture.md: Bump Kata Version to 1.2.0, add pseries info.
Since there have not been any major architecture changes
in Kata Containers since 1.0 release, bump version to latest
1.2.0 release. Also, add another supported machine type
"pseries" for IBM Power Systems. A typo is also fixed in this
commit.

Fixes #210

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2018-08-13 15:07:36 +05:30
Gabriela Cervantes
2341d753e2 docs: Add installation guide for SLES
This will add the installation guide for SLES.

Fixes #85

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-08-13 02:14:52 -05:00
James O. D. Hunt
6c81e212db
Merge pull request #208 from nitkon/master
Dev-guide: Kernel build fails on ppc64le
2018-08-08 15:43:29 +01:00
Nitesh Konkar
fb6ed6961a Dev-guide: Kernel build fails on ppc64le
The kernel config file name prefix changed from
ppc64le to powerpc. This change broke the kernel
build on ppc64le. Fix the kernel build steps
accordingly.

Fixes: #207

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2018-08-07 17:55:41 +05:30
James O. D. Hunt
b1c3c58def
Merge pull request #203 from grahamwhaley/20180728_debug_console
Fix debug console socket docs
2018-08-02 13:59:07 +01:00
James O. D. Hunt
47a0d6affc
Merge pull request #205 from jodh-intel/add-initcall-debug-to-debug-info
docs: Add initcall_debug to dev guide debug section
2018-08-02 10:05:02 +01:00
James O. D. Hunt
c270496937 docs: Add initcall_debug to dev guide debug section
https://github.com/kata-containers/runtime/pull/527 Removed the
hard-coded `initcall_debug` kernel option (as it generates a lot of
kernel output at boot).

Add the `initcall_debug` option to the "Enable full debug" section to
allow users to enable these potentially useful messages when debugging.

Fixes #204.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-07-30 15:34:52 +01:00
James O. D. Hunt
7897760a1c
Merge pull request #200 from jodh-intel/dev-guide-add-standalone-details
docs: Add standalone details to dev guide
2018-07-30 14:24:58 +01:00
James O. D. Hunt
b9c2598a63 docs: Add standalone details to dev guide
Explain how to create an OCI bundle and launch the runtime directly.

Fixes #199.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-07-30 10:17:11 +01:00
Graham Whaley
0b63ec0b1e Dev: debug console: minor grammatical cleanups
Minor rewords, that read better to my eyes.

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2018-07-28 10:27:29 +01:00
Graham Whaley
e90eabd454 Dev: console socket: Update the path to the socket
The debug console socket path looks to have moved from
the `sbs` dir to the `vm` dir. Update the docs to reflect
this.

Fixes: #202

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2018-07-28 10:20:13 +01:00
Eric Ernst
596bf31bdf
Merge pull request #195 from morph027/docker-daemon-json
docs: add kata-runtime to Docker daemon.json
2018-07-27 19:19:02 -07:00
morph027
6ef28deb96 docs: add kata-runtime to Docker daemon.json
Fixes: #484

Signed-off-by: Stefan Heitmüller <morphsen@gmx.com>
2018-07-27 12:20:20 +02:00
Archana Shinde
4793a80c0a
Merge pull request #198 from egernst/gcp
install: gce: show should be describe for image inspection
2018-07-25 11:12:44 -07:00
Eric Ernst
443d7d9160 install: gce: show should be describe for image inspection
s/show/describe

Fixes: #197

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-07-25 10:59:07 -07:00
Eric Ernst
12d2049579
Merge pull request #188 from jodh-intel/doc-reqs-filenames
docs: Requirements for filenames and commands
2018-07-23 14:59:11 -07:00
Eric Ernst
21b4e09ccc
Merge pull request #182 from grahamwhaley/20180629_journald_setup
Dev: Document journald limitations and workarounds
2018-07-23 14:58:33 -07:00
Eric Ernst
473c450c5e
Merge pull request #190 from jodh-intel/doc-reqs-images
docs: Document image requirements
2018-07-23 14:55:49 -07:00
Eric Ernst
c2024c9f87
Merge pull request #192 from scooley/kube-anchor
docs: update kube anchor in distro install guides
2018-07-11 13:59:22 -07:00
Sarah
748acc6683 docs: update kube anchor in distro install guides.
Fixes: #184

Signed-off-by: Sarah <scooley@microsoft.com>
2018-07-11 12:57:00 -07:00
Graham Whaley
2540bb9569 Dev: Document journald limitations and workarounds
Journald, by default on some systems, will rate limit log messages,
and in the case of our 'enable full debug', will likely drop some
of our debug.
Document how to identify if this is happening, and how to configure
`systemd-journald` appropriately.

Fixes: #181

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2018-07-09 10:52:53 +01:00
James O. D. Hunt
86cde89809 docs: Requirements for filenames and commands
Explain how to handle filenames and command names in documentation.

Fixes #187.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-07-06 09:35:55 +01:00
James O. D. Hunt
1344bc5f84 docs: Document image requirements
Update the documentation requirements on the topic of images.

Fixes #189.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-07-06 07:48:08 +01:00
James O. D. Hunt
0e966255d1
Merge pull request #174 from jodh-intel/gce-tweaks
GCE tweaks
2018-07-04 17:38:06 +01:00
James O. D. Hunt
c556f1853f
Merge pull request #186 from nitkon/master
dev-guide: Mention distro support for ppc64le for rootfs creation
2018-07-04 13:45:22 +01:00
Nitesh Konkar
26d747fba9 dev-guide: Add note for rootfs platform-distro matrix
Fixes: #185

Signed-off-by: Nitesh Konkar niteshkonkar@in.ibm.com
2018-07-04 17:45:15 +05:30
Sebastien Boeuf
e0c6702790
Merge pull request #172 from sboeuf/update_docs
docs: svc-mesh: Create some documentation about service mesh
2018-06-22 16:06:05 -07:00
Sebastien Boeuf
daac13b1d5 docs: svc-mesh: Create some documentation about service mesh
This commit introduces the instructions to be able to run trendy
service mesh Istio and Conduit with Kata Containers. It provides
a bit of feedback on how they actually work to give the reader a
quick overview. After this introduction, it provides restrictions
and instructions to enable them with Kata Containers.

Fixes #171

Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
2018-06-22 15:41:01 -07:00
GabyCT
2f2be68d1e
Merge pull request #180 from chavafg/topic/static-checks
CI: update static-checks.sh call
2018-06-22 15:47:20 -05:00
Salvador Fuentes
7adbfa935e CI: update static-checks.sh call
Now static-checks.sh needs to have the
repository name as arguments.

Fixes #179.

Signed-off-by: Salvador Fuentes <salvador.fuentes@intel.com>
2018-06-22 15:20:27 -05:00
James O. D. Hunt
bc6d9970f6
Merge pull request #164 from nitkon/patch-2
docs: Add relevant URLs and fix grammar
2018-06-22 10:31:41 +01:00
James O. D. Hunt
baf66c743d docs: Remove double "the" in README
Excised an extraneous definite article in the install README.

How did we miss this in the review phase I wonder?

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 15:22:24 +01:00
James O. D. Hunt
84e2622f94 docs: Add TOC to GCE guide
Add a table of contents to the Google Compute Engine install guide.

Fixes #173.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 15:22:24 +01:00
James O. D. Hunt
062fef460d docs: Add GCE install guide to install README
Add the new Google Compute Engine installation guide to the
installation README, reworking this doc to add in a table of contents
and a new "Cloud services" section.

Fixes #173.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 15:22:22 +01:00
James O. D. Hunt
f96f7ea2d3 docs: Use relative links in install README
Simplify the installation README by using relative URLs - let github
expand them automatically for readers.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 15:22:22 +01:00
James O. D. Hunt
b50b512872
Merge pull request #176 from jodh-intel/docker-rm-terminal-option
docs: Remove "-ti" from docker invocations
2018-06-21 15:21:43 +01:00
James O. D. Hunt
81c7f9ec01 docs: Remove "-ti" from docker invocations
The docker install guides end with a call to `docker run`. However, they
all specify `-ti` which is causing our CI to fail.

Remove the `-ti` so that the command works both under the CI and as
expected for the user.

Fixes #175.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 14:44:21 +01:00
James O. D. Hunt
9e09f54e7c CI: Make install guide check less specific
Simplify the CI check that looks for modified install guides to catch
any modified document below `install/`.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-21 14:44:20 +01:00
Nitesh Konkar
62800fa271 docs: Add relevant URLs and fix grammar
Fixes:  #163

Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>
2018-06-21 17:59:14 +05:30
James O. D. Hunt
b67e3c3e01
Merge pull request #154 from jon/master
docs: Add GCE installation guide.
2018-06-21 10:02:29 +01:00
James O. D. Hunt
8f6e20d43d
Merge pull request #52 from kata-containers/sriov-use-case
sriov: Add instructions on using SR-IOV with Kata
2018-06-20 17:42:28 +01:00
Archana Shinde
4c9bee580a sriov: Add instructions on using SR-IOV with Kata
Add instructions for using SR-IOV enabled nic with Kata.

Fixes #168

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2018-06-20 09:21:53 -07:00
Jon Olson
04dfaece9b docs: Add GCE installation guide.
This covers the GCP portion of #130.

Introduces a guide to configuring a VM image with nested virtualization. The
primary focus of the guide is the set of commands required for creating and
managing nested VMX GCE images. For Kata installation itself the guide defers
to the distribution-specific Kata documentation for actually installing Kata.
The upside is that it needn't be updated every time the instructions for a
given distribution change. The downside is that it is not a standalone
artifact.

Fixes: #155.

Signed-off-by: Jon Olson <jonolson@google.com>
2018-06-19 10:42:07 -07:00
Graham Whaley
bf68be0c05
Merge pull request #159 from nitkon/patch-1
developer-guide: use the correct kernel config file name
2018-06-15 13:53:19 +01:00
James O. D. Hunt
0de5e4741c
Merge pull request #153 from GabyCT/topic/addrhel
docs: Add RHEL installation guide.
2018-06-15 08:41:48 +01:00
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
Gabriela Cervantes
8bc69ec8cf docs: Add RHEL installation guide.
This will add the RHEL installation guide for the OBS packages for
kata runtime.

Fixes #86

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2018-06-14 05:40:11 -05:00
James O. D. Hunt
a0a0a7b4ac
Merge pull request #145 from jodh-intel/install-guides-move-docker
docs: Split docker install into separate docs
2018-06-13 10:50:29 +01:00
James O. D. Hunt
ce077f0b96 docs: Split docker install into separate docs
The install guides assumed that users wanted to install Docker. Since
there are other container managers, split the Docker-specific
instructions into separate documents (with backlinks) and allow the
user to choose between Docker or Kubernetes from the install guides.

Fixes #144.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-13 10:47:30 +01:00
James O. D. Hunt
967f03aa01 docs: Properly format distro names
Ensure the first mention of all the distro names in the install guides:

- Have the required asterisk after the name.
- Have a link to the website.

Also folded the overly long lines.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-13 10:47:30 +01:00