blob: 7c5cefe0184bacf6e33cc3b74606dbfd352e998d [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}
Ian Wienand1f82f432017-10-04 09:51:02 +110054CINDER_AUTH_CACHE_DIR=${CINDER_AUTH_CACHE_DIR:-/var/cache/cinder}
Dean Troyer671c16e2012-12-13 16:22:38 -060055
Dean Troyer50ac7922012-09-13 14:02:01 -050056CINDER_CONF_DIR=/etc/cinder
57CINDER_CONF=$CINDER_CONF_DIR/cinder.conf
Sean McGinnisdaf12742017-03-03 18:09:35 +000058CINDER_UWSGI=$CINDER_BIN_DIR/cinder-wsgi
59CINDER_UWSGI_CONF=$CINDER_CONF_DIR/cinder-api-uwsgi.ini
Dean Troyer671c16e2012-12-13 16:22:38 -060060CINDER_API_PASTE_INI=$CINDER_CONF_DIR/api-paste.ini
Dean Troyer50ac7922012-09-13 14:02:01 -050061
Dean Troyer560346b2012-12-13 17:05:24 -060062# Public facing bits
Sean Daguef3b2f4c2017-04-13 10:11:48 -040063if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -040064 CINDER_SERVICE_PROTOCOL="https"
65fi
Dean Troyer560346b2012-12-13 17:05:24 -060066CINDER_SERVICE_HOST=${CINDER_SERVICE_HOST:-$SERVICE_HOST}
67CINDER_SERVICE_PORT=${CINDER_SERVICE_PORT:-8776}
68CINDER_SERVICE_PORT_INT=${CINDER_SERVICE_PORT_INT:-18776}
69CINDER_SERVICE_PROTOCOL=${CINDER_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Brian Haley180f5eb2015-06-16 13:14:31 -040070CINDER_SERVICE_LISTEN_ADDRESS=${CINDER_SERVICE_LISTEN_ADDRESS:-$SERVICE_LISTEN_ADDRESS}
Dean Troyer560346b2012-12-13 17:05:24 -060071
John Griffithce8e6f62015-05-12 17:28:59 -060072# What type of LVM device should Cinder use for LVM backend
Sean McGinnis486376e2017-09-05 19:56:06 -050073# Defaults to auto, which will do thin provisioning if it's a fresh
74# volume group, otherwise it will do thick. The other valid choices are
75# default, which is thick, or thin, which as the name implies utilizes lvm
76# thin provisioning.
77CINDER_LVM_TYPE=${CINDER_LVM_TYPE:-auto}
Dean Troyer09718332014-07-03 10:46:57 -050078
Dean Troyer09718332014-07-03 10:46:57 -050079# Default backends
80# The backend format is type:name where type is one of the supported backend
81# types (lvm, nfs, etc) and name is the identifier used in the Cinder
82# configuration and for the volume type name. Multiple backends are
83# comma-separated.
Dean Troyer311f4872014-12-18 16:31:34 -060084# The old ``CINDER_MULTI_LVM_BACKEND=True`` setting had a default of:
85# CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-lvm:lvmdriver-1,lvm:lvmdriver-2}
86CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-lvm:lvmdriver-1}
Dean Troyer09718332014-07-03 10:46:57 -050087
Joe D'Andreadfcc3872015-04-29 15:39:17 -040088CINDER_VOLUME_CLEAR=${CINDER_VOLUME_CLEAR:-${CINDER_VOLUME_CLEAR_DEFAULT:-zero}}
89CINDER_VOLUME_CLEAR=$(echo ${CINDER_VOLUME_CLEAR} | tr '[:upper:]' '[:lower:]')
Dean Troyerb7490da2013-03-18 16:07:56 -050090
Sean Daguef35ff722013-05-16 16:31:12 -040091# Cinder reports allocations back to the scheduler on periodic intervals
92# it turns out we can get an "out of space" issue when we run tests too
93# quickly just because cinder didn't realize we'd freed up resources.
94# Make this configurable so that devstack-gate/tempest can set it to
95# less than the 60 second default
96# https://bugs.launchpad.net/cinder/+bug/1180976
97CINDER_PERIODIC_INTERVAL=${CINDER_PERIODIC_INTERVAL:-60}
98
Ian Wienanda881b882017-04-19 15:42:34 +100099# Centos7 switched to using LIO and that's all that's supported,
100# although the tgt bits are in EPEL we don't want that for CI
101if is_fedora; then
102 CINDER_ISCSI_HELPER=${CINDER_ISCSI_HELPER:-lioadm}
103 if [[ ${CINDER_ISCSI_HELPER} != "lioadm" ]]; then
104 die "lioadm is the only valid Cinder iscsi_helper config on this platform"
105 fi
106else
107 CINDER_ISCSI_HELPER=${CINDER_ISCSI_HELPER:-tgtadm}
108fi
Attila Fazekasc70605d2015-01-26 15:44:47 +0100109
Sean McGinnisdaf12742017-03-03 18:09:35 +0000110# Toggle for deploying Cinder under a wsgi server. Legacy mod_wsgi
111# reference should be cleaned up to more accurately refer to uwsgi.
112CINDER_USE_MOD_WSGI=${CINDER_USE_MOD_WSGI:-True}
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
Patrick Eastdddb2c72016-05-03 17:34:00 -0700125# Environment variables to configure the image-volume cache
126CINDER_IMG_CACHE_ENABLED=${CINDER_IMG_CACHE_ENABLED:-True}
127
128# For limits, if left unset, it will use cinder defaults of 0 for unlimited
129CINDER_IMG_CACHE_SIZE_GB=${CINDER_IMG_CACHE_SIZE_GB:-}
130CINDER_IMG_CACHE_SIZE_COUNT=${CINDER_IMG_CACHE_SIZE_COUNT:-}
131
132# Configure which cinder backends will have the image-volume cache, this takes the same
133# form as the CINDER_ENABLED_BACKENDS config option. By default it will
134# enable the cache for all cinder backends.
135CINDER_CACHE_ENABLED_FOR_BACKENDS=${CINDER_CACHE_ENABLED_FOR_BACKENDS:-$CINDER_ENABLED_BACKENDS}
Dean Troyer09718332014-07-03 10:46:57 -0500136
Dean Troyercc6b4432013-04-08 15:38:03 -0500137# Functions
138# ---------
Dean Troyere4fa7212014-01-15 15:04:49 -0600139
140# Test if any Cinder services are enabled
141# is_cinder_enabled
142function is_cinder_enabled {
Clark Boylan902158b2017-05-30 14:11:09 -0700143 [[ ,${DISABLED_SERVICES} =~ ,"cinder" ]] && return 1
Dean Troyere4fa7212014-01-15 15:04:49 -0600144 [[ ,${ENABLED_SERVICES} =~ ,"c-" ]] && return 0
145 return 1
146}
147
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300148# _cinder_cleanup_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
149function _cinder_cleanup_apache_wsgi {
150 sudo rm -f $(apache_site_config_for osapi-volume)
151}
152
Dean Troyer67787e62012-05-02 11:48:15 -0500153# cleanup_cinder() - Remove residual data files, anything left over from previous
154# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100155function cleanup_cinder {
Sean Dague252f2f52012-12-20 16:41:57 -0500156 # ensure the volume group is cleared up because fails might
157 # leave dead volumes in the group
Attila Fazekasc70605d2015-01-26 15:44:47 +0100158 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
Ian Wienandada886d2015-10-07 14:06:26 +1100159 local targets
160 targets=$(sudo tgtadm --op show --mode target)
Attila Fazekasc70605d2015-01-26 15:44:47 +0100161 if [ $? -ne 0 ]; then
162 # If tgt driver isn't running this won't work obviously
163 # So check the response and restart if need be
164 echo "tgtd seems to be in a bad state, restarting..."
165 if is_ubuntu; then
166 restart_service tgt
167 else
168 restart_service tgtd
169 fi
170 targets=$(sudo tgtadm --op show --mode target)
Sean Dague252f2f52012-12-20 16:41:57 -0500171 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500172
Attila Fazekasc70605d2015-01-26 15:44:47 +0100173 if [[ -n "$targets" ]]; then
174 local iqn_list=( $(grep --no-filename -r iqn $SCSI_PERSIST_DIR | sed 's/<target //' | sed 's/>//') )
175 for i in "${iqn_list[@]}"; do
176 echo removing iSCSI target: $i
177 sudo tgt-admin --delete $i
178 done
179 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500180
Attila Fazekasc70605d2015-01-26 15:44:47 +0100181 if is_ubuntu; then
182 stop_service tgt
183 else
184 stop_service tgtd
185 fi
Sean Dague252f2f52012-12-20 16:41:57 -0500186 else
Attila Fazekasc70605d2015-01-26 15:44:47 +0100187 sudo cinder-rtstool get-targets | sudo xargs -rn 1 cinder-rtstool delete
Sean Dague252f2f52012-12-20 16:41:57 -0500188 fi
189
Dean Troyer09718332014-07-03 10:46:57 -0500190 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500191 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500192 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500193 be_type=${be%%:*}
194 be_name=${be##*:}
195 if type cleanup_cinder_backend_${be_type} >/dev/null 2>&1; then
196 cleanup_cinder_backend_${be_type} ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500197 fi
198 done
Jérôme Gallarddda2b7a2013-02-22 17:28:10 +0100199 fi
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300200
Sean McGinnisdaf12742017-03-03 18:09:35 +0000201 stop_process "c-api"
202 remove_uwsgi_config "$CINDER_UWSGI_CONF" "$CINDER_UWSGI"
Dean Troyer67787e62012-05-02 11:48:15 -0500203}
204
Thierry Carrez63e17842014-01-10 14:23:03 +0100205# configure_cinder() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100206function configure_cinder {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500207 sudo install -d -o $STACK_USER -m 755 $CINDER_CONF_DIR
Thierry Carrez63e17842014-01-10 14:23:03 +0100208
209 cp -p $CINDER_DIR/etc/cinder/policy.json $CINDER_CONF_DIR
210
Yalei Wangcecbd1f2015-01-05 17:05:47 +0800211 rm -f $CINDER_CONF
212
Ian Wienandc6782412015-05-14 10:01:53 +1000213 configure_rootwrap cinder
John Griffith4e823ff2012-07-20 13:18:17 -0600214
TommyLike401de4d2017-05-04 17:56:22 +0800215 if [[ -f "$CINDER_DIR/etc/cinder/resource_filters.json" ]]; then
216 cp -p "$CINDER_DIR/etc/cinder/resource_filters.json" "$CINDER_CONF_DIR/resource_filters.json"
217 fi
218
Dean Troyer67787e62012-05-02 11:48:15 -0500219 cp $CINDER_DIR/etc/cinder/api-paste.ini $CINDER_API_PASTE_INI
Dan Prince82dea7c2013-10-16 18:57:15 -0400220
221 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_host
222 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_port
223 inicomment $CINDER_API_PASTE_INI filter:authtoken auth_protocol
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000224 inicomment $CINDER_API_PASTE_INI filter:authtoken cafile
Dan Prince82dea7c2013-10-16 18:57:15 -0400225 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_tenant_name
226 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_user
227 inicomment $CINDER_API_PASTE_INI filter:authtoken admin_password
Ian Wienand1f82f432017-10-04 09:51:02 +1100228 inicomment $CINDER_API_PASTE_INI filter:authtoken signing_dir
Dean Troyerbc071bc2012-10-01 14:06:44 -0500229
Ian Wienand1f82f432017-10-04 09:51:02 +1100230 configure_auth_token_middleware $CINDER_CONF cinder $CINDER_AUTH_CACHE_DIR
Dan Prince82dea7c2013-10-16 18:57:15 -0400231
Dean Troyer67787e62012-05-02 11:48:15 -0500232 iniset $CINDER_CONF DEFAULT auth_strategy keystone
Ben Nemec03997942013-08-10 09:56:16 -0500233 iniset $CINDER_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Dean Troyer09718332014-07-03 10:46:57 -0500234
Attila Fazekasc70605d2015-01-26 15:44:47 +0100235 iniset $CINDER_CONF DEFAULT iscsi_helper "$CINDER_ISCSI_HELPER"
Joe Gordon23d6d502015-03-06 15:24:22 -0800236 iniset $CINDER_CONF database connection `database_connection_url cinder`
Dean Troyer67787e62012-05-02 11:48:15 -0500237 iniset $CINDER_CONF DEFAULT api_paste_config $CINDER_API_PASTE_INI
Joe Gordona58382a2013-02-20 12:45:02 -0800238 iniset $CINDER_CONF DEFAULT rootwrap_config "$CINDER_CONF_DIR/rootwrap.conf"
Dan Prince9f22f072013-01-28 09:53:38 -0500239 iniset $CINDER_CONF DEFAULT osapi_volume_extension cinder.api.contrib.standard_extensions
Brian Haley180f5eb2015-06-16 13:14:31 -0400240 iniset $CINDER_CONF DEFAULT osapi_volume_listen $CINDER_SERVICE_LISTEN_ADDRESS
Dean Troyer50ac7922012-09-13 14:02:01 -0500241 iniset $CINDER_CONF DEFAULT state_path $CINDER_STATE_PATH
Joe Gordon23d6d502015-03-06 15:24:22 -0800242 iniset $CINDER_CONF oslo_concurrency lock_path $CINDER_STATE_PATH
Sean Daguef35ff722013-05-16 16:31:12 -0400243 iniset $CINDER_CONF DEFAULT periodic_interval $CINDER_PERIODIC_INTERVAL
Michał Dulko9ee14262016-06-03 15:34:50 +0200244 iniset $CINDER_CONF DEFAULT my_ip "$HOST_IP"
John Griffith4e823ff2012-07-20 13:18:17 -0600245
Sean McGinnis32712712017-09-22 07:49:15 -0500246 iniset $CINDER_CONF key_manager backend cinder.keymgr.conf_key_mgr.ConfKeyManager
lkuchlancb8256f2017-08-30 07:36:11 +0300247 iniset $CINDER_CONF key_manager fixed_key $(openssl rand -hex 16)
Kaitlin Farra5b72b02016-01-26 22:46:13 -0500248
Dean Troyer09718332014-07-03 10:46:57 -0500249 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500250 local enabled_backends=""
251 local default_name=""
252 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500253 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500254 be_type=${be%%:*}
255 be_name=${be##*:}
256 if type configure_cinder_backend_${be_type} >/dev/null 2>&1; then
257 configure_cinder_backend_${be_type} ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500258 fi
Dean Troyera25922b2014-08-28 09:29:47 -0500259 if [[ -z "$default_name" ]]; then
260 default_name=$be_name
Dean Troyer09718332014-07-03 10:46:57 -0500261 fi
Dean Troyere8a35ac2014-07-25 12:37:41 -0500262 enabled_backends+=$be_name,
Sean McGinnis29ec2822017-05-30 14:21:39 -0500263
264 iniset $CINDER_CONF $be_name volume_clear $CINDER_VOLUME_CLEAR
265
Dean Troyer09718332014-07-03 10:46:57 -0500266 done
267 iniset $CINDER_CONF DEFAULT enabled_backends ${enabled_backends%,*}
Matt Riedemann6a4aa782014-07-25 13:35:53 -0700268 if [[ -n "$default_name" ]]; then
269 iniset $CINDER_CONF DEFAULT default_volume_type ${default_name}
Dean Troyer09718332014-07-03 10:46:57 -0500270 fi
Patrick Eastdddb2c72016-05-03 17:34:00 -0700271 configure_cinder_image_volume_cache
Dean Troyer09718332014-07-03 10:46:57 -0500272 fi
273
Attila Fazekas29834742014-03-09 18:36:42 +0100274 if is_service_enabled swift; then
Falk Reimann22f747b2015-08-28 12:40:19 +0200275 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 +0100276 fi
277
Gordon Chung2bfbc772013-08-09 10:55:12 -0400278 if is_service_enabled ceilometer; then
Matt Riedemann45da7772017-03-05 13:07:39 -0500279 iniset $CINDER_CONF oslo_messaging_notifications driver "messagingv2"
Gordon Chung2bfbc772013-08-09 10:55:12 -0400280 fi
281
Dean Troyer560346b2012-12-13 17:05:24 -0600282 if is_service_enabled tls-proxy; then
Sean McGinnisdaf12742017-03-03 18:09:35 +0000283 if [[ "$ENABLED_SERVICES" =~ "c-api" ]]; then
284 # Set the service port for a proxy to take the original
285 if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
286 iniset $CINDER_CONF DEFAULT osapi_volume_listen_port $CINDER_SERVICE_PORT_INT
Jens Harbott411c34d2017-08-29 14:40:26 +0000287 iniset $CINDER_CONF oslo_middleware enable_proxy_headers_parsing True
Sean McGinnisdaf12742017-03-03 18:09:35 +0000288 else
289 iniset $CINDER_CONF DEFAULT osapi_volume_listen_port $CINDER_SERVICE_PORT_INT
290 iniset $CINDER_CONF DEFAULT public_endpoint $CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT
291 iniset $CINDER_CONF DEFAULT osapi_volume_base_URL $CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT
292 fi
293 fi
Dean Troyer560346b2012-12-13 17:05:24 -0600294 fi
295
Dean Troyer4d3049e2012-11-06 20:38:14 -0600296 if [ "$SYSLOG" != "False" ]; then
297 iniset $CINDER_CONF DEFAULT use_syslog True
298 fi
299
Brant Knudson2dd110c2015-03-14 12:39:14 -0500300 iniset_rpc_backend cinder $CINDER_CONF
Gary Kottonf71bf192012-08-06 11:15:36 -0400301
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700302 # Format logging
Sean Dague9751be62016-04-05 12:08:57 -0400303 setup_logging $CINDER_CONF $CINDER_USE_MOD_WSGI
Mate Lakatb2fdafe2012-11-20 15:52:21 +0000304
Sean McGinnisdaf12742017-03-03 18:09:35 +0000305 write_uwsgi_config "$CINDER_UWSGI_CONF" "$CINDER_UWSGI" "/volume"
Anton Arefiev651cb1a2015-09-01 10:55:20 +0300306
john-griffithd0860cc2014-01-23 11:31:10 -0700307 if [[ -r $CINDER_PLUGINS/$CINDER_DRIVER ]]; then
308 configure_cinder_driver
Mate Lakatb2fdafe2012-11-20 15:52:21 +0000309 fi
Ian Wienand0db17132013-06-26 22:31:48 +1000310
Dean Troyer05bd7b82014-09-16 17:25:33 -0500311 iniset $CINDER_CONF DEFAULT osapi_volume_workers "$API_WORKERS"
Rob Crittenden18d47782014-03-19 17:47:42 -0400312
Matthew Treinish1fa65362017-06-23 22:32:37 +0000313 iniset $CINDER_CONF DEFAULT glance_api_servers "$GLANCE_URL"
Sean Daguef3b2f4c2017-04-13 10:11:48 -0400314 if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -0400315 iniset $CINDER_CONF DEFAULT glance_protocol https
Rob Crittenden4b109292014-10-21 18:17:48 -0400316 iniset $CINDER_CONF DEFAULT glance_ca_certificates_file $SSL_BUNDLE_FILE
Rob Crittenden18d47782014-03-19 17:47:42 -0400317 fi
318
Flavio Percoco22c695f2016-05-11 12:49:07 -0500319 if [ "$GLANCE_V1_ENABLED" != "True" ]; then
320 iniset $CINDER_CONF DEFAULT glance_api_version 2
321 fi
322
Gyorgy Szombathelyic04ac032017-05-23 16:52:35 +0200323 # Set nova credentials (used for os-assisted-snapshots)
324 configure_auth_token_middleware $CINDER_CONF nova $CINDER_AUTH_CACHE_DIR nova
325 iniset $CINDER_CONF nova region_name "$REGION_NAME"
Marian Horban7159b4b2015-10-22 15:47:49 -0400326 iniset $CINDER_CONF DEFAULT graceful_shutdown_timeout "$SERVICE_GRACEFUL_SHUTDOWN_TIMEOUT"
Mehdi Abaakouk52b10742016-12-01 16:11:17 +0100327
Davanum Srinivasc0d16c22017-05-19 10:23:46 -0400328 if [[ ! -z "$CINDER_COORDINATION_URL" ]]; then
329 iniset $CINDER_CONF coordination backend_url "$CINDER_COORDINATION_URL"
330 elif is_service_enabled etcd3; then
331 iniset $CINDER_CONF coordination backend_url "etcd3+http://${SERVICE_HOST}:2379"
Mehdi Abaakouk52b10742016-12-01 16:11:17 +0100332 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500333}
334
Dean Troyer671c16e2012-12-13 16:22:38 -0600335# create_cinder_accounts() - Set up common required cinder accounts
336
337# Tenant User Roles
338# ------------------------------------------------------------------
339# service cinder admin # if enabled
340
341# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100342function create_cinder_accounts {
Dean Troyer671c16e2012-12-13 16:22:38 -0600343 # Cinder
344 if [[ "$ENABLED_SERVICES" =~ "c-api" ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100345
Jamie Lennoxe8bc2b82015-02-10 20:38:56 +1100346 create_service_user "cinder"
Bartosz Górski0abde392014-02-28 14:15:19 +0100347
Sean Dague985e9582016-02-10 07:25:24 -0500348 get_or_create_service "cinder" "volume" "Cinder Volume Service"
Sean McGinnisdaf12742017-03-03 18:09:35 +0000349 if [ "$CINDER_USE_MOD_WSGI" == "False" ]; then
350 get_or_create_endpoint \
351 "volume" \
352 "$REGION_NAME" \
353 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(project_id)s"
Bartosz Górski0abde392014-02-28 14:15:19 +0100354
Sean McGinnisdaf12742017-03-03 18:09:35 +0000355 get_or_create_service "cinderv2" "volumev2" "Cinder Volume Service V2"
356 get_or_create_endpoint \
357 "volumev2" \
358 "$REGION_NAME" \
359 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(project_id)s"
Alex Meade06c7a442016-04-01 13:18:32 -0400360
Sean McGinnisdaf12742017-03-03 18:09:35 +0000361 get_or_create_service "cinderv3" "volumev3" "Cinder Volume Service V3"
362 get_or_create_endpoint \
363 "volumev3" \
364 "$REGION_NAME" \
365 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v3/\$(project_id)s"
366 else
367 get_or_create_endpoint \
368 "volume" \
369 "$REGION_NAME" \
370 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST/volume/v1/\$(project_id)s"
371
372 get_or_create_service "cinderv2" "volumev2" "Cinder Volume Service V2"
373 get_or_create_endpoint \
374 "volumev2" \
375 "$REGION_NAME" \
376 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST/volume/v2/\$(project_id)s"
377
378 get_or_create_service "cinderv3" "volumev3" "Cinder Volume Service V3"
379 get_or_create_endpoint \
380 "volumev3" \
381 "$REGION_NAME" \
382 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST/volume/v3/\$(project_id)s"
383 fi
Patrick Eastdddb2c72016-05-03 17:34:00 -0700384
385 configure_cinder_internal_tenant
Dean Troyer671c16e2012-12-13 16:22:38 -0600386 fi
387}
388
Ian Wienand1f82f432017-10-04 09:51:02 +1100389# create_cinder_cache_dir() - Part of the init_cinder() process
390function create_cinder_cache_dir {
391 # Create cache dir
392 sudo install -d -o $STACK_USER $CINDER_AUTH_CACHE_DIR
393 rm -f $CINDER_AUTH_CACHE_DIR/*
394}
395
Dean Troyer67787e62012-05-02 11:48:15 -0500396# init_cinder() - Initialize database and volume group
Ian Wienandaee18c72014-02-21 15:35:08 +1100397function init_cinder {
Terry Wilson428af5a2012-11-01 16:12:39 -0400398 if is_service_enabled $DATABASE_BACKENDS; then
Dean Troyerf03bafe2013-02-12 10:58:28 -0600399 # (Re)create cinder database
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +0200400 recreate_database cinder
Dean Troyer67787e62012-05-02 11:48:15 -0500401
Clark Boylan633dbc32017-06-14 12:09:21 -0700402 time_start "dbsync"
Dean Troyerf03bafe2013-02-12 10:58:28 -0600403 # Migrate cinder database
Einst Crazy4f55c2d2016-05-04 08:14:01 +0000404 $CINDER_BIN_DIR/cinder-manage --config-file $CINDER_CONF db sync
Clark Boylan633dbc32017-06-14 12:09:21 -0700405 time_stop "dbsync"
Dean Troyer67787e62012-05-02 11:48:15 -0500406 fi
407
Dean Troyer09718332014-07-03 10:46:57 -0500408 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Dean Troyere8a35ac2014-07-25 12:37:41 -0500409 local be be_name be_type
Dean Troyer09718332014-07-03 10:46:57 -0500410 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500411 be_type=${be%%:*}
412 be_name=${be##*:}
413 if type init_cinder_backend_${be_type} >/dev/null 2>&1; then
Maru Newbyc070a3d2015-01-27 17:44:44 +0000414 # Always init the default volume group for lvm.
415 if [[ "$be_type" == "lvm" ]]; then
416 init_default_lvm_volume_group
417 fi
Dean Troyere8a35ac2014-07-25 12:37:41 -0500418 init_cinder_backend_${be_type} ${be_name}
Vincent Untz0230aa82012-06-14 08:51:01 +0200419 fi
Dean Troyer09718332014-07-03 10:46:57 -0500420 done
Dean Troyer67787e62012-05-02 11:48:15 -0500421 fi
Dean Troyerbc071bc2012-10-01 14:06:44 -0500422
Dean Troyer09718332014-07-03 10:46:57 -0500423 mkdir -p $CINDER_STATE_PATH/volumes
Ian Wienand1f82f432017-10-04 09:51:02 +1100424 create_cinder_cache_dir
Dean Troyer67787e62012-05-02 11:48:15 -0500425}
426
427# install_cinder() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100428function install_cinder {
Dean Troyer67787e62012-05-02 11:48:15 -0500429 git_clone $CINDER_REPO $CINDER_DIR $CINDER_BRANCH
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400430 setup_develop $CINDER_DIR
Ian Wienanda881b882017-04-19 15:42:34 +1000431 if [[ "$CINDER_ISCSI_HELPER" == "tgtadm" ]]; then
432 install_package tgt
Attila Fazekas501aaeb2017-12-11 12:01:32 +0100433 elif [[ "$CINDER_ISCSI_HELPER" == "lioadm" ]]; then
Ian Wienanda881b882017-04-19 15:42:34 +1000434 install_package targetcli
Attila Fazekasc70605d2015-01-26 15:44:47 +0100435 fi
Dean Troyer253a1a32013-04-01 18:23:22 -0500436}
Sean Dague4bf9d7a2013-04-01 16:41:39 -0400437
Dean Troyer253a1a32013-04-01 18:23:22 -0500438# install_cinderclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100439function install_cinderclient {
Ivan Kolodyazhny8d0d3112016-05-26 23:41:49 +0300440 if use_library_from_git "python-brick-cinderclient-ext"; then
441 git_clone_by_name "python-brick-cinderclient-ext"
442 setup_dev_lib "python-brick-cinderclient-ext"
443 fi
444
Sean Daguee08ab102014-11-13 17:09:28 -0500445 if use_library_from_git "python-cinderclient"; then
446 git_clone_by_name "python-cinderclient"
447 setup_dev_lib "python-cinderclient"
448 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 +0100449 fi
Dean Troyer67787e62012-05-02 11:48:15 -0500450}
451
Steve Baker18225d92013-04-14 12:48:41 -0700452# apply config.d approach for cinder volumes directory
Ian Wienandaee18c72014-02-21 15:35:08 +1100453function _configure_tgt_for_config_d {
Steve Baker18225d92013-04-14 12:48:41 -0700454 if [[ ! -d /etc/tgt/stack.d/ ]]; then
455 sudo ln -sf $CINDER_STATE_PATH/volumes /etc/tgt/stack.d
Jordan Pittiera263e7d2016-01-07 19:40:44 +0100456 fi
457 if ! grep -q "include /etc/tgt/stack.d/*" /etc/tgt/targets.conf; then
Steve Baker18225d92013-04-14 12:48:41 -0700458 echo "include /etc/tgt/stack.d/*" | sudo tee -a /etc/tgt/targets.conf
Mate Lakata39caac2012-09-03 15:45:53 +0100459 fi
460}
461
Sean Dague0eebeb42017-08-30 14:16:58 -0400462# start_cinder() - Start running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100463function start_cinder {
Rob Crittenden18d47782014-03-19 17:47:42 -0400464 local service_port=$CINDER_SERVICE_PORT
465 local service_protocol=$CINDER_SERVICE_PROTOCOL
Sean McGinnisdaf12742017-03-03 18:09:35 +0000466 local cinder_url
Eric Harney8ea86602017-08-02 11:40:41 -0400467 if is_service_enabled tls-proxy && [ "$CINDER_USE_MOD_WSGI" == "False" ]; then
Rob Crittenden18d47782014-03-19 17:47:42 -0400468 service_port=$CINDER_SERVICE_PORT_INT
469 service_protocol="http"
470 fi
Attila Fazekasc70605d2015-01-26 15:44:47 +0100471 if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
472 if is_service_enabled c-vol; then
473 # Delete any old stack.conf
474 sudo rm -f /etc/tgt/conf.d/stack.conf
475 _configure_tgt_for_config_d
476 if is_ubuntu; then
477 sudo service tgt restart
Dirk Mueller6bc089f2015-06-01 12:39:12 +0200478 elif is_suse; then
479 # NOTE(dmllr): workaround restart bug
480 # https://bugzilla.suse.com/show_bug.cgi?id=934642
481 stop_service tgtd
482 start_service tgtd
Attila Fazekasc70605d2015-01-26 15:44:47 +0100483 else
Dirk Mueller6bc089f2015-06-01 12:39:12 +0200484 restart_service tgtd
Attila Fazekasc70605d2015-01-26 15:44:47 +0100485 fi
486 # NOTE(gfidente): ensure tgtd is running in debug mode
487 sudo tgtadm --mode system --op update --name debug --value on
Dean Troyer67787e62012-05-02 11:48:15 -0500488 fi
489 fi
490
Sean McGinnisdaf12742017-03-03 18:09:35 +0000491 if [[ "$ENABLED_SERVICES" =~ "c-api" ]]; then
492 if [ "$CINDER_USE_MOD_WSGI" == "False" ]; then
Clark Boylan2dfca042017-05-25 14:57:19 -0700493 run_process c-api "$CINDER_BIN_DIR/cinder-api --config-file $CINDER_CONF"
Sean McGinnisdaf12742017-03-03 18:09:35 +0000494 cinder_url=$service_protocol://$SERVICE_HOST:$service_port
Jens Harbott52609c62017-08-28 11:49:28 +0000495 # Start proxy if tls enabled
496 if is_service_enabled tls-proxy; then
497 start_tls_proxy cinder '*' $CINDER_SERVICE_PORT $CINDER_SERVICE_HOST $CINDER_SERVICE_PORT_INT
Sean McGinnisdaf12742017-03-03 18:09:35 +0000498 fi
499 else
Davanum Srinivasaceb27e2017-08-17 08:59:59 -0400500 run_process "c-api" "$CINDER_BIN_DIR/uwsgi --procname-prefix cinder-api --ini $CINDER_UWSGI_CONF"
Sean McGinnisdaf12742017-03-03 18:09:35 +0000501 cinder_url=$service_protocol://$SERVICE_HOST/volume/v3
Clark Boylan2dfca042017-05-25 14:57:19 -0700502 fi
Sean McGinnisdaf12742017-03-03 18:09:35 +0000503 fi
Eli Qiao4af6eea2017-02-28 15:13:02 +0800504
Sean McGinnisdaf12742017-03-03 18:09:35 +0000505 echo "Waiting for Cinder API to start..."
506 if ! wait_for_service $SERVICE_TIMEOUT $cinder_url; then
507 die $LINENO "c-api did not start"
Dean Troyer09718332014-07-03 10:46:57 -0500508 fi
509
Dean Troyer3159a822014-08-27 14:13:58 -0500510 run_process c-sch "$CINDER_BIN_DIR/cinder-scheduler --config-file $CINDER_CONF"
511 run_process c-bak "$CINDER_BIN_DIR/cinder-backup --config-file $CINDER_CONF"
512 run_process c-vol "$CINDER_BIN_DIR/cinder-volume --config-file $CINDER_CONF"
John Griffithe6d4fe52013-07-15 17:35:54 -0600513
514 # NOTE(jdg): For cinder, startup order matters. To ensure that repor_capabilities is received
515 # by the scheduler start the cinder-volume service last (or restart it) after the scheduler
516 # has started. This is a quick fix for lp bug/1189595
Dean Troyer67787e62012-05-02 11:48:15 -0500517}
518
Dean Troyer699a29f2012-09-10 14:10:27 -0500519# stop_cinder() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100520function stop_cinder {
Sean McGinnisdaf12742017-03-03 18:09:35 +0000521 stop_process c-api
Sean Dague0eebeb42017-08-30 14:16:58 -0400522 stop_process c-bak
523 stop_process c-sch
524 stop_process c-vol
Dean Troyer67787e62012-05-02 11:48:15 -0500525}
Dean Troyer7903b792012-09-13 17:16:12 -0500526
Dean Troyer09718332014-07-03 10:46:57 -0500527# create_volume_types() - Create Cinder's configured volume types
528function create_volume_types {
529 # Create volume types
530 if is_service_enabled c-api && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
Jamie Lennox494f7cd2015-05-29 08:33:03 +0000531 local be be_name
Dean Troyer09718332014-07-03 10:46:57 -0500532 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
Dean Troyere8a35ac2014-07-25 12:37:41 -0500533 be_name=${be##*:}
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300534 openstack --os-region-name="$REGION_NAME" volume type create --property volume_backend_name="${be_name}" ${be_name}
Dean Troyer09718332014-07-03 10:46:57 -0500535 done
536 fi
537}
538
539# Compatibility for Grenade
540
541function create_cinder_volume_group {
542 # During a transition period Grenade needs to have this function defined
543 # It is effectively a no-op in the Grenade 'target' use case
544 :
545}
546
Patrick Eastdddb2c72016-05-03 17:34:00 -0700547function configure_cinder_internal_tenant {
548 # Re-use the Cinder service account for simplicity.
549 iniset $CINDER_CONF DEFAULT cinder_internal_tenant_project_id $(get_or_create_project $SERVICE_PROJECT_NAME)
550 iniset $CINDER_CONF DEFAULT cinder_internal_tenant_user_id $(get_or_create_user "cinder")
551}
552
553function configure_cinder_image_volume_cache {
554 # Expect CINDER_CACHE_ENABLED_FOR_BACKENDS to be a list of backends
555 # similar to CINDER_ENABLED_BACKENDS with NAME:TYPE where NAME will
556 # be the backend specific configuration stanza in cinder.conf.
557 for be in ${CINDER_CACHE_ENABLED_FOR_BACKENDS//,/ }; do
558 local be_name=${be##*:}
559
560 iniset $CINDER_CONF $be_name image_volume_cache_enabled $CINDER_IMG_CACHE_ENABLED
561
562 if [[ -n $CINDER_IMG_CACHE_SIZE_GB ]]; then
563 iniset $CINDER_CONF $be_name image_volume_cache_max_size_gb $CINDER_IMG_CACHE_SIZE_GB
564 fi
565
566 if [[ -n $CINDER_IMG_CACHE_SIZE_COUNT ]]; then
567 iniset $CINDER_CONF $be_name image_volume_cache_max_count $CINDER_IMG_CACHE_SIZE_COUNT
568 fi
569 done
570}
571
Dean Troyercc6b4432013-04-08 15:38:03 -0500572
Dean Troyer7903b792012-09-13 17:16:12 -0500573# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100574$_XTRACE_CINDER
Sean Dague584d90e2013-03-29 14:34:53 -0400575
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100576# Tell emacs to use shell-script-mode
577## Local variables:
578## mode: shell-script
579## End: