1ATOMIC(1)                        January 2015                        ATOMIC(1)
2
3
4

NAME

6       atomic-uninstall - Remove/Uninstall container/container image from
7       system
8
9
10

SYNOPSIS

12       atomic uninstall [--display] [-f][--force] [-h|--help]
13       [-n][--name[=NAME]] [--storage] IMAGE [ARG...]
14
15
16

DESCRIPTION

18       atomic uninstall attempts to read the LABEL UNINSTALL field in the
19       container IMAGE, if this field does not exist atomic uninstall will
20       just uninstall the image.
21
22
23       The image won't be removed if there are containers using it and --force
24       is not used.
25
26
27       If the container image has a LABEL UNINSTALL instruction like the
28       following:
29
30
31       LABEL UNINSTALL /usr/bin/docker run -t -i --rm \${OPT1} --privileged -v
32       /:/host --net=host --ipc=host --pid=host -e HOST=/host -e NAME=${NAME}
33       -e IMAGE=${IMAGE} -e CONFDIR=\/etc/${NAME} -e LOGDIR=/var/log/\${NAME}
34       -e DATADIR=/var/lib/\${NAME} ${IMAGE} \${OPT2} /bin/uninstall.sh
35       \${OPT3}
36
37
38       atomic uninstall will set the following environment variables for use
39       in the command:
40
41
42       NAME
43         The name specified via the command.  NAME will be replaced with IMAGE
44       if it is not specified.
45
46
47       IMAGE
48         The name and image specified via the command.
49
50
51       OPT1, OPT2, OPT3
52         Additional options which can be specified via the command.
53
54
55       SUDO_UID
56         The SUDO_UID environment variable.  This is useful with the docker -u
57       option for user space tools.  If the environment variable is not
58       available, the value of /proc/self/loginuid is used.
59
60
61       SUDO_GID
62         The SUDO_GID environment variable.  This is useful with the docker -u
63       option for user space tools.  If the environment variable is not
64       available, the default GID of the value for SUDO_UID is used.  If this
65       value is not available, the value of /proc/self/loginuid is used.
66
67
68       Any additional arguments will be appended to the command.
69
70
71

OPTIONS:

73       --display Display the image's uninstall options and environment
74       variables populated into the uninstall command.  The uninstall command
75       will not execute if --display is specified.  If --display is not
76       specified the uninstall command will execute.
77
78
79       -f --force
80         Remove all containers based on this image before removing the image.
81
82
83       -h --help
84         Print usage statement
85
86
87       -n --name=""
88          If name is specified atomic uninstall will uninstall the named
89       container from the system, otherwise it will uninstall the container
90       images.
91
92
93       --storage The --storage option will direct atomic where it should look
94       for the image prior to uninstalling. Valid options are docker and
95       ostree.
96
97
98

HISTORY

100       January 2015, Originally compiled by Daniel Walsh (dwalsh at redhat dot
101       com)
102
103
104
105Dan Walsh                       Atomic Man Pages                     ATOMIC(1)
Impressum