Add containerd shim v2 support. by Random-Liu · Pull Request #13 · google/gvisor-containerd-shim

Random-Liu · 2019-01-28T20:05:13Z

For #1.

The shim v2 binary name is containerd-shim-runsc-v1.

Containerd 1.2

To use containerd-shim-runsc-v1:

[plugins.cri.containerd.runtimes.runsc]
  runtime_type = "io.containerd.runsc.v1"

A config.toml can be put in the runtime root (/run/containerd/runsc by default) to set runtime-handler specific options for containerd-shim-runsc-v1.
An example of /run/containerd/runsc/config.toml:

[runsc_config]
  debug = "true"
  debug-log = "/tmp/runsc-logs/runsc.log.%ID%.%TIMESTAMP%.%COMMAND%"
  user-log = "/tmp/runsc-logs/runsc.log.%ID%.user"

Containerd 1.3+

The containerd config to use containrd-shim-runsc-v1 is the same with containerd 1.2.

Containerd 1.3+ explicitly added config file support to configure runtime-handler specific options:

[plugins.cri.containerd.runtimes.runsc.options]
  TypeUrl = "io.containerd.runsc.v1.options"
  ConfigPath = "/somewhere/config.toml"

I'll send a follow-up PR to update the document.

Signed-off-by: Lantao Liu <lantaol@google.com>

Random-Liu · 2019-01-28T22:16:02Z

Please note that this PR also ported the fixes containerd/containerd@18f57e2#diff-2775e018eedd9942bc5c2c3c7f9039a8 and containerd/containerd@18f57e2#diff-2775e018eedd9942bc5c2c3c7f9039a8.

Signed-off-by: Lantao Liu <lantaol@google.com>

ianlewis

LGTM
Please address comments as best as possible before merging

ianlewis · 2019-01-29T03:53:38Z

docs/runtime-handler-shim-v2-quickstart.md

@@ -0,0 +1,187 @@
+# Runtime Handler Quickstart (Shim V2)
+
+This document describes how to install and run the `containerd-shim-runsc-v1`


This document describes how to install and run containerd-shim-runsc-v1

ianlewis · 2019-01-29T03:55:03Z

docs/runtime-handler-shim-v2-quickstart.md

+
+[embedmd]:# (../test/e2e/shim-install.sh shell /{ # Step 1\(dev\)/ /^}/)
+```shell
+{ # Step 1(dev): Build and install gvisor-containerd-shim and containerd-shim-runsc-v1


Should we make this use a release when we have it available?

Yeah, added a TODO.

ianlewis · 2019-01-29T04:07:36Z

pkg/v2/service.go

+	}
+	cmd := exec.Command(self, args...)
+	cmd.Dir = cwd
+	cmd.Env = append(os.Environ(), "GOMAXPROCS=2")


This should have a comment as to why it's here.

This is from the containerd-shim, and this is to minimize the resource usage of the shim.

I want to avoid unnecessary diff with upstream containerd-shim :)

ianlewis · 2019-01-29T04:14:11Z

pkg/v2/service.go

+		default:
+			return nil, errors.Errorf("unsupported option type")
+		}
+		if path != "" {


Where are you setting the default path to the shim config?

The default is empty string, means no special config.

The description says it's /run/containerd/runsc but I missed where this was being set.

Is the config.toml that gets set there per container or per sandbox?

ianlewis · 2019-01-29T04:18:36Z

pkg/v2/service.go

+}
+
+func (s *service) Stats(ctx context.Context, r *taskAPI.StatsRequest) (*taskAPI.StatsResponse, error) {
+	// TODO(random-liu): Use `runsc events --stats`.


Let's have an issue for this in gVisor (I believe it's not supported per container yet)

ianlewis · 2019-01-29T04:26:44Z

test/e2e/shim-install.sh

@@ -6,22 +6,20 @@ set -ex

 # Build gvisor-containerd-shim
 if [ "${INSTALL_LATEST}" === "1" ]; then


This should just be a == I think. Currently it shows an error in travis

if [ "${INSTALL_LATEST}" == "1" ]; then

ianlewis · 2019-01-29T04:29:38Z

test/e2e/shim-install.sh

 }
 else
+{ # Step 1(dev): Build and install gvisor-containerd-shim and containerd-shim-runsc-v1
    make


Is there a good way to check as part of the test that it's actually using the v2 shim as opposed to the v1 without just trusting that the config.toml is correct?

Maybe just something like this?

ps aux | grep containerd-shim-runsc-v1

Not sure it needs to be in the quick start, but it would be nice to have as part of the test script.

Random-Liu · 2019-01-30T02:51:08Z

Merging based on #13 (review).

Update vendors

9bb537a

Signed-off-by: Lantao Liu <lantaol@google.com>

Random-Liu requested a review from ianlewis as a code owner January 28, 2019 20:05

Random-Liu assigned ianlewis Jan 28, 2019

Random-Liu force-pushed the support-shim-v2-api branch from ce31f39 to 37e687c Compare January 28, 2019 21:50

Add containerd shim v2 support.

935512f

Signed-off-by: Lantao Liu <lantaol@google.com>

Random-Liu force-pushed the support-shim-v2-api branch from 37e687c to 41a8b59 Compare January 28, 2019 22:15

Random-Liu mentioned this pull request Jan 28, 2019

Update to containerd 1.2.2 #14

Merged

Random-Liu force-pushed the support-shim-v2-api branch 6 times, most recently from 8a8b7c7 to 09ea670 Compare January 28, 2019 23:29

Add test and doc for containerd-shim-runsc-v1.

5ccc68b

Signed-off-by: Lantao Liu <lantaol@google.com>

Random-Liu force-pushed the support-shim-v2-api branch from 09ea670 to 5ccc68b Compare January 29, 2019 02:41

ianlewis approved these changes Jan 29, 2019

View reviewed changes

Address comments.

0c2031f

Random-Liu merged commit 35db607 into google:master Jan 30, 2019

Random-Liu deleted the support-shim-v2-api branch January 30, 2019 02:51

Random-Liu mentioned this pull request Feb 26, 2019

Add containerd shim v2 api implementation #1

Closed

cmichelQT mentioned this pull request Feb 27, 2020

Unable to configure runtime options for gvisor-containerd-shim #49

Open

thaJeztah mentioned this pull request Apr 2, 2021

sys: refactor OOM utilities containerd/containerd#5253

Merged

		@@ -0,0 +1,187 @@
		# Runtime Handler Quickstart (Shim V2)

		This document describes how to install and run the `containerd-shim-runsc-v1`

		@@ -6,22 +6,20 @@ set -ex

		# Build gvisor-containerd-shim
		if [ "${INSTALL_LATEST}" === "1" ]; then

Conversation

Random-Liu commented Jan 28, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Containerd 1.2

Containerd 1.3+

Uh oh!

Random-Liu commented Jan 28, 2019

Uh oh!

ianlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Random-Liu commented Jan 30, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Random-Liu commented Jan 28, 2019 •

edited

Loading