blob: 51eb3c12624f53c8efc9b40a0b3cdddc4a4b884d [file] [log] [blame]
Dean Troyer67787e62012-05-02 11:48:15 -05001# lib/cinder
Dean Troyer6d04fd72012-12-21 11:03:37 -06002# Install and start **Cinder** volume service
Dean Troyer67787e62012-05-02 11:48:15 -05003
4# Dependencies:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01005#
Dean Troyer67787e62012-05-02 11:48:15 -05006# - functions
Attila Fazekas91b8d132013-01-06 22:40:09 +01007# - DEST, DATA_DIR, STACK_USER must be defined
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01008# - SERVICE_{TENANT_NAME|PASSWORD} must be defined
9# - ``KEYSTONE_TOKEN_FORMAT`` must be defined
Dean Troyer67787e62012-05-02 11:48:15 -050010
11# stack.sh
12# ---------
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010013# - install_cinder
14# - configure_cinder
15# - init_cinder
16# - start_cinder
17# - stop_cinder
18# - cleanup_cinder
Dean Troyer67787e62012-05-02 11:48:15 -050019
Dean Troyer7903b792012-09-13 17:16:12 -050020# Save trace setting
21XTRACE=$(set +o | grep xtrace)
22set +o xtrace
Dean Troyer67787e62012-05-02 11:48:15 -050023
24
25# Defaults
26# --------
27
Mate Lakatb2fdafe2012-11-20 15:52:21 +000028# set up default driver
29CINDER_DRIVER=${CINDER_DRIVER:-default}
john-griffithd0860cc2014-01-23 11:31:10 -070030CINDER_PLUGINS=$TOP_DIR/lib/cinder_plugins
31
32# grab plugin config if specified via cinder_driver
33if [[ -r $CINDER_PLUGINS/$CINDER_DRIVER ]]; then
34 source $CINDER_PLUGINS/$CINDER_DRIVER
35fi
Mate Lakatb2fdafe2012-11-20 15:52:21 +000036
Dean Troyer67787e62012-05-02 11:48:15 -050037# set up default directories
38CINDER_DIR=$DEST/cinder
Dean Troyer50ac7922012-09-13 14:02:01 -050039CINDERCLIENT_DIR=$DEST/python-cinderclient
40CINDER_STATE_PATH=${CINDER_STATE_PATH:=$DATA_DIR/cinder}
Dean Troyer671c16e2012-12-13 16:22:38 -060041CINDER_AUTH_CACHE_DIR=${CINDER_AUTH_CACHE_DIR:-/var/cache/cinder}
42
Dean Troyer50ac7922012-09-13 14:02:01 -050043CINDER_CONF_DIR=/etc/cinder
44CINDER_CONF=$CINDER_CONF_DIR/cinder.conf
Dean Troyer671c16e2012-12-13 16:22:38 -060045CINDER_API_PASTE_INI=$CINDER_CONF_DIR/api-paste.ini
Dean Troyer50ac7922012-09-13 14:02:01 -050046
Dean Troyer560346b2012-12-13 17:05:24 -060047# Public facing bits
48CINDER_SERVICE_HOST=${CINDER_SERVICE_HOST:-$SERVICE_HOST}
49CINDER_SERVICE_PORT=${CINDER_SERVICE_PORT:-8776}
50CINDER_SERVICE_PORT_INT=${CINDER_SERVICE_PORT_INT:-18776}
51CINDER_SERVICE_PROTOCOL=${CINDER_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
52
Dean Troyer50ac7922012-09-13 14:02:01 -050053# Support entry points installation of console scripts
54if [[ -d $CINDER_DIR/bin ]]; then
Monty Taylor9fbeedd2012-08-17 12:52:27 -040055 CINDER_BIN_DIR=$CINDER_DIR/bin
56else
Jakub Ruzicka4196d552013-01-30 15:35:54 +010057 CINDER_BIN_DIR=$(get_python_exec_prefix)
Monty Taylor9fbeedd2012-08-17 12:52:27 -040058fi
Dean Troyer67787e62012-05-02 11:48:15 -050059
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +010060# Support for multi lvm backend configuration (default is no support)
61CINDER_MULTI_LVM_BACKEND=$(trueorfalse False $CINDER_MULTI_LVM_BACKEND)
62
Dean Troyerb7490da2013-03-18 16:07:56 -050063# Should cinder perform secure deletion of volumes?
64# Defaults to true, can be set to False to avoid this bug when testing:
65# https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1023755
66CINDER_SECURE_DELETE=`trueorfalse True $CINDER_SECURE_DELETE`
67
Sean Daguef35ff722013-05-16 16:31:12 -040068# Cinder reports allocations back to the scheduler on periodic intervals
69# it turns out we can get an "out of space" issue when we run tests too
70# quickly just because cinder didn't realize we'd freed up resources.
71# Make this configurable so that devstack-gate/tempest can set it to
72# less than the 60 second default
73# https://bugs.launchpad.net/cinder/+bug/1180976
74CINDER_PERIODIC_INTERVAL=${CINDER_PERIODIC_INTERVAL:-60}
75
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +010076# Name of the lvm volume groups to use/create for iscsi volumes
Dean Troyer67787e62012-05-02 11:48:15 -050077VOLUME_GROUP=${VOLUME_GROUP:-stack-volumes}
JordanP51c90b82013-05-23 10:27:51 +020078VOLUME_BACKING_FILE=${VOLUME_BACKING_FILE:-$DATA_DIR/${VOLUME_GROUP}-backing-file}
Mate Lakat68ac03c2013-06-06 16:22:34 +010079VOLUME_BACKING_DEVICE=${VOLUME_BACKING_DEVICE:-}
JordanP51c90b82013-05-23 10:27:51 +020080
81# VOLUME_GROUP2 is used only if CINDER_MULTI_LVM_BACKEND = True
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +010082VOLUME_GROUP2=${VOLUME_GROUP2:-stack-volumes2}
JordanP51c90b82013-05-23 10:27:51 +020083VOLUME_BACKING_FILE2=${VOLUME_BACKING_FILE2:-$DATA_DIR/${VOLUME_GROUP2}-backing-file}
Mate Lakat68ac03c2013-06-06 16:22:34 +010084VOLUME_BACKING_DEVICE2=${VOLUME_BACKING_DEVICE2:-}
JordanP51c90b82013-05-23 10:27:51 +020085
Dean Troyer67787e62012-05-02 11:48:15 -050086VOLUME_NAME_PREFIX=${VOLUME_NAME_PREFIX:-volume-}
87
Dean Troyer4237f592014-01-29 16:22:11 -060088# Tell Tempest this project is present
89TEMPEST_SERVICES+=,cinder
90
Dean Troyercc6b4432013-04-08 15:38:03 -050091
92# Functions
93# ---------
JordanP022e9912013-07-09 14:14:48 +020094# _clean_lvm_lv removes all cinder LVM volumes
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010095#
96# Usage: _clean_lvm_lv $VOLUME_GROUP $VOLUME_NAME_PREFIX
JordanP022e9912013-07-09 14:14:48 +020097function _clean_lvm_lv() {
Dean Troyer22853c12013-01-07 15:18:12 -060098 local vg=$1
JordanP51c90b82013-05-23 10:27:51 +020099 local lv_prefix=$2
100
Dean Troyer22853c12013-01-07 15:18:12 -0600101 # Clean out existing volumes
102 for lv in `sudo lvs --noheadings -o lv_name $vg`; do
JordanP51c90b82013-05-23 10:27:51 +0200103 # lv_prefix prefixes the LVs we want
104 if [[ "${lv#$lv_prefix}" != "$lv" ]]; then
Dean Troyer22853c12013-01-07 15:18:12 -0600105 sudo lvremove -f $vg/$lv
106 fi
107 done
JordanP022e9912013-07-09 14:14:48 +0200108}
109
110# _clean_lvm_backing_file() removes the backing file of the
111# volume group used by cinder
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100112#
113# Usage: _clean_lvm_backing_file() $VOLUME_GROUP
JordanP022e9912013-07-09 14:14:48 +0200114function _clean_lvm_backing_file() {
115 local vg=$1
JordanP51c90b82013-05-23 10:27:51 +0200116
117 # if there is no logical volume left, it's safe to attempt a cleanup
118 # of the backing file
119 if [ -z "`sudo lvs --noheadings -o lv_name $vg`" ]; then
120 # if the backing physical device is a loop device, it was probably setup by devstack
Dean Troyer53ffc712013-12-17 11:13:40 -0600121 if [[ -n "$VG_DEV" ]] && [[ -e "$VG_DEV" ]]; then
122 VG_DEV=$(sudo losetup -j $DATA_DIR/${vg}-backing-file | awk -F':' '/backing-file/ { print $1}')
JordanP51c90b82013-05-23 10:27:51 +0200123 sudo losetup -d $VG_DEV
124 rm -f $DATA_DIR/${vg}-backing-file
125 fi
126 fi
Dean Troyer22853c12013-01-07 15:18:12 -0600127}
128
Dean Troyer67787e62012-05-02 11:48:15 -0500129# cleanup_cinder() - Remove residual data files, anything left over from previous
130# runs that a clean run would need to clean up
131function cleanup_cinder() {
Sean Dague252f2f52012-12-20 16:41:57 -0500132 # ensure the volume group is cleared up because fails might
133 # leave dead volumes in the group
134 TARGETS=$(sudo tgtadm --op show --mode target)
135 if [ $? -ne 0 ]; then
136 # If tgt driver isn't running this won't work obviously
137 # So check the response and restart if need be
138 echo "tgtd seems to be in a bad state, restarting..."
139 if is_ubuntu; then
140 restart_service tgt
141 else
142 restart_service tgtd
143 fi
144 TARGETS=$(sudo tgtadm --op show --mode target)
145 fi
146
147 if [[ -n "$TARGETS" ]]; then
148 iqn_list=( $(grep --no-filename -r iqn $SCSI_PERSIST_DIR | sed 's/<target //' | sed 's/>//') )
149 for i in "${iqn_list[@]}"; do
150 echo removing iSCSI target: $i
151 sudo tgt-admin --delete $i
152 done
153 fi
154
155 if is_service_enabled cinder; then
156 sudo rm -rf $CINDER_STATE_PATH/volumes/*
157 fi
158
159 if is_ubuntu; then
160 stop_service tgt
161 else
162 stop_service tgtd
163 fi
164
Dean Troyer22853c12013-01-07 15:18:12 -0600165 # Campsite rule: leave behind a volume group at least as clean as we found it
JordanP022e9912013-07-09 14:14:48 +0200166 _clean_lvm_lv $VOLUME_GROUP $VOLUME_NAME_PREFIX
167 _clean_lvm_backing_file $VOLUME_GROUP
JordanP51c90b82013-05-23 10:27:51 +0200168
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100169 if [ "$CINDER_MULTI_LVM_BACKEND" = "True" ]; then
JordanP022e9912013-07-09 14:14:48 +0200170 _clean_lvm_lv $VOLUME_GROUP2 $VOLUME_NAME_PREFIX
171 _clean_lvm_backing_file $VOLUME_GROUP2
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100172 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500173}
174
Thierry Carrez63e17842014-01-10 14:23:03 +0100175# configure_cinder_rootwrap() - configure Cinder's rootwrap
176function configure_cinder_rootwrap() {
John Griffith4e823ff2012-07-20 13:18:17 -0600177 # Set the paths of certain binaries
Vincent Untz856a11e2012-11-21 16:04:12 +0100178 CINDER_ROOTWRAP=$(get_rootwrap_location cinder)
Thierry Carrez07185682013-12-13 15:20:26 +0100179 if [[ ! -x $CINDER_ROOTWRAP ]]; then
180 CINDER_ROOTWRAP=$(get_rootwrap_location oslo)
181 if [[ ! -x $CINDER_ROOTWRAP ]]; then
182 die $LINENO "No suitable rootwrap found."
183 fi
184 fi
John Griffith4e823ff2012-07-20 13:18:17 -0600185
186 # If Cinder ships the new rootwrap filters files, deploy them
187 # (owned by root) and add a parameter to $CINDER_ROOTWRAP
188 ROOTWRAP_CINDER_SUDOER_CMD="$CINDER_ROOTWRAP"
189 if [[ -d $CINDER_DIR/etc/cinder/rootwrap.d ]]; then
190 # Wipe any existing rootwrap.d files first
191 if [[ -d $CINDER_CONF_DIR/rootwrap.d ]]; then
192 sudo rm -rf $CINDER_CONF_DIR/rootwrap.d
193 fi
194 # Deploy filters to /etc/cinder/rootwrap.d
195 sudo mkdir -m 755 $CINDER_CONF_DIR/rootwrap.d
196 sudo cp $CINDER_DIR/etc/cinder/rootwrap.d/*.filters $CINDER_CONF_DIR/rootwrap.d
197 sudo chown -R root:root $CINDER_CONF_DIR/rootwrap.d
198 sudo chmod 644 $CINDER_CONF_DIR/rootwrap.d/*
199 # Set up rootwrap.conf, pointing to /etc/cinder/rootwrap.d
Thierry Carrez07185682013-12-13 15:20:26 +0100200 if [[ -f $CINDER_DIR/etc/cinder/rootwrap.conf ]]; then
201 sudo cp $CINDER_DIR/etc/cinder/rootwrap.conf $CINDER_CONF_DIR/
202 else
203 # rootwrap.conf is no longer shipped in Cinder itself
204 echo "filters_path=" | sudo tee $CINDER_CONF_DIR/rootwrap.conf > /dev/null
205 fi
John Griffith4e823ff2012-07-20 13:18:17 -0600206 sudo sed -e "s:^filters_path=.*$:filters_path=$CINDER_CONF_DIR/rootwrap.d:" -i $CINDER_CONF_DIR/rootwrap.conf
207 sudo chown root:root $CINDER_CONF_DIR/rootwrap.conf
208 sudo chmod 0644 $CINDER_CONF_DIR/rootwrap.conf
Thierry Carrez07185682013-12-13 15:20:26 +0100209 # Specify rootwrap.conf as first parameter to rootwrap
John Griffith4e823ff2012-07-20 13:18:17 -0600210 CINDER_ROOTWRAP="$CINDER_ROOTWRAP $CINDER_CONF_DIR/rootwrap.conf"
211 ROOTWRAP_CINDER_SUDOER_CMD="$CINDER_ROOTWRAP *"
212 fi
213
214 TEMPFILE=`mktemp`
Stephan Renatuse578eff2013-11-19 13:31:04 +0100215 echo "$STACK_USER ALL=(root) NOPASSWD: $ROOTWRAP_CINDER_SUDOER_CMD" >$TEMPFILE
John Griffith4e823ff2012-07-20 13:18:17 -0600216 chmod 0440 $TEMPFILE
217 sudo chown root:root $TEMPFILE
218 sudo mv $TEMPFILE /etc/sudoers.d/cinder-rootwrap
Thierry Carrez63e17842014-01-10 14:23:03 +0100219}
220
221# configure_cinder() - Set config files, create data dirs, etc
222function configure_cinder() {
223 if [[ ! -d $CINDER_CONF_DIR ]]; then
224 sudo mkdir -p $CINDER_CONF_DIR
225 fi
226 sudo chown $STACK_USER $CINDER_CONF_DIR
227
228 cp -p $CINDER_DIR/etc/cinder/policy.json $CINDER_CONF_DIR
229
230 configure_cinder_rootwrap
John Griffith4e823ff2012-07-20 13:18:17 -0600231
Dean Troyer67787e62012-05-02 11:48:15 -0500232 cp $CINDER_DIR/etc/cinder/api-paste.ini $CINDER_API_PASTE_INI
Dan Prince82dea7c2013-10-16 18:57:15 -0400233
234 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_host
235 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_port
236 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_protocol
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000237 inicomment $CINDER_API_PASTE_INI filter:authtoken cafile
Dan Prince82dea7c2013-10-16 18:57:15 -0400238 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_tenant_name
239 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_user
240 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_password
241 inicomment $CINDER_API_PASTE_INI filter:authtoken signing_dir
Dean Troyerbc071bc2012-10-01 14:06:44 -0500242
Dean Troyer67787e62012-05-02 11:48:15 -0500243 cp $CINDER_DIR/etc/cinder/cinder.conf.sample $CINDER_CONF
Dan Prince82dea7c2013-10-16 18:57:15 -0400244
245 iniset $CINDER_CONF keystone_authtoken auth_host $KEYSTONE_AUTH_HOST
246 iniset $CINDER_CONF keystone_authtoken auth_port $KEYSTONE_AUTH_PORT
247 iniset $CINDER_CONF keystone_authtoken auth_protocol $KEYSTONE_AUTH_PROTOCOL
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000248 iniset $CINDER_CONF keystone_authtoken cafile $KEYSTONE_SSL_CA
Dan Prince82dea7c2013-10-16 18:57:15 -0400249 iniset $CINDER_CONF keystone_authtoken admin_tenant_name $SERVICE_TENANT_NAME
250 iniset $CINDER_CONF keystone_authtoken admin_user cinder
251 iniset $CINDER_CONF keystone_authtoken admin_password $SERVICE_PASSWORD
252 iniset $CINDER_CONF keystone_authtoken signing_dir $CINDER_AUTH_CACHE_DIR
253
Dean Troyer67787e62012-05-02 11:48:15 -0500254 iniset $CINDER_CONF DEFAULT auth_strategy keystone
Ben Nemec03997942013-08-10 09:56:16 -0500255 iniset $CINDER_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Dean Troyer67787e62012-05-02 11:48:15 -0500256 iniset $CINDER_CONF DEFAULT verbose True
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100257 if [ "$CINDER_MULTI_LVM_BACKEND" = "True" ]; then
258 iniset $CINDER_CONF DEFAULT enabled_backends lvmdriver-1,lvmdriver-2
259 iniset $CINDER_CONF lvmdriver-1 volume_group $VOLUME_GROUP
260 iniset $CINDER_CONF lvmdriver-1 volume_driver cinder.volume.drivers.lvm.LVMISCSIDriver
261 iniset $CINDER_CONF lvmdriver-1 volume_backend_name LVM_iSCSI
262 iniset $CINDER_CONF lvmdriver-2 volume_group $VOLUME_GROUP2
263 iniset $CINDER_CONF lvmdriver-2 volume_driver cinder.volume.drivers.lvm.LVMISCSIDriver
Giulio Fidente97e1bd02013-06-04 05:33:52 +0200264 iniset $CINDER_CONF lvmdriver-2 volume_backend_name LVM_iSCSI_2
Matt Riedemann7103a842013-12-07 13:53:33 -0800265 # NOTE(mriedem): Work around Cinder "wishlist" bug 1255593
266 if [[ "$CINDER_SECURE_DELETE" == "False" ]]; then
267 iniset $CINDER_CONF lvmdriver-1 volume_clear none
268 iniset $CINDER_CONF lvmdriver-2 volume_clear none
269 fi
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100270 else
271 iniset $CINDER_CONF DEFAULT volume_group $VOLUME_GROUP
272 iniset $CINDER_CONF DEFAULT volume_name_template ${VOLUME_NAME_PREFIX}%s
273 fi
Nikolay Sobolevskiy08df29b2013-08-30 21:59:15 +0400274 iniset $CINDER_CONF DEFAULT my_ip "$CINDER_SERVICE_HOST"
Dean Troyer67787e62012-05-02 11:48:15 -0500275 iniset $CINDER_CONF DEFAULT iscsi_helper tgtadm
Attila Fazekas7e79d912013-03-03 12:23:04 +0100276 iniset $CINDER_CONF DEFAULT sql_connection `database_connection_url cinder`
Dean Troyer67787e62012-05-02 11:48:15 -0500277 iniset $CINDER_CONF DEFAULT api_paste_config $CINDER_API_PASTE_INI
Joe Gordona58382a2013-02-20 12:45:02 -0800278 iniset $CINDER_CONF DEFAULT rootwrap_config "$CINDER_CONF_DIR/rootwrap.conf"
Dan Prince9f22f072013-01-28 09:53:38 -0500279 iniset $CINDER_CONF DEFAULT osapi_volume_extension cinder.api.contrib.standard_extensions
Dean Troyer50ac7922012-09-13 14:02:01 -0500280 iniset $CINDER_CONF DEFAULT state_path $CINDER_STATE_PATH
Sergey Kraynev84783c72013-10-10 09:08:48 -0400281 iniset $CINDER_CONF DEFAULT lock_path $CINDER_STATE_PATH
Sean Daguef35ff722013-05-16 16:31:12 -0400282 iniset $CINDER_CONF DEFAULT periodic_interval $CINDER_PERIODIC_INTERVAL
John Griffith4e823ff2012-07-20 13:18:17 -0600283
Gordon Chung2bfbc772013-08-09 10:55:12 -0400284 if is_service_enabled ceilometer; then
285 iniset $CINDER_CONF DEFAULT notification_driver "cinder.openstack.common.notifier.rpc_notifier"
286 fi
287
Dean Troyer560346b2012-12-13 17:05:24 -0600288 if is_service_enabled tls-proxy; then
289 # Set the service port for a proxy to take the original
290 iniset $CINDER_CONF DEFAULT osapi_volume_listen_port $CINDER_SERVICE_PORT_INT
291 fi
292
Dean Troyer4d3049e2012-11-06 20:38:14 -0600293 if [ "$SYSLOG" != "False" ]; then
294 iniset $CINDER_CONF DEFAULT use_syslog True
295 fi
296
Akihiro MOTOKIb0f1c382013-01-13 17:58:12 +0900297 iniset_rpc_backend cinder $CINDER_CONF DEFAULT
Gary Kottonf71bf192012-08-06 11:15:36 -0400298
James E. Blair213c4162012-11-06 09:38:36 +0100299 if [[ "$CINDER_SECURE_DELETE" == "False" ]]; then
300 iniset $CINDER_CONF DEFAULT secure_delete False
Pádraig Bradyeac93702013-01-02 16:02:54 +0000301 iniset $CINDER_CONF DEFAULT volume_clear none
James E. Blair213c4162012-11-06 09:38:36 +0100302 fi
303
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700304 # Format logging
Chmouel Boudjnah1057bff2012-08-03 11:42:51 +0000305 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ]; then
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700306 setup_colorized_logging $CINDER_CONF DEFAULT "project_id" "user_id"
Chmouel Boudjnah1057bff2012-08-03 11:42:51 +0000307 fi
Mate Lakatb2fdafe2012-11-20 15:52:21 +0000308
john-griffithd0860cc2014-01-23 11:31:10 -0700309 if [[ -r $CINDER_PLUGINS/$CINDER_DRIVER ]]; then
310 configure_cinder_driver
Mate Lakatb2fdafe2012-11-20 15:52:21 +0000311 fi
Ian Wienand0db17132013-06-26 22:31:48 +1000312
313 if [[ is_fedora && $DISTRO =~ (rhel6) ]]; then
314 # Cinder clones are slightly larger due to some extra
315 # metadata. RHEL6 will not allow auto-extending of LV's
316 # without this, leading to clones giving hard-to-track disk
317 # I/O errors.
318 # see https://bugzilla.redhat.com/show_bug.cgi?id=975052
319 sudo sed -i~ \
320 -e 's/snapshot_autoextend_threshold =.*/snapshot_autoextend_threshold = 80/' \
321 -e 's/snapshot_autoextend_percent =.*/snapshot_autoextend_percent = 20/' \
322 /etc/lvm/lvm.conf
323 fi
Vincent Hou21fe4e72013-11-21 03:10:27 -0500324 configure_API_version $CINDER_CONF $IDENTITY_API_VERSION
stackcf2d0d32013-08-05 04:51:56 -0400325 iniset $CINDER_CONF keystone_authtoken admin_user cinder
326 iniset $CINDER_CONF keystone_authtoken admin_tenant_name $SERVICE_TENANT_NAME
327 iniset $CINDER_CONF keystone_authtoken admin_password $SERVICE_PASSWORD
Ian Wienand0db17132013-06-26 22:31:48 +1000328
Dean Troyer67787e62012-05-02 11:48:15 -0500329}
330
Dean Troyer671c16e2012-12-13 16:22:38 -0600331# create_cinder_accounts() - Set up common required cinder accounts
332
333# Tenant User Roles
334# ------------------------------------------------------------------
335# service cinder admin # if enabled
336
337# Migrated from keystone_data.sh
338create_cinder_accounts() {
339
340 SERVICE_TENANT=$(keystone tenant-list | awk "/ $SERVICE_TENANT_NAME / { print \$2 }")
341 ADMIN_ROLE=$(keystone role-list | awk "/ admin / { print \$2 }")
342
343 # Cinder
344 if [[ "$ENABLED_SERVICES" =~ "c-api" ]]; then
345 CINDER_USER=$(keystone user-create \
346 --name=cinder \
347 --pass="$SERVICE_PASSWORD" \
Dirk Mueller25049cd2014-01-09 13:53:52 +0100348 --tenant-id $SERVICE_TENANT \
Dean Troyer671c16e2012-12-13 16:22:38 -0600349 --email=cinder@example.com \
350 | grep " id " | get_field 2)
351 keystone user-role-add \
Jorge Valderrama Romerof39ee962013-09-02 17:18:40 +0200352 --tenant-id $SERVICE_TENANT \
353 --user-id $CINDER_USER \
354 --role-id $ADMIN_ROLE
Dean Troyer671c16e2012-12-13 16:22:38 -0600355 if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
356 CINDER_SERVICE=$(keystone service-create \
357 --name=cinder \
358 --type=volume \
359 --description="Cinder Volume Service" \
360 | grep " id " | get_field 2)
361 keystone endpoint-create \
362 --region RegionOne \
363 --service_id $CINDER_SERVICE \
Dean Troyer560346b2012-12-13 17:05:24 -0600364 --publicurl "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(tenant_id)s" \
365 --adminurl "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(tenant_id)s" \
366 --internalurl "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(tenant_id)s"
Mike Perezb3862f92013-02-12 02:16:41 -0800367 CINDER_V2_SERVICE=$(keystone service-create \
Juan Manuel Olle4ad37632014-01-06 15:07:09 -0300368 --name=cinderv2 \
Mike Perezb3862f92013-02-12 02:16:41 -0800369 --type=volumev2 \
370 --description="Cinder Volume Service V2" \
371 | grep " id " | get_field 2)
372 keystone endpoint-create \
373 --region RegionOne \
374 --service_id $CINDER_V2_SERVICE \
375 --publicurl "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(tenant_id)s" \
376 --adminurl "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(tenant_id)s" \
377 --internalurl "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(tenant_id)s"
378
Dean Troyer671c16e2012-12-13 16:22:38 -0600379 fi
380 fi
381}
382
Dean Troyerf03bafe2013-02-12 10:58:28 -0600383# create_cinder_cache_dir() - Part of the init_cinder() process
384function create_cinder_cache_dir() {
385 # Create cache dir
386 sudo mkdir -p $CINDER_AUTH_CACHE_DIR
387 sudo chown $STACK_USER $CINDER_AUTH_CACHE_DIR
388 rm -f $CINDER_AUTH_CACHE_DIR/*
389}
390
391create_cinder_volume_group() {
Attila Fazekasa6ed3dc2013-07-01 22:49:31 +0200392 # According to the ``CINDER_MULTI_LVM_BACKEND`` value, configure one or two default volumes
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100393 # group called ``stack-volumes`` (and ``stack-volumes2``) for the volume
394 # service if it (they) does (do) not yet exist. If you don't wish to use a
395 # file backed volume group, create your own volume group called ``stack-volumes``
396 # and ``stack-volumes2`` before invoking ``stack.sh``.
Dean Troyerf03bafe2013-02-12 10:58:28 -0600397 #
Attila Fazekasa6ed3dc2013-07-01 22:49:31 +0200398 # The two backing files are ``VOLUME_BACKING_FILE_SIZE`` in size, and they are stored in
399 # the ``DATA_DIR``.
Dean Troyerf03bafe2013-02-12 10:58:28 -0600400
401 if ! sudo vgs $VOLUME_GROUP; then
Mate Lakat68ac03c2013-06-06 16:22:34 +0100402 if [ -z "$VOLUME_BACKING_DEVICE" ]; then
403 # Only create if the file doesn't already exists
404 [[ -f $VOLUME_BACKING_FILE ]] || truncate -s $VOLUME_BACKING_FILE_SIZE $VOLUME_BACKING_FILE
405 DEV=`sudo losetup -f --show $VOLUME_BACKING_FILE`
Dean Troyerf03bafe2013-02-12 10:58:28 -0600406
Mate Lakat68ac03c2013-06-06 16:22:34 +0100407 # Only create if the loopback device doesn't contain $VOLUME_GROUP
408 if ! sudo vgs $VOLUME_GROUP; then
409 sudo vgcreate $VOLUME_GROUP $DEV
410 fi
411 else
412 sudo vgcreate $VOLUME_GROUP $VOLUME_BACKING_DEVICE
Dean Troyerf03bafe2013-02-12 10:58:28 -0600413 fi
414 fi
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100415 if [ "$CINDER_MULTI_LVM_BACKEND" = "True" ]; then
416 #set up the second volume if CINDER_MULTI_LVM_BACKEND is enabled
417
418 if ! sudo vgs $VOLUME_GROUP2; then
Mate Lakat68ac03c2013-06-06 16:22:34 +0100419 if [ -z "$VOLUME_BACKING_DEVICE2" ]; then
420 # Only create if the file doesn't already exists
421 [[ -f $VOLUME_BACKING_FILE2 ]] || truncate -s $VOLUME_BACKING_FILE_SIZE $VOLUME_BACKING_FILE2
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100422
Mate Lakat68ac03c2013-06-06 16:22:34 +0100423 DEV=`sudo losetup -f --show $VOLUME_BACKING_FILE2`
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100424
Mate Lakat68ac03c2013-06-06 16:22:34 +0100425 # Only create if the loopback device doesn't contain $VOLUME_GROUP
426 if ! sudo vgs $VOLUME_GROUP2; then
427 sudo vgcreate $VOLUME_GROUP2 $DEV
428 fi
429 else
430 sudo vgcreate $VOLUME_GROUP2 $VOLUME_BACKING_DEVICE2
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100431 fi
432 fi
433 fi
Dean Troyerf03bafe2013-02-12 10:58:28 -0600434
435 mkdir -p $CINDER_STATE_PATH/volumes
436}
437
Dean Troyer67787e62012-05-02 11:48:15 -0500438# init_cinder() - Initialize database and volume group
439function init_cinder() {
440 # Force nova volumes off
441 NOVA_ENABLED_APIS=$(echo $NOVA_ENABLED_APIS | sed "s/osapi_volume,//")
442
Terry Wilson428af5a2012-11-01 16:12:39 -0400443 if is_service_enabled $DATABASE_BACKENDS; then
Dean Troyerf03bafe2013-02-12 10:58:28 -0600444 # (Re)create cinder database
Terry Wilson428af5a2012-11-01 16:12:39 -0400445 recreate_database cinder utf8
Dean Troyer67787e62012-05-02 11:48:15 -0500446
Dean Troyerf03bafe2013-02-12 10:58:28 -0600447 # Migrate cinder database
Monty Taylor9fbeedd2012-08-17 12:52:27 -0400448 $CINDER_BIN_DIR/cinder-manage db sync
Dean Troyer67787e62012-05-02 11:48:15 -0500449 fi
450
451 if is_service_enabled c-vol; then
Dean Troyer67787e62012-05-02 11:48:15 -0500452
Dean Troyerf03bafe2013-02-12 10:58:28 -0600453 create_cinder_volume_group
Chuck Short3f603d92012-07-28 13:28:33 -0500454
Dean Troyer67787e62012-05-02 11:48:15 -0500455 if sudo vgs $VOLUME_GROUP; then
Vincent Untz00011c02012-12-06 09:56:32 +0100456 if is_fedora || is_suse; then
457 # service is not started by default
Vincent Untz0230aa82012-06-14 08:51:01 +0200458 start_service tgtd
459 fi
460
Dean Troyer67787e62012-05-02 11:48:15 -0500461 # Remove iscsi targets
462 sudo tgtadm --op show --mode target | grep $VOLUME_NAME_PREFIX | grep Target | cut -f3 -d ' ' | sudo xargs -n1 tgt-admin --delete || true
Dean Troyer22853c12013-01-07 15:18:12 -0600463 # Start with a clean volume group
JordanP022e9912013-07-09 14:14:48 +0200464 _clean_lvm_lv $VOLUME_GROUP $VOLUME_NAME_PREFIX
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100465 if [ "$CINDER_MULTI_LVM_BACKEND" = "True" ]; then
JordanP022e9912013-07-09 14:14:48 +0200466 _clean_lvm_lv $VOLUME_GROUP2 $VOLUME_NAME_PREFIX
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100467 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500468 fi
469 fi
Dean Troyerbc071bc2012-10-01 14:06:44 -0500470
Dean Troyerf03bafe2013-02-12 10:58:28 -0600471 create_cinder_cache_dir
Dean Troyer67787e62012-05-02 11:48:15 -0500472}
473
474# install_cinder() - Collect source and prepare
475function install_cinder() {
476 git_clone $CINDER_REPO $CINDER_DIR $CINDER_BRANCH
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400477 setup_develop $CINDER_DIR
Dean Troyer253a1a32013-04-01 18:23:22 -0500478}
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400479
Dean Troyer253a1a32013-04-01 18:23:22 -0500480# install_cinderclient() - Collect source and prepare
481function install_cinderclient() {
Dean Troyer67787e62012-05-02 11:48:15 -0500482 git_clone $CINDERCLIENT_REPO $CINDERCLIENT_DIR $CINDERCLIENT_BRANCH
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400483 setup_develop $CINDERCLIENT_DIR
Attila Fazekasfac533e2013-08-14 16:04:01 +0200484 sudo install -D -m 0644 -o $STACK_USER {$CINDERCLIENT_DIR/tools/,/etc/bash_completion.d/}cinder.bash_completion
Dean Troyer67787e62012-05-02 11:48:15 -0500485}
486
Steve Baker18225d92013-04-14 12:48:41 -0700487# apply config.d approach for cinder volumes directory
Mate Lakata39caac2012-09-03 15:45:53 +0100488function _configure_tgt_for_config_d() {
Steve Baker18225d92013-04-14 12:48:41 -0700489 if [[ ! -d /etc/tgt/stack.d/ ]]; then
490 sudo ln -sf $CINDER_STATE_PATH/volumes /etc/tgt/stack.d
491 echo "include /etc/tgt/stack.d/*" | sudo tee -a /etc/tgt/targets.conf
Mate Lakata39caac2012-09-03 15:45:53 +0100492 fi
493}
494
Dean Troyer67787e62012-05-02 11:48:15 -0500495# start_cinder() - Start running processes, including screen
496function start_cinder() {
497 if is_service_enabled c-vol; then
Steve Baker18225d92013-04-14 12:48:41 -0700498 # Delete any old stack.conf
499 sudo rm -f /etc/tgt/conf.d/stack.conf
Attila Fazekasb79574b2012-12-01 10:42:46 +0100500 _configure_tgt_for_config_d
Vincent Untzc18b9652012-12-04 12:36:34 +0100501 if is_ubuntu; then
Dean Troyer67787e62012-05-02 11:48:15 -0500502 # tgt in oneiric doesn't restart properly if tgtd isn't running
503 # do it in two steps
504 sudo stop tgt || true
505 sudo start tgt
Vincent Untz00011c02012-12-06 09:56:32 +0100506 elif is_fedora; then
Dean Troyer67787e62012-05-02 11:48:15 -0500507 # bypass redirection to systemctl during restart
508 sudo /sbin/service --skip-redirect tgtd restart
Vincent Untz00011c02012-12-06 09:56:32 +0100509 elif is_suse; then
510 restart_service tgtd
511 else
512 # note for other distros: unstack.sh also uses the tgt/tgtd service
513 # name, and would need to be adjusted too
514 exit_distro_not_supported "restarting tgt"
Dean Troyer67787e62012-05-02 11:48:15 -0500515 fi
Giulio Fidente384454d2013-09-27 13:17:34 +0200516 # NOTE(gfidente): ensure tgtd is running in debug mode
517 sudo tgtadm --mode system --op update --name debug --value on
Dean Troyer67787e62012-05-02 11:48:15 -0500518 fi
519
Monty Taylor9fbeedd2012-08-17 12:52:27 -0400520 screen_it c-api "cd $CINDER_DIR && $CINDER_BIN_DIR/cinder-api --config-file $CINDER_CONF"
Monty Taylor9fbeedd2012-08-17 12:52:27 -0400521 screen_it c-sch "cd $CINDER_DIR && $CINDER_BIN_DIR/cinder-scheduler --config-file $CINDER_CONF"
Stephen Mulcahy67068ef2013-02-21 11:20:58 +0000522 screen_it c-bak "cd $CINDER_DIR && $CINDER_BIN_DIR/cinder-backup --config-file $CINDER_CONF"
John Griffithe6d4fe52013-07-15 17:35:54 -0600523 screen_it c-vol "cd $CINDER_DIR && $CINDER_BIN_DIR/cinder-volume --config-file $CINDER_CONF"
524
525 # NOTE(jdg): For cinder, startup order matters. To ensure that repor_capabilities is received
526 # by the scheduler start the cinder-volume service last (or restart it) after the scheduler
527 # has started. This is a quick fix for lp bug/1189595
Dean Troyer560346b2012-12-13 17:05:24 -0600528
529 # Start proxies if enabled
530 if is_service_enabled c-api && is_service_enabled tls-proxy; then
531 start_tls_proxy '*' $CINDER_SERVICE_PORT $CINDER_SERVICE_HOST $CINDER_SERVICE_PORT_INT &
532 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500533}
534
Dean Troyer699a29f2012-09-10 14:10:27 -0500535# stop_cinder() - Stop running processes
Dean Troyer67787e62012-05-02 11:48:15 -0500536function stop_cinder() {
Dean Troyer699a29f2012-09-10 14:10:27 -0500537 # Kill the cinder screen windows
Stephen Mulcahy67068ef2013-02-21 11:20:58 +0000538 for serv in c-api c-bak c-sch c-vol; do
Dean Troyer9fc87922013-05-22 17:19:06 -0500539 screen_stop $serv
Dean Troyer699a29f2012-09-10 14:10:27 -0500540 done
Dean Troyer67787e62012-05-02 11:48:15 -0500541
542 if is_service_enabled c-vol; then
Vincent Untz90dd96d2012-12-13 08:59:57 +0100543 if is_ubuntu; then
544 stop_service tgt
545 else
546 stop_service tgtd
547 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500548 fi
549}
Dean Troyer7903b792012-09-13 17:16:12 -0500550
Dean Troyercc6b4432013-04-08 15:38:03 -0500551
Dean Troyer7903b792012-09-13 17:16:12 -0500552# Restore xtrace
553$XTRACE
Sean Dague584d90e2013-03-29 14:34:53 -0400554
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100555# Tell emacs to use shell-script-mode
556## Local variables:
557## mode: shell-script
558## End: