blob: 20688129fdedcd0251de0089e6eadfdb1fde349f [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
Ivan Kolodyazhny8d0d3112016-05-26 23:41:49 +030042GITDIR["python-brick-cinderclient-ext"]=$DEST/python-brick-cinderclient-ext
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
Sean Daguef3b2f4c2017-04-13 10:11:48 -040061if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -040062 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
Matt Riedemannb6cbf922016-11-21 21:10:49 -050071# Defaults to default, which is thick, the other valid choice
72# is thin, which as the name implies utilizes lvm thin provisioning.
73# Thinly provisioned LVM volumes may be more efficient when using the Cinder
74# image cache, but there are also known race failures with volume snapshots
75# and thinly provisioned LVM volumes, see bug 1642111 for details.
76CINDER_LVM_TYPE=${CINDER_LVM_TYPE:-default}
Dean Troyer09718332014-07-03 10:46:57 -050077
Dean Troyer09718332014-07-03 10:46:57 -050078# Default backends
79# The backend format is type:name where type is one of the supported backend
80# types (lvm, nfs, etc) and name is the identifier used in the Cinder
81# configuration and for the volume type name. Multiple backends are
82# comma-separated.
Dean Troyer311f4872014-12-18 16:31:34 -060083# The old ``CINDER_MULTI_LVM_BACKEND=True`` setting had a default of:
84# CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-lvm:lvmdriver-1,lvm:lvmdriver-2}
85CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-lvm:lvmdriver-1}
Dean Troyer09718332014-07-03 10:46:57 -050086
Joe D'Andreadfcc3872015-04-29 15:39:17 -040087CINDER_VOLUME_CLEAR=${CINDER_VOLUME_CLEAR:-${CINDER_VOLUME_CLEAR_DEFAULT:-zero}}
88CINDER_VOLUME_CLEAR=$(echo ${CINDER_VOLUME_CLEAR} | tr '[:upper:]' '[:lower:]')
Dean Troyerb7490da2013-03-18 16:07:56 -050089
Sean Daguef35ff722013-05-16 16:31:12 -040090# Cinder reports allocations back to the scheduler on periodic intervals
91# it turns out we can get an "out of space" issue when we run tests too
92# quickly just because cinder didn't realize we'd freed up resources.
93# Make this configurable so that devstack-gate/tempest can set it to
94# less than the 60 second default
95# https://bugs.launchpad.net/cinder/+bug/1180976
96CINDER_PERIODIC_INTERVAL=${CINDER_PERIODIC_INTERVAL:-60}
97
Attila Fazekasc70605d2015-01-26 15:44:47 +010098CINDER_ISCSI_HELPER=${CINDER_ISCSI_HELPER:-tgtadm}
99
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300100# Toggle for deploying Cinder under HTTPD + mod_wsgi
101CINDER_USE_MOD_WSGI=${CINDER_USE_MOD_WSGI:-False}
Dean Troyercc6b4432013-04-08 15:38:03 -0500102
Dean Troyer09718332014-07-03 10:46:57 -0500103# Source the enabled backends
104if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
105 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500106 be_type=${be%%:*}
107 be_name=${be##*:}
108 if [[ -r $CINDER_BACKENDS/${be_type} ]]; then
109 source $CINDER_BACKENDS/${be_type}
Dean Troyer09718332014-07-03 10:46:57 -0500110 fi
111 done
112fi
113
Patrick Eastdddb2c72016-05-03 17:34:00 -0700114# Environment variables to configure the image-volume cache
115CINDER_IMG_CACHE_ENABLED=${CINDER_IMG_CACHE_ENABLED:-True}
116
117# For limits, if left unset, it will use cinder defaults of 0 for unlimited
118CINDER_IMG_CACHE_SIZE_GB=${CINDER_IMG_CACHE_SIZE_GB:-}
119CINDER_IMG_CACHE_SIZE_COUNT=${CINDER_IMG_CACHE_SIZE_COUNT:-}
120
121# Configure which cinder backends will have the image-volume cache, this takes the same
122# form as the CINDER_ENABLED_BACKENDS config option. By default it will
123# enable the cache for all cinder backends.
124CINDER_CACHE_ENABLED_FOR_BACKENDS=${CINDER_CACHE_ENABLED_FOR_BACKENDS:-$CINDER_ENABLED_BACKENDS}
Dean Troyer09718332014-07-03 10:46:57 -0500125
Dean Troyercc6b4432013-04-08 15:38:03 -0500126# Functions
127# ---------
Dean Troyere4fa7212014-01-15 15:04:49 -0600128
129# Test if any Cinder services are enabled
130# is_cinder_enabled
131function is_cinder_enabled {
Clark Boylan902158b2017-05-30 14:11:09 -0700132 [[ ,${DISABLED_SERVICES} =~ ,"cinder" ]] && return 1
Dean Troyere4fa7212014-01-15 15:04:49 -0600133 [[ ,${ENABLED_SERVICES} =~ ,"c-" ]] && return 0
134 return 1
135}
136
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300137# _cinder_cleanup_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
138function _cinder_cleanup_apache_wsgi {
139 sudo rm -f $(apache_site_config_for osapi-volume)
140}
141
Dean Troyer67787e62012-05-02 11:48:15 -0500142# cleanup_cinder() - Remove residual data files, anything left over from previous
143# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100144function cleanup_cinder {
Sean Dague252f2f52012-12-20 16:41:57 -0500145 # ensure the volume group is cleared up because fails might
146 # leave dead volumes in the group
Attila Fazekasc70605d2015-01-26 15:44:47 +0100147 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
Ian Wienandada886d2015-10-07 14:06:26 +1100148 local targets
149 targets=$(sudo tgtadm --op show --mode target)
Attila Fazekasc70605d2015-01-26 15:44:47 +0100150 if [ $? -ne 0 ]; then
151 # If tgt driver isn't running this won't work obviously
152 # So check the response and restart if need be
153 echo "tgtd seems to be in a bad state, restarting..."
154 if is_ubuntu; then
155 restart_service tgt
156 else
157 restart_service tgtd
158 fi
159 targets=$(sudo tgtadm --op show --mode target)
Sean Dague252f2f52012-12-20 16:41:57 -0500160 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500161
Attila Fazekasc70605d2015-01-26 15:44:47 +0100162 if [[ -n "$targets" ]]; then
163 local iqn_list=( $(grep --no-filename -r iqn $SCSI_PERSIST_DIR | sed 's/<target //' | sed 's/>//') )
164 for i in "${iqn_list[@]}"; do
165 echo removing iSCSI target: $i
166 sudo tgt-admin --delete $i
167 done
168 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500169
Attila Fazekasc70605d2015-01-26 15:44:47 +0100170 if is_ubuntu; then
171 stop_service tgt
172 else
173 stop_service tgtd
174 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500175 else
Attila Fazekasc70605d2015-01-26 15:44:47 +0100176 sudo cinder-rtstool get-targets | sudo xargs -rn 1 cinder-rtstool delete
Sean Dague252f2f52012-12-20 16:41:57 -0500177 fi
178
Dean Troyer09718332014-07-03 10:46:57 -0500179 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500180 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500181 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500182 be_type=${be%%:*}
183 be_name=${be##*:}
184 if type cleanup_cinder_backend_${be_type} >/dev/null 2>&1; then
185 cleanup_cinder_backend_${be_type} ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500186 fi
187 done
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100188 fi
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300189
190 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
191 _cinder_cleanup_apache_wsgi
192 fi
193}
194
195# _cinder_config_apache_wsgi() - Set WSGI config files
196function _cinder_config_apache_wsgi {
Ian Wienandada886d2015-10-07 14:06:26 +1100197 local cinder_apache_conf
198 cinder_apache_conf=$(apache_site_config_for osapi-volume)
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300199 local cinder_ssl=""
200 local cinder_certfile=""
201 local cinder_keyfile=""
202 local cinder_api_port=$CINDER_SERVICE_PORT
203 local venv_path=""
204
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300205 if [[ ${USE_VENV} = True ]]; then
206 venv_path="python-path=${PROJECT_VENV["cinder"]}/lib/python2.7/site-packages"
207 fi
208
209 # copy proxy vhost file
210 sudo cp $FILES/apache-cinder-api.template $cinder_apache_conf
211 sudo sed -e "
212 s|%PUBLICPORT%|$cinder_api_port|g;
213 s|%APACHE_NAME%|$APACHE_NAME|g;
214 s|%APIWORKERS%|$API_WORKERS|g
215 s|%CINDER_BIN_DIR%|$CINDER_BIN_DIR|g;
216 s|%SSLENGINE%|$cinder_ssl|g;
217 s|%SSLCERTFILE%|$cinder_certfile|g;
218 s|%SSLKEYFILE%|$cinder_keyfile|g;
219 s|%USER%|$STACK_USER|g;
220 s|%VIRTUALENV%|$venv_path|g
221 " -i $cinder_apache_conf
Dean Troyer67787e62012-05-02 11:48:15 -0500222}
223
Thierry Carrez63e17842014-01-10 14:23:03 +0100224# configure_cinder() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100225function configure_cinder {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500226 sudo install -d -o $STACK_USER -m 755 $CINDER_CONF_DIR
Thierry Carrez63e17842014-01-10 14:23:03 +0100227
228 cp -p $CINDER_DIR/etc/cinder/policy.json $CINDER_CONF_DIR
229
Yalei Wangcecbd1f2015-01-05 17:05:47 +0800230 rm -f $CINDER_CONF
231
Ian Wienandc6782412015-05-14 10:01:53 +1000232 configure_rootwrap cinder
John Griffith4e823ff2012-07-20 13:18:17 -0600233
TommyLike401de4d2017-05-04 17:56:22 +0800234 if [[ -f "$CINDER_DIR/etc/cinder/resource_filters.json" ]]; then
235 cp -p "$CINDER_DIR/etc/cinder/resource_filters.json" "$CINDER_CONF_DIR/resource_filters.json"
236 fi
237
Dean Troyer67787e62012-05-02 11:48:15 -0500238 cp $CINDER_DIR/etc/cinder/api-paste.ini $CINDER_API_PASTE_INI
Dan Prince82dea7c2013-10-16 18:57:15 -0400239
240 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_host
241 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_port
242 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_protocol
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000243 inicomment $CINDER_API_PASTE_INI filter:authtoken cafile
Dan Prince82dea7c2013-10-16 18:57:15 -0400244 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_tenant_name
245 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_user
246 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_password
247 inicomment $CINDER_API_PASTE_INI filter:authtoken signing_dir
Dean Troyerbc071bc2012-10-01 14:06:44 -0500248
Brant Knudson05952372014-09-19 17:22:22 -0500249 configure_auth_token_middleware $CINDER_CONF cinder $CINDER_AUTH_CACHE_DIR
Dan Prince82dea7c2013-10-16 18:57:15 -0400250
Sean Dague0b259c32017-02-17 11:51:36 -0500251 # Change the default nova_catalog_info and nova_catalog_admin_info values in
252 # cinder so that the service name cinder is searching for matches that set for
253 # nova in keystone.
254 if [[ -n "$CINDER_NOVA_CATALOG_INFO" ]]; then
255 iniset $CINDER_CONF DEFAULT nova_catalog_info $CINDER_NOVA_CATALOG_INFO
256 fi
257 if [[ -n "$CINDER_NOVA_CATALOG_ADMIN_INFO" ]]; then
258 iniset $CINDER_CONF DEFAULT nova_catalog_admin_info $CINDER_NOVA_CATALOG_ADMIN_INFO
259 fi
git-harryafc14232015-01-08 17:37:40 +0000260
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
Kaitlin Farra5b72b02016-01-26 22:46:13 -0500277 iniset $CINDER_CONF key_manager api_class cinder.keymgr.conf_key_mgr.ConfKeyManager
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,
Sean McGinnis29ec2822017-05-30 14:21:39 -0500293
294 iniset $CINDER_CONF $be_name volume_clear $CINDER_VOLUME_CLEAR
295
Dean Troyer09718332014-07-03 10:46:57 -0500296 done
297 iniset $CINDER_CONF DEFAULT enabled_backends ${enabled_backends%,*}
Matt Riedemann6a4aa782014-07-25 13:35:53 -0700298 if [[ -n "$default_name" ]]; then
299 iniset $CINDER_CONF DEFAULT default_volume_type ${default_name}
Dean Troyer09718332014-07-03 10:46:57 -0500300 fi
Patrick Eastdddb2c72016-05-03 17:34:00 -0700301 configure_cinder_image_volume_cache
Dean Troyer09718332014-07-03 10:46:57 -0500302 fi
303
Attila Fazekas29834742014-03-09 18:36:42 +0100304 if is_service_enabled swift; then
Falk Reimann22f747b2015-08-28 12:40:19 +0200305 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 +0100306 fi
307
Gordon Chung2bfbc772013-08-09 10:55:12 -0400308 if is_service_enabled ceilometer; then
Matt Riedemann45da7772017-03-05 13:07:39 -0500309 iniset $CINDER_CONF oslo_messaging_notifications driver "messagingv2"
Gordon Chung2bfbc772013-08-09 10:55:12 -0400310 fi
311
Dean Troyer560346b2012-12-13 17:05:24 -0600312 if is_service_enabled tls-proxy; then
313 # Set the service port for a proxy to take the original
314 iniset $CINDER_CONF DEFAULT osapi_volume_listen_port $CINDER_SERVICE_PORT_INT
Rob Crittendencdba7b02015-05-26 15:33:45 -0400315 iniset $CINDER_CONF DEFAULT public_endpoint $CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT
Gregory Haynes4b49e402016-08-31 18:19:51 -0700316 iniset $CINDER_CONF DEFAULT osapi_volume_base_URL $CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT
Dean Troyer560346b2012-12-13 17:05:24 -0600317 fi
318
Dean Troyer4d3049e2012-11-06 20:38:14 -0600319 if [ "$SYSLOG" != "False" ]; then
320 iniset $CINDER_CONF DEFAULT use_syslog True
321 fi
322
Brant Knudson2dd110c2015-03-14 12:39:14 -0500323 iniset_rpc_backend cinder $CINDER_CONF
Gary Kottonf71bf192012-08-06 11:15:36 -0400324
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700325 # Format logging
Sean Dague9751be62016-04-05 12:08:57 -0400326 setup_logging $CINDER_CONF $CINDER_USE_MOD_WSGI
Mate Lakatb2fdafe2012-11-20 15:52:21 +0000327
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300328 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
329 _cinder_config_apache_wsgi
330 fi
331
john-griffithd0860cc2014-01-23 11:31:10 -0700332 if [[ -r $CINDER_PLUGINS/$CINDER_DRIVER ]]; then
333 configure_cinder_driver
Mate Lakatb2fdafe2012-11-20 15:52:21 +0000334 fi
Ian Wienand0db17132013-06-26 22:31:48 +1000335
Dean Troyer05bd7b82014-09-16 17:25:33 -0500336 iniset $CINDER_CONF DEFAULT osapi_volume_workers "$API_WORKERS"
Rob Crittenden18d47782014-03-19 17:47:42 -0400337
338 iniset $CINDER_CONF DEFAULT glance_api_servers "${GLANCE_SERVICE_PROTOCOL}://${GLANCE_HOSTPORT}"
Sean Daguef3b2f4c2017-04-13 10:11:48 -0400339 if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -0400340 iniset $CINDER_CONF DEFAULT glance_protocol https
Rob Crittenden4b109292014-10-21 18:17:48 -0400341 iniset $CINDER_CONF DEFAULT glance_ca_certificates_file $SSL_BUNDLE_FILE
Rob Crittenden18d47782014-03-19 17:47:42 -0400342 fi
343
Flavio Percoco22c695f2016-05-11 12:49:07 -0500344 if [ "$GLANCE_V1_ENABLED" != "True" ]; then
345 iniset $CINDER_CONF DEFAULT glance_api_version 2
346 fi
347
Jordan Pittier38bee182015-05-11 16:51:10 +0200348 # Set os_privileged_user credentials (used for os-assisted-snapshots)
349 iniset $CINDER_CONF DEFAULT os_privileged_user_name nova
350 iniset $CINDER_CONF DEFAULT os_privileged_user_password "$SERVICE_PASSWORD"
Sean Dague7580a0c2016-02-17 06:23:36 -0500351 iniset $CINDER_CONF DEFAULT os_privileged_user_tenant "$SERVICE_PROJECT_NAME"
Marian Horban7159b4b2015-10-22 15:47:49 -0400352 iniset $CINDER_CONF DEFAULT graceful_shutdown_timeout "$SERVICE_GRACEFUL_SHUTDOWN_TIMEOUT"
Mehdi Abaakouk52b10742016-12-01 16:11:17 +0100353
Davanum Srinivasc0d16c22017-05-19 10:23:46 -0400354 if [[ ! -z "$CINDER_COORDINATION_URL" ]]; then
355 iniset $CINDER_CONF coordination backend_url "$CINDER_COORDINATION_URL"
356 elif is_service_enabled etcd3; then
357 iniset $CINDER_CONF coordination backend_url "etcd3+http://${SERVICE_HOST}:2379"
Mehdi Abaakouk52b10742016-12-01 16:11:17 +0100358 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500359}
360
Dean Troyer671c16e2012-12-13 16:22:38 -0600361# create_cinder_accounts() - Set up common required cinder accounts
362
363# Tenant User Roles
364# ------------------------------------------------------------------
365# service cinder admin # if enabled
366
367# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100368function create_cinder_accounts {
Dean Troyer671c16e2012-12-13 16:22:38 -0600369
Dean Troyer671c16e2012-12-13 16:22:38 -0600370 # Cinder
371 if [[ "$ENABLED_SERVICES" =~ "c-api" ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100372
Jamie Lennoxe8bc2b82015-02-10 20:38:56 +1100373 create_service_user "cinder"
Bartosz Górski0abde392014-02-28 14:15:19 +0100374
Sean Dague985e9582016-02-10 07:25:24 -0500375 get_or_create_service "cinder" "volume" "Cinder Volume Service"
Matt Riedemannae4578b2016-04-23 01:45:40 +0000376 get_or_create_endpoint \
Sean Dague985e9582016-02-10 07:25:24 -0500377 "volume" \
378 "$REGION_NAME" \
Sean Dagueab0a1b82016-04-04 09:09:27 -0400379 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(project_id)s"
Bartosz Górski0abde392014-02-28 14:15:19 +0100380
Sean Dague985e9582016-02-10 07:25:24 -0500381 get_or_create_service "cinderv2" "volumev2" "Cinder Volume Service V2"
Matt Riedemannae4578b2016-04-23 01:45:40 +0000382 get_or_create_endpoint \
Sean Dague985e9582016-02-10 07:25:24 -0500383 "volumev2" \
384 "$REGION_NAME" \
Sean Dagueab0a1b82016-04-04 09:09:27 -0400385 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(project_id)s"
Alex Meade06c7a442016-04-01 13:18:32 -0400386
387 get_or_create_service "cinderv3" "volumev3" "Cinder Volume Service V3"
Matt Riedemannae4578b2016-04-23 01:45:40 +0000388 get_or_create_endpoint \
Alex Meade06c7a442016-04-01 13:18:32 -0400389 "volumev3" \
390 "$REGION_NAME" \
Alex Meade06c7a442016-04-01 13:18:32 -0400391 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v3/\$(project_id)s"
Patrick Eastdddb2c72016-05-03 17:34:00 -0700392
393 configure_cinder_internal_tenant
Dean Troyer671c16e2012-12-13 16:22:38 -0600394 fi
395}
396
Dean Troyerf03bafe2013-02-12 10:58:28 -0600397# create_cinder_cache_dir() - Part of the init_cinder() process
Ian Wienandaee18c72014-02-21 15:35:08 +1100398function create_cinder_cache_dir {
Dean Troyerf03bafe2013-02-12 10:58:28 -0600399 # Create cache dir
Dean Troyer8421c2b2015-03-16 13:52:19 -0500400 sudo install -d -o $STACK_USER $CINDER_AUTH_CACHE_DIR
Dean Troyerf03bafe2013-02-12 10:58:28 -0600401 rm -f $CINDER_AUTH_CACHE_DIR/*
402}
403
Dean Troyer67787e62012-05-02 11:48:15 -0500404# init_cinder() - Initialize database and volume group
Ian Wienandaee18c72014-02-21 15:35:08 +1100405function init_cinder {
Terry Wilson428af5a2012-11-01 16:12:39 -0400406 if is_service_enabled $DATABASE_BACKENDS; then
Dean Troyerf03bafe2013-02-12 10:58:28 -0600407 # (Re)create cinder database
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +0200408 recreate_database cinder
Dean Troyer67787e62012-05-02 11:48:15 -0500409
Clark Boylan633dbc32017-06-14 12:09:21 -0700410 time_start "dbsync"
Dean Troyerf03bafe2013-02-12 10:58:28 -0600411 # Migrate cinder database
Einst Crazy4f55c2d2016-05-04 08:14:01 +0000412 $CINDER_BIN_DIR/cinder-manage --config-file $CINDER_CONF db sync
Clark Boylan633dbc32017-06-14 12:09:21 -0700413 time_stop "dbsync"
Dean Troyer67787e62012-05-02 11:48:15 -0500414 fi
415
Dean Troyer09718332014-07-03 10:46:57 -0500416 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500417 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500418 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500419 be_type=${be%%:*}
420 be_name=${be##*:}
421 if type init_cinder_backend_${be_type} >/dev/null 2>&1; then
Maru Newbyc070a3d2015-01-27 17:44:44 +0000422 # Always init the default volume group for lvm.
423 if [[ "$be_type" == "lvm" ]]; then
424 init_default_lvm_volume_group
425 fi
Dean Troyere8a35ac2014-07-25 12:37:41 -0500426 init_cinder_backend_${be_type} ${be_name}
Vincent Untz0230aa82012-06-14 08:51:01 +0200427 fi
Dean Troyer09718332014-07-03 10:46:57 -0500428 done
Dean Troyer67787e62012-05-02 11:48:15 -0500429 fi
Dean Troyerbc071bc2012-10-01 14:06:44 -0500430
Dean Troyer09718332014-07-03 10:46:57 -0500431 mkdir -p $CINDER_STATE_PATH/volumes
Dean Troyerf03bafe2013-02-12 10:58:28 -0600432 create_cinder_cache_dir
Dean Troyer67787e62012-05-02 11:48:15 -0500433}
434
435# install_cinder() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100436function install_cinder {
Dean Troyer67787e62012-05-02 11:48:15 -0500437 git_clone $CINDER_REPO $CINDER_DIR $CINDER_BRANCH
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400438 setup_develop $CINDER_DIR
Attila Fazekasc70605d2015-01-26 15:44:47 +0100439 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
440 if is_fedora; then
441 install_package scsi-target-utils
442 else
443 install_package tgt
444 fi
445 fi
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300446
447 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
448 install_apache_wsgi
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300449 fi
Dean Troyer253a1a32013-04-01 18:23:22 -0500450}
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400451
Dean Troyer253a1a32013-04-01 18:23:22 -0500452# install_cinderclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100453function install_cinderclient {
Ivan Kolodyazhny8d0d3112016-05-26 23:41:49 +0300454 if use_library_from_git "python-brick-cinderclient-ext"; then
455 git_clone_by_name "python-brick-cinderclient-ext"
456 setup_dev_lib "python-brick-cinderclient-ext"
457 fi
458
Sean Daguee08ab102014-11-13 17:09:28 -0500459 if use_library_from_git "python-cinderclient"; then
460 git_clone_by_name "python-cinderclient"
461 setup_dev_lib "python-cinderclient"
462 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 +0100463 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500464}
465
Steve Baker18225d92013-04-14 12:48:41 -0700466# apply config.d approach for cinder volumes directory
Ian Wienandaee18c72014-02-21 15:35:08 +1100467function _configure_tgt_for_config_d {
Steve Baker18225d92013-04-14 12:48:41 -0700468 if [[ ! -d /etc/tgt/stack.d/ ]]; then
469 sudo ln -sf $CINDER_STATE_PATH/volumes /etc/tgt/stack.d
Jordan Pittiera263e7d2016-01-07 19:40:44 +0100470 fi
471 if ! grep -q "include /etc/tgt/stack.d/*" /etc/tgt/targets.conf; then
Steve Baker18225d92013-04-14 12:48:41 -0700472 echo "include /etc/tgt/stack.d/*" | sudo tee -a /etc/tgt/targets.conf
Mate Lakata39caac2012-09-03 15:45:53 +0100473 fi
474}
475
Dean Troyer67787e62012-05-02 11:48:15 -0500476# start_cinder() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100477function start_cinder {
Rob Crittenden18d47782014-03-19 17:47:42 -0400478 local service_port=$CINDER_SERVICE_PORT
479 local service_protocol=$CINDER_SERVICE_PROTOCOL
480 if is_service_enabled tls-proxy; then
481 service_port=$CINDER_SERVICE_PORT_INT
482 service_protocol="http"
483 fi
Attila Fazekasc70605d2015-01-26 15:44:47 +0100484 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
485 if is_service_enabled c-vol; then
486 # Delete any old stack.conf
487 sudo rm -f /etc/tgt/conf.d/stack.conf
488 _configure_tgt_for_config_d
489 if is_ubuntu; then
490 sudo service tgt restart
Dirk Mueller6bc089f2015-06-01 12:39:12 +0200491 elif is_suse; then
492 # NOTE(dmllr): workaround restart bug
493 # https://bugzilla.suse.com/show_bug.cgi?id=934642
494 stop_service tgtd
495 start_service tgtd
Attila Fazekasc70605d2015-01-26 15:44:47 +0100496 else
Dirk Mueller6bc089f2015-06-01 12:39:12 +0200497 restart_service tgtd
Attila Fazekasc70605d2015-01-26 15:44:47 +0100498 fi
499 # NOTE(gfidente): ensure tgtd is running in debug mode
500 sudo tgtadm --mode system --op update --name debug --value on
Dean Troyer67787e62012-05-02 11:48:15 -0500501 fi
502 fi
503
Clark Boylan2dfca042017-05-25 14:57:19 -0700504 if is_service_enabled c-api ; then
505 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
506 enable_apache_site osapi-volume
507 restart_apache_server
508 tail_log c-api /var/log/$APACHE_NAME/c-api.log
509 else
510 run_process c-api "$CINDER_BIN_DIR/cinder-api --config-file $CINDER_CONF"
511 fi
Eli Qiao4af6eea2017-02-28 15:13:02 +0800512
Clark Boylan2dfca042017-05-25 14:57:19 -0700513 echo "Waiting for Cinder API to start..."
514 if ! wait_for_service $SERVICE_TIMEOUT $service_protocol://$CINDER_SERVICE_HOST:$service_port; then
515 die $LINENO "c-api did not start"
516 fi
517
518 # Start proxies if enabled
519 if is_service_enabled tls-proxy; then
520 start_tls_proxy cinder '*' $CINDER_SERVICE_PORT $CINDER_SERVICE_HOST $CINDER_SERVICE_PORT_INT
521 fi
Dean Troyer09718332014-07-03 10:46:57 -0500522 fi
523
Dean Troyer3159a822014-08-27 14:13:58 -0500524 run_process c-sch "$CINDER_BIN_DIR/cinder-scheduler --config-file $CINDER_CONF"
525 run_process c-bak "$CINDER_BIN_DIR/cinder-backup --config-file $CINDER_CONF"
526 run_process c-vol "$CINDER_BIN_DIR/cinder-volume --config-file $CINDER_CONF"
John Griffithe6d4fe52013-07-15 17:35:54 -0600527
528 # NOTE(jdg): For cinder, startup order matters. To ensure that repor_capabilities is received
529 # by the scheduler start the cinder-volume service last (or restart it) after the scheduler
530 # has started. This is a quick fix for lp bug/1189595
Dean Troyer67787e62012-05-02 11:48:15 -0500531}
532
Dean Troyer699a29f2012-09-10 14:10:27 -0500533# stop_cinder() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100534function stop_cinder {
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300535 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
536 disable_apache_site osapi-volume
537 restart_apache_server
538 else
539 stop_process c-api
540 fi
541
Dean Troyer699a29f2012-09-10 14:10:27 -0500542 # Kill the cinder screen windows
Dean Troyere8a35ac2014-07-25 12:37:41 -0500543 local serv
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300544 for serv in c-bak c-sch c-vol; do
Chris Dent2f27a0e2014-09-09 13:46:02 +0100545 stop_process $serv
Dean Troyer699a29f2012-09-10 14:10:27 -0500546 done
Dean Troyer67787e62012-05-02 11:48:15 -0500547}
Dean Troyer7903b792012-09-13 17:16:12 -0500548
Dean Troyer09718332014-07-03 10:46:57 -0500549# create_volume_types() - Create Cinder's configured volume types
550function create_volume_types {
551 # Create volume types
552 if is_service_enabled c-api && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Jamie Lennox494f7cd2015-05-29 08:33:03 +0000553 local be be_name
Dean Troyer09718332014-07-03 10:46:57 -0500554 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500555 be_name=${be##*:}
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300556 openstack --os-region-name="$REGION_NAME" volume type create --property volume_backend_name="${be_name}" ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500557 done
558 fi
559}
560
561# Compatibility for Grenade
562
563function create_cinder_volume_group {
564 # During a transition period Grenade needs to have this function defined
565 # It is effectively a no-op in the Grenade 'target' use case
566 :
567}
568
Patrick Eastdddb2c72016-05-03 17:34:00 -0700569function configure_cinder_internal_tenant {
570 # Re-use the Cinder service account for simplicity.
571 iniset $CINDER_CONF DEFAULT cinder_internal_tenant_project_id $(get_or_create_project $SERVICE_PROJECT_NAME)
572 iniset $CINDER_CONF DEFAULT cinder_internal_tenant_user_id $(get_or_create_user "cinder")
573}
574
575function configure_cinder_image_volume_cache {
576 # Expect CINDER_CACHE_ENABLED_FOR_BACKENDS to be a list of backends
577 # similar to CINDER_ENABLED_BACKENDS with NAME:TYPE where NAME will
578 # be the backend specific configuration stanza in cinder.conf.
579 for be in ${CINDER_CACHE_ENABLED_FOR_BACKENDS//,/ }; do
580 local be_name=${be##*:}
581
582 iniset $CINDER_CONF $be_name image_volume_cache_enabled $CINDER_IMG_CACHE_ENABLED
583
584 if [[ -n $CINDER_IMG_CACHE_SIZE_GB ]]; then
585 iniset $CINDER_CONF $be_name image_volume_cache_max_size_gb $CINDER_IMG_CACHE_SIZE_GB
586 fi
587
588 if [[ -n $CINDER_IMG_CACHE_SIZE_COUNT ]]; then
589 iniset $CINDER_CONF $be_name image_volume_cache_max_count $CINDER_IMG_CACHE_SIZE_COUNT
590 fi
591 done
592}
593
Dean Troyercc6b4432013-04-08 15:38:03 -0500594
Dean Troyer7903b792012-09-13 17:16:12 -0500595# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100596$_XTRACE_CINDER
Sean Dague584d90e2013-03-29 14:34:53 -0400597
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100598# Tell emacs to use shell-script-mode
599## Local variables:
600## mode: shell-script
601## End: