lib/cinder
e263c82e
 #!/bin/bash
 #
67787e6b
 # lib/cinder
6d04fd7b
 # Install and start **Cinder** volume service
67787e6b
 
 # Dependencies:
6a5aa7c6
 #
67787e6b
 # - functions
91b8d13e
 # - DEST, DATA_DIR, STACK_USER must be defined
6a5aa7c6
 # - SERVICE_{TENANT_NAME|PASSWORD} must be defined
 # - ``KEYSTONE_TOKEN_FORMAT`` must be defined
67787e6b
 
 # stack.sh
 # ---------
6a5aa7c6
 # - install_cinder
 # - configure_cinder
 # - init_cinder
 # - start_cinder
 # - stop_cinder
 # - cleanup_cinder
67787e6b
 
7903b795
 # Save trace setting
 XTRACE=$(set +o | grep xtrace)
 set +o xtrace
67787e6b
 
 
 # Defaults
 # --------
 
b2fdafea
 # set up default driver
 CINDER_DRIVER=${CINDER_DRIVER:-default}
d0860cc2
 CINDER_PLUGINS=$TOP_DIR/lib/cinder_plugins
09718335
 CINDER_BACKENDS=$TOP_DIR/lib/cinder_backends
d0860cc2
 
 # grab plugin config if specified via cinder_driver
 if [[ -r $CINDER_PLUGINS/$CINDER_DRIVER ]]; then
     source $CINDER_PLUGINS/$CINDER_DRIVER
 fi
b2fdafea
 
67787e6b
 # set up default directories
e08ab104
 GITDIR["python-cinderclient"]=$DEST/python-cinderclient
10e1fd42
 GITDIR["os-brick"]=$DEST/os-brick
67787e6b
 CINDER_DIR=$DEST/cinder
6aaad5f7
 
 # Cinder virtual environment
 if [[ ${USE_VENV} = True ]]; then
     PROJECT_VENV["cinder"]=${CINDER_DIR}.venv
     CINDER_BIN_DIR=${PROJECT_VENV["cinder"]}/bin
 else
     CINDER_BIN_DIR=$(get_python_exec_prefix)
 fi
 
50ac7921
 CINDER_STATE_PATH=${CINDER_STATE_PATH:=$DATA_DIR/cinder}
671c16e6
 CINDER_AUTH_CACHE_DIR=${CINDER_AUTH_CACHE_DIR:-/var/cache/cinder}
 
50ac7921
 CINDER_CONF_DIR=/etc/cinder
 CINDER_CONF=$CINDER_CONF_DIR/cinder.conf
671c16e6
 CINDER_API_PASTE_INI=$CINDER_CONF_DIR/api-paste.ini
50ac7921
 
560346b5
 # Public facing bits
18d4778c
 if is_ssl_enabled_service "cinder" || is_service_enabled tls-proxy; then
     CINDER_SERVICE_PROTOCOL="https"
 fi
560346b5
 CINDER_SERVICE_HOST=${CINDER_SERVICE_HOST:-$SERVICE_HOST}
 CINDER_SERVICE_PORT=${CINDER_SERVICE_PORT:-8776}
 CINDER_SERVICE_PORT_INT=${CINDER_SERVICE_PORT_INT:-18776}
 CINDER_SERVICE_PROTOCOL=${CINDER_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
180f5eb6
 CINDER_SERVICE_LISTEN_ADDRESS=${CINDER_SERVICE_LISTEN_ADDRESS:-$SERVICE_LISTEN_ADDRESS}
560346b5
 
ce8e6f6a
 # What type of LVM device should Cinder use for LVM backend
 # Defaults to default, which is thick, the other valid choice
 # is thin, which as the name implies utilizes lvm thin provisioning.
 CINDER_LVM_TYPE=${CINDER_LVM_TYPE:-default}
09718335
 
 # Default backends
 # The backend format is type:name where type is one of the supported backend
 # types (lvm, nfs, etc) and name is the identifier used in the Cinder
 # configuration and for the volume type name.  Multiple backends are
 # comma-separated.
311f4876
 # The old ``CINDER_MULTI_LVM_BACKEND=True`` setting had a default of:
 # CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-lvm:lvmdriver-1,lvm:lvmdriver-2}
 CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-lvm:lvmdriver-1}
