blob: 4df7de8959066497a449c46ca052875977f5f904 [file] [log] [blame]
Sean Daguee263c822014-12-05 14:25:28 -05001#!/bin/bash
2#
Dean Troyer67787e62012-05-02 11:48:15 -05003# lib/cinder
Dean Troyer6d04fd72012-12-21 11:03:37 -06004# Install and start **Cinder** volume service
Dean Troyer67787e62012-05-02 11:48:15 -05005
6# Dependencies:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01007#
Dean Troyer67787e62012-05-02 11:48:15 -05008# - functions
Attila Fazekas91b8d132013-01-06 22:40:09 +01009# - DEST, DATA_DIR, STACK_USER must be defined
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010010# - SERVICE_{TENANT_NAME|PASSWORD} must be defined
11# - ``KEYSTONE_TOKEN_FORMAT`` must be defined
Dean Troyer67787e62012-05-02 11:48:15 -050012
13# stack.sh
14# ---------
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010015# - install_cinder
16# - configure_cinder
17# - init_cinder
18# - start_cinder
19# - stop_cinder
20# - cleanup_cinder
Dean Troyer67787e62012-05-02 11:48:15 -050021
Dean Troyer7903b792012-09-13 17:16:12 -050022# Save trace setting
Ian Wienand523f4882015-10-13 11:03:03 +110023_XTRACE_CINDER=$(set +o | grep xtrace)
Dean Troyer7903b792012-09-13 17:16:12 -050024set +o xtrace
Dean Troyer67787e62012-05-02 11:48:15 -050025
26
27# Defaults
28# --------
29
Mate Lakatb2fdafe2012-11-20 15:52:21 +000030# set up default driver
31CINDER_DRIVER=${CINDER_DRIVER:-default}
john-griffithd0860cc2014-01-23 11:31:10 -070032CINDER_PLUGINS=$TOP_DIR/lib/cinder_plugins
Dean Troyer09718332014-07-03 10:46:57 -050033CINDER_BACKENDS=$TOP_DIR/lib/cinder_backends
john-griffithd0860cc2014-01-23 11:31:10 -070034
35# grab plugin config if specified via cinder_driver
36if [[ -r $CINDER_PLUGINS/$CINDER_DRIVER ]]; then
37 source $CINDER_PLUGINS/$CINDER_DRIVER
38fi
Mate Lakatb2fdafe2012-11-20 15:52:21 +000039
Dean Troyer67787e62012-05-02 11:48:15 -050040# set up default directories
Sean Daguee08ab102014-11-13 17:09:28 -050041GITDIR["python-cinderclient"]=$DEST/python-cinderclient
Ramy Asselin10e1fd42015-06-04 12:12:15 -070042GITDIR["os-brick"]=$DEST/os-brick
Dean Troyer67787e62012-05-02 11:48:15 -050043CINDER_DIR=$DEST/cinder
Dean Troyer6aaad5f2015-02-18 07:09:04 -060044
45# Cinder virtual environment
46if [[ ${USE_VENV} = True ]]; then
47 PROJECT_VENV["cinder"]=${CINDER_DIR}.venv
48 CINDER_BIN_DIR=${PROJECT_VENV["cinder"]}/bin
49else
50 CINDER_BIN_DIR=$(get_python_exec_prefix)
51fi
52
Dean Troyer50ac7922012-09-13 14:02:01 -050053CINDER_STATE_PATH=${CINDER_STATE_PATH:=$DATA_DIR/cinder}
Dean Troyer671c16e2012-12-13 16:22:38 -060054CINDER_AUTH_CACHE_DIR=${CINDER_AUTH_CACHE_DIR:-/var/cache/cinder}
55
Dean Troyer50ac7922012-09-13 14:02:01 -050056CINDER_CONF_DIR=/etc/cinder
57CINDER_CONF=$CINDER_CONF_DIR/cinder.conf
Dean Troyer671c16e2012-12-13 16:22:38 -060058CINDER_API_PASTE_INI=$CINDER_CONF_DIR/api-paste.ini
Dean Troyer50ac7922012-09-13 14:02:01 -050059
Dean Troyer560346b2012-12-13 17:05:24 -060060# Public facing bits
Rob Crittenden18d47782014-03-19 17:47:42 -040061if is_ssl_enabled_service "cinder" || is_service_enabled tls-proxy; then
62 CINDER_SERVICE_PROTOCOL="https"
63fi
Dean Troyer560346b2012-12-13 17:05:24 -060064CINDER_SERVICE_HOST=${CINDER_SERVICE_HOST:-$SERVICE_HOST}
65CINDER_SERVICE_PORT=${CINDER_SERVICE_PORT:-8776}
66CINDER_SERVICE_PORT_INT=${CINDER_SERVICE_PORT_INT:-18776}
67CINDER_SERVICE_PROTOCOL=${CINDER_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Brian Haley180f5eb2015-06-16 13:14:31 -040068CINDER_SERVICE_LISTEN_ADDRESS=${CINDER_SERVICE_LISTEN_ADDRESS:-$SERVICE_LISTEN_ADDRESS}
Dean Troyer560346b2012-12-13 17:05:24 -060069
John Griffithce8e6f62015-05-12 17:28:59 -060070# What type of LVM device should Cinder use for LVM backend
71# Defaults to default, which is thick, the other valid choice
72# is thin, which as the name implies utilizes lvm thin provisioning.
73CINDER_LVM_TYPE=${CINDER_LVM_TYPE:-default}
Dean Troyer09718332014-07-03 10:46:57 -050074
Dean Troyer09718332014-07-03 10:46:57 -050075# Default backends
76# The backend format is type:name where type is one of the supported backend
77# types (lvm, nfs, etc) and name is the identifier used in the Cinder
78# configuration and for the volume type name. Multiple backends are
79# comma-separated.
Dean Troyer311f4872014-12-18 16:31:34 -060080# The old ``CINDER_MULTI_LVM_BACKEND=True`` setting had a default of:
81# CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-lvm:lvmdriver-1,lvm:lvmdriver-2}
82CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-lvm:lvmdriver-1}
Dean Troyer09718332014-07-03 10:46:57 -050083
84
Dean Troyerb7490da2013-03-18 16:07:56 -050085# Should cinder perform secure deletion of volumes?
Joe D'Andreadfcc3872015-04-29 15:39:17 -040086# Defaults to zero. Can also be set to none or shred.
87# This was previously CINDER_SECURE_DELETE (True or False).
88# Equivalents using CINDER_VOLUME_CLEAR are zero and none, respectively.
89# Set to none to avoid this bug when testing:
Dean Troyerb7490da2013-03-18 16:07:56 -050090# https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1023755
Joe D'Andreadfcc3872015-04-29 15:39:17 -040091if [[ -n $CINDER_SECURE_DELETE ]]; then
92 CINDER_SECURE_DELETE=$(trueorfalse True CINDER_SECURE_DELETE)
93 if [[ $CINDER_SECURE_DELETE == "False" ]]; then
94 CINDER_VOLUME_CLEAR_DEFAULT="none"
95 fi
Sean Dague72ad9422015-10-07 11:51:40 -040096 deprecated "Configure secure Cinder volume deletion using CINDER_VOLUME_CLEAR instead of CINDER_SECURE_DELETE."
Joe D'Andreadfcc3872015-04-29 15:39:17 -040097fi
98CINDER_VOLUME_CLEAR=${CINDER_VOLUME_CLEAR:-${CINDER_VOLUME_CLEAR_DEFAULT:-zero}}
99CINDER_VOLUME_CLEAR=$(echo ${CINDER_VOLUME_CLEAR} | tr '[:upper:]' '[:lower:]')
Dean Troyerb7490da2013-03-18 16:07:56 -0500100
Sean Daguef35ff722013-05-16 16:31:12 -0400101# Cinder reports allocations back to the scheduler on periodic intervals
102# it turns out we can get an "out of space" issue when we run tests too
103# quickly just because cinder didn't realize we'd freed up resources.
104# Make this configurable so that devstack-gate/tempest can set it to
105# less than the 60 second default
106# https://bugs.launchpad.net/cinder/+bug/1180976
107CINDER_PERIODIC_INTERVAL=${CINDER_PERIODIC_INTERVAL:-60}
108
Attila Fazekasc70605d2015-01-26 15:44:47 +0100109CINDER_ISCSI_HELPER=${CINDER_ISCSI_HELPER:-tgtadm}
110
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300111# Toggle for deploying Cinder under HTTPD + mod_wsgi
112CINDER_USE_MOD_WSGI=${CINDER_USE_MOD_WSGI:-False}
Dean Troyercc6b4432013-04-08 15:38:03 -0500113
Dean Troyer09718332014-07-03 10:46:57 -0500114# Source the enabled backends
115if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
116 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500117 be_type=${be%%:*}
118 be_name=${be##*:}
119 if [[ -r $CINDER_BACKENDS/${be_type} ]]; then
120 source $CINDER_BACKENDS/${be_type}
Dean Troyer09718332014-07-03 10:46:57 -0500121 fi
122 done
123fi
124
git-harryafc14232015-01-08 17:37:40 +0000125# Change the default nova_catalog_info and nova_catalog_admin_info values in
126# cinder so that the service name cinder is searching for matches that set for
127# nova in keystone.
128CINDER_NOVA_CATALOG_INFO=${CINDER_NOVA_CATALOG_INFO:-compute:nova:publicURL}
129CINDER_NOVA_CATALOG_ADMIN_INFO=${CINDER_NOVA_CATALOG_ADMIN_INFO:-compute:nova:adminURL}
130
Dean Troyer09718332014-07-03 10:46:57 -0500131
Dean Troyercc6b4432013-04-08 15:38:03 -0500132# Functions
133# ---------
Dean Troyere4fa7212014-01-15 15:04:49 -0600134
135# Test if any Cinder services are enabled
136# is_cinder_enabled
137function is_cinder_enabled {
138 [[ ,${ENABLED_SERVICES} =~ ,"c-" ]] && return 0
139 return 1
140}
141
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300142# _cinder_cleanup_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
143function _cinder_cleanup_apache_wsgi {
144 sudo rm -f $(apache_site_config_for osapi-volume)
145}
146
Dean Troyer67787e62012-05-02 11:48:15 -0500147# cleanup_cinder() - Remove residual data files, anything left over from previous
148# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100149function cleanup_cinder {
Sean Dague252f2f52012-12-20 16:41:57 -0500150 # ensure the volume group is cleared up because fails might
151 # leave dead volumes in the group
Attila Fazekasc70605d2015-01-26 15:44:47 +0100152 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
Ian Wienandada886d2015-10-07 14:06:26 +1100153 local targets
154 targets=$(sudo tgtadm --op show --mode target)
Attila Fazekasc70605d2015-01-26 15:44:47 +0100155 if [ $? -ne 0 ]; then
156 # If tgt driver isn't running this won't work obviously
157 # So check the response and restart if need be
158 echo "tgtd seems to be in a bad state, restarting..."
159 if is_ubuntu; then
160 restart_service tgt
161 else
162 restart_service tgtd
163 fi
164 targets=$(sudo tgtadm --op show --mode target)
Sean Dague252f2f52012-12-20 16:41:57 -0500165 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500166
Attila Fazekasc70605d2015-01-26 15:44:47 +0100167 if [[ -n "$targets" ]]; then
168 local iqn_list=( $(grep --no-filename -r iqn $SCSI_PERSIST_DIR | sed 's/<target //' | sed 's/>//') )
169 for i in "${iqn_list[@]}"; do
170 echo removing iSCSI target: $i
171 sudo tgt-admin --delete $i
172 done
173 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500174
Attila Fazekasc70605d2015-01-26 15:44:47 +0100175 if is_ubuntu; then
176 stop_service tgt
177 else
178 stop_service tgtd
179 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500180 else
Attila Fazekasc70605d2015-01-26 15:44:47 +0100181 sudo cinder-rtstool get-targets | sudo xargs -rn 1 cinder-rtstool delete
Sean Dague252f2f52012-12-20 16:41:57 -0500182 fi
183
Dean Troyer09718332014-07-03 10:46:57 -0500184 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500185 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500186 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500187 be_type=${be%%:*}
188 be_name=${be##*:}
189 if type cleanup_cinder_backend_${be_type} >/dev/null 2>&1; then
190 cleanup_cinder_backend_${be_type} ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500191 fi
192 done
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100193 fi
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300194
195 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
196 _cinder_cleanup_apache_wsgi
197 fi
198}
199
200# _cinder_config_apache_wsgi() - Set WSGI config files
201function _cinder_config_apache_wsgi {
Ian Wienandada886d2015-10-07 14:06:26 +1100202 local cinder_apache_conf
203 cinder_apache_conf=$(apache_site_config_for osapi-volume)
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300204 local cinder_ssl=""
205 local cinder_certfile=""
206 local cinder_keyfile=""
207 local cinder_api_port=$CINDER_SERVICE_PORT
208 local venv_path=""
209
210 if is_ssl_enabled_service c-api; then
211 cinder_ssl="SSLEngine On"
212 cinder_certfile="SSLCertificateFile $CINDER_SSL_CERT"
213 cinder_keyfile="SSLCertificateKeyFile $CINDER_SSL_KEY"
214 fi
215 if [[ ${USE_VENV} = True ]]; then
216 venv_path="python-path=${PROJECT_VENV["cinder"]}/lib/python2.7/site-packages"
217 fi
218
219 # copy proxy vhost file
220 sudo cp $FILES/apache-cinder-api.template $cinder_apache_conf
221 sudo sed -e "
222 s|%PUBLICPORT%|$cinder_api_port|g;
223 s|%APACHE_NAME%|$APACHE_NAME|g;
224 s|%APIWORKERS%|$API_WORKERS|g
225 s|%CINDER_BIN_DIR%|$CINDER_BIN_DIR|g;
226 s|%SSLENGINE%|$cinder_ssl|g;
227 s|%SSLCERTFILE%|$cinder_certfile|g;
228 s|%SSLKEYFILE%|$cinder_keyfile|g;
229 s|%USER%|$STACK_USER|g;
230 s|%VIRTUALENV%|$venv_path|g
231 " -i $cinder_apache_conf
Dean Troyer67787e62012-05-02 11:48:15 -0500232}
233
Thierry Carrez63e17842014-01-10 14:23:03 +0100234# configure_cinder() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100235function configure_cinder {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500236 sudo install -d -o $STACK_USER -m 755 $CINDER_CONF_DIR
Thierry Carrez63e17842014-01-10 14:23:03 +0100237
238 cp -p $CINDER_DIR/etc/cinder/policy.json $CINDER_CONF_DIR
239
Yalei Wangcecbd1f2015-01-05 17:05:47 +0800240 rm -f $CINDER_CONF
241
Ian Wienandc6782412015-05-14 10:01:53 +1000242 configure_rootwrap cinder
John Griffith4e823ff2012-07-20 13:18:17 -0600243
Dean Troyer67787e62012-05-02 11:48:15 -0500244 cp $CINDER_DIR/etc/cinder/api-paste.ini $CINDER_API_PASTE_INI
Dan Prince82dea7c2013-10-16 18:57:15 -0400245
246 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_host
247 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_port
248 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_protocol
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000249 inicomment $CINDER_API_PASTE_INI filter:authtoken cafile
Dan Prince82dea7c2013-10-16 18:57:15 -0400250 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_tenant_name
251 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_user
252 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_password
253 inicomment $CINDER_API_PASTE_INI filter:authtoken signing_dir
Dean Troyerbc071bc2012-10-01 14:06:44 -0500254
Brant Knudson05952372014-09-19 17:22:22 -0500255 configure_auth_token_middleware $CINDER_CONF cinder $CINDER_AUTH_CACHE_DIR
Dan Prince82dea7c2013-10-16 18:57:15 -0400256
git-harryafc14232015-01-08 17:37:40 +0000257 iniset $CINDER_CONF DEFAULT nova_catalog_info $CINDER_NOVA_CATALOG_INFO
258 iniset $CINDER_CONF DEFAULT nova_catalog_admin_info $CINDER_NOVA_CATALOG_ADMIN_INFO
259
Dean Troyer67787e62012-05-02 11:48:15 -0500260 iniset $CINDER_CONF DEFAULT auth_strategy keystone
Ben Nemec03997942013-08-10 09:56:16 -0500261 iniset $CINDER_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Dean Troyer09718332014-07-03 10:46:57 -0500262
Attila Fazekasc70605d2015-01-26 15:44:47 +0100263 iniset $CINDER_CONF DEFAULT iscsi_helper "$CINDER_ISCSI_HELPER"
Joe Gordon23d6d502015-03-06 15:24:22 -0800264 iniset $CINDER_CONF database connection `database_connection_url cinder`
Dean Troyer67787e62012-05-02 11:48:15 -0500265 iniset $CINDER_CONF DEFAULT api_paste_config $CINDER_API_PASTE_INI
Joe Gordona58382a2013-02-20 12:45:02 -0800266 iniset $CINDER_CONF DEFAULT rootwrap_config "$CINDER_CONF_DIR/rootwrap.conf"
Dan Prince9f22f072013-01-28 09:53:38 -0500267 iniset $CINDER_CONF DEFAULT osapi_volume_extension cinder.api.contrib.standard_extensions
Brian Haley180f5eb2015-06-16 13:14:31 -0400268 iniset $CINDER_CONF DEFAULT osapi_volume_listen $CINDER_SERVICE_LISTEN_ADDRESS
Dean Troyer50ac7922012-09-13 14:02:01 -0500269 iniset $CINDER_CONF DEFAULT state_path $CINDER_STATE_PATH
Joe Gordon23d6d502015-03-06 15:24:22 -0800270 iniset $CINDER_CONF oslo_concurrency lock_path $CINDER_STATE_PATH
Sean Daguef35ff722013-05-16 16:31:12 -0400271 iniset $CINDER_CONF DEFAULT periodic_interval $CINDER_PERIODIC_INTERVAL
John Griffith4e823ff2012-07-20 13:18:17 -0600272
Ethan Lynn679f3952015-03-09 23:45:18 +0800273 iniset $CINDER_CONF DEFAULT os_region_name "$REGION_NAME"
274
Angus Lees8a6d7672016-02-15 10:53:20 +1100275 iniset $CINDER_CONF privsep_osbrick helper_command "sudo cinder-rootwrap \$rootwrap_config privsep-helper --config-file $CINDER_CONF"
276
Dean Troyer09718332014-07-03 10:46:57 -0500277 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500278 local enabled_backends=""
279 local default_name=""
280 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500281 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500282 be_type=${be%%:*}
283 be_name=${be##*:}
284 if type configure_cinder_backend_${be_type} >/dev/null 2>&1; then
285 configure_cinder_backend_${be_type} ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500286 fi
Dean Troyera25922b2014-08-28 09:29:47 -0500287 if [[ -z "$default_name" ]]; then
288 default_name=$be_name
Dean Troyer09718332014-07-03 10:46:57 -0500289 fi
Dean Troyere8a35ac2014-07-25 12:37:41 -0500290 enabled_backends+=$be_name,
Dean Troyer09718332014-07-03 10:46:57 -0500291 done
292 iniset $CINDER_CONF DEFAULT enabled_backends ${enabled_backends%,*}
Matt Riedemann6a4aa782014-07-25 13:35:53 -0700293 if [[ -n "$default_name" ]]; then
294 iniset $CINDER_CONF DEFAULT default_volume_type ${default_name}
Dean Troyer09718332014-07-03 10:46:57 -0500295 fi
296 fi
297
Attila Fazekas29834742014-03-09 18:36:42 +0100298 if is_service_enabled swift; then
Falk Reimann22f747b2015-08-28 12:40:19 +0200299 iniset $CINDER_CONF DEFAULT backup_swift_url "$SWIFT_SERVICE_PROTOCOL://$SERVICE_HOST:$SWIFT_DEFAULT_BIND_PORT/v1/AUTH_"
Attila Fazekas29834742014-03-09 18:36:42 +0100300 fi
301
Gordon Chung2bfbc772013-08-09 10:55:12 -0400302 if is_service_enabled ceilometer; then
Wanlong Gaocf04a9a2016-01-16 17:46:35 +0800303 iniset $CINDER_CONF oslo_messaging_notifications driver "messaging"
Gordon Chung2bfbc772013-08-09 10:55:12 -0400304 fi
305
Dean Troyer560346b2012-12-13 17:05:24 -0600306 if is_service_enabled tls-proxy; then
307 # Set the service port for a proxy to take the original
308 iniset $CINDER_CONF DEFAULT osapi_volume_listen_port $CINDER_SERVICE_PORT_INT
Rob Crittendencdba7b02015-05-26 15:33:45 -0400309
310 iniset $CINDER_CONF DEFAULT public_endpoint $CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT
Dean Troyer560346b2012-12-13 17:05:24 -0600311 fi
312
Dean Troyer4d3049e2012-11-06 20:38:14 -0600313 if [ "$SYSLOG" != "False" ]; then
314 iniset $CINDER_CONF DEFAULT use_syslog True
315 fi
316
Brant Knudson2dd110c2015-03-14 12:39:14 -0500317 iniset_rpc_backend cinder $CINDER_CONF
Gary Kottonf71bf192012-08-06 11:15:36 -0400318
Matt Riedemanncdcdeb62015-10-29 09:48:17 -0700319 iniset $CINDER_CONF DEFAULT volume_clear $CINDER_VOLUME_CLEAR
James E. Blair213c4162012-11-06 09:38:36 +0100320
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700321 # Format logging
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300322 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && [ "$CINDER_USE_MOD_WSGI" == "False" ]; then
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700323 setup_colorized_logging $CINDER_CONF DEFAULT "project_id" "user_id"
John Griffith95b994d2015-04-18 11:20:15 -0600324 else
325 # Set req-id, project-name and resource in log format
326 iniset $CINDER_CONF DEFAULT logging_context_format_string "%(asctime)s.%(msecs)03d %(levelname)s %(name)s [%(request_id)s %(project_name)s] %(resource)s%(message)s"
Chmouel Boudjnah1057bff2012-08-03 11:42:51 +0000327 fi
Mate Lakatb2fdafe2012-11-20 15:52:21 +0000328
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300329 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
330 _cinder_config_apache_wsgi
331 fi
332
john-griffithd0860cc2014-01-23 11:31:10 -0700333 if [[ -r $CINDER_PLUGINS/$CINDER_DRIVER ]]; then
334 configure_cinder_driver
Mate Lakatb2fdafe2012-11-20 15:52:21 +0000335 fi
Ian Wienand0db17132013-06-26 22:31:48 +1000336
Dean Troyer05bd7b82014-09-16 17:25:33 -0500337 iniset $CINDER_CONF DEFAULT osapi_volume_workers "$API_WORKERS"
Rob Crittenden18d47782014-03-19 17:47:42 -0400338
339 iniset $CINDER_CONF DEFAULT glance_api_servers "${GLANCE_SERVICE_PROTOCOL}://${GLANCE_HOSTPORT}"
340 if is_ssl_enabled_service glance || is_service_enabled tls-proxy; then
341 iniset $CINDER_CONF DEFAULT glance_protocol https
Rob Crittenden4b109292014-10-21 18:17:48 -0400342 iniset $CINDER_CONF DEFAULT glance_ca_certificates_file $SSL_BUNDLE_FILE
Rob Crittenden18d47782014-03-19 17:47:42 -0400343 fi
344
345 # Register SSL certificates if provided
346 if is_ssl_enabled_service cinder; then
347 ensure_certificates CINDER
348
349 iniset $CINDER_CONF DEFAULT ssl_cert_file "$CINDER_SSL_CERT"
350 iniset $CINDER_CONF DEFAULT ssl_key_file "$CINDER_SSL_KEY"
351 fi
352
Jordan Pittier38bee182015-05-11 16:51:10 +0200353 # Set os_privileged_user credentials (used for os-assisted-snapshots)
354 iniset $CINDER_CONF DEFAULT os_privileged_user_name nova
355 iniset $CINDER_CONF DEFAULT os_privileged_user_password "$SERVICE_PASSWORD"
Sean Dague7580a0c2016-02-17 06:23:36 -0500356 iniset $CINDER_CONF DEFAULT os_privileged_user_tenant "$SERVICE_PROJECT_NAME"
Marian Horban7159b4b2015-10-22 15:47:49 -0400357 iniset $CINDER_CONF DEFAULT graceful_shutdown_timeout "$SERVICE_GRACEFUL_SHUTDOWN_TIMEOUT"
Dean Troyer67787e62012-05-02 11:48:15 -0500358}
359
Dean Troyer671c16e2012-12-13 16:22:38 -0600360# create_cinder_accounts() - Set up common required cinder accounts
361
362# Tenant User Roles
363# ------------------------------------------------------------------
364# service cinder admin # if enabled
365
366# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100367function create_cinder_accounts {
Dean Troyer671c16e2012-12-13 16:22:38 -0600368
Dean Troyer671c16e2012-12-13 16:22:38 -0600369 # Cinder
370 if [[ "$ENABLED_SERVICES" =~ "c-api" ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100371
Jamie Lennoxe8bc2b82015-02-10 20:38:56 +1100372 create_service_user "cinder"
Bartosz Górski0abde392014-02-28 14:15:19 +0100373
Sean Dague985e9582016-02-10 07:25:24 -0500374 get_or_create_service "cinder" "volume" "Cinder Volume Service"
375 get_or_create_endpoint \
376 "volume" \
377 "$REGION_NAME" \
Sean Dagueab0a1b82016-04-04 09:09:27 -0400378 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(project_id)s" \
379 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(project_id)s" \
380 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(project_id)s"
Bartosz Górski0abde392014-02-28 14:15:19 +0100381
Sean Dague985e9582016-02-10 07:25:24 -0500382 get_or_create_service "cinderv2" "volumev2" "Cinder Volume Service V2"
383 get_or_create_endpoint \
384 "volumev2" \
385 "$REGION_NAME" \
Sean Dagueab0a1b82016-04-04 09:09:27 -0400386 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(project_id)s" \
387 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(project_id)s" \
388 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(project_id)s"
Dean Troyer671c16e2012-12-13 16:22:38 -0600389 fi
390}
391
Dean Troyerf03bafe2013-02-12 10:58:28 -0600392# create_cinder_cache_dir() - Part of the init_cinder() process
Ian Wienandaee18c72014-02-21 15:35:08 +1100393function create_cinder_cache_dir {
Dean Troyerf03bafe2013-02-12 10:58:28 -0600394 # Create cache dir
Dean Troyer8421c2b2015-03-16 13:52:19 -0500395 sudo install -d -o $STACK_USER $CINDER_AUTH_CACHE_DIR
Dean Troyerf03bafe2013-02-12 10:58:28 -0600396 rm -f $CINDER_AUTH_CACHE_DIR/*
397}
398
Dean Troyer67787e62012-05-02 11:48:15 -0500399# init_cinder() - Initialize database and volume group
Dean Troyere8a35ac2014-07-25 12:37:41 -0500400# Uses global ``NOVA_ENABLED_APIS``
Ian Wienandaee18c72014-02-21 15:35:08 +1100401function init_cinder {
Dean Troyer67787e62012-05-02 11:48:15 -0500402 # Force nova volumes off
403 NOVA_ENABLED_APIS=$(echo $NOVA_ENABLED_APIS | sed "s/osapi_volume,//")
404
Terry Wilson428af5a2012-11-01 16:12:39 -0400405 if is_service_enabled $DATABASE_BACKENDS; then
Dean Troyerf03bafe2013-02-12 10:58:28 -0600406 # (Re)create cinder database
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +0200407 recreate_database cinder
Dean Troyer67787e62012-05-02 11:48:15 -0500408
Dean Troyerf03bafe2013-02-12 10:58:28 -0600409 # Migrate cinder database
Monty Taylor9fbeedd2012-08-17 12:52:27 -0400410 $CINDER_BIN_DIR/cinder-manage db sync
Dean Troyer67787e62012-05-02 11:48:15 -0500411 fi
412
Dean Troyer09718332014-07-03 10:46:57 -0500413 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500414 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500415 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500416 be_type=${be%%:*}
417 be_name=${be##*:}
418 if type init_cinder_backend_${be_type} >/dev/null 2>&1; then
Maru Newbyc070a3d2015-01-27 17:44:44 +0000419 # Always init the default volume group for lvm.
420 if [[ "$be_type" == "lvm" ]]; then
421 init_default_lvm_volume_group
422 fi
Dean Troyere8a35ac2014-07-25 12:37:41 -0500423 init_cinder_backend_${be_type} ${be_name}
Vincent Untz0230aa82012-06-14 08:51:01 +0200424 fi
Dean Troyer09718332014-07-03 10:46:57 -0500425 done
Dean Troyer67787e62012-05-02 11:48:15 -0500426 fi
Dean Troyerbc071bc2012-10-01 14:06:44 -0500427
Dean Troyer09718332014-07-03 10:46:57 -0500428 mkdir -p $CINDER_STATE_PATH/volumes
Dean Troyerf03bafe2013-02-12 10:58:28 -0600429 create_cinder_cache_dir
Dean Troyer67787e62012-05-02 11:48:15 -0500430}
431
432# install_cinder() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100433function install_cinder {
Ramy Asselin10e1fd42015-06-04 12:12:15 -0700434 # Install os-brick from git so we make sure we're testing
435 # the latest code.
436 if use_library_from_git "os-brick"; then
437 git_clone_by_name "os-brick"
438 setup_dev_lib "os-brick"
439 fi
440
Dean Troyer67787e62012-05-02 11:48:15 -0500441 git_clone $CINDER_REPO $CINDER_DIR $CINDER_BRANCH
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400442 setup_develop $CINDER_DIR
Attila Fazekasc70605d2015-01-26 15:44:47 +0100443 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
444 if is_fedora; then
445 install_package scsi-target-utils
446 else
447 install_package tgt
448 fi
449 fi
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300450
451 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
452 install_apache_wsgi
453 if is_ssl_enabled_service "c-api"; then
454 enable_mod_ssl
455 fi
456 fi
Dean Troyer253a1a32013-04-01 18:23:22 -0500457}
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400458
Dean Troyer253a1a32013-04-01 18:23:22 -0500459# install_cinderclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100460function install_cinderclient {
Sean Daguee08ab102014-11-13 17:09:28 -0500461 if use_library_from_git "python-cinderclient"; then
462 git_clone_by_name "python-cinderclient"
463 setup_dev_lib "python-cinderclient"
464 sudo install -D -m 0644 -o $STACK_USER {${GITDIR["python-cinderclient"]}/tools/,/etc/bash_completion.d/}cinder.bash_completion
Sean Dague5cb19062014-11-01 01:37:45 +0100465 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500466}
467
Steve Baker18225d92013-04-14 12:48:41 -0700468# apply config.d approach for cinder volumes directory
Ian Wienandaee18c72014-02-21 15:35:08 +1100469function _configure_tgt_for_config_d {
Steve Baker18225d92013-04-14 12:48:41 -0700470 if [[ ! -d /etc/tgt/stack.d/ ]]; then
471 sudo ln -sf $CINDER_STATE_PATH/volumes /etc/tgt/stack.d
Jordan Pittiera263e7d2016-01-07 19:40:44 +0100472 fi
473 if ! grep -q "include /etc/tgt/stack.d/*" /etc/tgt/targets.conf; then
Steve Baker18225d92013-04-14 12:48:41 -0700474 echo "include /etc/tgt/stack.d/*" | sudo tee -a /etc/tgt/targets.conf
Mate Lakata39caac2012-09-03 15:45:53 +0100475 fi
476}
477
Dean Troyer67787e62012-05-02 11:48:15 -0500478# start_cinder() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100479function start_cinder {
Rob Crittenden18d47782014-03-19 17:47:42 -0400480 local service_port=$CINDER_SERVICE_PORT
481 local service_protocol=$CINDER_SERVICE_PROTOCOL
482 if is_service_enabled tls-proxy; then
483 service_port=$CINDER_SERVICE_PORT_INT
484 service_protocol="http"
485 fi
Attila Fazekasc70605d2015-01-26 15:44:47 +0100486 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
487 if is_service_enabled c-vol; then
488 # Delete any old stack.conf
489 sudo rm -f /etc/tgt/conf.d/stack.conf
490 _configure_tgt_for_config_d
491 if is_ubuntu; then
492 sudo service tgt restart
Dirk Mueller6bc089f2015-06-01 12:39:12 +0200493 elif is_suse; then
494 # NOTE(dmllr): workaround restart bug
495 # https://bugzilla.suse.com/show_bug.cgi?id=934642
496 stop_service tgtd
497 start_service tgtd
Attila Fazekasc70605d2015-01-26 15:44:47 +0100498 else
Dirk Mueller6bc089f2015-06-01 12:39:12 +0200499 restart_service tgtd
Attila Fazekasc70605d2015-01-26 15:44:47 +0100500 fi
501 # NOTE(gfidente): ensure tgtd is running in debug mode
502 sudo tgtadm --mode system --op update --name debug --value on
Dean Troyer67787e62012-05-02 11:48:15 -0500503 fi
504 fi
505
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300506 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
507 enable_apache_site osapi-volume
508 restart_apache_server
509 tail_log c-api /var/log/$APACHE_NAME/c-api.log
510 else
511 run_process c-api "$CINDER_BIN_DIR/cinder-api --config-file $CINDER_CONF"
512 echo "Waiting for Cinder API to start..."
513 if ! wait_for_service $SERVICE_TIMEOUT $service_protocol://$CINDER_SERVICE_HOST:$service_port; then
514 die $LINENO "c-api did not start"
515 fi
Dean Troyer09718332014-07-03 10:46:57 -0500516 fi
517
Dean Troyer3159a822014-08-27 14:13:58 -0500518 run_process c-sch "$CINDER_BIN_DIR/cinder-scheduler --config-file $CINDER_CONF"
519 run_process c-bak "$CINDER_BIN_DIR/cinder-backup --config-file $CINDER_CONF"
520 run_process c-vol "$CINDER_BIN_DIR/cinder-volume --config-file $CINDER_CONF"
John Griffithe6d4fe52013-07-15 17:35:54 -0600521
522 # NOTE(jdg): For cinder, startup order matters. To ensure that repor_capabilities is received
523 # by the scheduler start the cinder-volume service last (or restart it) after the scheduler
524 # has started. This is a quick fix for lp bug/1189595
Dean Troyer560346b2012-12-13 17:05:24 -0600525
526 # Start proxies if enabled
527 if is_service_enabled c-api && is_service_enabled tls-proxy; then
528 start_tls_proxy '*' $CINDER_SERVICE_PORT $CINDER_SERVICE_HOST $CINDER_SERVICE_PORT_INT &
529 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500530}
531
Dean Troyer699a29f2012-09-10 14:10:27 -0500532# stop_cinder() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100533function stop_cinder {
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300534 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
535 disable_apache_site osapi-volume
536 restart_apache_server
537 else
538 stop_process c-api
539 fi
540
Dean Troyer699a29f2012-09-10 14:10:27 -0500541 # Kill the cinder screen windows
Dean Troyere8a35ac2014-07-25 12:37:41 -0500542 local serv
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300543 for serv in c-bak c-sch c-vol; do
Chris Dent2f27a0e2014-09-09 13:46:02 +0100544 stop_process $serv
Dean Troyer699a29f2012-09-10 14:10:27 -0500545 done
Dean Troyer67787e62012-05-02 11:48:15 -0500546}
Dean Troyer7903b792012-09-13 17:16:12 -0500547
Dean Troyer09718332014-07-03 10:46:57 -0500548# create_volume_types() - Create Cinder's configured volume types
549function create_volume_types {
550 # Create volume types
551 if is_service_enabled c-api && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Jamie Lennox494f7cd2015-05-29 08:33:03 +0000552 local be be_name
Dean Troyer09718332014-07-03 10:46:57 -0500553 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500554 be_name=${be##*:}
Sean McGinnis357dff52015-12-11 13:51:24 -0600555 openstack volume type create --property volume_backend_name="${be_name}" ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500556 done
557 fi
558}
559
560# Compatibility for Grenade
561
562function create_cinder_volume_group {
563 # During a transition period Grenade needs to have this function defined
564 # It is effectively a no-op in the Grenade 'target' use case
565 :
566}
567
Dean Troyercc6b4432013-04-08 15:38:03 -0500568
Dean Troyer7903b792012-09-13 17:16:12 -0500569# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100570$_XTRACE_CINDER
Sean Dague584d90e2013-03-29 14:34:53 -0400571
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100572# Tell emacs to use shell-script-mode
573## Local variables:
574## mode: shell-script
575## End: