moby/api/types
Kir Kolyshkin 7120976d74 Implement none, private, and shareable ipc modes
Since the commit d88fe447df ("Add support for sharing /dev/shm/ and
/dev/mqueue between containers") container's /dev/shm is mounted on the
host first, then bind-mounted inside the container. This is done that
way in order to be able to share this container's IPC namespace
(and the /dev/shm mount point) with another container.

Unfortunately, this functionality breaks container checkpoint/restore
(even if IPC is not shared). Since /dev/shm is an external mount, its
contents is not saved by `criu checkpoint`, and so upon restore any
application that tries to access data under /dev/shm is severily
disappointed (which usually results in a fatal crash).

This commit solves the issue by introducing new IPC modes for containers
(in addition to 'host' and 'container:ID'). The new modes are:

 - 'shareable':	enables sharing this container's IPC with others
		(this used to be the implicit default);

 - 'private':	disables sharing this container's IPC.

In 'private' mode, container's /dev/shm is truly mounted inside the
container, without any bind-mounting from the host, which solves the
issue.

While at it, let's also implement 'none' mode. The motivation, as
eloquently put by Justin Cormack, is:

> I wondered a while back about having a none shm mode, as currently it is
> not possible to have a totally unwriteable container as there is always
> a /dev/shm writeable mount. It is a bit of a niche case (and clearly
> should never be allowed to be daemon default) but it would be trivial to
> add now so maybe we should...

...so here's yet yet another mode:

 - 'none':	no /dev/shm mount inside the container (though it still
		has its own private IPC namespace).

Now, to ultimately solve the abovementioned checkpoint/restore issue, we'd
need to make 'private' the default mode, but unfortunately it breaks the
backward compatibility. So, let's make the default container IPC mode
per-daemon configurable (with the built-in default set to 'shareable'
for now). The default can be changed either via a daemon CLI option
(--default-shm-mode) or a daemon.json configuration file parameter
of the same name.

Note one can only set either 'shareable' or 'private' IPC modes as a
daemon default (i.e. in this context 'host', 'container', or 'none'
do not make much sense).

Some other changes this patch introduces are:

1. A mount for /dev/shm is added to default OCI Linux spec.

2. IpcMode.Valid() is simplified to remove duplicated code that parsed
   'container:ID' form. Note the old version used to check that ID does
   not contain a semicolon -- this is no longer the case (tests are
   modified accordingly). The motivation is we should either do a
   proper check for container ID validity, or don't check it at all
   (since it is checked in other places anyway). I chose the latter.

3. IpcMode.Container() is modified to not return container ID if the
   mode value does not start with "container:", unifying the check to
   be the same as in IpcMode.IsContainer().

3. IPC mode unit tests (runconfig/hostconfig_test.go) are modified
   to add checks for newly added values.

[v2: addressed review at https://github.com/moby/moby/pull/34087#pullrequestreview-51345997]
[v3: addressed review at https://github.com/moby/moby/pull/34087#pullrequestreview-53902833]
[v4: addressed the case of upgrading from older daemon, in this case
     container.HostConfig.IpcMode is unset and this is valid]
[v5: document old and new IpcMode values in api/swagger.yaml]
[v6: add the 'none' mode, changelog entry to docs/api/version-history.md]

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
2017-08-14 10:50:39 +03:00
..
backend Avoid using a map for log attributes 2017-07-18 19:01:20 -07:00
blkiodev Add engine-api types to docker 2016-09-07 11:05:58 -07:00
container Implement none, private, and shareable ipc modes 2017-08-14 10:50:39 +03:00
events make engine support cluster config event 2017-07-11 17:21:15 +08:00
filters Spelling fixes 2017-07-03 13:13:09 -07:00
image Set expected response headers for Ping. 2017-01-03 11:47:47 -05:00
mount Windows: Add named pipe mount support 2017-08-07 11:34:36 -07:00
network Adding network specific options to service create/update 2017-05-17 18:46:34 -07:00
plugins/logdriver Implement plugins for logging drivers 2017-04-10 13:17:20 -04:00
registry Merge pull request #33237 from aaronlehmann/oci-types 2017-05-17 02:40:11 +02:00
strslice Add engine-api types to docker 2016-09-07 11:05:58 -07:00
swarm Add API documentation for plugable secret backends 2017-07-28 00:00:53 +02:00
time fix typo in api/types/time/timestamp.go 2017-01-14 14:16:03 +08:00
versions Merge pull request #28651 from YuPengZTE/devMD002 2016-11-22 13:11:37 +01:00
volume hack/swagger-gen.sh is not exist, it should be /hack/generate-swagger-api.sh 2016-11-22 16:32:32 +08:00
auth.go Add engine-api types to docker 2016-09-07 11:05:58 -07:00
client.go Add long-running client session endpoint 2017-06-22 11:22:41 -07:00
configs.go LCOW: Builder plumbing 2017-06-20 19:49:53 -07:00
error_response.go Update to inline comments. 2016-10-31 11:13:41 -04:00
graph_driver_data.go Generate GraphDriver from spec, and fix up image spec. 2017-01-03 11:47:47 -05:00
id_response.go Add an IDResponse type 2016-10-31 11:16:02 -04:00
image_delete_response_item.go Generate ImageDeleteResponse from swagger spec. 2017-01-03 11:47:47 -05:00
image_summary.go Generate api/types:Image from the swagger spec 2016-10-20 13:24:23 -07:00
plugin.go Update API plugin response examples 2017-07-27 18:43:13 +02:00
plugin_device.go Generate plugin types from the swagger spec. 2016-10-20 13:24:23 -07:00
plugin_env.go Generate plugin types from the swagger spec. 2016-10-20 13:24:23 -07:00
plugin_interface_type.go Generate plugin types from the swagger spec. 2016-10-20 13:24:23 -07:00
plugin_mount.go Generate plugin types from the swagger spec. 2016-10-20 13:24:23 -07:00
plugin_responses.go Remove unused constants in plugin_responses 2017-07-25 17:07:04 +02:00
port.go Generate api/types:Port from swagger spec. 2016-10-20 13:24:23 -07:00
seccomp.go change minor mistake of spelling 2016-12-20 21:05:19 +08:00
service_update_response.go Return warnings from service create and service update when digest pinning fails 2016-11-18 09:31:31 -08:00
stats.go Correct CPU usage calculation in presence of offline CPUs and newer Linux 2017-03-10 10:24:33 +00:00
types.go Added support for Generic Resources 2017-07-24 17:49:56 -07:00
volume.go Merge pull request #34186 from thaJeztah/api-update-example-data 2017-07-20 09:38:28 +02:00