09718335
 
 
b7490da9
 # Should cinder perform secure deletion of volumes?
dfcc3871
 # Defaults to zero. Can also be set to none or shred.
 # This was previously CINDER_SECURE_DELETE (True or False).
 # Equivalents using CINDER_VOLUME_CLEAR are zero and none, respectively.
 # Set to none to avoid this bug when testing:
b7490da9
 # https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1023755
dfcc3871
 if [[ -n $CINDER_SECURE_DELETE ]]; then
     CINDER_SECURE_DELETE=$(trueorfalse True CINDER_SECURE_DELETE)
     if [[ $CINDER_SECURE_DELETE == "False" ]]; then
         CINDER_VOLUME_CLEAR_DEFAULT="none"
     fi
72ad9427
     deprecated "Configure secure Cinder volume deletion using CINDER_VOLUME_CLEAR instead of CINDER_SECURE_DELETE."
dfcc3871
 fi
 CINDER_VOLUME_CLEAR=${CINDER_VOLUME_CLEAR:-${CINDER_VOLUME_CLEAR_DEFAULT:-zero}}
 CINDER_VOLUME_CLEAR=$(echo ${CINDER_VOLUME_CLEAR} | tr '[:upper:]' '[:lower:]')
b7490da9
 
f35ff72b
 # Cinder reports allocations back to the scheduler on periodic intervals
 # it turns out we can get an "out of space" issue when we run tests too
 # quickly just because cinder didn't realize we'd freed up resources.
 # Make this configurable so that devstack-gate/tempest can set it to
 # less than the 60 second default
 # https://bugs.launchpad.net/cinder/+bug/1180976
 CINDER_PERIODIC_INTERVAL=${CINDER_PERIODIC_INTERVAL:-60}
 
c70605d1
 CINDER_ISCSI_HELPER=${CINDER_ISCSI_HELPER:-tgtadm}
 
651cb1ad
 # Toggle for deploying Cinder under HTTPD + mod_wsgi
 CINDER_USE_MOD_WSGI=${CINDER_USE_MOD_WSGI:-False}
cc6b4435
 
09718335
 # Source the enabled backends
 if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
     for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
