Go to file
James O. D. Hunt 2f07105e1f CI: Test remaining install methods
Add new CI tests to ensure that the following installation methods are
also tested:

- "Automatic" method ([`kata-manager`](https://github.com/kata-containers/tests/tree/master/cmd/kata-manager))
- "Scripted" method ([`kata-doc-to-script`](https://github.com/kata-containers/tests/blob/master/.ci/kata-doc-to-script.sh))

**Note:** the "Automatic" method is **not** the same as the existing
`kata-manager` test: the existing test executes the "Manual"
installation method (which runs `kata-manager` to execute the
appropriate distro-specific install guide). However, this new test
executes the `install/installing-with-kata-manager.md` document, which
subsequently calls the `kata-manager` script.

Since the "Automatic" and "Scripted" installation methods are designed
to run "standalone" (without requiring any local git repo clones), the
script which runs these new tests has to take care to ensure the
environment they run in is clean. It does this by using the following
approach:

- Removes any local Kata github repos from the standard `GOPATH`
  locations (to ensure the scripts do not inadvertently access local
  files) [1].
- Creates a temporary directory containing:
  - A copy of *itself*.
  - The scripts it generated from the "Automatic" and "Scripted" installation documents.
- Re-exec's itself to run the version in the temporary directory,
  passing an option that tells itself to simply execute the scripts in
  the specified directory.
- It then runs the scripts in the directory specified.

---

[1] - Since the recursive delete of all local Kata github repos is
potentially dangerous, the test will immediately fail if the standard
`KATA_DEV_MODE` variable is set (since this denotes a developer system)
and will also fail unless the standard `CI` variable is set (denoting
the script is running in a Continuous Integration environment, such as
JenkinsCI.

Fixes #278.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-10-25 16:28:22 +01:00
.ci CI: Test remaining install methods 2018-10-25 16:28:22 +01:00
arch-images uml: add txt source of network hotplug uml 2018-09-25 15:24:14 +08:00
constraints constraints: document CPU constraints 2018-06-04 09:51:19 -05:00
design api: update kata api design doc 2018-09-25 15:24:14 +08:00
how-to docs: Add a quickstart about Kata Containers and NEMU 2018-10-11 10:58:04 -07:00
install docs: Add instructions to run the kata-doc-to-script generated scripts 2018-10-25 16:28:19 +01:00
svc-mesh docs: svc-mesh: Create some documentation about service mesh 2018-06-22 15:41:01 -07:00
use-cases use-cases: Add documentation for using Intel GPU with Kata 2018-10-08 10:20:24 -07:00
zun Zun: Move to subdir and add to README 2018-06-12 10:36:45 +01:00
.pullapprove.yml CI: Require doc team signoff for doc changes 2018-01-24 13:42:26 +00:00
.travis.yml CI: Pin Travis golang version 2018-10-23 17:25:20 +01:00
architecture.md architecture.md: add network hotplug diagram 2018-09-25 15:24:14 +08:00
CODE_OF_CONDUCT.md docs: Add code of conduct doc 2018-02-06 10:39:00 +00:00
CONTRIBUTING.md cs : Add minimal contribution guidelines 2018-01-30 22:14:52 +05:30
Developer-Guide.md Developer-Guide: Update kernel installation doc 2018-10-14 16:15:33 +05:30
Documentation-Requirements.md Merge pull request #188 from jodh-intel/doc-reqs-filenames 2018-07-23 14:59:11 -07:00
LICENSE Initial commit 2017-12-21 13:41:45 +00:00
Licensing-strategy.md docs: Add license strategy doc 2018-04-19 17:40:03 +01:00
Limitations.md Limitations: add selinux support limitation 2018-10-01 16:31:39 +01:00
Makefile CI: Pin Travis golang version 2018-10-23 17:25:20 +01:00
README.md README.md: update the README of the documentation repo 2018-09-12 16:41:47 +08:00
Release-Checklist.md checklist: add snap packages to the release checklist 2018-09-28 09:32:26 -05:00
Releases.md docs: Fix release checklist link in releases doc 2018-05-14 16:27:43 +01:00
Stable-Branch-Strategy.md stable: initial stable-branching documentation 2018-09-18 07:25:10 -07:00
Upgrading.md docs: Remove throttler in upgrading doc 2018-06-05 17:21:03 +08:00
VSocks.md usecases: add vsock documentation 2018-08-22 09:27:19 -05:00

Documentation

The Kata Containers documentation repository hosts overall system documentation, with information common to multiple components.

For details of the other Kata Containers repositories, see the repository summary.

Getting Started

More User Guides

Developer Guide

Documents that help to understand and contribute to Kata Containers.

Design and Implementations

How to Contribute

Code Licensing

  • Licensing: About the licensing strategy of Kata Containers.

The Release Process

Help Improving the Documents