HGKeeper

Update the docs to mention waiting for a detached container to go healthy if a HEALTHCHECK is specified in the Dockerfile

2017-09-11, Gary Kramlich

152edd04308a

Parents 86936d63131c
Children 7648ec9b2dad

Update the docs to mention waiting for a detached container to go healthy if a HEALTHCHECK is specified in the Dockerfile

1 files changed, 1 insertions(+), 1 deletions(-)

+1 -1

REFERENCE.md

~~--- a/REFERENCE.md Mon Sep 11 22:36:56 2017 -0500~~

+++ b/REFERENCE.md Mon Sep 11 22:38:41 2017 -0500

@@ -304,7 +304,7 @@

| ----------- | -------- | ---------- | ----------- |

| command | | | The command to run in the container. This is only necessary if the image does not provide a command by default. |

+| detach | | false | Will run the container in the background allowing other tasks to run. The container will be cleaned up on exit. If the image has a HEALTHCHECK specified in the Dockerfile, convey will wait until it is healthy before proceeding. |

| entrypoint | | | The entrypoint to use for the container. This is only necessary if the image does not provide one by default. |

| environment | | | A list of environment variables to set. The should be specified in a `NAME` or `NAME=VALUE` format. If no value is provided, the value of the variable from the host will be provided if it is available. |

grim/convey