blob: 118fa7c863a2153f669d38cbd6e14d4082daa608 [file] [log] [blame]
Sean Daguee263c822014-12-05 14:25:28 -05001#!/bin/bash
2#
Dean Troyer73f6f252012-09-17 11:22:21 -05003# lib/glance
Dean Troyer6d04fd72012-12-21 11:03:37 -06004# Functions to control the configuration and operation of the **Glance** service
Dean Troyer73f6f252012-09-17 11:22:21 -05005
6# Dependencies:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01007#
8# - ``functions`` file
9# - ``DEST``, ``DATA_DIR``, ``STACK_USER`` must be defined
10# - ``SERVICE_{TENANT_NAME|PASSWORD}`` must be defined
11# - ``SERVICE_HOST``
12# - ``KEYSTONE_TOKEN_FORMAT`` must be defined
Dean Troyer73f6f252012-09-17 11:22:21 -050013
14# ``stack.sh`` calls the entry points in this order:
15#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010016# - install_glance
17# - configure_glance
18# - init_glance
19# - start_glance
20# - stop_glance
21# - cleanup_glance
Dean Troyer73f6f252012-09-17 11:22:21 -050022
23# Save trace setting
Ian Wienand523f4882015-10-13 11:03:03 +110024_XTRACE_GLANCE=$(set +o | grep xtrace)
Dean Troyer73f6f252012-09-17 11:22:21 -050025set +o xtrace
26
27
28# Defaults
29# --------
30
Dean Troyer73f6f252012-09-17 11:22:21 -050031# Set up default directories
Sean Daguee08ab102014-11-13 17:09:28 -050032GITDIR["python-glanceclient"]=$DEST/python-glanceclient
Sean Dagueaecd1892014-11-19 15:19:51 -050033GITDIR["glance_store"]=$DEST/glance_store
Dean Troyer73f6f252012-09-17 11:22:21 -050034GLANCE_DIR=$DEST/glance
Dean Troyeraed60792015-02-17 15:38:16 -060035
36# Glance virtual environment
37if [[ ${USE_VENV} = True ]]; then
38 PROJECT_VENV["glance"]=${GLANCE_DIR}.venv
39 GLANCE_BIN_DIR=${PROJECT_VENV["glance"]}/bin
40else
41 GLANCE_BIN_DIR=$(get_python_exec_prefix)
42fi
43
Abhishek Kekane057aaa62020-07-29 07:37:16 +000044# Cinder for Glance
45USE_CINDER_FOR_GLANCE=$(trueorfalse False USE_CINDER_FOR_GLANCE)
46# GLANCE_CINDER_DEFAULT_BACKEND should be one of the values
47# from CINDER_ENABLED_BACKENDS
48GLANCE_CINDER_DEFAULT_BACKEND=${GLANCE_CINDER_DEFAULT_BACKEND:-lvmdriver-1}
49GLANCE_STORE_ROOTWRAP_BASE_DIR=/usr/local/etc/glance
50# NOTE (abhishekk): For opensuse data files are stored in different directory
51if is_opensuse; then
52 GLANCE_STORE_ROOTWRAP_BASE_DIR=/usr/etc/glance
53fi
Brian Rosmaita6e9f7c22020-10-13 14:20:38 -040054# When Cinder is used as a glance store, you can optionally configure cinder to
55# optimize bootable volume creation by allowing volumes to be cloned directly
56# in the backend instead of transferring data via Glance. To use this feature,
57# set CINDER_ALLOWED_DIRECT_URL_SCHEMES for cinder.conf and enable
58# GLANCE_SHOW_DIRECT_URL and/or GLANCE_SHOW_MULTIPLE_LOCATIONS for Glance. The
59# default value for both of these is False, because for some backends they
60# present a grave security risk (though not for Cinder, because all that's
61# exposed is the volume_id where the image data is stored.) See OSSN-0065 for
62# more information: https://wiki.openstack.org/wiki/OSSN/OSSN-0065
63GLANCE_SHOW_DIRECT_URL=$(trueorfalse False GLANCE_SHOW_DIRECT_URL)
64GLANCE_SHOW_MULTIPLE_LOCATIONS=$(trueorfalse False GLANCE_SHOW_MULTIPLE_LOCATIONS)
65
Abhishek Kekane6f91da92019-10-17 09:02:41 +000066# Glance multi-store configuration
67# Boolean flag to enable multiple store configuration for glance
68GLANCE_ENABLE_MULTIPLE_STORES=$(trueorfalse False GLANCE_ENABLE_MULTIPLE_STORES)
69
70# Comma separated list for configuring multiple file stores of glance,
71# for example; GLANCE_MULTIPLE_FILE_STORES = fast,cheap,slow
72GLANCE_MULTIPLE_FILE_STORES=${GLANCE_MULTIPLE_FILE_STORES:-fast}
73
74# Default store/backend for glance, must be one of the store specified
75# in GLANCE_MULTIPLE_FILE_STORES option.
76GLANCE_DEFAULT_BACKEND=${GLANCE_DEFAULT_BACKEND:-fast}
77
Dean Troyer73f6f252012-09-17 11:22:21 -050078GLANCE_CACHE_DIR=${GLANCE_CACHE_DIR:=$DATA_DIR/glance/cache}
Abhishek Kekane6f91da92019-10-17 09:02:41 +000079
Dan Smith09eea0b2020-07-09 08:31:51 -070080# Full Glance functionality requires running in standalone mode. If we are
81# not in uwsgi mode, then we are standalone, otherwise allow separate control.
82if [[ "$WSGI_MODE" != "uwsgi" ]]; then
83 GLANCE_STANDALONE=True
84fi
Dan Smith155109d2020-07-24 06:49:01 -070085GLANCE_STANDALONE=${GLANCE_STANDALONE:-False}
Dan Smith09eea0b2020-07-09 08:31:51 -070086
Abhishek Kekane6f91da92019-10-17 09:02:41 +000087# File path for each store specified in GLANCE_MULTIPLE_FILE_STORES, the store
88# identifier will be appended to this path at runtime. If GLANCE_MULTIPLE_FILE_STORES
89# has fast,cheap specified then filepath will be generated like $DATA_DIR/glance/fast
90# and $DATA_DIR/glance/cheap.
91GLANCE_MULTISTORE_FILE_IMAGE_DIR=${GLANCE_MULTISTORE_FILE_IMAGE_DIR:=$DATA_DIR/glance}
Dean Troyer73f6f252012-09-17 11:22:21 -050092GLANCE_IMAGE_DIR=${GLANCE_IMAGE_DIR:=$DATA_DIR/glance/images}
Abhishek Kekane057aaa62020-07-29 07:37:16 +000093GLANCE_NFS_MOUNTPOINT=$GLANCE_IMAGE_DIR/mnt
Matthew Treinishfa898f52017-04-25 01:30:10 -040094GLANCE_LOCK_DIR=${GLANCE_LOCK_DIR:=$DATA_DIR/glance/locks}
Abhishek Kekane6f91da92019-10-17 09:02:41 +000095GLANCE_STAGING_DIR=${GLANCE_MULTISTORE_FILE_IMAGE_DIR:=$DATA_DIR/os_glance_staging_store}
96GLANCE_TASKS_DIR=${GLANCE_MULTISTORE_FILE_IMAGE_DIR:=$DATA_DIR/os_glance_tasks_store}
Dean Troyer73f6f252012-09-17 11:22:21 -050097
Abhishek Kekane73ad9762020-06-16 15:20:48 +000098GLANCE_USE_IMPORT_WORKFLOW=$(trueorfalse False GLANCE_USE_IMPORT_WORKFLOW)
99
Dean Troyer73f6f252012-09-17 11:22:21 -0500100GLANCE_CONF_DIR=${GLANCE_CONF_DIR:-/etc/glance}
Pawel Koniszewski76e39252014-09-06 07:06:46 -0400101GLANCE_METADEF_DIR=$GLANCE_CONF_DIR/metadefs
Dean Troyer73f6f252012-09-17 11:22:21 -0500102GLANCE_API_CONF=$GLANCE_CONF_DIR/glance-api.conf
Dean Troyer73f6f252012-09-17 11:22:21 -0500103GLANCE_API_PASTE_INI=$GLANCE_CONF_DIR/glance-api-paste.ini
104GLANCE_CACHE_CONF=$GLANCE_CONF_DIR/glance-cache.conf
Dirk Mueller46d1ba62013-09-09 14:31:37 +0200105GLANCE_SCHEMA_JSON=$GLANCE_CONF_DIR/schema-image.json
Jamie Lennoxf4f01c62015-06-19 02:52:41 +0000106GLANCE_SWIFT_STORE_CONF=$GLANCE_CONF_DIR/glance-swift-store.conf
bhagyashris6a25fb92017-12-14 13:23:41 +0530107GLANCE_IMAGE_IMPORT_CONF=$GLANCE_CONF_DIR/glance-image-import.conf
Dean Troyer73f6f252012-09-17 11:22:21 -0500108
Sean Daguef3b2f4c2017-04-13 10:11:48 -0400109if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -0400110 GLANCE_SERVICE_PROTOCOL="https"
111fi
112
Dean Troyer73f6f252012-09-17 11:22:21 -0500113# Glance connection info. Note the port must be specified.
Rob Crittenden18d47782014-03-19 17:47:42 -0400114GLANCE_SERVICE_HOST=${GLANCE_SERVICE_HOST:-$SERVICE_HOST}
Jens Harbottdc7b4292017-09-19 10:52:32 +0000115GLANCE_SERVICE_LISTEN_ADDRESS=${GLANCE_SERVICE_LISTEN_ADDRESS:-$(ipv6_unquote $SERVICE_LISTEN_ADDRESS)}
Rob Crittenden18d47782014-03-19 17:47:42 -0400116GLANCE_SERVICE_PORT=${GLANCE_SERVICE_PORT:-9292}
117GLANCE_SERVICE_PORT_INT=${GLANCE_SERVICE_PORT_INT:-19292}
118GLANCE_HOSTPORT=${GLANCE_HOSTPORT:-$GLANCE_SERVICE_HOST:$GLANCE_SERVICE_PORT}
119GLANCE_SERVICE_PROTOCOL=${GLANCE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Matthew Treinish1fa65362017-06-23 22:32:37 +0000120GLANCE_UWSGI=$GLANCE_BIN_DIR/glance-wsgi-api
Jeremy Liu2f7df512017-07-12 10:09:48 +0800121GLANCE_UWSGI_CONF=$GLANCE_CONF_DIR/glance-uwsgi.ini
Matthew Treinish1fa65362017-06-23 22:32:37 +0000122# If wsgi mode is uwsgi run glance under uwsgi, else default to eventlet
123# TODO(mtreinish): Remove the eventlet path here and in all the similar
124# conditionals below after the Pike release
125if [[ "$WSGI_MODE" == "uwsgi" ]]; then
126 GLANCE_URL="$GLANCE_SERVICE_PROTOCOL://$GLANCE_SERVICE_HOST/image"
127else
128 GLANCE_URL="$GLANCE_SERVICE_PROTOCOL://$GLANCE_HOSTPORT"
129fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500130
Dean Troyercc6b4432013-04-08 15:38:03 -0500131# Functions
132# ---------
Dean Troyer73f6f252012-09-17 11:22:21 -0500133
Dean Troyere4fa7212014-01-15 15:04:49 -0600134# Test if any Glance services are enabled
135# is_glance_enabled
136function is_glance_enabled {
Clark Boylan902158b2017-05-30 14:11:09 -0700137 [[ ,${DISABLED_SERVICES} =~ ,"glance" ]] && return 1
Dean Troyere4fa7212014-01-15 15:04:49 -0600138 [[ ,${ENABLED_SERVICES} =~ ,"g-" ]] && return 0
139 return 1
140}
141
Dean Troyer73f6f252012-09-17 11:22:21 -0500142# cleanup_glance() - 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_glance {
Dan Smith61b4fbf2021-03-09 08:05:37 -0800145 # delete image files (glance) and all of the glance-remote temporary
146 # storage
147 sudo rm -rf $GLANCE_CACHE_DIR $GLANCE_IMAGE_DIR "${DATA_DIR}/glance-remote"
Abhishek Kekane6f91da92019-10-17 09:02:41 +0000148
149 # Cleanup multiple stores directories
150 if [[ "$GLANCE_ENABLE_MULTIPLE_STORES" == "True" ]]; then
151 local store file_dir
152 for store in $(echo $GLANCE_MULTIPLE_FILE_STORES | tr "," "\n"); do
153 file_dir="${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/${store}/"
154 sudo rm -rf $file_dir
155 done
156
157 # Cleanup reserved stores directories
158 sudo rm -rf $GLANCE_STAGING_DIR $GLANCE_TASKS_DIR
159 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500160}
161
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000162# Set multiple cinder store related config options for each of the cinder store
163#
164function configure_multiple_cinder_stores {
165
166 local be be_name be_type enabled_backends
167 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
168 be_type=${be%%:*}
169 be_name=${be##*:}
170 enabled_backends+="${be_name}:cinder,"
171
172 set_common_cinder_store_params $be_name
173 iniset $GLANCE_API_CONF $be_name cinder_volume_type ${be_name}
174 if [[ "$be_type" == "nfs" ]]; then
175 mkdir -p "$GLANCE_NFS_MOUNTPOINT"
176 iniset $GLANCE_API_CONF $be_name cinder_mount_point_base "$GLANCE_NFS_MOUNTPOINT"
177 fi
178 done
179 iniset $GLANCE_API_CONF DEFAULT enabled_backends ${enabled_backends::-1}
180 iniset $GLANCE_API_CONF glance_store default_backend $GLANCE_CINDER_DEFAULT_BACKEND
181}
182
183# Set common cinder store options to given config section
184#
185# Arguments:
186# config_section
187#
188function set_common_cinder_store_params {
189 local config_section="$1"
190 iniset $GLANCE_API_CONF $config_section cinder_store_auth_address $KEYSTONE_SERVICE_URI_V3
191 iniset $GLANCE_API_CONF $config_section cinder_store_user_name glance
192 iniset $GLANCE_API_CONF $config_section cinder_store_password $SERVICE_PASSWORD
193 iniset $GLANCE_API_CONF $config_section cinder_store_project_name $SERVICE_PROJECT_NAME
194}
195
196# Configure multiple file stores options for each file store
197#
198# Arguments:
199#
200function configure_multiple_file_stores {
201 local store enabled_backends
202 enabled_backends=""
203 for store in $(echo $GLANCE_MULTIPLE_FILE_STORES | tr "," "\n"); do
204 enabled_backends+="${store}:file,"
205 done
206 iniset $GLANCE_API_CONF DEFAULT enabled_backends ${enabled_backends::-1}
207
208 # Glance multiple store Store specific configs
209 iniset $GLANCE_API_CONF glance_store default_backend $GLANCE_DEFAULT_BACKEND
210 local store
211 for store in $(echo $glance_multiple_file_stores | tr "," "\n"); do
212 iniset $GLANCE_API_CONF $store filesystem_store_datadir "${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/${store}/"
213 done
214}
215
216# Set reserved stores for glance
217function configure_reserved_stores {
218 iniset $GLANCE_API_CONF os_glance_staging_store filesystem_store_datadir "${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/os_glance_staging_store/"
219 iniset $GLANCE_API_CONF os_glance_tasks_store filesystem_store_datadir "${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/os_glance_tasks_store/"
220}
221
222# Copy rootwrap file from glance_store/etc/glance to /etc/glance
223#
224# Arguments:
225# source_path Source path to copy rootwrap files from
226#
227function copy_rootwrap {
228 local source_path="$1"
229 # Make glance configuration directory if it is not exists
230 sudo install -d -o $STACK_USER $GLANCE_CONF_DIR
231 cp -r $source_path/rootwrap.* $GLANCE_CONF_DIR/
232}
233
234# Set glance_store related config options
235#
236# Arguments:
237# USE_CINDER_FOR_GLANCE
238# GLANCE_ENABLE_MULTIPLE_STORES
239#
240function configure_glance_store {
241 local use_cinder_for_glance="$1"
242 local glance_enable_multiple_stores="$2"
243 local be
244
245 if [[ "$glance_enable_multiple_stores" == "False" ]]; then
246 # Configure traditional glance_store
247 if [[ "$use_cinder_for_glance" == "True" ]]; then
248 # set common glance_store parameters
249 iniset $GLANCE_API_CONF glance_store stores "cinder,file,http"
250 iniset $GLANCE_API_CONF glance_store default_store cinder
251
252 # set cinder related store parameters
253 set_common_cinder_store_params glance_store
254 # set nfs mount_point dir
255 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
256 local be_name=${be##*:}
257 if [[ "$be_name" == "nfs" ]]; then
258 mkdir -p $GLANCE_NFS_MOUNTPOINT
259 iniset $GLANCE_API_CONF glance_store cinder_mount_point_base $GLANCE_NFS_MOUNTPOINT
260 fi
261 done
262 fi
263 # Store specific configs
264 iniset $GLANCE_API_CONF glance_store filesystem_store_datadir $GLANCE_IMAGE_DIR/
265 else
266 if [[ "$use_cinder_for_glance" == "True" ]]; then
267 # Configure multiple cinder stores for glance
268 configure_multiple_cinder_stores
269 else
270 # Configure multiple file stores for glance
271 configure_multiple_file_stores
272 fi
273 # Configure reserved stores
274 configure_reserved_stores
275 fi
276}
277
Dean Troyer73f6f252012-09-17 11:22:21 -0500278# configure_glance() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100279function configure_glance {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500280 sudo install -d -o $STACK_USER $GLANCE_CONF_DIR $GLANCE_METADEF_DIR
Pawel Koniszewski76e39252014-09-06 07:06:46 -0400281
Abhishek Kekane0ae57872020-02-17 06:11:15 +0000282 # Set non-default configuration options for the API server
Ian Wienandada886d2015-10-07 14:06:26 +1100283 local dburl
284 dburl=`database_connection_url glance`
Dean Troyer73f6f252012-09-17 11:22:21 -0500285
Ben Nemec03997942013-08-10 09:56:16 -0500286 iniset $GLANCE_API_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Jordan Pittierceca15d2015-06-19 11:46:36 +0200287 iniset $GLANCE_API_CONF database connection $dburl
Dean Troyer73f6f252012-09-17 11:22:21 -0500288 iniset $GLANCE_API_CONF DEFAULT use_syslog $SYSLOG
Dean Troyer73f6f252012-09-17 11:22:21 -0500289 iniset $GLANCE_API_CONF DEFAULT image_cache_dir $GLANCE_CACHE_DIR/
ZhongShengping5fe60c12019-04-30 10:12:51 +0800290 iniset $GLANCE_API_CONF oslo_concurrency lock_path $GLANCE_LOCK_DIR
Dean Troyer73f6f252012-09-17 11:22:21 -0500291 iniset $GLANCE_API_CONF paste_deploy flavor keystone+cachemanagement
Dirk Mueller8ab64b32017-11-17 19:52:29 +0100292 configure_keystone_authtoken_middleware $GLANCE_API_CONF glance
Matt Riedemann45da7772017-03-05 13:07:39 -0500293 iniset $GLANCE_API_CONF oslo_messaging_notifications driver messagingv2
Brant Knudson2dd110c2015-03-14 12:39:14 -0500294 iniset_rpc_backend glance $GLANCE_API_CONF
Evgeny Antyshev19354582014-11-24 14:20:35 +0400295 if [ "$VIRT_DRIVER" = 'libvirt' ] && [ "$LIBVIRT_TYPE" = 'parallels' ]; then
296 iniset $GLANCE_API_CONF DEFAULT disk_formats "ami,ari,aki,vhd,vmdk,raw,qcow2,vdi,iso,ploop"
297 fi
Brian Rosmaita6e9f7c22020-10-13 14:20:38 -0400298 # Only use these if you know what you are doing! See OSSN-0065
299 iniset $GLANCE_API_CONF DEFAULT show_image_direct_url $GLANCE_SHOW_DIRECT_URL
300 iniset $GLANCE_API_CONF DEFAULT show_multiple_locations $GLANCE_SHOW_MULTIPLE_LOCATIONS
Dean Troyer73f6f252012-09-17 11:22:21 -0500301
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000302 # Configure glance_store
303 configure_glance_store $USE_CINDER_FOR_GLANCE $GLANCE_ENABLE_MULTIPLE_STORES
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200304
Timur Sufieva44dd9a2016-04-29 14:08:51 +0300305 # CORS feature support - to allow calls from Horizon by default
306 if [ -n "$GLANCE_CORS_ALLOWED_ORIGIN" ]; then
307 iniset $GLANCE_API_CONF cors allowed_origin "$GLANCE_CORS_ALLOWED_ORIGIN"
308 else
309 iniset $GLANCE_API_CONF cors allowed_origin "http://$SERVICE_HOST"
310 fi
311
Abhishek Kekane6f91da92019-10-17 09:02:41 +0000312 # No multiple stores for swift yet
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000313 if [[ "$GLANCE_ENABLE_MULTIPLE_STORES" == "False" ]]; then
314 # Store the images in swift if enabled.
315 if is_service_enabled s-proxy; then
316 iniset $GLANCE_API_CONF glance_store default_store swift
317 iniset $GLANCE_API_CONF glance_store swift_store_create_container_on_put True
Jamie Lennoxf4f01c62015-06-19 02:52:41 +0000318
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000319 iniset $GLANCE_API_CONF glance_store swift_store_config_file $GLANCE_SWIFT_STORE_CONF
320 iniset $GLANCE_API_CONF glance_store default_swift_reference ref1
321 iniset $GLANCE_API_CONF glance_store stores "file, http, swift"
322 if is_service_enabled tls-proxy; then
323 iniset $GLANCE_API_CONF glance_store swift_store_cacert $SSL_BUNDLE_FILE
324 fi
325 iniset $GLANCE_API_CONF DEFAULT graceful_shutdown_timeout "$SERVICE_GRACEFUL_SHUTDOWN_TIMEOUT"
326
327 iniset $GLANCE_SWIFT_STORE_CONF ref1 user $SERVICE_PROJECT_NAME:glance-swift
328
329 iniset $GLANCE_SWIFT_STORE_CONF ref1 key $SERVICE_PASSWORD
330 iniset $GLANCE_SWIFT_STORE_CONF ref1 auth_address $KEYSTONE_SERVICE_URI/v3
331 iniset $GLANCE_SWIFT_STORE_CONF ref1 auth_version 3
Vladislav Kuzmin9cbd02d2020-05-20 12:14:04 +0400332 fi
Dean Troyerc77b9322013-03-29 10:51:01 -0500333 fi
334
Matthew Treinish1fa65362017-06-23 22:32:37 +0000335 # We need to tell glance what it's public endpoint is so that the version
336 # discovery document will be correct
337 iniset $GLANCE_API_CONF DEFAULT public_endpoint $GLANCE_URL
338
Rob Crittenden18d47782014-03-19 17:47:42 -0400339 if is_service_enabled tls-proxy; then
340 iniset $GLANCE_API_CONF DEFAULT bind_port $GLANCE_SERVICE_PORT_INT
Jens Harbott32c00892019-04-10 10:33:39 +0000341 iniset $GLANCE_API_CONF keystone_authtoken identity_uri $KEYSTONE_SERVICE_URI
Rob Crittenden18d47782014-03-19 17:47:42 -0400342 fi
343
Louis Taylor701276a2015-02-11 19:34:09 +0000344 # Format logging
Sean Dague9751be62016-04-05 12:08:57 -0400345 setup_logging $GLANCE_API_CONF
Louis Taylor701276a2015-02-11 19:34:09 +0000346
Dean Troyer73f6f252012-09-17 11:22:21 -0500347 cp -p $GLANCE_DIR/etc/glance-api-paste.ini $GLANCE_API_PASTE_INI
348
Brian Rosmaita44a19b42017-12-11 18:07:50 -0500349 # Set non-default configuration options for the glance-cache
Ben Nemec03997942013-08-10 09:56:16 -0500350 iniset $GLANCE_CACHE_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Dean Troyer73f6f252012-09-17 11:22:21 -0500351 iniset $GLANCE_CACHE_CONF DEFAULT use_syslog $SYSLOG
Dean Troyer73f6f252012-09-17 11:22:21 -0500352 iniset $GLANCE_CACHE_CONF DEFAULT image_cache_dir $GLANCE_CACHE_DIR/
Jens Harbott32c00892019-04-10 10:33:39 +0000353 iniset $GLANCE_CACHE_CONF DEFAULT auth_url $KEYSTONE_SERVICE_URI
Sean Dague7580a0c2016-02-17 06:23:36 -0500354 iniset $GLANCE_CACHE_CONF DEFAULT admin_tenant_name $SERVICE_PROJECT_NAME
Dean Troyer73f6f252012-09-17 11:22:21 -0500355 iniset $GLANCE_CACHE_CONF DEFAULT admin_user glance
Dean Troyer73f6f252012-09-17 11:22:21 -0500356 iniset $GLANCE_CACHE_CONF DEFAULT admin_password $SERVICE_PASSWORD
357
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200358 # Store specific confs
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200359 iniset $GLANCE_CACHE_CONF glance_store filesystem_store_datadir $GLANCE_IMAGE_DIR/
360
bhagyashris6a25fb92017-12-14 13:23:41 +0530361 # Set default configuration options for the glance-image-import
362 iniset $GLANCE_IMAGE_IMPORT_CONF image_import_opts image_import_plugins []
363 iniset $GLANCE_IMAGE_IMPORT_CONF inject_metadata_properties ignore_user_roles admin
364 iniset $GLANCE_IMAGE_IMPORT_CONF inject_metadata_properties inject
365
Dirk Mueller46d1ba62013-09-09 14:31:37 +0200366 cp -p $GLANCE_DIR/etc/schema-image.json $GLANCE_SCHEMA_JSON
Pawel Koniszewski76e39252014-09-06 07:06:46 -0400367
368 cp -p $GLANCE_DIR/etc/metadefs/*.json $GLANCE_METADEF_DIR
Rob Crittenden18d47782014-03-19 17:47:42 -0400369
Sean Daguef3b2f4c2017-04-13 10:11:48 -0400370 if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -0400371 CINDER_SERVICE_HOST=${CINDER_SERVICE_HOST:-$SERVICE_HOST}
372 CINDER_SERVICE_PORT=${CINDER_SERVICE_PORT:-8776}
373
Brian Rosmaitab43810a2019-02-07 16:46:49 -0500374 iniset $GLANCE_API_CONF DEFAULT cinder_endpoint_template "https://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v3/%(project_id)s"
375 iniset $GLANCE_CACHE_CONF DEFAULT cinder_endpoint_template "https://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v3/%(project_id)s"
Rob Crittenden18d47782014-03-19 17:47:42 -0400376 fi
Matthew Treinish1fa65362017-06-23 22:32:37 +0000377
Dan Smith09eea0b2020-07-09 08:31:51 -0700378 if [[ "$GLANCE_STANDALONE" == False ]]; then
Matthew Treinish1fa65362017-06-23 22:32:37 +0000379 write_local_uwsgi_http_config "$GLANCE_UWSGI_CONF" "$GLANCE_UWSGI" "/image"
Dan Smith802259a2021-01-12 22:55:57 +0000380 # Grab our uwsgi listen address and use that to fill out our
381 # worker_self_reference_url config
382 iniset $GLANCE_API_CONF DEFAULT worker_self_reference_url \
383 $(awk '-F= ' '/^http-socket/ { print "http://"$2}' \
384 $GLANCE_UWSGI_CONF)
Matthew Treinish1fa65362017-06-23 22:32:37 +0000385 else
Dan Smith09eea0b2020-07-09 08:31:51 -0700386 write_local_proxy_http_config glance "http://$GLANCE_SERVICE_HOST:$GLANCE_SERVICE_PORT_INT" "/image"
Matthew Treinish1fa65362017-06-23 22:32:37 +0000387 iniset $GLANCE_API_CONF DEFAULT bind_host $GLANCE_SERVICE_LISTEN_ADDRESS
Dan Smithfcbf3e92020-07-17 10:14:14 -0700388 iniset $GLANCE_API_CONF DEFAULT bind_port $GLANCE_SERVICE_PORT_INT
Matthew Treinish1fa65362017-06-23 22:32:37 +0000389 iniset $GLANCE_API_CONF DEFAULT workers "$API_WORKERS"
390 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500391}
392
Dean Troyer42a59c22014-03-03 14:31:29 -0600393# create_glance_accounts() - Set up common required glance accounts
394
Wayne Okumadd622932015-03-31 00:28:39 -0700395# Project User Roles
396# ---------------------------------------------------------------------
Sean Dague7580a0c2016-02-17 06:23:36 -0500397# SERVICE_PROJECT_NAME glance service
398# SERVICE_PROJECT_NAME glance-swift ResellerAdmin (if Swift is enabled)
399# SERVICE_PROJECT_NAME glance-search search (if Search is enabled)
Dean Troyer42a59c22014-03-03 14:31:29 -0600400
401function create_glance_accounts {
402 if is_service_enabled g-api; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100403
Jamie Lennox85ff5322015-01-28 14:28:01 +1000404 create_service_user "glance"
Bartosz Górski0abde392014-02-28 14:15:19 +0100405
Dean Troyer42a59c22014-03-03 14:31:29 -0600406 # required for swift access
407 if is_service_enabled s-proxy; then
Jamie Lennoxcbcbd8f2016-01-21 16:08:14 -0600408 create_service_user "glance-swift" "ResellerAdmin"
Dean Troyer42a59c22014-03-03 14:31:29 -0600409 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100410
Sean Dague985e9582016-02-10 07:25:24 -0500411 get_or_create_service "glance" "image" "Glance Image Service"
Matt Riedemannae4578b2016-04-23 01:45:40 +0000412 get_or_create_endpoint \
Sean Dague985e9582016-02-10 07:25:24 -0500413 "image" \
414 "$REGION_NAME" \
Matthew Treinish1fa65362017-06-23 22:32:37 +0000415 "$GLANCE_URL"
Jens Rosenboom890342e2016-09-13 22:41:41 +0200416
417 # Note(frickler): Crude workaround for https://bugs.launchpad.net/glance-store/+bug/1620999
418 service_domain_id=$(get_or_create_domain $SERVICE_DOMAIN_NAME)
419 iniset $GLANCE_SWIFT_STORE_CONF ref1 project_domain_id $service_domain_id
420 iniset $GLANCE_SWIFT_STORE_CONF ref1 user_domain_id $service_domain_id
Dean Troyer42a59c22014-03-03 14:31:29 -0600421 fi
422}
423
Dean Troyer73f6f252012-09-17 11:22:21 -0500424# init_glance() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100425function init_glance {
Dean Troyer73f6f252012-09-17 11:22:21 -0500426 # Delete existing images
427 rm -rf $GLANCE_IMAGE_DIR
428 mkdir -p $GLANCE_IMAGE_DIR
429
Radosław Piliszek09e860f2020-01-19 12:41:14 +0100430 # (Re)create glance database
431 recreate_database glance
Dean Troyer73f6f252012-09-17 11:22:21 -0500432
Radosław Piliszek09e860f2020-01-19 12:41:14 +0100433 time_start "dbsync"
434 # Migrate glance database
435 $GLANCE_BIN_DIR/glance-manage --config-file $GLANCE_CONF_DIR/glance-api.conf db_sync
Dean Troyerbc071bc2012-10-01 14:06:44 -0500436
Radosław Piliszek09e860f2020-01-19 12:41:14 +0100437 # Load metadata definitions
438 $GLANCE_BIN_DIR/glance-manage --config-file $GLANCE_CONF_DIR/glance-api.conf db_load_metadefs
439 time_stop "dbsync"
Dean Troyer73f6f252012-09-17 11:22:21 -0500440}
441
442# install_glanceclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100443function install_glanceclient {
Sean Daguee08ab102014-11-13 17:09:28 -0500444 if use_library_from_git "python-glanceclient"; then
445 git_clone_by_name "python-glanceclient"
446 setup_dev_lib "python-glanceclient"
Louis Taylor8df690c2014-11-20 13:09:03 +0000447 sudo install -D -m 0644 -o $STACK_USER {${GITDIR["python-glanceclient"]}/tools/,/etc/bash_completion.d/}glance.bash_completion
Sean Dague5cb19062014-11-01 01:37:45 +0100448 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500449}
450
451# install_glance() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100452function install_glance {
Radosław Piliszekbe263062020-03-30 09:56:53 +0200453 local glance_store_extras=()
454
455 if is_service_enabled cinder; then
456 glance_store_extras=("cinder" "${glance_store_extras[@]}")
457 fi
458
459 if is_service_enabled swift; then
460 glance_store_extras=("swift" "${glance_store_extras[@]}")
461 fi
462
Flavio Percoco4f78f8f2014-09-09 09:37:42 +0200463 # Install glance_store from git so we make sure we're testing
464 # the latest code.
Sean Dagueee5ae7b2014-11-13 13:23:27 -0500465 if use_library_from_git "glance_store"; then
466 git_clone_by_name "glance_store"
Radosław Piliszekbe263062020-03-30 09:56:53 +0200467 setup_dev_lib "glance_store" $(join_extras "${glance_store_extras[@]}")
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000468 copy_rootwrap ${DEST}/glance_store/etc/glance
Radosław Piliszekbe263062020-03-30 09:56:53 +0200469 else
470 # we still need to pass extras
471 pip_install_gr_extras glance-store $(join_extras "${glance_store_extras[@]}")
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000472 copy_rootwrap $GLANCE_STORE_ROOTWRAP_BASE_DIR
Sean Dagueee5ae7b2014-11-13 13:23:27 -0500473 fi
Flavio Percoco4f78f8f2014-09-09 09:37:42 +0200474
Dean Troyer73f6f252012-09-17 11:22:21 -0500475 git_clone $GLANCE_REPO $GLANCE_DIR $GLANCE_BRANCH
Wayne Okumadd622932015-03-31 00:28:39 -0700476
Wayne Okumadd622932015-03-31 00:28:39 -0700477 setup_develop $GLANCE_DIR
Dean Troyer73f6f252012-09-17 11:22:21 -0500478}
479
Dan Smith802259a2021-01-12 22:55:57 +0000480# glance_remote_conf() - Return the path to an alternate config file for
481# the remote glance clone
482function glance_remote_conf {
Dan Smith61b4fbf2021-03-09 08:05:37 -0800483 echo $(dirname "${GLANCE_CONF_DIR}")/glance-remote/$(basename "$1")
Dan Smith802259a2021-01-12 22:55:57 +0000484}
485
486# start_glance_remote_clone() - Clone the regular glance api worker
487function start_glance_remote_clone {
Dan Smith61b4fbf2021-03-09 08:05:37 -0800488 local glance_remote_conf_dir glance_remote_port remote_data
489 local glance_remote_uwsgi
Dan Smith802259a2021-01-12 22:55:57 +0000490
Dan Smith61b4fbf2021-03-09 08:05:37 -0800491 glance_remote_conf_dir="$(glance_remote_conf "")"
Dan Smith802259a2021-01-12 22:55:57 +0000492 glance_remote_port=$(get_random_port)
Dan Smith61b4fbf2021-03-09 08:05:37 -0800493 glance_remote_uwsgi="$(glance_remote_conf $GLANCE_UWSGI_CONF)"
Dan Smith802259a2021-01-12 22:55:57 +0000494
495 # Clone the existing ready-to-go glance-api setup
Dan Smith61b4fbf2021-03-09 08:05:37 -0800496 sudo rm -Rf "$glance_remote_conf_dir"
497 sudo cp -r "$GLANCE_CONF_DIR" "$glance_remote_conf_dir"
498 sudo chown $STACK_USER -R "$glance_remote_conf_dir"
Dan Smith802259a2021-01-12 22:55:57 +0000499
500 # Point this worker at different data dirs
501 remote_data="${DATA_DIR}/glance-remote"
502 mkdir -p $remote_data/os_glance_tasks_store \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800503 "${remote_data}/os_glance_staging_store"
504 iniset $(glance_remote_conf "$GLANCE_API_CONF") os_glance_staging_store \
505 filesystem_store_datadir "${remote_data}/os_glance_staging_store"
506 iniset $(glance_remote_conf "$GLANCE_API_CONF") os_glance_tasks_store \
507 filesystem_store_datadir "${remote_data}/os_glance_tasks_store"
Dan Smith802259a2021-01-12 22:55:57 +0000508
509 # Change our uwsgi to our new port
510 sed -ri "s/^(http-socket.*):[0-9]+/\1:$glance_remote_port/" \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800511 "$glance_remote_uwsgi"
Dan Smith802259a2021-01-12 22:55:57 +0000512
513 # Update the self-reference url with our new port
514 iniset $(glance_remote_conf $GLANCE_API_CONF) DEFAULT \
515 worker_self_reference_url \
516 $(awk '-F= ' '/^http-socket/ { print "http://"$2 }' \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800517 "$glance_remote_uwsgi")
Dan Smith802259a2021-01-12 22:55:57 +0000518
519 # We need to create the systemd service for the clone, but then
520 # change it to include an Environment line to point the WSGI app
521 # at the alternate config directory.
522 write_uwsgi_user_unit_file devstack@g-api-r.service "$(which uwsgi) \
523 --procname-prefix \
524 glance-api-remote \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800525 --ini $glance_remote_uwsgi" \
Dan Smith802259a2021-01-12 22:55:57 +0000526 "" "$STACK_USER"
527 iniset -sudo ${SYSTEMD_DIR}/devstack@g-api-r.service \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800528 "Service" "Environment" \
529 "OS_GLANCE_CONFIG_DIR=$glance_remote_conf_dir"
Dan Smith802259a2021-01-12 22:55:57 +0000530
531 # Reload and restart with the new config
532 $SYSTEMCTL daemon-reload
533 $SYSTEMCTL restart devstack@g-api-r
534
535 get_or_create_service glance_remote image_remote "Alternate glance"
536 get_or_create_endpoint image_remote $REGION_NAME \
537 $(awk '-F= ' '/^http-socket/ { print "http://"$2 }' \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800538 $glance_remote_uwsgi)
Dan Smith802259a2021-01-12 22:55:57 +0000539}
540
Sean Dague0eebeb42017-08-30 14:16:58 -0400541# start_glance() - Start running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100542function start_glance {
Rob Crittenden18d47782014-03-19 17:47:42 -0400543 local service_protocol=$GLANCE_SERVICE_PROTOCOL
544 if is_service_enabled tls-proxy; then
Matthew Treinish1fa65362017-06-23 22:32:37 +0000545 if [[ "$WSGI_MODE" != "uwsgi" ]]; then
546 start_tls_proxy glance-service '*' $GLANCE_SERVICE_PORT $GLANCE_SERVICE_HOST $GLANCE_SERVICE_PORT_INT
547 fi
Rob Crittenden18d47782014-03-19 17:47:42 -0400548 fi
549
Dan Smith09eea0b2020-07-09 08:31:51 -0700550 if [[ "$GLANCE_STANDALONE" == False ]]; then
Ian Wienand312517d2018-06-22 22:23:29 +1000551 run_process g-api "$(which uwsgi) --procname-prefix glance-api --ini $GLANCE_UWSGI_CONF"
Matthew Treinish1fa65362017-06-23 22:32:37 +0000552 else
Brian Rosmaita96269d82018-12-17 10:38:42 -0500553 run_process g-api "$GLANCE_BIN_DIR/glance-api --config-dir=$GLANCE_CONF_DIR"
Matthew Treinish1fa65362017-06-23 22:32:37 +0000554 fi
Rob Crittenden18d47782014-03-19 17:47:42 -0400555
Dan Smith802259a2021-01-12 22:55:57 +0000556 if is_service_enabled g-api-r; then
557 echo "Starting the g-api-r clone service..."
558 start_glance_remote_clone
559 fi
560
Matthew Treinish1fa65362017-06-23 22:32:37 +0000561 echo "Waiting for g-api ($GLANCE_SERVICE_HOST) to start..."
562 if ! wait_for_service $SERVICE_TIMEOUT $GLANCE_URL; then
Sean Dague101b4242013-10-22 08:47:11 -0400563 die $LINENO "g-api did not start"
Dean Troyer73f6f252012-09-17 11:22:21 -0500564 fi
565}
566
Dean Troyer699a29f2012-09-10 14:10:27 -0500567# stop_glance() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100568function stop_glance {
Chris Dent2f27a0e2014-09-09 13:46:02 +0100569 stop_process g-api
Dan Smith802259a2021-01-12 22:55:57 +0000570 stop_process g-api-r
Dean Troyer73f6f252012-09-17 11:22:21 -0500571}
572
573# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100574$_XTRACE_GLANCE
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: