blob: bcf240953b56b8e84b07eb737caddb87bd154d92 [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
Ivan Kolodyazhny8d0d3112016-05-26 23:41:49 +030043GITDIR["python-brick-cinderclient-ext"]=$DEST/python-brick-cinderclient-ext
Dean Troyer67787e62012-05-02 11:48:15 -050044CINDER_DIR=$DEST/cinder
Dean Troyer6aaad5f2015-02-18 07:09:04 -060045
46# Cinder virtual environment
47if [[ ${USE_VENV} = True ]]; then
48 PROJECT_VENV["cinder"]=${CINDER_DIR}.venv
49 CINDER_BIN_DIR=${PROJECT_VENV["cinder"]}/bin
50else
51 CINDER_BIN_DIR=$(get_python_exec_prefix)
52fi
53
Dean Troyer50ac7922012-09-13 14:02:01 -050054CINDER_STATE_PATH=${CINDER_STATE_PATH:=$DATA_DIR/cinder}
Dean Troyer671c16e2012-12-13 16:22:38 -060055CINDER_AUTH_CACHE_DIR=${CINDER_AUTH_CACHE_DIR:-/var/cache/cinder}
56
Dean Troyer50ac7922012-09-13 14:02:01 -050057CINDER_CONF_DIR=/etc/cinder
58CINDER_CONF=$CINDER_CONF_DIR/cinder.conf
Dean Troyer671c16e2012-12-13 16:22:38 -060059CINDER_API_PASTE_INI=$CINDER_CONF_DIR/api-paste.ini
Dean Troyer50ac7922012-09-13 14:02:01 -050060
Dean Troyer560346b2012-12-13 17:05:24 -060061# Public facing bits
Rob Crittenden18d47782014-03-19 17:47:42 -040062if is_ssl_enabled_service "cinder" || is_service_enabled tls-proxy; then
63 CINDER_SERVICE_PROTOCOL="https"
64fi
Dean Troyer560346b2012-12-13 17:05:24 -060065CINDER_SERVICE_HOST=${CINDER_SERVICE_HOST:-$SERVICE_HOST}
66CINDER_SERVICE_PORT=${CINDER_SERVICE_PORT:-8776}
67CINDER_SERVICE_PORT_INT=${CINDER_SERVICE_PORT_INT:-18776}
68CINDER_SERVICE_PROTOCOL=${CINDER_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Brian Haley180f5eb2015-06-16 13:14:31 -040069CINDER_SERVICE_LISTEN_ADDRESS=${CINDER_SERVICE_LISTEN_ADDRESS:-$SERVICE_LISTEN_ADDRESS}
Dean Troyer560346b2012-12-13 17:05:24 -060070
John Griffithce8e6f62015-05-12 17:28:59 -060071# What type of LVM device should Cinder use for LVM backend
72# Defaults to default, which is thick, the other valid choice
73# is thin, which as the name implies utilizes lvm thin provisioning.
74CINDER_LVM_TYPE=${CINDER_LVM_TYPE:-default}
Dean Troyer09718332014-07-03 10:46:57 -050075
Dean Troyer09718332014-07-03 10:46:57 -050076# Default backends
77# The backend format is type:name where type is one of the supported backend
78# types (lvm, nfs, etc) and name is the identifier used in the Cinder
79# configuration and for the volume type name. Multiple backends are
80# comma-separated.
Dean Troyer311f4872014-12-18 16:31:34 -060081# The old ``CINDER_MULTI_LVM_BACKEND=True`` setting had a default of:
82# CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-lvm:lvmdriver-1,lvm:lvmdriver-2}
83CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-lvm:lvmdriver-1}
Dean Troyer09718332014-07-03 10:46:57 -050084
85
Dean Troyerb7490da2013-03-18 16:07:56 -050086# Should cinder perform secure deletion of volumes?
Joe D'Andreadfcc3872015-04-29 15:39:17 -040087# Defaults to zero. Can also be set to none or shred.
88# This was previously CINDER_SECURE_DELETE (True or False).
89# Equivalents using CINDER_VOLUME_CLEAR are zero and none, respectively.
90# Set to none to avoid this bug when testing:
Dean Troyerb7490da2013-03-18 16:07:56 -050091# https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1023755
Joe D'Andreadfcc3872015-04-29 15:39:17 -040092if [[ -n $CINDER_SECURE_DELETE ]]; then
93 CINDER_SECURE_DELETE=$(trueorfalse True CINDER_SECURE_DELETE)
94 if [[ $CINDER_SECURE_DELETE == "False" ]]; then
95 CINDER_VOLUME_CLEAR_DEFAULT="none"
96 fi
Sean Dague72ad9422015-10-07 11:51:40 -040097 deprecated "Configure secure Cinder volume deletion using CINDER_VOLUME_CLEAR instead of CINDER_SECURE_DELETE."
Joe D'Andreadfcc3872015-04-29 15:39:17 -040098fi
99CINDER_VOLUME_CLEAR=${CINDER_VOLUME_CLEAR:-${CINDER_VOLUME_CLEAR_DEFAULT:-zero}}
100CINDER_VOLUME_CLEAR=$(echo ${CINDER_VOLUME_CLEAR} | tr '[:upper:]' '[:lower:]')
Dean Troyerb7490da2013-03-18 16:07:56 -0500101
Sean Daguef35ff722013-05-16 16:31:12 -0400102# Cinder reports allocations back to the scheduler on periodic intervals
103# it turns out we can get an "out of space" issue when we run tests too
104# quickly just because cinder didn't realize we'd freed up resources.
105# Make this configurable so that devstack-gate/tempest can set it to
106# less than the 60 second default
107# https://bugs.launchpad.net/cinder/+bug/1180976
108CINDER_PERIODIC_INTERVAL=${CINDER_PERIODIC_INTERVAL:-60}
109
Attila Fazekasc70605d2015-01-26 15:44:47 +0100110CINDER_ISCSI_HELPER=${CINDER_ISCSI_HELPER:-tgtadm}
111
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300112# Toggle for deploying Cinder under HTTPD + mod_wsgi
113CINDER_USE_MOD_WSGI=${CINDER_USE_MOD_WSGI:-False}
Dean Troyercc6b4432013-04-08 15:38:03 -0500114
Dean Troyer09718332014-07-03 10:46:57 -0500115# Source the enabled backends
116if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
117 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500118 be_type=${be%%:*}
119 be_name=${be##*:}
120 if [[ -r $CINDER_BACKENDS/${be_type} ]]; then
121 source $CINDER_BACKENDS/${be_type}
Dean Troyer09718332014-07-03 10:46:57 -0500122 fi
123 done
124fi
125
git-harryafc14232015-01-08 17:37:40 +0000126# Change the default nova_catalog_info and nova_catalog_admin_info values in
127# cinder so that the service name cinder is searching for matches that set for
128# nova in keystone.
129CINDER_NOVA_CATALOG_INFO=${CINDER_NOVA_CATALOG_INFO:-compute:nova:publicURL}
130CINDER_NOVA_CATALOG_ADMIN_INFO=${CINDER_NOVA_CATALOG_ADMIN_INFO:-compute:nova:adminURL}
131
Dean Troyer09718332014-07-03 10:46:57 -0500132
Dean Troyercc6b4432013-04-08 15:38:03 -0500133# Functions
134# ---------
Dean Troyere4fa7212014-01-15 15:04:49 -0600135
136# Test if any Cinder services are enabled
137# is_cinder_enabled
138function is_cinder_enabled {
139 [[ ,${ENABLED_SERVICES} =~ ,"c-" ]] && return 0
140 return 1
141}
142
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300143# _cinder_cleanup_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
144function _cinder_cleanup_apache_wsgi {
145 sudo rm -f $(apache_site_config_for osapi-volume)
146}
147
Dean Troyer67787e62012-05-02 11:48:15 -0500148# cleanup_cinder() - Remove residual data files, anything left over from previous
149# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100150function cleanup_cinder {
Sean Dague252f2f52012-12-20 16:41:57 -0500151 # ensure the volume group is cleared up because fails might
152 # leave dead volumes in the group
Attila Fazekasc70605d2015-01-26 15:44:47 +0100153 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
Ian Wienandada886d2015-10-07 14:06:26 +1100154 local targets
155 targets=$(sudo tgtadm --op show --mode target)
Attila Fazekasc70605d2015-01-26 15:44:47 +0100156 if [ $? -ne 0 ]; then
157 # If tgt driver isn't running this won't work obviously
158 # So check the response and restart if need be
159 echo "tgtd seems to be in a bad state, restarting..."
160 if is_ubuntu; then
161 restart_service tgt
162 else
163 restart_service tgtd
164 fi
165 targets=$(sudo tgtadm --op show --mode target)
Sean Dague252f2f52012-12-20 16:41:57 -0500166 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500167
Attila Fazekasc70605d2015-01-26 15:44:47 +0100168 if [[ -n "$targets" ]]; then
169 local iqn_list=( $(grep --no-filename -r iqn $SCSI_PERSIST_DIR | sed 's/<target //' | sed 's/>//') )
170 for i in "${iqn_list[@]}"; do
171 echo removing iSCSI target: $i
172 sudo tgt-admin --delete $i
173 done
174 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500175
Attila Fazekasc70605d2015-01-26 15:44:47 +0100176 if is_ubuntu; then
177 stop_service tgt
178 else
179 stop_service tgtd
180 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500181 else
Attila Fazekasc70605d2015-01-26 15:44:47 +0100182 sudo cinder-rtstool get-targets | sudo xargs -rn 1 cinder-rtstool delete
Sean Dague252f2f52012-12-20 16:41:57 -0500183 fi
184
Dean Troyer09718332014-07-03 10:46:57 -0500185 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500186 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500187 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500188 be_type=${be%%:*}
189 be_name=${be##*:}
190 if type cleanup_cinder_backend_${be_type} >/dev/null 2>&1; then
191 cleanup_cinder_backend_${be_type} ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500192 fi
193 done
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100194 fi
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300195
196 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
197 _cinder_cleanup_apache_wsgi
198 fi
199}
200
201# _cinder_config_apache_wsgi() - Set WSGI config files
202function _cinder_config_apache_wsgi {
Ian Wienandada886d2015-10-07 14:06:26 +1100203 local cinder_apache_conf
204 cinder_apache_conf=$(apache_site_config_for osapi-volume)
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300205 local cinder_ssl=""
206 local cinder_certfile=""
207 local cinder_keyfile=""
208 local cinder_api_port=$CINDER_SERVICE_PORT
209 local venv_path=""
210
211 if is_ssl_enabled_service c-api; then
212 cinder_ssl="SSLEngine On"
213 cinder_certfile="SSLCertificateFile $CINDER_SSL_CERT"
214 cinder_keyfile="SSLCertificateKeyFile $CINDER_SSL_KEY"
215 fi
216 if [[ ${USE_VENV} = True ]]; then
217 venv_path="python-path=${PROJECT_VENV["cinder"]}/lib/python2.7/site-packages"
218 fi
219
220 # copy proxy vhost file
221 sudo cp $FILES/apache-cinder-api.template $cinder_apache_conf
222 sudo sed -e "
223 s|%PUBLICPORT%|$cinder_api_port|g;
224 s|%APACHE_NAME%|$APACHE_NAME|g;
225 s|%APIWORKERS%|$API_WORKERS|g
226 s|%CINDER_BIN_DIR%|$CINDER_BIN_DIR|g;
227 s|%SSLENGINE%|$cinder_ssl|g;
228 s|%SSLCERTFILE%|$cinder_certfile|g;
229 s|%SSLKEYFILE%|$cinder_keyfile|g;
230 s|%USER%|$STACK_USER|g;
231 s|%VIRTUALENV%|$venv_path|g
232 " -i $cinder_apache_conf
Dean Troyer67787e62012-05-02 11:48:15 -0500233}
234
Thierry Carrez63e17842014-01-10 14:23:03 +0100235# configure_cinder() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100236function configure_cinder {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500237 sudo install -d -o $STACK_USER -m 755 $CINDER_CONF_DIR
Thierry Carrez63e17842014-01-10 14:23:03 +0100238
239 cp -p $CINDER_DIR/etc/cinder/policy.json $CINDER_CONF_DIR
240
Yalei Wangcecbd1f2015-01-05 17:05:47 +0800241 rm -f $CINDER_CONF
242
Ian Wienandc6782412015-05-14 10:01:53 +1000243 configure_rootwrap cinder
John Griffith4e823ff2012-07-20 13:18:17 -0600244
Dean Troyer67787e62012-05-02 11:48:15 -0500245 cp $CINDER_DIR/etc/cinder/api-paste.ini $CINDER_API_PASTE_INI
Dan Prince82dea7c2013-10-16 18:57:15 -0400246
247 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_host
248 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_port
249 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_protocol
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000250 inicomment $CINDER_API_PASTE_INI filter:authtoken cafile
Dan Prince82dea7c2013-10-16 18:57:15 -0400251 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_tenant_name
252 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_user
253 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_password
254 inicomment $CINDER_API_PASTE_INI filter:authtoken signing_dir
Dean Troyerbc071bc2012-10-01 14:06:44 -0500255
Brant Knudson05952372014-09-19 17:22:22 -0500256 configure_auth_token_middleware $CINDER_CONF cinder $CINDER_AUTH_CACHE_DIR
Dan Prince82dea7c2013-10-16 18:57:15 -0400257
git-harryafc14232015-01-08 17:37:40 +0000258 iniset $CINDER_CONF DEFAULT nova_catalog_info $CINDER_NOVA_CATALOG_INFO
259 iniset $CINDER_CONF DEFAULT nova_catalog_admin_info $CINDER_NOVA_CATALOG_ADMIN_INFO
260
Dean Troyer67787e62012-05-02 11:48:15 -0500261 iniset $CINDER_CONF DEFAULT auth_strategy keystone
Ben Nemec03997942013-08-10 09:56:16 -0500262 iniset $CINDER_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Dean Troyer09718332014-07-03 10:46:57 -0500263
Attila Fazekasc70605d2015-01-26 15:44:47 +0100264 iniset $CINDER_CONF DEFAULT iscsi_helper "$CINDER_ISCSI_HELPER"
Joe Gordon23d6d502015-03-06 15:24:22 -0800265 iniset $CINDER_CONF database connection `database_connection_url cinder`
Dean Troyer67787e62012-05-02 11:48:15 -0500266 iniset $CINDER_CONF DEFAULT api_paste_config $CINDER_API_PASTE_INI
Joe Gordona58382a2013-02-20 12:45:02 -0800267 iniset $CINDER_CONF DEFAULT rootwrap_config "$CINDER_CONF_DIR/rootwrap.conf"
Dan Prince9f22f072013-01-28 09:53:38 -0500268 iniset $CINDER_CONF DEFAULT osapi_volume_extension cinder.api.contrib.standard_extensions
Brian Haley180f5eb2015-06-16 13:14:31 -0400269 iniset $CINDER_CONF DEFAULT osapi_volume_listen $CINDER_SERVICE_LISTEN_ADDRESS
Dean Troyer50ac7922012-09-13 14:02:01 -0500270 iniset $CINDER_CONF DEFAULT state_path $CINDER_STATE_PATH
Joe Gordon23d6d502015-03-06 15:24:22 -0800271 iniset $CINDER_CONF oslo_concurrency lock_path $CINDER_STATE_PATH
Sean Daguef35ff722013-05-16 16:31:12 -0400272 iniset $CINDER_CONF DEFAULT periodic_interval $CINDER_PERIODIC_INTERVAL
Michał Dulko9ee14262016-06-03 15:34:50 +0200273 iniset $CINDER_CONF DEFAULT my_ip "$HOST_IP"
John Griffith4e823ff2012-07-20 13:18:17 -0600274
Ethan Lynn679f3952015-03-09 23:45:18 +0800275 iniset $CINDER_CONF DEFAULT os_region_name "$REGION_NAME"
276
Angus Lees8a6d7672016-02-15 10:53:20 +1100277 iniset $CINDER_CONF privsep_osbrick helper_command "sudo cinder-rootwrap \$rootwrap_config privsep-helper --config-file $CINDER_CONF"
278
Dean Troyer09718332014-07-03 10:46:57 -0500279 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500280 local enabled_backends=""
281 local default_name=""
282 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500283 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500284 be_type=${be%%:*}
285 be_name=${be##*:}
286 if type configure_cinder_backend_${be_type} >/dev/null 2>&1; then
287 configure_cinder_backend_${be_type} ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500288 fi
Dean Troyera25922b2014-08-28 09:29:47 -0500289 if [[ -z "$default_name" ]]; then
290 default_name=$be_name
Dean Troyer09718332014-07-03 10:46:57 -0500291 fi
Dean Troyere8a35ac2014-07-25 12:37:41 -0500292 enabled_backends+=$be_name,
Dean Troyer09718332014-07-03 10:46:57 -0500293 done
294 iniset $CINDER_CONF DEFAULT enabled_backends ${enabled_backends%,*}
Matt Riedemann6a4aa782014-07-25 13:35:53 -0700295 if [[ -n "$default_name" ]]; then
296 iniset $CINDER_CONF DEFAULT default_volume_type ${default_name}
Dean Troyer09718332014-07-03 10:46:57 -0500297 fi
298 fi
299
Attila Fazekas29834742014-03-09 18:36:42 +0100300 if is_service_enabled swift; then
Falk Reimann22f747b2015-08-28 12:40:19 +0200301 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 +0100302 fi
303
Gordon Chung2bfbc772013-08-09 10:55:12 -0400304 if is_service_enabled ceilometer; then
Wanlong Gaocf04a9a2016-01-16 17:46:35 +0800305 iniset $CINDER_CONF oslo_messaging_notifications driver "messaging"
Gordon Chung2bfbc772013-08-09 10:55:12 -0400306 fi
307
Dean Troyer560346b2012-12-13 17:05:24 -0600308 if is_service_enabled tls-proxy; then
309 # Set the service port for a proxy to take the original
310 iniset $CINDER_CONF DEFAULT osapi_volume_listen_port $CINDER_SERVICE_PORT_INT
Rob Crittendencdba7b02015-05-26 15:33:45 -0400311
312 iniset $CINDER_CONF DEFAULT public_endpoint $CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT
Dean Troyer560346b2012-12-13 17:05:24 -0600313 fi
314
Dean Troyer4d3049e2012-11-06 20:38:14 -0600315 if [ "$SYSLOG" != "False" ]; then
316 iniset $CINDER_CONF DEFAULT use_syslog True
317 fi
318
Brant Knudson2dd110c2015-03-14 12:39:14 -0500319 iniset_rpc_backend cinder $CINDER_CONF
Gary Kottonf71bf192012-08-06 11:15:36 -0400320
Matt Riedemanncdcdeb62015-10-29 09:48:17 -0700321 iniset $CINDER_CONF DEFAULT volume_clear $CINDER_VOLUME_CLEAR
James E. Blair213c4162012-11-06 09:38:36 +0100322
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700323 # Format logging
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300324 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && [ "$CINDER_USE_MOD_WSGI" == "False" ]; then
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700325 setup_colorized_logging $CINDER_CONF DEFAULT "project_id" "user_id"
John Griffith95b994d2015-04-18 11:20:15 -0600326 else
327 # Set req-id, project-name and resource in log format
328 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 +0000329 fi
Mate Lakatb2fdafe2012-11-20 15:52:21 +0000330
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300331 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
332 _cinder_config_apache_wsgi
333 fi
334
john-griffithd0860cc2014-01-23 11:31:10 -0700335 if [[ -r $CINDER_PLUGINS/$CINDER_DRIVER ]]; then
336 configure_cinder_driver
Mate Lakatb2fdafe2012-11-20 15:52:21 +0000337 fi
Ian Wienand0db17132013-06-26 22:31:48 +1000338
Dean Troyer05bd7b82014-09-16 17:25:33 -0500339 iniset $CINDER_CONF DEFAULT osapi_volume_workers "$API_WORKERS"
Rob Crittenden18d47782014-03-19 17:47:42 -0400340
341 iniset $CINDER_CONF DEFAULT glance_api_servers "${GLANCE_SERVICE_PROTOCOL}://${GLANCE_HOSTPORT}"
342 if is_ssl_enabled_service glance || is_service_enabled tls-proxy; then
343 iniset $CINDER_CONF DEFAULT glance_protocol https
Rob Crittenden4b109292014-10-21 18:17:48 -0400344 iniset $CINDER_CONF DEFAULT glance_ca_certificates_file $SSL_BUNDLE_FILE
Rob Crittenden18d47782014-03-19 17:47:42 -0400345 fi
346
347 # Register SSL certificates if provided
348 if is_ssl_enabled_service cinder; then
349 ensure_certificates CINDER
350
351 iniset $CINDER_CONF DEFAULT ssl_cert_file "$CINDER_SSL_CERT"
352 iniset $CINDER_CONF DEFAULT ssl_key_file "$CINDER_SSL_KEY"
353 fi
354
Jordan Pittier38bee182015-05-11 16:51:10 +0200355 # Set os_privileged_user credentials (used for os-assisted-snapshots)
356 iniset $CINDER_CONF DEFAULT os_privileged_user_name nova
357 iniset $CINDER_CONF DEFAULT os_privileged_user_password "$SERVICE_PASSWORD"
Sean Dague7580a0c2016-02-17 06:23:36 -0500358 iniset $CINDER_CONF DEFAULT os_privileged_user_tenant "$SERVICE_PROJECT_NAME"
Marian Horban7159b4b2015-10-22 15:47:49 -0400359 iniset $CINDER_CONF DEFAULT graceful_shutdown_timeout "$SERVICE_GRACEFUL_SHUTDOWN_TIMEOUT"
Dean Troyer67787e62012-05-02 11:48:15 -0500360}
361
Dean Troyer671c16e2012-12-13 16:22:38 -0600362# create_cinder_accounts() - Set up common required cinder accounts
363
364# Tenant User Roles
365# ------------------------------------------------------------------
366# service cinder admin # if enabled
367
368# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100369function create_cinder_accounts {
Dean Troyer671c16e2012-12-13 16:22:38 -0600370
Dean Troyer671c16e2012-12-13 16:22:38 -0600371 # Cinder
372 if [[ "$ENABLED_SERVICES" =~ "c-api" ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100373
Jamie Lennoxe8bc2b82015-02-10 20:38:56 +1100374 create_service_user "cinder"
Bartosz Górski0abde392014-02-28 14:15:19 +0100375
Sean Dague985e9582016-02-10 07:25:24 -0500376 get_or_create_service "cinder" "volume" "Cinder Volume Service"
Matt Riedemannae4578b2016-04-23 01:45:40 +0000377 get_or_create_endpoint \
Sean Dague985e9582016-02-10 07:25:24 -0500378 "volume" \
379 "$REGION_NAME" \
Sean Dagueab0a1b82016-04-04 09:09:27 -0400380 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(project_id)s" \
381 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(project_id)s" \
382 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(project_id)s"
Bartosz Górski0abde392014-02-28 14:15:19 +0100383
Sean Dague985e9582016-02-10 07:25:24 -0500384 get_or_create_service "cinderv2" "volumev2" "Cinder Volume Service V2"
Matt Riedemannae4578b2016-04-23 01:45:40 +0000385 get_or_create_endpoint \
Sean Dague985e9582016-02-10 07:25:24 -0500386 "volumev2" \
387 "$REGION_NAME" \
Sean Dagueab0a1b82016-04-04 09:09:27 -0400388 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(project_id)s" \
389 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(project_id)s" \
390 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(project_id)s"
Alex Meade06c7a442016-04-01 13:18:32 -0400391
392 get_or_create_service "cinderv3" "volumev3" "Cinder Volume Service V3"
Matt Riedemannae4578b2016-04-23 01:45:40 +0000393 get_or_create_endpoint \
Alex Meade06c7a442016-04-01 13:18:32 -0400394 "volumev3" \
395 "$REGION_NAME" \
396 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v3/\$(project_id)s" \
397 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v3/\$(project_id)s" \
398 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v3/\$(project_id)s"
Dean Troyer671c16e2012-12-13 16:22:38 -0600399 fi
400}
401
Dean Troyerf03bafe2013-02-12 10:58:28 -0600402# create_cinder_cache_dir() - Part of the init_cinder() process
Ian Wienandaee18c72014-02-21 15:35:08 +1100403function create_cinder_cache_dir {
Dean Troyerf03bafe2013-02-12 10:58:28 -0600404 # Create cache dir
Dean Troyer8421c2b2015-03-16 13:52:19 -0500405 sudo install -d -o $STACK_USER $CINDER_AUTH_CACHE_DIR
Dean Troyerf03bafe2013-02-12 10:58:28 -0600406 rm -f $CINDER_AUTH_CACHE_DIR/*
407}
408
Dean Troyer67787e62012-05-02 11:48:15 -0500409# init_cinder() - Initialize database and volume group
Dean Troyere8a35ac2014-07-25 12:37:41 -0500410# Uses global ``NOVA_ENABLED_APIS``
Ian Wienandaee18c72014-02-21 15:35:08 +1100411function init_cinder {
Dean Troyer67787e62012-05-02 11:48:15 -0500412 # Force nova volumes off
413 NOVA_ENABLED_APIS=$(echo $NOVA_ENABLED_APIS | sed "s/osapi_volume,//")
414
Terry Wilson428af5a2012-11-01 16:12:39 -0400415 if is_service_enabled $DATABASE_BACKENDS; then
Dean Troyerf03bafe2013-02-12 10:58:28 -0600416 # (Re)create cinder database
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +0200417 recreate_database cinder
Dean Troyer67787e62012-05-02 11:48:15 -0500418
Dean Troyerf03bafe2013-02-12 10:58:28 -0600419 # Migrate cinder database
Einst Crazy4f55c2d2016-05-04 08:14:01 +0000420 $CINDER_BIN_DIR/cinder-manage --config-file $CINDER_CONF db sync
Dean Troyer67787e62012-05-02 11:48:15 -0500421 fi
422
Dean Troyer09718332014-07-03 10:46:57 -0500423 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500424 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500425 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500426 be_type=${be%%:*}
427 be_name=${be##*:}
428 if type init_cinder_backend_${be_type} >/dev/null 2>&1; then
Maru Newbyc070a3d2015-01-27 17:44:44 +0000429 # Always init the default volume group for lvm.
430 if [[ "$be_type" == "lvm" ]]; then
431 init_default_lvm_volume_group
432 fi
Dean Troyere8a35ac2014-07-25 12:37:41 -0500433 init_cinder_backend_${be_type} ${be_name}
Vincent Untz0230aa82012-06-14 08:51:01 +0200434 fi
Dean Troyer09718332014-07-03 10:46:57 -0500435 done
Dean Troyer67787e62012-05-02 11:48:15 -0500436 fi
Dean Troyerbc071bc2012-10-01 14:06:44 -0500437
Dean Troyer09718332014-07-03 10:46:57 -0500438 mkdir -p $CINDER_STATE_PATH/volumes
Dean Troyerf03bafe2013-02-12 10:58:28 -0600439 create_cinder_cache_dir
Dean Troyer67787e62012-05-02 11:48:15 -0500440}
441
442# install_cinder() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100443function install_cinder {
Ramy Asselin10e1fd42015-06-04 12:12:15 -0700444 # Install os-brick from git so we make sure we're testing
445 # the latest code.
446 if use_library_from_git "os-brick"; then
447 git_clone_by_name "os-brick"
448 setup_dev_lib "os-brick"
449 fi
450
Dean Troyer67787e62012-05-02 11:48:15 -0500451 git_clone $CINDER_REPO $CINDER_DIR $CINDER_BRANCH
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400452 setup_develop $CINDER_DIR
Attila Fazekasc70605d2015-01-26 15:44:47 +0100453 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
454 if is_fedora; then
455 install_package scsi-target-utils
456 else
457 install_package tgt
458 fi
459 fi
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300460
461 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
462 install_apache_wsgi
463 if is_ssl_enabled_service "c-api"; then
464 enable_mod_ssl
465 fi
466 fi
Dean Troyer253a1a32013-04-01 18:23:22 -0500467}
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400468
Dean Troyer253a1a32013-04-01 18:23:22 -0500469# install_cinderclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100470function install_cinderclient {
Ivan Kolodyazhny8d0d3112016-05-26 23:41:49 +0300471 if use_library_from_git "python-brick-cinderclient-ext"; then
472 git_clone_by_name "python-brick-cinderclient-ext"
473 setup_dev_lib "python-brick-cinderclient-ext"
474 fi
475
Sean Daguee08ab102014-11-13 17:09:28 -0500476 if use_library_from_git "python-cinderclient"; then
477 git_clone_by_name "python-cinderclient"
478 setup_dev_lib "python-cinderclient"
479 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 +0100480 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500481}
482
Steve Baker18225d92013-04-14 12:48:41 -0700483# apply config.d approach for cinder volumes directory
Ian Wienandaee18c72014-02-21 15:35:08 +1100484function _configure_tgt_for_config_d {
Steve Baker18225d92013-04-14 12:48:41 -0700485 if [[ ! -d /etc/tgt/stack.d/ ]]; then
486 sudo ln -sf $CINDER_STATE_PATH/volumes /etc/tgt/stack.d
Jordan Pittiera263e7d2016-01-07 19:40:44 +0100487 fi
488 if ! grep -q "include /etc/tgt/stack.d/*" /etc/tgt/targets.conf; then
Steve Baker18225d92013-04-14 12:48:41 -0700489 echo "include /etc/tgt/stack.d/*" | sudo tee -a /etc/tgt/targets.conf
Mate Lakata39caac2012-09-03 15:45:53 +0100490 fi
491}
492
Dean Troyer67787e62012-05-02 11:48:15 -0500493# start_cinder() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100494function start_cinder {
Rob Crittenden18d47782014-03-19 17:47:42 -0400495 local service_port=$CINDER_SERVICE_PORT
496 local service_protocol=$CINDER_SERVICE_PROTOCOL
497 if is_service_enabled tls-proxy; then
498 service_port=$CINDER_SERVICE_PORT_INT
499 service_protocol="http"
500 fi
Attila Fazekasc70605d2015-01-26 15:44:47 +0100501 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
502 if is_service_enabled c-vol; then
503 # Delete any old stack.conf
504 sudo rm -f /etc/tgt/conf.d/stack.conf
505 _configure_tgt_for_config_d
506 if is_ubuntu; then
507 sudo service tgt restart
Dirk Mueller6bc089f2015-06-01 12:39:12 +0200508 elif is_suse; then
509 # NOTE(dmllr): workaround restart bug
510 # https://bugzilla.suse.com/show_bug.cgi?id=934642
511 stop_service tgtd
512 start_service tgtd
Attila Fazekasc70605d2015-01-26 15:44:47 +0100513 else
Dirk Mueller6bc089f2015-06-01 12:39:12 +0200514 restart_service tgtd
Attila Fazekasc70605d2015-01-26 15:44:47 +0100515 fi
516 # 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 fi
520
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300521 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
522 enable_apache_site osapi-volume
523 restart_apache_server
524 tail_log c-api /var/log/$APACHE_NAME/c-api.log
525 else
526 run_process c-api "$CINDER_BIN_DIR/cinder-api --config-file $CINDER_CONF"
527 echo "Waiting for Cinder API to start..."
528 if ! wait_for_service $SERVICE_TIMEOUT $service_protocol://$CINDER_SERVICE_HOST:$service_port; then
529 die $LINENO "c-api did not start"
530 fi
Dean Troyer09718332014-07-03 10:46:57 -0500531 fi
532
Dean Troyer3159a822014-08-27 14:13:58 -0500533 run_process c-sch "$CINDER_BIN_DIR/cinder-scheduler --config-file $CINDER_CONF"
534 run_process c-bak "$CINDER_BIN_DIR/cinder-backup --config-file $CINDER_CONF"
535 run_process c-vol "$CINDER_BIN_DIR/cinder-volume --config-file $CINDER_CONF"
John Griffithe6d4fe52013-07-15 17:35:54 -0600536
537 # NOTE(jdg): For cinder, startup order matters. To ensure that repor_capabilities is received
538 # by the scheduler start the cinder-volume service last (or restart it) after the scheduler
539 # has started. This is a quick fix for lp bug/1189595
Dean Troyer560346b2012-12-13 17:05:24 -0600540
541 # Start proxies if enabled
542 if is_service_enabled c-api && is_service_enabled tls-proxy; then
543 start_tls_proxy '*' $CINDER_SERVICE_PORT $CINDER_SERVICE_HOST $CINDER_SERVICE_PORT_INT &
544 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500545}
546
Dean Troyer699a29f2012-09-10 14:10:27 -0500547# stop_cinder() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100548function stop_cinder {
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300549 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
550 disable_apache_site osapi-volume
551 restart_apache_server
552 else
553 stop_process c-api
554 fi
555
Dean Troyer699a29f2012-09-10 14:10:27 -0500556 # Kill the cinder screen windows
Dean Troyere8a35ac2014-07-25 12:37:41 -0500557 local serv
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300558 for serv in c-bak c-sch c-vol; do
Chris Dent2f27a0e2014-09-09 13:46:02 +0100559 stop_process $serv
Dean Troyer699a29f2012-09-10 14:10:27 -0500560 done
Dean Troyer67787e62012-05-02 11:48:15 -0500561}
Dean Troyer7903b792012-09-13 17:16:12 -0500562
Dean Troyer09718332014-07-03 10:46:57 -0500563# create_volume_types() - Create Cinder's configured volume types
564function create_volume_types {
565 # Create volume types
566 if is_service_enabled c-api && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Jamie Lennox494f7cd2015-05-29 08:33:03 +0000567 local be be_name
Dean Troyer09718332014-07-03 10:46:57 -0500568 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500569 be_name=${be##*:}
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300570 openstack --os-region-name="$REGION_NAME" volume type create --property volume_backend_name="${be_name}" ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500571 done
572 fi
573}
574
575# Compatibility for Grenade
576
577function create_cinder_volume_group {
578 # During a transition period Grenade needs to have this function defined
579 # It is effectively a no-op in the Grenade 'target' use case
580 :
581}
582
Dean Troyercc6b4432013-04-08 15:38:03 -0500583
Dean Troyer7903b792012-09-13 17:16:12 -0500584# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100585$_XTRACE_CINDER
Sean Dague584d90e2013-03-29 14:34:53 -0400586
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100587# Tell emacs to use shell-script-mode
588## Local variables:
589## mode: shell-script
590## End: