1DOCKER-STORAGE-SETUP(1) DOCKER-STORAGE-SETUP(1)
2
6 docker-latest-storage-setup - Grows the root filesystem and sets up
7 storage for docker-latest.
8
10 docker-latest-storage-setup [OPTIONS]
11
13 --help
14 Print usage statement
15 --reset
17 Reset your docker-latest storage to init state. Reset does not try to
18 remove volume groups or try to remove any of the disks added previ‐
19 ously.
20 Note: The --reset command is not sufficient to cleanup your docker-lat‐
22 est environment. This option is used by other tools. (atomic storage
23 reset)
24
27 Run docker-latest-storage-setup after setting up your configuration in
28 /etc/sysconfig/docker-latest-storage-setup. One can look at
29 /usr/lib/docker-latest-storage-setup/docker-latest-storage-setup for
30 various options and their default settings. Anything user wants to
31 change, should be changed in /etc/sysconfig/docker-latest-storage-set‐
32 up. This is the file which will override any settings specified in
33 /usr/lib/docker-latest-storage-setup/docker-latest-storage-setup.
34 lvm2 version should be same or higher than lvm2-2.02.112 for lvm thin
36 pool functionality to work properly.
37 Supported options for the configuration file:
39 STORAGE_DRIVER:
41 Specify a storage driver to be used with docker-latest. Default
42 driver is "devicemapper". Other valid values are overlay,
43 overlay2 and "". Empty string tells docker-latest-storage-setup
44 to
45 not do any storage setup.
46 EXTRA_DOCKER_STORAGE_OPTIONS:
48 A set of extra options that should be passed to the Docker
49 daemon.
50 DEVS: A quoted, space-separated list of devices to be used.
52 If a drive is partitioned and contains a ${dev}1 partition,
53 that partition will be configured for use. Unpartitioned
54 drives will be partitioned and configured for use. If "VG"
55 is not specified, then use of the root disk's extra space
56 is implied.
57 VG: The volume group to use for docker-latest storage. Defaults to
59 the
60 volume group where the root filesystem resides. If VG is
61 specified and the volume group does not exist, it will be
62 created (which requires that "DEVS" be nonempty, since we don't
63 currently support putting a second partition on the root disk).
64 lvm2 version should be same or higher than lvm2-2.02.112 for lvm
66 thin pool functionality to work properly.
67 GROWPART:
69 One can use this option to enable/disable growing of partition
70 table backing root volume group. This is intended for
71 virtualization and cloud installations. By default it is
72 disabled. Use GROWPART=true to enable automatic partition
73 table resizing.
74 AUTO_EXTEND_POOL:
76 Enable automatic extension of pool by lvm. lvm can monitor
77 the pool and automatically extend it when pool is getting full.
78 POOL_AUTOEXTEND_THRESHOLD:
80 Determines the pool extension threshold in terms of percentage
81 of pool size. For example, if threshold is 60, that means when
82 pool is 60% full, threshold has been hit.
83 POOL_AUTOEXTEND_PERCENT:
85 Determines the amount by which pool needs to be grown. This is
86 specified in terms of % of pool size. So a value of 20 means
87 that when threshold is hit, pool will be grown by 20% of existing
88 pool size.
89 CHUNK_SIZE:
91 Controls the chunk size/block size of thin pool. Value of
92 CHUNK_SIZE
93 be suitable to be passed to --chunk-size option of lvconvert.
94 DEVICE_WAIT_TIMEOUT:
96 Specifies a device wait timeout value in seconds. In
97 certain cases required devices might not be immediately
98 available and docker-latest-storage-setup might decide to
99 wait for
100 it. This timeout specifies how long one should wait for the
101 device. Default is 60 seconds. One can disable the wait by
102 specifying a value of 0.
103 WIPE_SIGNATURES:
105 Wipe any signatures found on disk. Valid values are
106 true/false and default value is false. By default if any
107 signatures are found on disk operation is aborted. If this value
108 is set to true, then signatures will either be wiped or
109 overwritten as suitable. This also means that if there is any
110 data on disk, it will be lost.
111 The options below should be specified as values acceptable to 'lvextend
113 -L':
114 ROOT_SIZE: The size to which the root filesystem should be grown.
116 DATA_SIZE: The desired size for the docker-latest data LV. Defaults to
118 using
119 40% free space in the VG after the root LV and docker-latest
120 metadata LV have been allocated/grown.
121 DATA_SIZE can take values acceptable to "lvcreate -L" as
123 well as some values acceptable to "lvcreate -l". If user
124 intends to pass values acceptable to "lvcreate -l", then
125 only those values which contains "%" in syntax are
126 acceptable. If value does not contain "%" it is assumed
127 value is suitable for "lvcreate -L".
128 MIN_DATA_SIZE:
130 Specifies the minimum size of the data volume. If sufficient
131 free space is not available, the pool creation will fail.
132 Value should be a number followed by a optional suffix.
134 "bBsSkKmMgGtTpPeE" are valid suffixes. If no suffix is
135 specified then value will be considered as megabyte unit.
136 Both upper and lower case suffix represent same unit of
138 size. Use suffix B for Bytes, S for sectors as 512 bytes, K
139 for kibibytes (1024 bytes), M for mebibytes
140 (1024 kibibytes), G for gibibytes, T for tebibytes, P for
141 pebibytes and E for exbibytes.
142 Sample
144 A simple, sample /etc/sysconfig/docker-latest-storage-setup:
146 DEVS=/dev/vdb
148 DATA_SIZE=8GB
150
154 atomic(1)
155
158 November 2014, originally compiled by Joe Brockmeier <jzb@redhat.com>
159 based on comments in Andy Grimm's <agrimm@redhat.com> script.
160
162 Joe Brockmeier Andy Grimm
163Helper Script for Docker Storage SNeOtVuEpMBER 2014 DOCKER-STORAGE-SETUP(1)