e8a35acd
         be_type=${be%%:*}
         be_name=${be##*:}
         if [[ -r $CINDER_BACKENDS/${be_type} ]]; then
             source $CINDER_BACKENDS/${be_type}
09718335
         fi
     done
 fi
 
afc1423e
 # Change the default nova_catalog_info and nova_catalog_admin_info values in
 # cinder so that the service name cinder is searching for matches that set for
 # nova in keystone.
 CINDER_NOVA_CATALOG_INFO=${CINDER_NOVA_CATALOG_INFO:-compute:nova:publicURL}
 CINDER_NOVA_CATALOG_ADMIN_INFO=${CINDER_NOVA_CATALOG_ADMIN_INFO:-compute:nova:adminURL}
 
09718335
 
cc6b4435
 # Functions
 # ---------
e4fa7213
 
 # Test if any Cinder services are enabled
 # is_cinder_enabled
 function is_cinder_enabled {
     [[ ,${ENABLED_SERVICES} =~ ,"c-" ]] && return 0
     return 1
 }
 
651cb1ad
 # _cinder_cleanup_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
 function _cinder_cleanup_apache_wsgi {
     sudo rm -f $(apache_site_config_for osapi-volume)
 }
 
67787e6b
 # cleanup_cinder() - Remove residual data files, anything left over from previous
 # runs that a clean run would need to clean up
aee18c74
 function cleanup_cinder {
252f2f53
     # ensure the volume group is cleared up because fails might
     # leave dead volumes in the group
c70605d1
     if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
ada886dd
         local targets
         targets=$(sudo tgtadm --op show --mode target)
c70605d1
         if [ $? -ne 0 ]; then
             # If tgt driver isn't running this won't work obviously
             # So check the response and restart if need be
             echo "tgtd seems to be in a bad state, restarting..."
             if is_ubuntu; then
                 restart_service tgt
             else
                 restart_service tgtd
             fi
             targets=$(sudo tgtadm --op show --mode target)
252f2f53
         fi
 
c70605d1
         if [[ -n "$targets" ]]; then
             local iqn_list=( $(grep --no-filename -r iqn $SCSI_PERSIST_DIR | sed 's/<target //' | sed 's/>//') )
             for i in "${iqn_list[@]}"; do
                 echo removing iSCSI target: $i
                 sudo tgt-admin --delete $i
             done
         fi
252f2f53
 
c70605d1
         if is_ubuntu; then
             stop_service tgt
         else
             stop_service tgtd
         fi
252f2f53
     else
c70605d1
         sudo cinder-rtstool get-targets | sudo xargs -rn 1 cinder-rtstool delete
252f2f53
     fi
 
09718335
     if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
e8a35acd
         local be be_name be_type
09718335
         for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
e8a35acd
             be_type=${be%%:*}
             be_name=${be##*:}
             if type cleanup_cinder_backend_${be_type} >/dev/null 2>&1; then
                 cleanup_cinder_backend_${be_type} ${be_name}
09718335
             fi
         done
dda2b7af
     fi
651cb1ad
 
     if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
         _cinder_cleanup_apache_wsgi
     fi
 }
 
 # _cinder_config_apache_wsgi() - Set WSGI config files
 function _cinder_config_apache_wsgi {
ada886dd
     local cinder_apache_conf
     cinder_apache_conf=$(apache_site_config_for osapi-volume)
651cb1ad
     local cinder_ssl=""
     local cinder_certfile=""
     local cinder_keyfile=""
     local cinder_api_port=$CINDER_SERVICE_PORT
     local venv_path=""
 
     if is_ssl_enabled_service c-api; then
         cinder_ssl="SSLEngine On"
         cinder_certfile="SSLCertificateFile $CINDER_SSL_CERT"
         cinder_keyfile="SSLCertificateKeyFile $CINDER_SSL_KEY"
     fi
     if [[ ${USE_VENV} = True ]]; then
         venv_path="python-path=${PROJECT_VENV["cinder"]}/lib/python2.7/site-packages"
     fi
 
     # copy proxy vhost file
     sudo cp $FILES/apache-cinder-api.template $cinder_apache_conf
     sudo sed -e "
         s|%PUBLICPORT%|$cinder_api_port|g;
         s|%APACHE_NAME%|$APACHE_NAME|g;
         s|%APIWORKERS%|$API_WORKERS|g
         s|%CINDER_BIN_DIR%|$CINDER_BIN_DIR|g;
         s|%SSLENGINE%|$cinder_ssl|g;
         s|%SSLCERTFILE%|$cinder_certfile|g;
         s|%SSLKEYFILE%|$cinder_keyfile|g;
         s|%USER%|$STACK_USER|g;
         s|%VIRTUALENV%|$venv_path|g
     " -i $cinder_apache_conf
67787e6b
 }
 
63e17843
 # configure_cinder() - Set config files, create data dirs, etc
aee18c74
 function configure_cinder {
8421c2b9
     sudo install -d -o $STACK_USER -m 755 $CINDER_CONF_DIR
63e17843
 
     cp -p $CINDER_DIR/etc/cinder/policy.json $CINDER_CONF_DIR
 
cecbd1ff
     rm -f $CINDER_CONF
 
c6782413
     configure_rootwrap cinder
4e823ff4
 
67787e6b
     cp $CINDER_DIR/etc/cinder/api-paste.ini $CINDER_API_PASTE_INI
82dea7c6
 
     inicomment $CINDER_API_PASTE_INI filter:authtoken auth_host
     inicomment $CINDER_API_PASTE_INI filter:authtoken auth_port
     inicomment $CINDER_API_PASTE_INI filter:authtoken auth_protocol
bd24a8d0
     inicomment $CINDER_API_PASTE_INI filter:authtoken cafile
82dea7c6
     inicomment $CINDER_API_PASTE_INI filter:authtoken admin_tenant_name
     inicomment $CINDER_API_PASTE_INI filter:authtoken admin_user
     inicomment $CINDER_API_PASTE_INI filter:authtoken admin_password
     inicomment $CINDER_API_PASTE_INI filter:authtoken signing_dir
bc071bce
 
0595237e
     configure_auth_token_middleware $CINDER_CONF cinder $CINDER_AUTH_CACHE_DIR
82dea7c6
 
afc1423e
     iniset $CINDER_CONF DEFAULT nova_catalog_info $CINDER_NOVA_CATALOG_INFO
     iniset $CINDER_CONF DEFAULT nova_catalog_admin_info $CINDER_NOVA_CATALOG_ADMIN_INFO
 
67787e6b
     iniset $CINDER_CONF DEFAULT auth_strategy keystone
03997942
     iniset $CINDER_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
67787e6b
     iniset $CINDER_CONF DEFAULT verbose True
09718335
 
c70605d1
     iniset $CINDER_CONF DEFAULT iscsi_helper "$CINDER_ISCSI_HELPER"
23d6d506
     iniset $CINDER_CONF database connection `database_connection_url cinder`
67787e6b
     iniset $CINDER_CONF DEFAULT api_paste_config $CINDER_API_PASTE_INI
a58382ac
     iniset $CINDER_CONF DEFAULT rootwrap_config "$CINDER_CONF_DIR/rootwrap.conf"
9f22f07a
     iniset $CINDER_CONF DEFAULT osapi_volume_extension cinder.api.contrib.standard_extensions
180f5eb6
     iniset $CINDER_CONF DEFAULT osapi_volume_listen $CINDER_SERVICE_LISTEN_ADDRESS
50ac7921
     iniset $CINDER_CONF DEFAULT state_path $CINDER_STATE_PATH
23d6d506
     iniset $CINDER_CONF oslo_concurrency lock_path $CINDER_STATE_PATH
f35ff72b
     iniset $CINDER_CONF DEFAULT periodic_interval $CINDER_PERIODIC_INTERVAL
f64f43b5
     # NOTE(thingee): Cinder V1 API is deprecated and defaults to off as of
     # Juno. Keep it enabled so we can continue testing while it's still
     # supported.
     iniset $CINDER_CONF DEFAULT enable_v1_api true
4e823ff4
 
679f395f
     iniset $CINDER_CONF DEFAULT os_region_name "$REGION_NAME"
 
09718335
     if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
e8a35acd
         local enabled_backends=""
         local default_name=""
         local be be_name be_type
09718335
         for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
e8a35acd
             be_type=${be%%:*}
             be_name=${be##*:}
             if type configure_cinder_backend_${be_type} >/dev/null 2>&1; then
                 configure_cinder_backend_${be_type} ${be_name}
09718335
             fi
a25922b9
             if [[ -z "$default_name" ]]; then
                 default_name=$be_name
09718335
             fi
e8a35acd
             enabled_backends+=$be_name,
09718335
         done
         iniset $CINDER_CONF DEFAULT enabled_backends ${enabled_backends%,*}
6a4aa78f
         if [[ -n "$default_name" ]]; then
             iniset $CINDER_CONF DEFAULT default_volume_type ${default_name}
09718335
         fi
     fi
 
2983474e
     if is_service_enabled swift; then
22f747b8
         iniset $CINDER_CONF DEFAULT backup_swift_url "$SWIFT_SERVICE_PROTOCOL://$SERVICE_HOST:$SWIFT_DEFAULT_BIND_PORT/v1/AUTH_"
2983474e
     fi
 
2bfbc779
     if is_service_enabled ceilometer; then
dc0938e1
         iniset $CINDER_CONF DEFAULT notification_driver "messaging"
2bfbc779
     fi
 
560346b5
     if is_service_enabled tls-proxy; then
         # Set the service port for a proxy to take the original
         iniset $CINDER_CONF DEFAULT osapi_volume_listen_port $CINDER_SERVICE_PORT_INT
     fi
 
4d3049e7
     if [ "$SYSLOG" != "False" ]; then
         iniset $CINDER_CONF DEFAULT use_syslog True
     fi
 
2dd110ce
     iniset_rpc_backend cinder $CINDER_CONF
f71bf192
 
dfcc3871
     if [[ "$CINDER_VOLUME_CLEAR" == "none" ]] || [[ "$CINDER_VOLUME_CLEAR" == "zero" ]] || [[ "$CINDER_VOLUME_CLEAR" == "shred" ]]; then
         iniset $CINDER_CONF DEFAULT volume_clear $CINDER_VOLUME_CLEAR
213c4168
     fi
 
05ae833b
     # Format logging
651cb1ad
     if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && [ "$CINDER_USE_MOD_WSGI" == "False" ]; then
05ae833b
         setup_colorized_logging $CINDER_CONF DEFAULT "project_id" "user_id"
95b994d5
     else
         # Set req-id, project-name and resource in log format
         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"
1057bffa
     fi
b2fdafea
 
651cb1ad
     if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
         _cinder_config_apache_wsgi
     fi
 
d0860cc2
     if [[ -r $CINDER_PLUGINS/$CINDER_DRIVER ]]; then
         configure_cinder_driver
b2fdafea
     fi
0db17137
 
05bd7b80
     iniset $CINDER_CONF DEFAULT osapi_volume_workers "$API_WORKERS"
18d4778c
 
     iniset $CINDER_CONF DEFAULT glance_api_servers "${GLANCE_SERVICE_PROTOCOL}://${GLANCE_HOSTPORT}"
     if is_ssl_enabled_service glance || is_service_enabled tls-proxy; then
         iniset $CINDER_CONF DEFAULT glance_protocol https
4b109297
         iniset $CINDER_CONF DEFAULT glance_ca_certificates_file $SSL_BUNDLE_FILE
18d4778c
     fi
 
     # Register SSL certificates if provided
     if is_ssl_enabled_service cinder; then
         ensure_certificates CINDER
 
         iniset $CINDER_CONF DEFAULT ssl_cert_file "$CINDER_SSL_CERT"
         iniset $CINDER_CONF DEFAULT ssl_key_file "$CINDER_SSL_KEY"
     fi
 
38bee18a
     # Set os_privileged_user credentials (used for os-assisted-snapshots)
     iniset $CINDER_CONF DEFAULT os_privileged_user_name nova
     iniset $CINDER_CONF DEFAULT os_privileged_user_password "$SERVICE_PASSWORD"
     iniset $CINDER_CONF DEFAULT os_privileged_user_tenant "$SERVICE_TENANT_NAME"
7159b4ba
     iniset $CINDER_CONF DEFAULT graceful_shutdown_timeout "$SERVICE_GRACEFUL_SHUTDOWN_TIMEOUT"
67787e6b
 }
 
671c16e6
 # create_cinder_accounts() - Set up common required cinder accounts
 
 # Tenant               User       Roles
 # ------------------------------------------------------------------
 # service              cinder     admin        # if enabled
 
 # Migrated from keystone_data.sh
aee18c74
 function create_cinder_accounts {
671c16e6
 
     # Cinder
     if [[ "$ENABLED_SERVICES" =~ "c-api" ]]; then
0abde393
 
e8bc2b82
         create_service_user "cinder"
0abde393
 
671c16e6
         if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
0abde393
 
b17ad756
             get_or_create_service "cinder" "volume" "Cinder Volume Service"
             get_or_create_endpoint "volume" "$REGION_NAME" \
0abde393
                 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(tenant_id)s" \
                 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(tenant_id)s" \
                 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v1/\$(tenant_id)s"
 
b17ad756
             get_or_create_service "cinderv2" "volumev2" "Cinder Volume Service V2"
             get_or_create_endpoint "volumev2" "$REGION_NAME" \
0abde393
                 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(tenant_id)s" \
                 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(tenant_id)s" \
                 "$CINDER_SERVICE_PROTOCOL://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v2/\$(tenant_id)s"
671c16e6
         fi
     fi
 }
 
f03bafeb
 # create_cinder_cache_dir() - Part of the init_cinder() process
aee18c74
 function create_cinder_cache_dir {
f03bafeb
     # Create cache dir
8421c2b9
     sudo install -d -o $STACK_USER $CINDER_AUTH_CACHE_DIR
f03bafeb
     rm -f $CINDER_AUTH_CACHE_DIR/*
 }
 
67787e6b
 # init_cinder() - Initialize database and volume group
e8a35acd
 # Uses global ``NOVA_ENABLED_APIS``
aee18c74
 function init_cinder {
67787e6b
     # Force nova volumes off
     NOVA_ENABLED_APIS=$(echo $NOVA_ENABLED_APIS | sed "s/osapi_volume,//")
 
428af5a2
     if is_service_enabled $DATABASE_BACKENDS; then
f03bafeb
         # (Re)create cinder database
157c84b8
         recreate_database cinder
67787e6b
 
f03bafeb
         # Migrate cinder database
9fbeeddc
         $CINDER_BIN_DIR/cinder-manage db sync
67787e6b
     fi
 
09718335
     if is_service_enabled c-vol && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
e8a35acd
         local be be_name be_type
09718335
         for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
e8a35acd
             be_type=${be%%:*}
             be_name=${be##*:}
             if type init_cinder_backend_${be_type} >/dev/null 2>&1; then
c070a3db
                 # Always init the default volume group for lvm.
                 if [[ "$be_type" == "lvm" ]]; then
                     init_default_lvm_volume_group
                 fi
e8a35acd
                 init_cinder_backend_${be_type} ${be_name}
0230aa89
             fi
09718335
         done
67787e6b
     fi
bc071bce
 
09718335
     mkdir -p $CINDER_STATE_PATH/volumes
f03bafeb
     create_cinder_cache_dir
67787e6b
 }
 
 # install_cinder() - Collect source and prepare
aee18c74
 function install_cinder {
10e1fd42
     # Install os-brick from git so we make sure we're testing
     # the latest code.
     if use_library_from_git "os-brick"; then
         git_clone_by_name "os-brick"
         setup_dev_lib "os-brick"
     fi
 
67787e6b
     git_clone $CINDER_REPO $CINDER_DIR $CINDER_BRANCH
4bf9d7a7
     setup_develop $CINDER_DIR
c70605d1
     if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
         if is_fedora; then
             install_package scsi-target-utils
         else
             install_package tgt
         fi
     fi
651cb1ad
 
     if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
         install_apache_wsgi
         if is_ssl_enabled_service "c-api"; then
             enable_mod_ssl
         fi
     fi
253a1a35
 }
4bf9d7a7
 
253a1a35
 # install_cinderclient() - Collect source and prepare
aee18c74
 function install_cinderclient {
e08ab104
     if use_library_from_git "python-cinderclient"; then
         git_clone_by_name "python-cinderclient"
         setup_dev_lib "python-cinderclient"
         sudo install -D -m 0644 -o $STACK_USER {${GITDIR["python-cinderclient"]}/tools/,/etc/bash_completion.d/}cinder.bash_completion
5cb19069
     fi
67787e6b
 }
 
18225d92
 # apply config.d approach for cinder volumes directory
aee18c74
 function _configure_tgt_for_config_d {
18225d92
     if [[ ! -d /etc/tgt/stack.d/ ]]; then
         sudo ln -sf $CINDER_STATE_PATH/volumes /etc/tgt/stack.d
         echo "include /etc/tgt/stack.d/*" | sudo tee -a /etc/tgt/targets.conf
a39caaca
     fi
 }
 
67787e6b
 # start_cinder() - Start running processes, including screen
aee18c74
 function start_cinder {
18d4778c
     local service_port=$CINDER_SERVICE_PORT
     local service_protocol=$CINDER_SERVICE_PROTOCOL
     if is_service_enabled tls-proxy; then
         service_port=$CINDER_SERVICE_PORT_INT
         service_protocol="http"
     fi
c70605d1
     if [ "$CINDER_ISCSI_HELPER" = "tgtadm" ]; then
         if is_service_enabled c-vol; then
             # Delete any old stack.conf
             sudo rm -f /etc/tgt/conf.d/stack.conf
             _configure_tgt_for_config_d
             if is_ubuntu; then
                 sudo service tgt restart
6bc089fc
             elif is_suse; then
                 # NOTE(dmllr): workaround restart bug
                 # https://bugzilla.suse.com/show_bug.cgi?id=934642
                 stop_service tgtd
                 start_service tgtd
c70605d1
             else
6bc089fc
                 restart_service tgtd
c70605d1
             fi
             # NOTE(gfidente): ensure tgtd is running in debug mode
             sudo tgtadm --mode system --op update --name debug --value on
67787e6b
         fi
     fi
 
651cb1ad
     if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
         enable_apache_site osapi-volume
         restart_apache_server
         tail_log c-api /var/log/$APACHE_NAME/c-api.log
     else
         run_process c-api "$CINDER_BIN_DIR/cinder-api --config-file $CINDER_CONF"
         echo "Waiting for Cinder API to start..."
         if ! wait_for_service $SERVICE_TIMEOUT $service_protocol://$CINDER_SERVICE_HOST:$service_port; then
             die $LINENO "c-api did not start"
         fi
09718335
     fi
 
3159a821
     run_process c-sch "$CINDER_BIN_DIR/cinder-scheduler --config-file $CINDER_CONF"
     run_process c-bak "$CINDER_BIN_DIR/cinder-backup --config-file $CINDER_CONF"
     run_process c-vol "$CINDER_BIN_DIR/cinder-volume --config-file $CINDER_CONF"
e6d4fe5f
 
     # NOTE(jdg): For cinder, startup order matters.  To ensure that repor_capabilities is received
     # by the scheduler start the cinder-volume service last (or restart it) after the scheduler
     # has started.  This is a quick fix for lp bug/1189595
560346b5
 
     # Start proxies if enabled
     if is_service_enabled c-api && is_service_enabled tls-proxy; then
         start_tls_proxy '*' $CINDER_SERVICE_PORT $CINDER_SERVICE_HOST $CINDER_SERVICE_PORT_INT &
     fi
67787e6b
 }
 
699a29f7
 # stop_cinder() - Stop running processes
aee18c74
 function stop_cinder {
651cb1ad
     if [ "$CINDER_USE_MOD_WSGI" == "True" ]; then
         disable_apache_site osapi-volume
         restart_apache_server
     else
         stop_process c-api
     fi
 
699a29f7
     # Kill the cinder screen windows
e8a35acd
     local serv
651cb1ad
     for serv in c-bak c-sch c-vol; do
2f27a0ed
         stop_process $serv
699a29f7
     done
67787e6b
 }
7903b795
 
09718335
 # create_volume_types() - Create Cinder's configured volume types
 function create_volume_types {
     # Create volume types
     if is_service_enabled c-api && [[ -n "$CINDER_ENABLED_BACKENDS" ]]; then
494f7cdf
         local be be_name
09718335
         for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
e8a35acd
             be_name=${be##*:}
7e5fb63b
             # FIXME(jamielennox): Remove --os-volume-api-version pinning when
             # osc supports volume type create on v2 api. bug #1475060
             openstack volume type create --os-volume-api-version 1 --property volume_backend_name="${be_name}" ${be_name}
09718335
         done
     fi
 }
 
 # Compatibility for Grenade
 
 function create_cinder_volume_group {
     # During a transition period Grenade needs to have this function defined
     # It is effectively a no-op in the Grenade 'target' use case
     :
 }
 
cc6b4435
 
7903b795
 # Restore xtrace
 $XTRACE
584d90ec
 
6a5aa7c6
 # Tell emacs to use shell-script-mode
 ## Local variables:
 ## mode: shell-script
 ## End: