Merge pull request #8073 from ClusterHQ/7743-restart-policy-api-doc

Add some documentation for the RestartPolicy feature.
This commit is contained in:
Fred Lifton 2014-09-16 20:06:55 -07:00
commit b03f506303
2 changed files with 18 additions and 2 deletions

View File

@ -133,7 +133,8 @@ Create a container
"NetworkDisabled": false,
"ExposedPorts":{
"22/tcp": {}
}
},
"RestartPolicy": { "Name": "always" }
}
**Example response**:
@ -150,6 +151,13 @@ Json Parameters:
 
- **RestartPolicy** The behavior to apply when the container exits. The
value is an object with a `Name` property of either `"always"` to
always restart or `"on-failure"` to restart only when the container
exit code is non-zero. If `on-failure` is used, `MaximumRetryCount`
controls the number of times to retry before giving up.
The default is not to restart. (optional)
- **config** the container's configuration
Query Parameters:

View File

@ -135,7 +135,8 @@ Create a container
"NetworkDisabled": false,
"ExposedPorts":{
"22/tcp": {}
}
},
"RestartPolicy": { "Name": "always" }
}
**Example response**:
@ -152,6 +153,13 @@ Json Parameters:
 
- **RestartPolicy** The behavior to apply when the container exits. The
value is an object with a `Name` property of either `"always"` to
always restart or `"on-failure"` to restart only when the container
exit code is non-zero. If `on-failure` is used, `MaximumRetryCount`
controls the number of times to retry before giving up.
The default is not to restart. (optional)
- **config** the container's configuration
Query Parameters: