aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/options/health-on-failure.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/markdown/options/health-on-failure.md')
-rw-r--r--docs/source/markdown/options/health-on-failure.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/source/markdown/options/health-on-failure.md b/docs/source/markdown/options/health-on-failure.md
new file mode 100644
index 000000000..c25a1c574
--- /dev/null
+++ b/docs/source/markdown/options/health-on-failure.md
@@ -0,0 +1,8 @@
+#### **--health-on-failure**=*action*
+
+Action to take once the container transitions to an unhealthy state. The default is **none**.
+
+- **none**: Take no action.
+- **kill**: Kill the container.
+- **restart**: Restart the container. Do not combine the `restart` action with the `--restart` flag. When running inside of a systemd unit, consider using the `kill` or `stop` action instead to make use of systemd's restart policy.
+- **stop**: Stop the container.