grim/convey

Add the detach option to the reference docs. Refs #21

2017-09-05, Gary Kramlich
d08ed4c3561b
Parents f5b544495b15
Children 86936d63131c
Add the detach option to the reference docs. Refs #21
1 files changed, 5 insertions(+), 0 deletions(-)
  • +5 -0
    REFERENCE.md
    • --- a/REFERENCE.md Tue Sep 05 22:43:33 2017 -0500
    +++ b/REFERENCE.md Tue Sep 05 22:46:06 2017 -0500
    @@ -16,6 +16,10 @@
    A simple plan that aliases the default plan.
    +## detach.yml
    +
    +A simple plan to show how you can detach a container.
    +
    ## environment.yml
    This example shows how environment substitution works in your config file.
    @@ -300,6 +304,7 @@
    | Name | Required | Default | Description |
    | ----------- | -------- | ---------- | ----------- |
    | 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. |
    | 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. |
    | image | Yes | | The image including the registry and tag to run. |