From c1713e7c5a8f2eee7d78b17eef81b0d4203aabdd Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Wed, 30 Sep 2015 13:12:41 -0400 Subject: [PATCH] Documentation for filtering events by label Signed-off-by: Daniel Nephin --- docs/reference/api/docker_remote_api.md | 4 +--- docs/reference/api/docker_remote_api_v1.21.md | 7 ++++--- docs/reference/commandline/events.md | 8 ++++---- 3 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/reference/api/docker_remote_api.md b/docs/reference/api/docker_remote_api.md index 0315ba92fd..e7888bcb99 100644 --- a/docs/reference/api/docker_remote_api.md +++ b/docs/reference/api/docker_remote_api.md @@ -88,6 +88,7 @@ This section lists each version from latest to oldest. Each listing includes a list of DNS options to be used in the container. * `POST /build` now optionally takes a serialized map of build-time variables. * `GET /events` now includes a `timenano` field, in addition to the existing `time` field. +* `GET /events` now supports filtering by image and container labels. * `GET /info` now lists engine version information. * `GET /containers/json` will return `ImageID` of the image used by container. * `POST /exec/(name)/start` will now return an HTTP 409 when the container is either stopped or paused. @@ -181,6 +182,3 @@ to add, and the field `CapDrop`, which specifies a list of capabilities to drop. * `POST /images/create` th `fromImage` and `repo` parameters supportthe `repo:tag` format. Consequently, the `tag` parameter is now obsolete. Using the new format and the `tag` parameter at the same time will return an error. - - - diff --git a/docs/reference/api/docker_remote_api_v1.21.md b/docs/reference/api/docker_remote_api_v1.21.md index df905c26ad..af5538bd14 100644 --- a/docs/reference/api/docker_remote_api_v1.21.md +++ b/docs/reference/api/docker_remote_api_v1.21.md @@ -233,7 +233,7 @@ Json Parameters: - **CpuShares** - An integer value containing the container's CPU Shares (ie. the relative weight vs other containers). - **CpuPeriod** - The length of a CPU period in microseconds. -- **Cpuset** - Deprecated please don't use. Use `CpusetCpus` instead. +- **Cpuset** - Deprecated please don't use. Use `CpusetCpus` instead. - **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use. - **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. - **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000. @@ -1363,7 +1363,7 @@ or being killed. Query Parameters: -- **dockerfile** - Path within the build context to the Dockerfile. This is +- **dockerfile** - Path within the build context to the Dockerfile. This is ignored if `remote` is specified and points to an individual filename. - **t** – A repository name (and optionally a tag) to apply to the resulting image in case of success. @@ -2038,9 +2038,10 @@ Query Parameters: - **since** – Timestamp used for polling - **until** – Timestamp used for polling - **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters: + - `container=`; -- container to filter - `event=`; -- event to filter - `image=`; -- image to filter - - `container=`; -- container to filter + - `label=`; -- image and container label to filter Status Codes: diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/events.md index f714621309..ad306943ff 100644 --- a/docs/reference/commandline/events.md +++ b/docs/reference/commandline/events.md @@ -48,9 +48,10 @@ container container 588a23dac085 *AND* the event type is *start* The currently supported filters are: -* container -* event -* image +* container (`container=`) +* event (`event=`) +* image (`image=`) +* label (`label=` or `label==`) ## Examples @@ -133,4 +134,3 @@ relative to the current time on the client machine: 2014-05-10T17:42:14.999999999Z07:00 4386fb97867d: (from ubuntu-1:14.04) stop 2014-05-10T17:42:14.999999999Z07:00 7805c1d35632: (from redis:2.8) die 2014-09-03T15:49:29.999999999Z07:00 7805c1d35632: (from redis:2.8) stop -