diff --git a/docs/reference/api/docker_remote_api.md b/docs/reference/api/docker_remote_api.md index 180ea94fd5..0568e8bbe3 100644 --- a/docs/reference/api/docker_remote_api.md +++ b/docs/reference/api/docker_remote_api.md @@ -137,6 +137,8 @@ This section lists each version from latest to oldest. Each listing includes a no longer expects a "Container" field to be present. This property was not used and is no longer sent by the docker client. * `POST /containers/create/` now validates the hostname (should be a valid RFC 1123 hostname). +* `POST /containers/create/` `HostConfig.PidMode` field now accepts `container:`, + to have the container join the PID namespace of an existing container. ### v1.23 API changes diff --git a/docs/reference/api/docker_remote_api_v1.18.md b/docs/reference/api/docker_remote_api_v1.18.md index 0112088bf9..22df689d69 100644 --- a/docs/reference/api/docker_remote_api_v1.18.md +++ b/docs/reference/api/docker_remote_api_v1.18.md @@ -169,6 +169,7 @@ Create a container "MemorySwap": 0, "CpuShares": 512, "CpusetCpus": "0,1", + "PidMode": "", "PortBindings": { "22/tcp": [{ "HostPort": "11022" }] }, "PublishAllPorts": false, "Privileged": false, @@ -242,6 +243,9 @@ Json Parameters: - **CpuShares** - An integer value containing the CPU Shares for container (ie. the relative weight vs other containers). - **CpusetCpus** - String value containing the cgroups CpusetCpus to use. + - **PidMode** - Set the PID (Process) Namespace mode for the container; + `"container:"`: joins another container's PID namespace + `"host"`: use the host's PID namespace inside the container - **PortBindings** - A map of exposed container ports and the host port they should map to. It should be specified in the form `{ /: [{ "HostPort": "" }] }` @@ -373,6 +377,7 @@ Return low-level information on the container `id` "Memory": 0, "MemorySwap": 0, "NetworkMode": "bridge", + "PidMode": "", "PortBindings": {}, "Privileged": false, "ReadonlyRootfs": false, diff --git a/docs/reference/api/docker_remote_api_v1.19.md b/docs/reference/api/docker_remote_api_v1.19.md index 078b3ad429..43ff9c689b 100644 --- a/docs/reference/api/docker_remote_api_v1.19.md +++ b/docs/reference/api/docker_remote_api_v1.19.md @@ -176,6 +176,7 @@ Create a container "CpusetMems": "0,1", "BlkioWeight": 300, "OomKillDisable": false, + "PidMode": "", "PortBindings": { "22/tcp": [{ "HostPort": "11022" }] }, "PublishAllPorts": false, "Privileged": false, @@ -253,6 +254,9 @@ Json Parameters: - **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. - **OomKillDisable** - Boolean value, whether to disable OOM Killer for the container or not. + - **PidMode** - Set the PID (Process) Namespace mode for the container; + `"container:"`: joins another container's PID namespace + `"host"`: use the host's PID namespace inside the container - **PortBindings** - A map of exposed container ports and the host port they should map to. A JSON object in the form `{ /: [{ "HostPort": "" }] }` @@ -388,6 +392,7 @@ Return low-level information on the container `id` "MemorySwap": 0, "OomKillDisable": false, "NetworkMode": "bridge", + "PidMode": "", "PortBindings": {}, "Privileged": false, "ReadonlyRootfs": false, diff --git a/docs/reference/api/docker_remote_api_v1.20.md b/docs/reference/api/docker_remote_api_v1.20.md index 05bfeff6b3..e381a243d1 100644 --- a/docs/reference/api/docker_remote_api_v1.20.md +++ b/docs/reference/api/docker_remote_api_v1.20.md @@ -177,6 +177,7 @@ Create a container "BlkioWeight": 300, "MemorySwappiness": 60, "OomKillDisable": false, + "PidMode": "", "PortBindings": { "22/tcp": [{ "HostPort": "11022" }] }, "PublishAllPorts": false, "Privileged": false, @@ -256,6 +257,9 @@ Json Parameters: - **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000. - **MemorySwappiness** - Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. - **OomKillDisable** - Boolean value, whether to disable OOM Killer for the container or not. + - **PidMode** - Set the PID (Process) Namespace mode for the container; + `"container:"`: joins another container's PID namespace + `"host"`: use the host's PID namespace inside the container - **PortBindings** - A map of exposed container ports and the host port they should map to. A JSON object in the form `{ /: [{ "HostPort": "" }] }` @@ -391,6 +395,7 @@ Return low-level information on the container `id` "MemorySwap": 0, "OomKillDisable": false, "NetworkMode": "bridge", + "PidMode": "", "PortBindings": {}, "Privileged": false, "ReadonlyRootfs": false, diff --git a/docs/reference/api/docker_remote_api_v1.21.md b/docs/reference/api/docker_remote_api_v1.21.md index 11c2d5981f..d55e4a174e 100644 --- a/docs/reference/api/docker_remote_api_v1.21.md +++ b/docs/reference/api/docker_remote_api_v1.21.md @@ -184,6 +184,7 @@ Create a container "BlkioWeight": 300, "MemorySwappiness": 60, "OomKillDisable": false, + "PidMode": "", "PortBindings": { "22/tcp": [{ "HostPort": "11022" }] }, "PublishAllPorts": false, "Privileged": false, @@ -271,6 +272,9 @@ Json Parameters: - **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000. - **MemorySwappiness** - Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. - **OomKillDisable** - Boolean value, whether to disable OOM Killer for the container or not. + - **PidMode** - Set the PID (Process) Namespace mode for the container; + `"container:"`: joins another container's PID namespace + `"host"`: use the host's PID namespace inside the container - **PortBindings** - A map of exposed container ports and the host port they should map to. A JSON object in the form `{ /: [{ "HostPort": "" }] }` @@ -414,6 +418,7 @@ Return low-level information on the container `id` "KernelMemory": 0, "OomKillDisable": false, "NetworkMode": "bridge", + "PidMode": "", "PortBindings": {}, "Privileged": false, "ReadonlyRootfs": false, diff --git a/docs/reference/api/docker_remote_api_v1.22.md b/docs/reference/api/docker_remote_api_v1.22.md index a97e01db74..07fa423743 100644 --- a/docs/reference/api/docker_remote_api_v1.22.md +++ b/docs/reference/api/docker_remote_api_v1.22.md @@ -277,6 +277,7 @@ Create a container "MemorySwappiness": 60, "OomKillDisable": false, "OomScoreAdj": 500, + "PidMode": "", "PortBindings": { "22/tcp": [{ "HostPort": "11022" }] }, "PublishAllPorts": false, "Privileged": false, @@ -382,6 +383,9 @@ Json Parameters: - **MemorySwappiness** - Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. - **OomKillDisable** - Boolean value, whether to disable OOM Killer for the container or not. - **OomScoreAdj** - An integer value containing the score given to the container in order to tune OOM killer preferences. + - **PidMode** - Set the PID (Process) Namespace mode for the container; + `"container:"`: joins another container's PID namespace + `"host"`: use the host's PID namespace inside the container - **PortBindings** - A map of exposed container ports and the host port they should map to. A JSON object in the form `{ /: [{ "HostPort": "" }] }` @@ -534,6 +538,7 @@ Return low-level information on the container `id` "OomKillDisable": false, "OomScoreAdj": 500, "NetworkMode": "bridge", + "PidMode": "", "PortBindings": {}, "Privileged": false, "ReadonlyRootfs": false, diff --git a/docs/reference/api/docker_remote_api_v1.23.md b/docs/reference/api/docker_remote_api_v1.23.md index 3e14d7f129..3e9ca61430 100644 --- a/docs/reference/api/docker_remote_api_v1.23.md +++ b/docs/reference/api/docker_remote_api_v1.23.md @@ -296,6 +296,7 @@ Create a container "MemorySwappiness": 60, "OomKillDisable": false, "OomScoreAdj": 500, + "PidMode": "", "PidsLimit": -1, "PortBindings": { "22/tcp": [{ "HostPort": "11022" }] }, "PublishAllPorts": false, @@ -402,6 +403,9 @@ Json Parameters: - **MemorySwappiness** - Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. - **OomKillDisable** - Boolean value, whether to disable OOM Killer for the container or not. - **OomScoreAdj** - An integer value containing the score given to the container in order to tune OOM killer preferences. + - **PidMode** - Set the PID (Process) Namespace mode for the container; + `"container:"`: joins another container's PID namespace + `"host"`: use the host's PID namespace inside the container - **PidsLimit** - Tune a container's pids limit. Set -1 for unlimited. - **PortBindings** - A map of exposed container ports and the host port they should map to. A JSON object in the form @@ -557,6 +561,7 @@ Return low-level information on the container `id` "OomKillDisable": false, "OomScoreAdj": 500, "NetworkMode": "bridge", + "PidMode": "", "PortBindings": {}, "Privileged": false, "ReadonlyRootfs": false, diff --git a/docs/reference/api/docker_remote_api_v1.24.md b/docs/reference/api/docker_remote_api_v1.24.md index 1598034d8e..af73b55277 100644 --- a/docs/reference/api/docker_remote_api_v1.24.md +++ b/docs/reference/api/docker_remote_api_v1.24.md @@ -310,6 +310,7 @@ Create a container "MemorySwappiness": 60, "OomKillDisable": false, "OomScoreAdj": 500, + "PidMode": "", "PidsLimit": -1, "PortBindings": { "22/tcp": [{ "HostPort": "11022" }] }, "PublishAllPorts": false, @@ -421,6 +422,9 @@ Create a container - **MemorySwappiness** - Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. - **OomKillDisable** - Boolean value, whether to disable OOM Killer for the container or not. - **OomScoreAdj** - An integer value containing the score given to the container in order to tune OOM killer preferences. + - **PidMode** - Set the PID (Process) Namespace mode for the container; + `"container:"`: joins another container's PID namespace + `"host"`: use the host's PID namespace inside the container - **PidsLimit** - Tune a container's pids limit. Set -1 for unlimited. - **PortBindings** - A map of exposed container ports and the host port they should map to. A JSON object in the form @@ -583,6 +587,7 @@ Return low-level information on the container `id` "OomKillDisable": false, "OomScoreAdj": 500, "NetworkMode": "bridge", + "PidMode": "", "PortBindings": {}, "Privileged": false, "ReadonlyRootfs": false,