p4u1/docker-cli
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #33299 from thaJeztah/explain-relation-between-paused-and-stopped

Browse Source 
Improve description of Running and Paused booleans
Upstream-commit: 58b1788c81f937bb2aaf1b0077c6b3b23a8397ff
Component: engine
This commit is contained in:
Sebastiaan van Stijn
2017-05-19 16:29:05 +02:00
committed by GitHub
parent 1dc2936c51 4bffda81c9
commit 756d246384
3 changed files with 19 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
components/engine/api/swagger.yaml
View File

@ -3107,10 +3107,22 @@ paths:
type: "object"
properties:
Status:
description: "The status of the container. For example, `running` or `exited`."
description: |
The status of the container. For example, `"running"` or `"exited"`.
type: "string"
enum: ["created", "running", "paused", "restarting", "removing", "exited", "dead"]
Running:
description: "Whether this container is running."
description: |
Whether this container is running.
Note that a running container can be _paused_. The `Running` and `Paused`
booleans are not mutually exclusive:
When pausing a container (on Linux), the cgroups freezer is used to suspend
all processes in the container. Freezing the process requires the process to
be running. As a result, paused containers are both `Running` _and_ `Paused`.
Use the `Status` field instead to determin if a container's state is "running".
type: "boolean"
Paused:
description: "Whether this container is paused."

2
components/engine/api/types/types.go
View File

@ -277,7 +277,7 @@ type Health struct {
// ContainerState stores container's running state
// it's part of ContainerJSONBase and will return by "inspect" command
type ContainerState struct {
Status string
Status string // String representation of the container state. Can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead"
Running bool
Paused bool
Restarting bool

6
components/engine/container/state.go
View File

@ -17,8 +17,10 @@ import (
// functions defined against State to run against Container.
type State struct {
sync.Mutex
// FIXME: Why do we have both paused and running if a
// container cannot be paused and running at the same time?
// Note that `Running` and `Paused` are not mutually exclusive:
// When pausing a container (on Linux), the cgroups freezer is used to suspend
// all processes in the container. Freezing the process requires the process to
// be running. As a result, paused containers are both `Running` _and_ `Paused`.
Running bool
Paused bool
Restarting bool