blob: fd2e0afcc18496856f8babfed2023f95c1dc320c [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
Abhishek Kekane6f91da92019-10-17 09:02:41 +000054# Glance multi-store configuration
55# Boolean flag to enable multiple store configuration for glance
56GLANCE_ENABLE_MULTIPLE_STORES=$(trueorfalse False GLANCE_ENABLE_MULTIPLE_STORES)
57
58# Comma separated list for configuring multiple file stores of glance,
59# for example; GLANCE_MULTIPLE_FILE_STORES = fast,cheap,slow
60GLANCE_MULTIPLE_FILE_STORES=${GLANCE_MULTIPLE_FILE_STORES:-fast}
61
62# Default store/backend for glance, must be one of the store specified
63# in GLANCE_MULTIPLE_FILE_STORES option.
64GLANCE_DEFAULT_BACKEND=${GLANCE_DEFAULT_BACKEND:-fast}
65
Dean Troyer73f6f252012-09-17 11:22:21 -050066GLANCE_CACHE_DIR=${GLANCE_CACHE_DIR:=$DATA_DIR/glance/cache}
Abhishek Kekane6f91da92019-10-17 09:02:41 +000067
Dan Smith09eea0b2020-07-09 08:31:51 -070068# Full Glance functionality requires running in standalone mode. If we are
69# not in uwsgi mode, then we are standalone, otherwise allow separate control.
70if [[ "$WSGI_MODE" != "uwsgi" ]]; then
71 GLANCE_STANDALONE=True
72fi
Dan Smith155109d2020-07-24 06:49:01 -070073GLANCE_STANDALONE=${GLANCE_STANDALONE:-False}
Dan Smith09eea0b2020-07-09 08:31:51 -070074
Abhishek Kekane6f91da92019-10-17 09:02:41 +000075# File path for each store specified in GLANCE_MULTIPLE_FILE_STORES, the store
76# identifier will be appended to this path at runtime. If GLANCE_MULTIPLE_FILE_STORES
77# has fast,cheap specified then filepath will be generated like $DATA_DIR/glance/fast
78# and $DATA_DIR/glance/cheap.
79GLANCE_MULTISTORE_FILE_IMAGE_DIR=${GLANCE_MULTISTORE_FILE_IMAGE_DIR:=$DATA_DIR/glance}
Dean Troyer73f6f252012-09-17 11:22:21 -050080GLANCE_IMAGE_DIR=${GLANCE_IMAGE_DIR:=$DATA_DIR/glance/images}
Abhishek Kekane057aaa62020-07-29 07:37:16 +000081GLANCE_NFS_MOUNTPOINT=$GLANCE_IMAGE_DIR/mnt
Matthew Treinishfa898f52017-04-25 01:30:10 -040082GLANCE_LOCK_DIR=${GLANCE_LOCK_DIR:=$DATA_DIR/glance/locks}
Abhishek Kekane6f91da92019-10-17 09:02:41 +000083GLANCE_STAGING_DIR=${GLANCE_MULTISTORE_FILE_IMAGE_DIR:=$DATA_DIR/os_glance_staging_store}
84GLANCE_TASKS_DIR=${GLANCE_MULTISTORE_FILE_IMAGE_DIR:=$DATA_DIR/os_glance_tasks_store}
Dean Troyer73f6f252012-09-17 11:22:21 -050085
Abhishek Kekane73ad9762020-06-16 15:20:48 +000086GLANCE_USE_IMPORT_WORKFLOW=$(trueorfalse False GLANCE_USE_IMPORT_WORKFLOW)
Dan Smith4e916ae2021-04-26 08:52:23 -070087GLANCE_ENABLE_QUOTAS=$(trueorfalse True GLANCE_ENABLE_QUOTAS)
Abhishek Kekane73ad9762020-06-16 15:20:48 +000088
Dean Troyer73f6f252012-09-17 11:22:21 -050089GLANCE_CONF_DIR=${GLANCE_CONF_DIR:-/etc/glance}
Pawel Koniszewski76e39252014-09-06 07:06:46 -040090GLANCE_METADEF_DIR=$GLANCE_CONF_DIR/metadefs
Dean Troyer73f6f252012-09-17 11:22:21 -050091GLANCE_API_CONF=$GLANCE_CONF_DIR/glance-api.conf
Dean Troyer73f6f252012-09-17 11:22:21 -050092GLANCE_API_PASTE_INI=$GLANCE_CONF_DIR/glance-api-paste.ini
93GLANCE_CACHE_CONF=$GLANCE_CONF_DIR/glance-cache.conf
Dirk Mueller46d1ba62013-09-09 14:31:37 +020094GLANCE_SCHEMA_JSON=$GLANCE_CONF_DIR/schema-image.json
Jamie Lennoxf4f01c62015-06-19 02:52:41 +000095GLANCE_SWIFT_STORE_CONF=$GLANCE_CONF_DIR/glance-swift-store.conf
bhagyashris6a25fb92017-12-14 13:23:41 +053096GLANCE_IMAGE_IMPORT_CONF=$GLANCE_CONF_DIR/glance-image-import.conf
Dean Troyer73f6f252012-09-17 11:22:21 -050097
Sean Daguef3b2f4c2017-04-13 10:11:48 -040098if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -040099 GLANCE_SERVICE_PROTOCOL="https"
100fi
101
Dean Troyer73f6f252012-09-17 11:22:21 -0500102# Glance connection info. Note the port must be specified.
Rob Crittenden18d47782014-03-19 17:47:42 -0400103GLANCE_SERVICE_HOST=${GLANCE_SERVICE_HOST:-$SERVICE_HOST}
Jens Harbottdc7b4292017-09-19 10:52:32 +0000104GLANCE_SERVICE_LISTEN_ADDRESS=${GLANCE_SERVICE_LISTEN_ADDRESS:-$(ipv6_unquote $SERVICE_LISTEN_ADDRESS)}
Rob Crittenden18d47782014-03-19 17:47:42 -0400105GLANCE_SERVICE_PORT=${GLANCE_SERVICE_PORT:-9292}
106GLANCE_SERVICE_PORT_INT=${GLANCE_SERVICE_PORT_INT:-19292}
107GLANCE_HOSTPORT=${GLANCE_HOSTPORT:-$GLANCE_SERVICE_HOST:$GLANCE_SERVICE_PORT}
108GLANCE_SERVICE_PROTOCOL=${GLANCE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Matthew Treinish1fa65362017-06-23 22:32:37 +0000109GLANCE_UWSGI=$GLANCE_BIN_DIR/glance-wsgi-api
Jeremy Liu2f7df512017-07-12 10:09:48 +0800110GLANCE_UWSGI_CONF=$GLANCE_CONF_DIR/glance-uwsgi.ini
Matthew Treinish1fa65362017-06-23 22:32:37 +0000111# If wsgi mode is uwsgi run glance under uwsgi, else default to eventlet
112# TODO(mtreinish): Remove the eventlet path here and in all the similar
113# conditionals below after the Pike release
114if [[ "$WSGI_MODE" == "uwsgi" ]]; then
115 GLANCE_URL="$GLANCE_SERVICE_PROTOCOL://$GLANCE_SERVICE_HOST/image"
116else
117 GLANCE_URL="$GLANCE_SERVICE_PROTOCOL://$GLANCE_HOSTPORT"
118fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500119
Dean Troyercc6b4432013-04-08 15:38:03 -0500120# Functions
121# ---------
Dean Troyer73f6f252012-09-17 11:22:21 -0500122
Dean Troyere4fa7212014-01-15 15:04:49 -0600123# Test if any Glance services are enabled
124# is_glance_enabled
125function is_glance_enabled {
Clark Boylan902158b2017-05-30 14:11:09 -0700126 [[ ,${DISABLED_SERVICES} =~ ,"glance" ]] && return 1
Dean Troyere4fa7212014-01-15 15:04:49 -0600127 [[ ,${ENABLED_SERVICES} =~ ,"g-" ]] && return 0
128 return 1
129}
130
Dean Troyer73f6f252012-09-17 11:22:21 -0500131# cleanup_glance() - Remove residual data files, anything left over from previous
132# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100133function cleanup_glance {
Dan Smith61b4fbf2021-03-09 08:05:37 -0800134 # delete image files (glance) and all of the glance-remote temporary
135 # storage
136 sudo rm -rf $GLANCE_CACHE_DIR $GLANCE_IMAGE_DIR "${DATA_DIR}/glance-remote"
Abhishek Kekane6f91da92019-10-17 09:02:41 +0000137
138 # Cleanup multiple stores directories
139 if [[ "$GLANCE_ENABLE_MULTIPLE_STORES" == "True" ]]; then
140 local store file_dir
141 for store in $(echo $GLANCE_MULTIPLE_FILE_STORES | tr "," "\n"); do
142 file_dir="${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/${store}/"
143 sudo rm -rf $file_dir
144 done
145
146 # Cleanup reserved stores directories
147 sudo rm -rf $GLANCE_STAGING_DIR $GLANCE_TASKS_DIR
148 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500149}
150
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000151# Set multiple cinder store related config options for each of the cinder store
152#
153function configure_multiple_cinder_stores {
154
155 local be be_name be_type enabled_backends
156 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
157 be_type=${be%%:*}
158 be_name=${be##*:}
159 enabled_backends+="${be_name}:cinder,"
160
161 set_common_cinder_store_params $be_name
162 iniset $GLANCE_API_CONF $be_name cinder_volume_type ${be_name}
163 if [[ "$be_type" == "nfs" ]]; then
164 mkdir -p "$GLANCE_NFS_MOUNTPOINT"
165 iniset $GLANCE_API_CONF $be_name cinder_mount_point_base "$GLANCE_NFS_MOUNTPOINT"
166 fi
167 done
168 iniset $GLANCE_API_CONF DEFAULT enabled_backends ${enabled_backends::-1}
169 iniset $GLANCE_API_CONF glance_store default_backend $GLANCE_CINDER_DEFAULT_BACKEND
170}
171
172# Set common cinder store options to given config section
173#
174# Arguments:
175# config_section
176#
177function set_common_cinder_store_params {
178 local config_section="$1"
179 iniset $GLANCE_API_CONF $config_section cinder_store_auth_address $KEYSTONE_SERVICE_URI_V3
180 iniset $GLANCE_API_CONF $config_section cinder_store_user_name glance
181 iniset $GLANCE_API_CONF $config_section cinder_store_password $SERVICE_PASSWORD
182 iniset $GLANCE_API_CONF $config_section cinder_store_project_name $SERVICE_PROJECT_NAME
183}
184
185# Configure multiple file stores options for each file store
186#
187# Arguments:
188#
189function configure_multiple_file_stores {
190 local store enabled_backends
191 enabled_backends=""
192 for store in $(echo $GLANCE_MULTIPLE_FILE_STORES | tr "," "\n"); do
193 enabled_backends+="${store}:file,"
194 done
195 iniset $GLANCE_API_CONF DEFAULT enabled_backends ${enabled_backends::-1}
196
197 # Glance multiple store Store specific configs
198 iniset $GLANCE_API_CONF glance_store default_backend $GLANCE_DEFAULT_BACKEND
199 local store
200 for store in $(echo $glance_multiple_file_stores | tr "," "\n"); do
201 iniset $GLANCE_API_CONF $store filesystem_store_datadir "${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/${store}/"
202 done
203}
204
205# Set reserved stores for glance
206function configure_reserved_stores {
207 iniset $GLANCE_API_CONF os_glance_staging_store filesystem_store_datadir "${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/os_glance_staging_store/"
208 iniset $GLANCE_API_CONF os_glance_tasks_store filesystem_store_datadir "${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/os_glance_tasks_store/"
209}
210
211# Copy rootwrap file from glance_store/etc/glance to /etc/glance
212#
213# Arguments:
214# source_path Source path to copy rootwrap files from
215#
216function copy_rootwrap {
217 local source_path="$1"
218 # Make glance configuration directory if it is not exists
219 sudo install -d -o $STACK_USER $GLANCE_CONF_DIR
220 cp -r $source_path/rootwrap.* $GLANCE_CONF_DIR/
221}
222
223# Set glance_store related config options
224#
225# Arguments:
226# USE_CINDER_FOR_GLANCE
227# GLANCE_ENABLE_MULTIPLE_STORES
228#
229function configure_glance_store {
230 local use_cinder_for_glance="$1"
231 local glance_enable_multiple_stores="$2"
232 local be
233
234 if [[ "$glance_enable_multiple_stores" == "False" ]]; then
235 # Configure traditional glance_store
236 if [[ "$use_cinder_for_glance" == "True" ]]; then
237 # set common glance_store parameters
238 iniset $GLANCE_API_CONF glance_store stores "cinder,file,http"
239 iniset $GLANCE_API_CONF glance_store default_store cinder
240
241 # set cinder related store parameters
242 set_common_cinder_store_params glance_store
243 # set nfs mount_point dir
244 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
245 local be_name=${be##*:}
246 if [[ "$be_name" == "nfs" ]]; then
247 mkdir -p $GLANCE_NFS_MOUNTPOINT
248 iniset $GLANCE_API_CONF glance_store cinder_mount_point_base $GLANCE_NFS_MOUNTPOINT
249 fi
250 done
251 fi
252 # Store specific configs
253 iniset $GLANCE_API_CONF glance_store filesystem_store_datadir $GLANCE_IMAGE_DIR/
254 else
255 if [[ "$use_cinder_for_glance" == "True" ]]; then
256 # Configure multiple cinder stores for glance
257 configure_multiple_cinder_stores
258 else
259 # Configure multiple file stores for glance
260 configure_multiple_file_stores
261 fi
262 # Configure reserved stores
263 configure_reserved_stores
264 fi
265}
266
Dan Smith4e916ae2021-04-26 08:52:23 -0700267function configure_glance_quotas {
268
269 # NOTE(danms): We need to have some of the OS_ things unset in
270 # order to use system scope, which is required for creating these
271 # limits. This is a hack, but I dunno how else to get osc to use
272 # system scope.
273
274 bash -c "unset OS_USERNAME OS_TENANT_NAME OS_PROJECT_NAME;
275 openstack --os-cloud devstack-system-admin registered limit create \
276 --service glance --default-limit 1000 --region $REGION_NAME \
277 image_size_total; \
278 openstack --os-cloud devstack-system-admin registered limit create \
279 --service glance --default-limit 1000 --region $REGION_NAME \
280 image_stage_total; \
281 openstack --os-cloud devstack-system-admin registered limit create \
282 --service glance --default-limit 100 --region $REGION_NAME \
283 image_count_total; \
284 openstack --os-cloud devstack-system-admin registered limit create \
285 --service glance --default-limit 100 --region $REGION_NAME \
286 image_count_uploading"
287
288 # Tell glance to use these limits
289 iniset $GLANCE_API_CONF DEFAULT use_keystone_limits True
290
291 # Configure oslo_limit so it can talk to keystone
292 iniset $GLANCE_API_CONF oslo_limit user_domain_name $SERVICE_DOMAIN_NAME
293 iniset $GLANCE_API_CONF oslo_limit password $SERVICE_PASSWORD
294 iniset $GLANCE_API_CONF oslo_limit username glance
295 iniset $GLANCE_API_CONF oslo_limit auth_type password
296 iniset $GLANCE_API_CONF oslo_limit auth_url $KEYSTONE_SERVICE_URI
297 iniset $GLANCE_API_CONF oslo_limit system_scope "'all'"
298 iniset $GLANCE_API_CONF oslo_limit endpoint_id \
299 $(openstack endpoint list --service glance -f value -c ID)
300
301 # Allow the glance service user to read quotas
302 openstack role add --user glance --user-domain Default --system all \
303 reader
304}
305
Dean Troyer73f6f252012-09-17 11:22:21 -0500306# configure_glance() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100307function configure_glance {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500308 sudo install -d -o $STACK_USER $GLANCE_CONF_DIR $GLANCE_METADEF_DIR
Pawel Koniszewski76e39252014-09-06 07:06:46 -0400309
Abhishek Kekane0ae57872020-02-17 06:11:15 +0000310 # Set non-default configuration options for the API server
Ian Wienandada886d2015-10-07 14:06:26 +1100311 local dburl
312 dburl=`database_connection_url glance`
Dean Troyer73f6f252012-09-17 11:22:21 -0500313
Ben Nemec03997942013-08-10 09:56:16 -0500314 iniset $GLANCE_API_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Jordan Pittierceca15d2015-06-19 11:46:36 +0200315 iniset $GLANCE_API_CONF database connection $dburl
Dean Troyer73f6f252012-09-17 11:22:21 -0500316 iniset $GLANCE_API_CONF DEFAULT use_syslog $SYSLOG
Dean Troyer73f6f252012-09-17 11:22:21 -0500317 iniset $GLANCE_API_CONF DEFAULT image_cache_dir $GLANCE_CACHE_DIR/
ZhongShengping5fe60c12019-04-30 10:12:51 +0800318 iniset $GLANCE_API_CONF oslo_concurrency lock_path $GLANCE_LOCK_DIR
Dean Troyer73f6f252012-09-17 11:22:21 -0500319 iniset $GLANCE_API_CONF paste_deploy flavor keystone+cachemanagement
Dirk Mueller8ab64b32017-11-17 19:52:29 +0100320 configure_keystone_authtoken_middleware $GLANCE_API_CONF glance
Matt Riedemann45da7772017-03-05 13:07:39 -0500321 iniset $GLANCE_API_CONF oslo_messaging_notifications driver messagingv2
Brant Knudson2dd110c2015-03-14 12:39:14 -0500322 iniset_rpc_backend glance $GLANCE_API_CONF
Evgeny Antyshev19354582014-11-24 14:20:35 +0400323 if [ "$VIRT_DRIVER" = 'libvirt' ] && [ "$LIBVIRT_TYPE" = 'parallels' ]; then
324 iniset $GLANCE_API_CONF DEFAULT disk_formats "ami,ari,aki,vhd,vmdk,raw,qcow2,vdi,iso,ploop"
325 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500326
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000327 # Configure glance_store
328 configure_glance_store $USE_CINDER_FOR_GLANCE $GLANCE_ENABLE_MULTIPLE_STORES
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200329
Timur Sufieva44dd9a2016-04-29 14:08:51 +0300330 # CORS feature support - to allow calls from Horizon by default
331 if [ -n "$GLANCE_CORS_ALLOWED_ORIGIN" ]; then
332 iniset $GLANCE_API_CONF cors allowed_origin "$GLANCE_CORS_ALLOWED_ORIGIN"
333 else
334 iniset $GLANCE_API_CONF cors allowed_origin "http://$SERVICE_HOST"
335 fi
336
Abhishek Kekane6f91da92019-10-17 09:02:41 +0000337 # No multiple stores for swift yet
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000338 if [[ "$GLANCE_ENABLE_MULTIPLE_STORES" == "False" ]]; then
339 # Store the images in swift if enabled.
340 if is_service_enabled s-proxy; then
341 iniset $GLANCE_API_CONF glance_store default_store swift
342 iniset $GLANCE_API_CONF glance_store swift_store_create_container_on_put True
Jamie Lennoxf4f01c62015-06-19 02:52:41 +0000343
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000344 iniset $GLANCE_API_CONF glance_store swift_store_config_file $GLANCE_SWIFT_STORE_CONF
345 iniset $GLANCE_API_CONF glance_store default_swift_reference ref1
346 iniset $GLANCE_API_CONF glance_store stores "file, http, swift"
347 if is_service_enabled tls-proxy; then
348 iniset $GLANCE_API_CONF glance_store swift_store_cacert $SSL_BUNDLE_FILE
349 fi
350 iniset $GLANCE_API_CONF DEFAULT graceful_shutdown_timeout "$SERVICE_GRACEFUL_SHUTDOWN_TIMEOUT"
351
352 iniset $GLANCE_SWIFT_STORE_CONF ref1 user $SERVICE_PROJECT_NAME:glance-swift
353
354 iniset $GLANCE_SWIFT_STORE_CONF ref1 key $SERVICE_PASSWORD
355 iniset $GLANCE_SWIFT_STORE_CONF ref1 auth_address $KEYSTONE_SERVICE_URI/v3
356 iniset $GLANCE_SWIFT_STORE_CONF ref1 auth_version 3
Vladislav Kuzmin9cbd02d2020-05-20 12:14:04 +0400357 fi
Dean Troyerc77b9322013-03-29 10:51:01 -0500358 fi
359
Matthew Treinish1fa65362017-06-23 22:32:37 +0000360 # We need to tell glance what it's public endpoint is so that the version
361 # discovery document will be correct
362 iniset $GLANCE_API_CONF DEFAULT public_endpoint $GLANCE_URL
363
Rob Crittenden18d47782014-03-19 17:47:42 -0400364 if is_service_enabled tls-proxy; then
365 iniset $GLANCE_API_CONF DEFAULT bind_port $GLANCE_SERVICE_PORT_INT
Jens Harbott32c00892019-04-10 10:33:39 +0000366 iniset $GLANCE_API_CONF keystone_authtoken identity_uri $KEYSTONE_SERVICE_URI
Rob Crittenden18d47782014-03-19 17:47:42 -0400367 fi
368
Louis Taylor701276a2015-02-11 19:34:09 +0000369 # Format logging
Sean Dague9751be62016-04-05 12:08:57 -0400370 setup_logging $GLANCE_API_CONF
Louis Taylor701276a2015-02-11 19:34:09 +0000371
Dean Troyer73f6f252012-09-17 11:22:21 -0500372 cp -p $GLANCE_DIR/etc/glance-api-paste.ini $GLANCE_API_PASTE_INI
373
Brian Rosmaita44a19b42017-12-11 18:07:50 -0500374 # Set non-default configuration options for the glance-cache
Ben Nemec03997942013-08-10 09:56:16 -0500375 iniset $GLANCE_CACHE_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Dean Troyer73f6f252012-09-17 11:22:21 -0500376 iniset $GLANCE_CACHE_CONF DEFAULT use_syslog $SYSLOG
Dean Troyer73f6f252012-09-17 11:22:21 -0500377 iniset $GLANCE_CACHE_CONF DEFAULT image_cache_dir $GLANCE_CACHE_DIR/
Jens Harbott32c00892019-04-10 10:33:39 +0000378 iniset $GLANCE_CACHE_CONF DEFAULT auth_url $KEYSTONE_SERVICE_URI
Sean Dague7580a0c2016-02-17 06:23:36 -0500379 iniset $GLANCE_CACHE_CONF DEFAULT admin_tenant_name $SERVICE_PROJECT_NAME
Dean Troyer73f6f252012-09-17 11:22:21 -0500380 iniset $GLANCE_CACHE_CONF DEFAULT admin_user glance
Dean Troyer73f6f252012-09-17 11:22:21 -0500381 iniset $GLANCE_CACHE_CONF DEFAULT admin_password $SERVICE_PASSWORD
382
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200383 # Store specific confs
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200384 iniset $GLANCE_CACHE_CONF glance_store filesystem_store_datadir $GLANCE_IMAGE_DIR/
385
bhagyashris6a25fb92017-12-14 13:23:41 +0530386 # Set default configuration options for the glance-image-import
387 iniset $GLANCE_IMAGE_IMPORT_CONF image_import_opts image_import_plugins []
388 iniset $GLANCE_IMAGE_IMPORT_CONF inject_metadata_properties ignore_user_roles admin
389 iniset $GLANCE_IMAGE_IMPORT_CONF inject_metadata_properties inject
390
Dirk Mueller46d1ba62013-09-09 14:31:37 +0200391 cp -p $GLANCE_DIR/etc/schema-image.json $GLANCE_SCHEMA_JSON
Pawel Koniszewski76e39252014-09-06 07:06:46 -0400392
393 cp -p $GLANCE_DIR/etc/metadefs/*.json $GLANCE_METADEF_DIR
Rob Crittenden18d47782014-03-19 17:47:42 -0400394
Sean Daguef3b2f4c2017-04-13 10:11:48 -0400395 if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -0400396 CINDER_SERVICE_HOST=${CINDER_SERVICE_HOST:-$SERVICE_HOST}
397 CINDER_SERVICE_PORT=${CINDER_SERVICE_PORT:-8776}
398
Brian Rosmaitab43810a2019-02-07 16:46:49 -0500399 iniset $GLANCE_API_CONF DEFAULT cinder_endpoint_template "https://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v3/%(project_id)s"
400 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 -0400401 fi
Matthew Treinish1fa65362017-06-23 22:32:37 +0000402
Dan Smith09eea0b2020-07-09 08:31:51 -0700403 if [[ "$GLANCE_STANDALONE" == False ]]; then
Matthew Treinish1fa65362017-06-23 22:32:37 +0000404 write_local_uwsgi_http_config "$GLANCE_UWSGI_CONF" "$GLANCE_UWSGI" "/image"
Dan Smith802259a2021-01-12 22:55:57 +0000405 # Grab our uwsgi listen address and use that to fill out our
406 # worker_self_reference_url config
407 iniset $GLANCE_API_CONF DEFAULT worker_self_reference_url \
408 $(awk '-F= ' '/^http-socket/ { print "http://"$2}' \
409 $GLANCE_UWSGI_CONF)
Matthew Treinish1fa65362017-06-23 22:32:37 +0000410 else
Dan Smith09eea0b2020-07-09 08:31:51 -0700411 write_local_proxy_http_config glance "http://$GLANCE_SERVICE_HOST:$GLANCE_SERVICE_PORT_INT" "/image"
Matthew Treinish1fa65362017-06-23 22:32:37 +0000412 iniset $GLANCE_API_CONF DEFAULT bind_host $GLANCE_SERVICE_LISTEN_ADDRESS
Dan Smithfcbf3e92020-07-17 10:14:14 -0700413 iniset $GLANCE_API_CONF DEFAULT bind_port $GLANCE_SERVICE_PORT_INT
Matthew Treinish1fa65362017-06-23 22:32:37 +0000414 iniset $GLANCE_API_CONF DEFAULT workers "$API_WORKERS"
415 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500416}
417
Dean Troyer42a59c22014-03-03 14:31:29 -0600418# create_glance_accounts() - Set up common required glance accounts
419
Wayne Okumadd622932015-03-31 00:28:39 -0700420# Project User Roles
421# ---------------------------------------------------------------------
Sean Dague7580a0c2016-02-17 06:23:36 -0500422# SERVICE_PROJECT_NAME glance service
423# SERVICE_PROJECT_NAME glance-swift ResellerAdmin (if Swift is enabled)
424# SERVICE_PROJECT_NAME glance-search search (if Search is enabled)
Dean Troyer42a59c22014-03-03 14:31:29 -0600425
426function create_glance_accounts {
427 if is_service_enabled g-api; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100428
Jamie Lennox85ff5322015-01-28 14:28:01 +1000429 create_service_user "glance"
Bartosz Górski0abde392014-02-28 14:15:19 +0100430
Dean Troyer42a59c22014-03-03 14:31:29 -0600431 # required for swift access
432 if is_service_enabled s-proxy; then
Jamie Lennoxcbcbd8f2016-01-21 16:08:14 -0600433 create_service_user "glance-swift" "ResellerAdmin"
Dean Troyer42a59c22014-03-03 14:31:29 -0600434 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100435
Sean Dague985e9582016-02-10 07:25:24 -0500436 get_or_create_service "glance" "image" "Glance Image Service"
Matt Riedemannae4578b2016-04-23 01:45:40 +0000437 get_or_create_endpoint \
Sean Dague985e9582016-02-10 07:25:24 -0500438 "image" \
439 "$REGION_NAME" \
Matthew Treinish1fa65362017-06-23 22:32:37 +0000440 "$GLANCE_URL"
Jens Rosenboom890342e2016-09-13 22:41:41 +0200441
442 # Note(frickler): Crude workaround for https://bugs.launchpad.net/glance-store/+bug/1620999
443 service_domain_id=$(get_or_create_domain $SERVICE_DOMAIN_NAME)
444 iniset $GLANCE_SWIFT_STORE_CONF ref1 project_domain_id $service_domain_id
445 iniset $GLANCE_SWIFT_STORE_CONF ref1 user_domain_id $service_domain_id
Dan Smith4e916ae2021-04-26 08:52:23 -0700446
447 if [[ "$GLANCE_ENABLE_QUOTAS" = True ]]; then
448 configure_glance_quotas
449 fi
450
Dean Troyer42a59c22014-03-03 14:31:29 -0600451 fi
452}
453
Dean Troyer73f6f252012-09-17 11:22:21 -0500454# init_glance() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100455function init_glance {
Dean Troyer73f6f252012-09-17 11:22:21 -0500456 # Delete existing images
457 rm -rf $GLANCE_IMAGE_DIR
458 mkdir -p $GLANCE_IMAGE_DIR
459
Radosław Piliszek09e860f2020-01-19 12:41:14 +0100460 # (Re)create glance database
461 recreate_database glance
Dean Troyer73f6f252012-09-17 11:22:21 -0500462
Radosław Piliszek09e860f2020-01-19 12:41:14 +0100463 time_start "dbsync"
464 # Migrate glance database
465 $GLANCE_BIN_DIR/glance-manage --config-file $GLANCE_CONF_DIR/glance-api.conf db_sync
Dean Troyerbc071bc2012-10-01 14:06:44 -0500466
Radosław Piliszek09e860f2020-01-19 12:41:14 +0100467 # Load metadata definitions
468 $GLANCE_BIN_DIR/glance-manage --config-file $GLANCE_CONF_DIR/glance-api.conf db_load_metadefs
469 time_stop "dbsync"
Dean Troyer73f6f252012-09-17 11:22:21 -0500470}
471
472# install_glanceclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100473function install_glanceclient {
Sean Daguee08ab102014-11-13 17:09:28 -0500474 if use_library_from_git "python-glanceclient"; then
475 git_clone_by_name "python-glanceclient"
476 setup_dev_lib "python-glanceclient"
Louis Taylor8df690c2014-11-20 13:09:03 +0000477 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 +0100478 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500479}
480
481# install_glance() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100482function install_glance {
Radosław Piliszekbe263062020-03-30 09:56:53 +0200483 local glance_store_extras=()
484
485 if is_service_enabled cinder; then
486 glance_store_extras=("cinder" "${glance_store_extras[@]}")
487 fi
488
489 if is_service_enabled swift; then
490 glance_store_extras=("swift" "${glance_store_extras[@]}")
491 fi
492
Flavio Percoco4f78f8f2014-09-09 09:37:42 +0200493 # Install glance_store from git so we make sure we're testing
494 # the latest code.
Sean Dagueee5ae7b2014-11-13 13:23:27 -0500495 if use_library_from_git "glance_store"; then
496 git_clone_by_name "glance_store"
Radosław Piliszekbe263062020-03-30 09:56:53 +0200497 setup_dev_lib "glance_store" $(join_extras "${glance_store_extras[@]}")
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000498 copy_rootwrap ${DEST}/glance_store/etc/glance
Radosław Piliszekbe263062020-03-30 09:56:53 +0200499 else
500 # we still need to pass extras
501 pip_install_gr_extras glance-store $(join_extras "${glance_store_extras[@]}")
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000502 copy_rootwrap $GLANCE_STORE_ROOTWRAP_BASE_DIR
Sean Dagueee5ae7b2014-11-13 13:23:27 -0500503 fi
Flavio Percoco4f78f8f2014-09-09 09:37:42 +0200504
Dean Troyer73f6f252012-09-17 11:22:21 -0500505 git_clone $GLANCE_REPO $GLANCE_DIR $GLANCE_BRANCH
Wayne Okumadd622932015-03-31 00:28:39 -0700506
Wayne Okumadd622932015-03-31 00:28:39 -0700507 setup_develop $GLANCE_DIR
Dean Troyer73f6f252012-09-17 11:22:21 -0500508}
509
Dan Smith802259a2021-01-12 22:55:57 +0000510# glance_remote_conf() - Return the path to an alternate config file for
511# the remote glance clone
512function glance_remote_conf {
Dan Smith61b4fbf2021-03-09 08:05:37 -0800513 echo $(dirname "${GLANCE_CONF_DIR}")/glance-remote/$(basename "$1")
Dan Smith802259a2021-01-12 22:55:57 +0000514}
515
516# start_glance_remote_clone() - Clone the regular glance api worker
517function start_glance_remote_clone {
Dan Smith61b4fbf2021-03-09 08:05:37 -0800518 local glance_remote_conf_dir glance_remote_port remote_data
519 local glance_remote_uwsgi
Dan Smith802259a2021-01-12 22:55:57 +0000520
Dan Smith61b4fbf2021-03-09 08:05:37 -0800521 glance_remote_conf_dir="$(glance_remote_conf "")"
Dan Smith802259a2021-01-12 22:55:57 +0000522 glance_remote_port=$(get_random_port)
Dan Smith61b4fbf2021-03-09 08:05:37 -0800523 glance_remote_uwsgi="$(glance_remote_conf $GLANCE_UWSGI_CONF)"
Dan Smith802259a2021-01-12 22:55:57 +0000524
525 # Clone the existing ready-to-go glance-api setup
Dan Smith61b4fbf2021-03-09 08:05:37 -0800526 sudo rm -Rf "$glance_remote_conf_dir"
527 sudo cp -r "$GLANCE_CONF_DIR" "$glance_remote_conf_dir"
528 sudo chown $STACK_USER -R "$glance_remote_conf_dir"
Dan Smith802259a2021-01-12 22:55:57 +0000529
530 # Point this worker at different data dirs
531 remote_data="${DATA_DIR}/glance-remote"
532 mkdir -p $remote_data/os_glance_tasks_store \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800533 "${remote_data}/os_glance_staging_store"
534 iniset $(glance_remote_conf "$GLANCE_API_CONF") os_glance_staging_store \
535 filesystem_store_datadir "${remote_data}/os_glance_staging_store"
536 iniset $(glance_remote_conf "$GLANCE_API_CONF") os_glance_tasks_store \
537 filesystem_store_datadir "${remote_data}/os_glance_tasks_store"
Dan Smith802259a2021-01-12 22:55:57 +0000538
539 # Change our uwsgi to our new port
540 sed -ri "s/^(http-socket.*):[0-9]+/\1:$glance_remote_port/" \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800541 "$glance_remote_uwsgi"
Dan Smith802259a2021-01-12 22:55:57 +0000542
543 # Update the self-reference url with our new port
544 iniset $(glance_remote_conf $GLANCE_API_CONF) DEFAULT \
545 worker_self_reference_url \
546 $(awk '-F= ' '/^http-socket/ { print "http://"$2 }' \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800547 "$glance_remote_uwsgi")
Dan Smith802259a2021-01-12 22:55:57 +0000548
549 # We need to create the systemd service for the clone, but then
550 # change it to include an Environment line to point the WSGI app
551 # at the alternate config directory.
552 write_uwsgi_user_unit_file devstack@g-api-r.service "$(which uwsgi) \
553 --procname-prefix \
554 glance-api-remote \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800555 --ini $glance_remote_uwsgi" \
Dan Smith802259a2021-01-12 22:55:57 +0000556 "" "$STACK_USER"
557 iniset -sudo ${SYSTEMD_DIR}/devstack@g-api-r.service \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800558 "Service" "Environment" \
559 "OS_GLANCE_CONFIG_DIR=$glance_remote_conf_dir"
Dan Smith802259a2021-01-12 22:55:57 +0000560
561 # Reload and restart with the new config
562 $SYSTEMCTL daemon-reload
563 $SYSTEMCTL restart devstack@g-api-r
564
565 get_or_create_service glance_remote image_remote "Alternate glance"
566 get_or_create_endpoint image_remote $REGION_NAME \
567 $(awk '-F= ' '/^http-socket/ { print "http://"$2 }' \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800568 $glance_remote_uwsgi)
Dan Smith802259a2021-01-12 22:55:57 +0000569}
570
Sean Dague0eebeb42017-08-30 14:16:58 -0400571# start_glance() - Start running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100572function start_glance {
Rob Crittenden18d47782014-03-19 17:47:42 -0400573 local service_protocol=$GLANCE_SERVICE_PROTOCOL
574 if is_service_enabled tls-proxy; then
Matthew Treinish1fa65362017-06-23 22:32:37 +0000575 if [[ "$WSGI_MODE" != "uwsgi" ]]; then
576 start_tls_proxy glance-service '*' $GLANCE_SERVICE_PORT $GLANCE_SERVICE_HOST $GLANCE_SERVICE_PORT_INT
577 fi
Rob Crittenden18d47782014-03-19 17:47:42 -0400578 fi
579
Dan Smith09eea0b2020-07-09 08:31:51 -0700580 if [[ "$GLANCE_STANDALONE" == False ]]; then
Ian Wienand312517d2018-06-22 22:23:29 +1000581 run_process g-api "$(which uwsgi) --procname-prefix glance-api --ini $GLANCE_UWSGI_CONF"
Matthew Treinish1fa65362017-06-23 22:32:37 +0000582 else
Brian Rosmaita96269d82018-12-17 10:38:42 -0500583 run_process g-api "$GLANCE_BIN_DIR/glance-api --config-dir=$GLANCE_CONF_DIR"
Matthew Treinish1fa65362017-06-23 22:32:37 +0000584 fi
Rob Crittenden18d47782014-03-19 17:47:42 -0400585
Dan Smith802259a2021-01-12 22:55:57 +0000586 if is_service_enabled g-api-r; then
587 echo "Starting the g-api-r clone service..."
588 start_glance_remote_clone
589 fi
590
Matthew Treinish1fa65362017-06-23 22:32:37 +0000591 echo "Waiting for g-api ($GLANCE_SERVICE_HOST) to start..."
592 if ! wait_for_service $SERVICE_TIMEOUT $GLANCE_URL; then
Sean Dague101b4242013-10-22 08:47:11 -0400593 die $LINENO "g-api did not start"
Dean Troyer73f6f252012-09-17 11:22:21 -0500594 fi
595}
596
Dean Troyer699a29f2012-09-10 14:10:27 -0500597# stop_glance() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100598function stop_glance {
Chris Dent2f27a0e2014-09-09 13:46:02 +0100599 stop_process g-api
Dan Smith802259a2021-01-12 22:55:57 +0000600 stop_process g-api-r
Dean Troyer73f6f252012-09-17 11:22:21 -0500601}
602
603# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100604$_XTRACE_GLANCE
Sean Dague584d90e2013-03-29 14:34:53 -0400605
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100606# Tell emacs to use shell-script-mode
607## Local variables:
608## mode: shell-script
609## End: