From bd2940861c282dfc39309bca94378c820ab7df7e Mon Sep 17 00:00:00 2001 From: Ian Lewis Date: Tue, 15 Jan 2019 16:41:01 +0900 Subject: [PATCH] End to end tests refs #3 (#10) * Separate docs for containerd 1.1 and 1.2 The configuration for the untrusted workload annotation and runtime class are different enough that it makes sense to separate the docs. Commands in docs are taken from scripts in the docs/scripts directory. These scripts can be used later for integration & doc tests (#3). The docs can be updated using the embedmd tool: https://github.com/campoy/embedmd * Add basic e2e tests refs #3 Added end-to-end tests based on the quickstart workflows for containerd 1.1 and containerd 1.2+. --- .travis.yml | 26 +++ README.md | 121 +------------- docs/README.md | 6 + docs/runtime-handler-quickstart.md | 214 ++++++++++++++++++++++++ docs/untrusted-workload-quickstart.md | 220 +++++++++++++++++++++++++ test/e2e/containerd-install.sh | 38 +++++ test/e2e/crictl-install.sh | 17 ++ test/e2e/run-container.sh | 30 ++++ test/e2e/runsc-install.sh | 8 + test/e2e/runtime-handler/install.sh | 24 +++ test/e2e/runtime-handler/test.sh | 33 ++++ test/e2e/runtime-handler/usage.sh | 30 ++++ test/e2e/shim-install.sh | 30 ++++ test/e2e/untrusted-workload/install.sh | 24 +++ test/e2e/untrusted-workload/test.sh | 33 ++++ test/e2e/untrusted-workload/usage.sh | 33 ++++ test/e2e/validate.sh | 17 ++ 17 files changed, 791 insertions(+), 113 deletions(-) create mode 100644 .travis.yml create mode 100644 docs/README.md create mode 100644 docs/runtime-handler-quickstart.md create mode 100644 docs/untrusted-workload-quickstart.md create mode 100755 test/e2e/containerd-install.sh create mode 100755 test/e2e/crictl-install.sh create mode 100755 test/e2e/run-container.sh create mode 100755 test/e2e/runsc-install.sh create mode 100755 test/e2e/runtime-handler/install.sh create mode 100755 test/e2e/runtime-handler/test.sh create mode 100755 test/e2e/runtime-handler/usage.sh create mode 100755 test/e2e/shim-install.sh create mode 100755 test/e2e/untrusted-workload/install.sh create mode 100755 test/e2e/untrusted-workload/test.sh create mode 100755 test/e2e/untrusted-workload/usage.sh create mode 100755 test/e2e/validate.sh diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..4aaccf523 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,26 @@ +dist: trusty +sudo: required +language: go +go: "1.11.x" + +env: + - CONTAINERD_VERSION=1.1.5 RUNSC_VERSION=2018-12-07 TEST=untrusted-workload + - CONTAINERD_VERSION=1.2.1 RUNSC_VERSION=2018-12-07 TEST=untrusted-workload + - CONTAINERD_VERSION=1.2.1 RUNSC_VERSION=2018-12-07 TEST=runtime-handler + + +go_import_path: github.com/google/gvisor-containerd-shim + +addons: + apt: + packages: + - socat + - conntrack + - ipset + +before_install: + - uname -r + - sudo apt-get -q update + - sudo apt-get install -y libseccomp-dev/trusty-backports + +script: ./test/e2e/${TEST}/test.sh diff --git a/README.md b/README.md index d3b10fe07..cabd715d7 100644 --- a/README.md +++ b/README.md @@ -1,125 +1,20 @@ # gvisor-containerd-shim +[![Build Status](https://travis-ci.org/google/gvisor-containerd-shim.svg?branch=master)](https://travis-ci.org/google/gvisor-containerd-shim) +[![Go Report Card](https://goreportcard.com/badge/github.com/google/gvisor-containerd-shim)](https://goreportcard.com/report/github.com/google/gvisor-containerd-shim) + gvisor-containerd-shim is a containerd shim for [gVisor](https://github.com/google/gvisor/). It implements the containerd v1 shim API. It can be used as a drop-in replacement for [containerd-shim](https://github.com/containerd/containerd/tree/master/cmd/containerd-shim) (though containerd-shim must still be installed). It allows the use of both gVisor (runsc) and normal containers in the same containerd installation by deferring to the runc shim if the desired runtime engine is not runsc. ## Requirements -- gvisor (runsc) >= a2ad8fe +- gvisor (runsc) >= 2018-12-07 - containerd, containerd-shim >= 1.1 ## Installation -1. Download the latest release of the gvisor-containerd-shim and unpack the binary to the desired directory: +- [Untrusted Workload Quick Start (containerd >=1.1)](docs/untrusted-workload-quickstart.md) +- [Runtime Handler Quick Start (containerd >=1.2)](docs/runtime-handler-quickstart.md) -``` -$ tar xf gvisor-containerd-shim.tar.gz -$ mv gvisor-containerd-shim /usr/local/bin -``` +# Contributing -2. Create the configuration for the gvisor shim in `/etc/containerd/gvisor-containerd-shim.yaml`: - -``` -# This is the path to the default runc containerd-shim. -runc_shim = "/path/to/containerd-shim" -``` - -3. Update `/etc/containerd/config.toml`. Be sure to update the path to `gvisor-containerd-shim` and `runsc` if necessary: - -``` -disabled_plugins = ["restart"] -[plugins.linux] - shim = "/usr/local/bin/gvisor-containerd-shim" - shim_debug = true -# Uncomment the following 2 lines if you want runsc to be the default runtime. -# runtime = "/usr/local/bin/runsc" -# runtime_root = "/run/containerd/runsc" -# To support the untrusted-workload annotation. -[plugins.cri.containerd.untrusted_workload_runtime] - runtime_type = "io.containerd.runtime.v1.linux" - runtime_engine = "/usr/local/bin/runsc" - runtime_root = "/run/containerd/runsc" -[plugins.cri.containerd.runtimes.runsc] - runtime_type = "io.containerd.runtime.v1.linux" - runtime_engine = "/usr/local/bin/runsc" - runtime_root = "/run/containerd/runsc" -``` - -4. Restart `containerd` - -## Usage - -### CRI - -You can run containers in gVisor via containerd's CRI. - -1. Build and install crictl from HEAD: - -``` -$ go get github.com/kubernetes-sigs/cri-tools/cmd/crictl -$ sudo sh -c 'echo "runtime-endpoint: unix:///run/containerd/containerd.sock" > /etc/crictl.yaml' -``` - -2. Pull the busybox image - -``` -$ sudo crictl pull busybox -``` - -### Containerd 1.1 - -If running containerd 1.1 you will need to invoke `runsc` via the `io.kubernetes.cri.untrusted-workload` annotation. - -1. Create a pod config: - -``` -$ cat > sandbox.json << EOL -{ - "metadata": { - "name": "nginx-sandbox", - "namespace": "default", - "attempt": 1, - "uid": "hdishd83djaidwnduwk28bcsb" - }, - "annotations": { - "io.kubernetes.cri.untrusted-workload": "true" - }, - "linux": { - }, - "log_directory": "/tmp" -} -EOL -``` - -2. Run a sandbox with the `runsc` runtime. - -``` -$ sudo crictl runp sandbox.json -``` - -### Containerd 1.2 - -If running containerd 1.2 you can specify runsc as the runtime using the new runtime handler. - -1. Create a pod config: - -``` -$ cat > sandbox.json << EOL -{ - "metadata": { - "name": "nginx-sandbox", - "namespace": "default", - "attempt": 1, - "uid": "hdishd83djaidwnduwk28bcsb" - }, - "linux": { - }, - "log_directory": "/tmp" -} -EOL -``` - -2. Run a sandbox with the `runsc` runtime. - -``` -$ sudo crictl runp --runtime=runsc sandbox.json -``` +See [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..a0915e32c --- /dev/null +++ b/docs/README.md @@ -0,0 +1,6 @@ +# gvisor-containerd-shim docs + +Everything you need to know about gvisor-containerd-shim + +- [Untrusted Workload Quick Start (containerd >=1.1)](untrusted-workload-quickstart.md) +- [Runtime Handler Quick Start (containerd >=1.2)](runtime-handler-quickstart.md) diff --git a/docs/runtime-handler-quickstart.md b/docs/runtime-handler-quickstart.md new file mode 100644 index 000000000..d97b99034 --- /dev/null +++ b/docs/runtime-handler-quickstart.md @@ -0,0 +1,214 @@ +# Runtime Handler Quickstart + +This document describes how to install and run the `gvisor-containerd-shim` +using the containerd runtime handler support. This requires containerd 1.2 or +later. + +## Requirements + +- **runsc**: See the [gVisor documentation](https://github.com/google/gvisor) for information on how to install runsc. +- **containerd**: See the [containerd website](https://containerd.io/) for information on how to install containerd. + +## Install + +### Install gvisor-containerd-shim + +1. Download the latest release of the `gvisor-containerd-shim`. See the + [releases page](https://github.com/google/gvisor-containerd-shim/releases) + +[embedmd]:# (../test/e2e/shim-install.sh shell /{ # Step 1/ /^}/) +```shell +{ # Step 1: Download gvisor-containerd-shim +LATEST_RELEASE=$(wget -qO - https://api.github.com/repos/google/gvisor-containerd-shim/releases | grep -oP '(?<="browser_download_url": ")https://[^"]*' | head -1) +wget -O gvisor-containerd-shim +chmod +x gvisor-containerd-shim +} +``` + +2. Copy the binary to the desired directory: + +[embedmd]:# (../test/e2e/shim-install.sh shell /{ # Step 2/ /^}/) +```shell +{ # Step 2: Copy the binary to the desired directory +sudo mv gvisor-containerd-shim-* /usr/local/bin/gvisor-containerd-shim +} +``` + +3. Create the configuration for the gvisor shim in + `/etc/containerd/gvisor-containerd-shim.yaml`: + +[embedmd]:# (../test/e2e/shim-install.sh shell /{ # Step 3/ /^}/) +```shell +{ # Step 3: Create the gvisor-containerd-shim.yaml +cat < /tmp/containerd-cri.log & + diff --git a/test/e2e/crictl-install.sh b/test/e2e/crictl-install.sh new file mode 100755 index 000000000..1d63c889b --- /dev/null +++ b/test/e2e/crictl-install.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +# A sample script for installing crictl. + +set -ex + +{ # Step 1: Download crictl +wget https://github.com/kubernetes-sigs/cri-tools/releases/download/v1.13.0/crictl-v1.13.0-linux-amd64.tar.gz +tar xf crictl-v1.13.0-linux-amd64.tar.gz +sudo mv crictl /usr/local/bin +} + +{ # Step 2: Configure crictl +cat < /tmp/containerd-cri.log & +} diff --git a/test/e2e/runtime-handler/test.sh b/test/e2e/runtime-handler/test.sh new file mode 100755 index 000000000..99f3565b6 --- /dev/null +++ b/test/e2e/runtime-handler/test.sh @@ -0,0 +1,33 @@ +#!/bin/bash + +# Runs end-to-end tests for gvisor-containerd-shim to test the use of runtime +# handler. This should work on containerd 1.2+ + +# This is meant to be run in a VM as it makes a fairly invasive install of +# containerd. + +set -ex + +# Install containerd +. ./test/e2e/containerd-install.sh + +# Install gVisor +. ./test/e2e/runsc-install.sh + +# Install gvisor-containerd-shim +. ./test/e2e/shim-install.sh + +# Test installation/configuration +. ./test/e2e/runtime-handler/install.sh + +# Install crictl +. ./test/e2e/crictl-install.sh + +# Test usage +. ./test/e2e/runtime-handler/usage.sh + +# Run a container in the sandbox +. ./test/e2e/run-container.sh + +# Validate the pod and container +. ./test/e2e/validate.sh diff --git a/test/e2e/runtime-handler/usage.sh b/test/e2e/runtime-handler/usage.sh new file mode 100755 index 000000000..1f8a09757 --- /dev/null +++ b/test/e2e/runtime-handler/usage.sh @@ -0,0 +1,30 @@ +#!/bin/bash + +# A sample script for testing the gvisor-containerd-shim # using untrusted +# workload extension. + +set -ex + +{ # Step 1: Pull the nginx image +sudo crictl pull nginx +} + +{ # Step 2: Create sandbox.json +cat < /tmp/containerd-cri.log & +} diff --git a/test/e2e/untrusted-workload/test.sh b/test/e2e/untrusted-workload/test.sh new file mode 100755 index 000000000..6e312cf6d --- /dev/null +++ b/test/e2e/untrusted-workload/test.sh @@ -0,0 +1,33 @@ +#!/bin/bash + +# Runs end-to-end tests for gvisor-containerd-shim to test using the +# untrusted workload extension. This should work on containerd 1.1+ + +# This is meant to be run in a VM as it makes a fairly invasive install of +# containerd. + +set -ex + +# Install containerd +. ./test/e2e/containerd-install.sh + +# Install gVisor +. ./test/e2e/runsc-install.sh + +# Install gvisor-containerd-shim +. ./test/e2e/shim-install.sh + +# Test installation/configuration +. ./test/e2e/untrusted-workload/install.sh + +# Install crictl +. ./test/e2e/crictl-install.sh + +# Test usage +. ./test/e2e/untrusted-workload/usage.sh + +# Run a container in the sandbox +. ./test/e2e/run-container.sh + +# Validate the pod and container +. ./test/e2e/validate.sh diff --git a/test/e2e/untrusted-workload/usage.sh b/test/e2e/untrusted-workload/usage.sh new file mode 100755 index 000000000..db8206964 --- /dev/null +++ b/test/e2e/untrusted-workload/usage.sh @@ -0,0 +1,33 @@ +#!/bin/bash + +# A sample script for testing the gvisor-containerd-shim # using untrusted +# workload extension. + +set -ex + +{ # Step 1: Pull the nginx image +sudo crictl pull nginx +} + +{ # Step 2: Create sandbox.json +cat <