1
0
mirror of https://github.com/projectatomic/atomic.git synced 2026-02-07 06:44:52 +01:00
Files
atomic/docs/atomic-stop.1.md
Brent Baude ed9eaf2e55 Fix Stop Regression: BZ #1422448
BZ #1422448 actually points out one regression and one
bug related to atomic stop. The BZ itself points out
a TypeError exception in the code when trying to glue
together a python list and str.

Then the atomic stop command was failling in the case where a
STOP label was defined and it uses the variable $NAME resulting
in a subprocess exception.

The self.name variable was not being set by set_args after
refactoring occured.  Ideally, this should all be moved
into the image|container object handling but for now we
just handle it in set_args.

Also added a test in test_display to catch any future
regressions.

Closes: #899
Approved by: rhatdan
2017-02-20 20:37:38 +00:00

40 lines
1.1 KiB
Markdown

% ATOMIC(1) Atomic Man Pages
% Dan Walsh
% January 2015
# NAME
atomic-stop - Execute container image stop method
# SYNOPSIS
**atomic stop**
[**--display**]
[**-h**|**--help**]
container [ARG...]
# DESCRIPTION
**atomic stop** attempts to stop a running container, first reading the
`LABEL STOP` field in the container IMAGE.
If the container image has a `LABEL STOP` instruction like the following:
`LABEL STOP /usr/bin/docker kill -s HUP \${NAME}`
atomic would execute this command before stopping the container.
`atomic stop` will set the following environment variables for use in the command:
If this field does not exist, `atomic stop` will just stop the container, if
the container is running.
Any additional arguments will be appended to the command.
# OPTIONS:
**--display**
Display the container's stop options and environment variables populated into the stop command.
The stop command will not execute if --display is specified.
If --display is not specified the stop command will execute.
**-h** **--help**
Print usage statement
# HISTORY
March 2015, Originally compiled by Daniel Walsh (dwalsh at redhat dot com)