blob: f18bea9ccb4231ceefb26d336cbf4247d76e0ab4 [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)
Dan Smith4e916ae2021-04-26 08:52:23 -070099GLANCE_ENABLE_QUOTAS=$(trueorfalse True GLANCE_ENABLE_QUOTAS)
Abhishek Kekane73ad9762020-06-16 15:20:48 +0000100
Ghanshyam Mann8c930492021-03-05 09:40:39 -0600101# Flag to set the oslo_policy.enforce_scope. This is used to switch
102# the Image API policies to start checking the scope of token. By Default,
103# this flag is False.
104# For more detail: https://docs.openstack.org/oslo.policy/latest/configuration/index.html#oslo_policy.enforce_scope
105GLANCE_ENFORCE_SCOPE=$(trueorfalse False GLANCE_ENFORCE_SCOPE)
106
Dean Troyer73f6f252012-09-17 11:22:21 -0500107GLANCE_CONF_DIR=${GLANCE_CONF_DIR:-/etc/glance}
Pawel Koniszewski76e39252014-09-06 07:06:46 -0400108GLANCE_METADEF_DIR=$GLANCE_CONF_DIR/metadefs
Dean Troyer73f6f252012-09-17 11:22:21 -0500109GLANCE_API_CONF=$GLANCE_CONF_DIR/glance-api.conf
Dean Troyer73f6f252012-09-17 11:22:21 -0500110GLANCE_API_PASTE_INI=$GLANCE_CONF_DIR/glance-api-paste.ini
111GLANCE_CACHE_CONF=$GLANCE_CONF_DIR/glance-cache.conf
Dirk Mueller46d1ba62013-09-09 14:31:37 +0200112GLANCE_SCHEMA_JSON=$GLANCE_CONF_DIR/schema-image.json
Jamie Lennoxf4f01c62015-06-19 02:52:41 +0000113GLANCE_SWIFT_STORE_CONF=$GLANCE_CONF_DIR/glance-swift-store.conf
bhagyashris6a25fb92017-12-14 13:23:41 +0530114GLANCE_IMAGE_IMPORT_CONF=$GLANCE_CONF_DIR/glance-image-import.conf
Dean Troyer73f6f252012-09-17 11:22:21 -0500115
Sean Daguef3b2f4c2017-04-13 10:11:48 -0400116if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -0400117 GLANCE_SERVICE_PROTOCOL="https"
118fi
119
Dean Troyer73f6f252012-09-17 11:22:21 -0500120# Glance connection info. Note the port must be specified.
Rob Crittenden18d47782014-03-19 17:47:42 -0400121GLANCE_SERVICE_HOST=${GLANCE_SERVICE_HOST:-$SERVICE_HOST}
Jens Harbottdc7b4292017-09-19 10:52:32 +0000122GLANCE_SERVICE_LISTEN_ADDRESS=${GLANCE_SERVICE_LISTEN_ADDRESS:-$(ipv6_unquote $SERVICE_LISTEN_ADDRESS)}
Rob Crittenden18d47782014-03-19 17:47:42 -0400123GLANCE_SERVICE_PORT=${GLANCE_SERVICE_PORT:-9292}
124GLANCE_SERVICE_PORT_INT=${GLANCE_SERVICE_PORT_INT:-19292}
125GLANCE_HOSTPORT=${GLANCE_HOSTPORT:-$GLANCE_SERVICE_HOST:$GLANCE_SERVICE_PORT}
126GLANCE_SERVICE_PROTOCOL=${GLANCE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Matthew Treinish1fa65362017-06-23 22:32:37 +0000127GLANCE_UWSGI=$GLANCE_BIN_DIR/glance-wsgi-api
Jeremy Liu2f7df512017-07-12 10:09:48 +0800128GLANCE_UWSGI_CONF=$GLANCE_CONF_DIR/glance-uwsgi.ini
Julia Kreger5a642452021-07-19 07:01:29 -0700129
130# Glance default limit for Devstack
131GLANCE_LIMIT_IMAGE_SIZE_TOTAL=${GLANCE_LIMIT_IMAGE_SIZE_TOTAL:-1000}
132
Matthew Treinish1fa65362017-06-23 22:32:37 +0000133# If wsgi mode is uwsgi run glance under uwsgi, else default to eventlet
134# TODO(mtreinish): Remove the eventlet path here and in all the similar
135# conditionals below after the Pike release
136if [[ "$WSGI_MODE" == "uwsgi" ]]; then
137 GLANCE_URL="$GLANCE_SERVICE_PROTOCOL://$GLANCE_SERVICE_HOST/image"
138else
139 GLANCE_URL="$GLANCE_SERVICE_PROTOCOL://$GLANCE_HOSTPORT"
140fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500141
Dean Troyercc6b4432013-04-08 15:38:03 -0500142# Functions
143# ---------
Dean Troyer73f6f252012-09-17 11:22:21 -0500144
Dean Troyere4fa7212014-01-15 15:04:49 -0600145# Test if any Glance services are enabled
146# is_glance_enabled
147function is_glance_enabled {
Clark Boylan902158b2017-05-30 14:11:09 -0700148 [[ ,${DISABLED_SERVICES} =~ ,"glance" ]] && return 1
Dean Troyere4fa7212014-01-15 15:04:49 -0600149 [[ ,${ENABLED_SERVICES} =~ ,"g-" ]] && return 0
150 return 1
151}
152
Dean Troyer73f6f252012-09-17 11:22:21 -0500153# cleanup_glance() - 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_glance {
Dan Smith61b4fbf2021-03-09 08:05:37 -0800156 # delete image files (glance) and all of the glance-remote temporary
157 # storage
158 sudo rm -rf $GLANCE_CACHE_DIR $GLANCE_IMAGE_DIR "${DATA_DIR}/glance-remote"
Abhishek Kekane6f91da92019-10-17 09:02:41 +0000159
160 # Cleanup multiple stores directories
161 if [[ "$GLANCE_ENABLE_MULTIPLE_STORES" == "True" ]]; then
162 local store file_dir
163 for store in $(echo $GLANCE_MULTIPLE_FILE_STORES | tr "," "\n"); do
164 file_dir="${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/${store}/"
165 sudo rm -rf $file_dir
166 done
167
168 # Cleanup reserved stores directories
169 sudo rm -rf $GLANCE_STAGING_DIR $GLANCE_TASKS_DIR
170 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500171}
172
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000173# Set multiple cinder store related config options for each of the cinder store
174#
175function configure_multiple_cinder_stores {
176
177 local be be_name be_type enabled_backends
178 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
179 be_type=${be%%:*}
180 be_name=${be##*:}
181 enabled_backends+="${be_name}:cinder,"
182
183 set_common_cinder_store_params $be_name
184 iniset $GLANCE_API_CONF $be_name cinder_volume_type ${be_name}
185 if [[ "$be_type" == "nfs" ]]; then
186 mkdir -p "$GLANCE_NFS_MOUNTPOINT"
187 iniset $GLANCE_API_CONF $be_name cinder_mount_point_base "$GLANCE_NFS_MOUNTPOINT"
188 fi
189 done
190 iniset $GLANCE_API_CONF DEFAULT enabled_backends ${enabled_backends::-1}
191 iniset $GLANCE_API_CONF glance_store default_backend $GLANCE_CINDER_DEFAULT_BACKEND
192}
193
194# Set common cinder store options to given config section
195#
196# Arguments:
197# config_section
198#
199function set_common_cinder_store_params {
200 local config_section="$1"
201 iniset $GLANCE_API_CONF $config_section cinder_store_auth_address $KEYSTONE_SERVICE_URI_V3
202 iniset $GLANCE_API_CONF $config_section cinder_store_user_name glance
203 iniset $GLANCE_API_CONF $config_section cinder_store_password $SERVICE_PASSWORD
204 iniset $GLANCE_API_CONF $config_section cinder_store_project_name $SERVICE_PROJECT_NAME
205}
206
207# Configure multiple file stores options for each file store
208#
209# Arguments:
210#
211function configure_multiple_file_stores {
212 local store enabled_backends
213 enabled_backends=""
214 for store in $(echo $GLANCE_MULTIPLE_FILE_STORES | tr "," "\n"); do
215 enabled_backends+="${store}:file,"
216 done
217 iniset $GLANCE_API_CONF DEFAULT enabled_backends ${enabled_backends::-1}
218
219 # Glance multiple store Store specific configs
220 iniset $GLANCE_API_CONF glance_store default_backend $GLANCE_DEFAULT_BACKEND
221 local store
222 for store in $(echo $glance_multiple_file_stores | tr "," "\n"); do
223 iniset $GLANCE_API_CONF $store filesystem_store_datadir "${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/${store}/"
224 done
225}
226
227# Set reserved stores for glance
228function configure_reserved_stores {
229 iniset $GLANCE_API_CONF os_glance_staging_store filesystem_store_datadir "${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/os_glance_staging_store/"
230 iniset $GLANCE_API_CONF os_glance_tasks_store filesystem_store_datadir "${GLANCE_MULTISTORE_FILE_IMAGE_DIR}/os_glance_tasks_store/"
231}
232
233# Copy rootwrap file from glance_store/etc/glance to /etc/glance
234#
235# Arguments:
236# source_path Source path to copy rootwrap files from
237#
238function copy_rootwrap {
239 local source_path="$1"
240 # Make glance configuration directory if it is not exists
241 sudo install -d -o $STACK_USER $GLANCE_CONF_DIR
242 cp -r $source_path/rootwrap.* $GLANCE_CONF_DIR/
243}
244
245# Set glance_store related config options
246#
247# Arguments:
248# USE_CINDER_FOR_GLANCE
249# GLANCE_ENABLE_MULTIPLE_STORES
250#
251function configure_glance_store {
252 local use_cinder_for_glance="$1"
253 local glance_enable_multiple_stores="$2"
254 local be
255
256 if [[ "$glance_enable_multiple_stores" == "False" ]]; then
257 # Configure traditional glance_store
258 if [[ "$use_cinder_for_glance" == "True" ]]; then
259 # set common glance_store parameters
260 iniset $GLANCE_API_CONF glance_store stores "cinder,file,http"
261 iniset $GLANCE_API_CONF glance_store default_store cinder
262
263 # set cinder related store parameters
264 set_common_cinder_store_params glance_store
265 # set nfs mount_point dir
266 for be in ${CINDER_ENABLED_BACKENDS//,/ }; do
267 local be_name=${be##*:}
268 if [[ "$be_name" == "nfs" ]]; then
269 mkdir -p $GLANCE_NFS_MOUNTPOINT
270 iniset $GLANCE_API_CONF glance_store cinder_mount_point_base $GLANCE_NFS_MOUNTPOINT
271 fi
272 done
273 fi
274 # Store specific configs
275 iniset $GLANCE_API_CONF glance_store filesystem_store_datadir $GLANCE_IMAGE_DIR/
276 else
277 if [[ "$use_cinder_for_glance" == "True" ]]; then
278 # Configure multiple cinder stores for glance
279 configure_multiple_cinder_stores
280 else
281 # Configure multiple file stores for glance
282 configure_multiple_file_stores
283 fi
284 # Configure reserved stores
285 configure_reserved_stores
286 fi
287}
288
Dan Smith4e916ae2021-04-26 08:52:23 -0700289function configure_glance_quotas {
290
291 # NOTE(danms): We need to have some of the OS_ things unset in
292 # order to use system scope, which is required for creating these
293 # limits. This is a hack, but I dunno how else to get osc to use
294 # system scope.
295
296 bash -c "unset OS_USERNAME OS_TENANT_NAME OS_PROJECT_NAME;
297 openstack --os-cloud devstack-system-admin registered limit create \
Julia Kreger5a642452021-07-19 07:01:29 -0700298 --service glance --default-limit $GLANCE_LIMIT_IMAGE_SIZE_TOTAL \
299 --region $REGION_NAME image_size_total; \
Dan Smith4e916ae2021-04-26 08:52:23 -0700300 openstack --os-cloud devstack-system-admin registered limit create \
Julia Kreger5a642452021-07-19 07:01:29 -0700301 --service glance --default-limit $GLANCE_LIMIT_IMAGE_SIZE_TOTAL \
302 --region $REGION_NAME image_stage_total; \
Dan Smith4e916ae2021-04-26 08:52:23 -0700303 openstack --os-cloud devstack-system-admin registered limit create \
304 --service glance --default-limit 100 --region $REGION_NAME \
305 image_count_total; \
306 openstack --os-cloud devstack-system-admin registered limit create \
307 --service glance --default-limit 100 --region $REGION_NAME \
308 image_count_uploading"
309
310 # Tell glance to use these limits
311 iniset $GLANCE_API_CONF DEFAULT use_keystone_limits True
312
313 # Configure oslo_limit so it can talk to keystone
314 iniset $GLANCE_API_CONF oslo_limit user_domain_name $SERVICE_DOMAIN_NAME
315 iniset $GLANCE_API_CONF oslo_limit password $SERVICE_PASSWORD
316 iniset $GLANCE_API_CONF oslo_limit username glance
317 iniset $GLANCE_API_CONF oslo_limit auth_type password
318 iniset $GLANCE_API_CONF oslo_limit auth_url $KEYSTONE_SERVICE_URI
319 iniset $GLANCE_API_CONF oslo_limit system_scope "'all'"
320 iniset $GLANCE_API_CONF oslo_limit endpoint_id \
321 $(openstack endpoint list --service glance -f value -c ID)
322
323 # Allow the glance service user to read quotas
324 openstack role add --user glance --user-domain Default --system all \
325 reader
326}
327
Dean Troyer73f6f252012-09-17 11:22:21 -0500328# configure_glance() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100329function configure_glance {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500330 sudo install -d -o $STACK_USER $GLANCE_CONF_DIR $GLANCE_METADEF_DIR
Pawel Koniszewski76e39252014-09-06 07:06:46 -0400331
Abhishek Kekane0ae57872020-02-17 06:11:15 +0000332 # Set non-default configuration options for the API server
Ian Wienandada886d2015-10-07 14:06:26 +1100333 local dburl
334 dburl=`database_connection_url glance`
Dean Troyer73f6f252012-09-17 11:22:21 -0500335
Ben Nemec03997942013-08-10 09:56:16 -0500336 iniset $GLANCE_API_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Jordan Pittierceca15d2015-06-19 11:46:36 +0200337 iniset $GLANCE_API_CONF database connection $dburl
Dean Troyer73f6f252012-09-17 11:22:21 -0500338 iniset $GLANCE_API_CONF DEFAULT use_syslog $SYSLOG
Dean Troyer73f6f252012-09-17 11:22:21 -0500339 iniset $GLANCE_API_CONF DEFAULT image_cache_dir $GLANCE_CACHE_DIR/
ZhongShengping5fe60c12019-04-30 10:12:51 +0800340 iniset $GLANCE_API_CONF oslo_concurrency lock_path $GLANCE_LOCK_DIR
Dean Troyer73f6f252012-09-17 11:22:21 -0500341 iniset $GLANCE_API_CONF paste_deploy flavor keystone+cachemanagement
Dirk Mueller8ab64b32017-11-17 19:52:29 +0100342 configure_keystone_authtoken_middleware $GLANCE_API_CONF glance
Matt Riedemann45da7772017-03-05 13:07:39 -0500343 iniset $GLANCE_API_CONF oslo_messaging_notifications driver messagingv2
Brant Knudson2dd110c2015-03-14 12:39:14 -0500344 iniset_rpc_backend glance $GLANCE_API_CONF
Evgeny Antyshev19354582014-11-24 14:20:35 +0400345 if [ "$VIRT_DRIVER" = 'libvirt' ] && [ "$LIBVIRT_TYPE" = 'parallels' ]; then
346 iniset $GLANCE_API_CONF DEFAULT disk_formats "ami,ari,aki,vhd,vmdk,raw,qcow2,vdi,iso,ploop"
347 fi
Brian Rosmaita6e9f7c22020-10-13 14:20:38 -0400348 # Only use these if you know what you are doing! See OSSN-0065
349 iniset $GLANCE_API_CONF DEFAULT show_image_direct_url $GLANCE_SHOW_DIRECT_URL
350 iniset $GLANCE_API_CONF DEFAULT show_multiple_locations $GLANCE_SHOW_MULTIPLE_LOCATIONS
Dean Troyer73f6f252012-09-17 11:22:21 -0500351
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000352 # Configure glance_store
353 configure_glance_store $USE_CINDER_FOR_GLANCE $GLANCE_ENABLE_MULTIPLE_STORES
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200354
Timur Sufieva44dd9a2016-04-29 14:08:51 +0300355 # CORS feature support - to allow calls from Horizon by default
356 if [ -n "$GLANCE_CORS_ALLOWED_ORIGIN" ]; then
357 iniset $GLANCE_API_CONF cors allowed_origin "$GLANCE_CORS_ALLOWED_ORIGIN"
358 else
359 iniset $GLANCE_API_CONF cors allowed_origin "http://$SERVICE_HOST"
360 fi
361
Abhishek Kekane6f91da92019-10-17 09:02:41 +0000362 # No multiple stores for swift yet
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000363 if [[ "$GLANCE_ENABLE_MULTIPLE_STORES" == "False" ]]; then
364 # Store the images in swift if enabled.
365 if is_service_enabled s-proxy; then
366 iniset $GLANCE_API_CONF glance_store default_store swift
367 iniset $GLANCE_API_CONF glance_store swift_store_create_container_on_put True
Jamie Lennoxf4f01c62015-06-19 02:52:41 +0000368
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000369 iniset $GLANCE_API_CONF glance_store swift_store_config_file $GLANCE_SWIFT_STORE_CONF
370 iniset $GLANCE_API_CONF glance_store default_swift_reference ref1
371 iniset $GLANCE_API_CONF glance_store stores "file, http, swift"
372 if is_service_enabled tls-proxy; then
373 iniset $GLANCE_API_CONF glance_store swift_store_cacert $SSL_BUNDLE_FILE
374 fi
375 iniset $GLANCE_API_CONF DEFAULT graceful_shutdown_timeout "$SERVICE_GRACEFUL_SHUTDOWN_TIMEOUT"
376
377 iniset $GLANCE_SWIFT_STORE_CONF ref1 user $SERVICE_PROJECT_NAME:glance-swift
378
379 iniset $GLANCE_SWIFT_STORE_CONF ref1 key $SERVICE_PASSWORD
380 iniset $GLANCE_SWIFT_STORE_CONF ref1 auth_address $KEYSTONE_SERVICE_URI/v3
381 iniset $GLANCE_SWIFT_STORE_CONF ref1 auth_version 3
Vladislav Kuzmin9cbd02d2020-05-20 12:14:04 +0400382 fi
Dean Troyerc77b9322013-03-29 10:51:01 -0500383 fi
384
Matthew Treinish1fa65362017-06-23 22:32:37 +0000385 # We need to tell glance what it's public endpoint is so that the version
386 # discovery document will be correct
387 iniset $GLANCE_API_CONF DEFAULT public_endpoint $GLANCE_URL
388
Rob Crittenden18d47782014-03-19 17:47:42 -0400389 if is_service_enabled tls-proxy; then
390 iniset $GLANCE_API_CONF DEFAULT bind_port $GLANCE_SERVICE_PORT_INT
Jens Harbott32c00892019-04-10 10:33:39 +0000391 iniset $GLANCE_API_CONF keystone_authtoken identity_uri $KEYSTONE_SERVICE_URI
Rob Crittenden18d47782014-03-19 17:47:42 -0400392 fi
393
Louis Taylor701276a2015-02-11 19:34:09 +0000394 # Format logging
Sean Dague9751be62016-04-05 12:08:57 -0400395 setup_logging $GLANCE_API_CONF
Louis Taylor701276a2015-02-11 19:34:09 +0000396
Dean Troyer73f6f252012-09-17 11:22:21 -0500397 cp -p $GLANCE_DIR/etc/glance-api-paste.ini $GLANCE_API_PASTE_INI
398
Brian Rosmaita44a19b42017-12-11 18:07:50 -0500399 # Set non-default configuration options for the glance-cache
Ben Nemec03997942013-08-10 09:56:16 -0500400 iniset $GLANCE_CACHE_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Dean Troyer73f6f252012-09-17 11:22:21 -0500401 iniset $GLANCE_CACHE_CONF DEFAULT use_syslog $SYSLOG
Dean Troyer73f6f252012-09-17 11:22:21 -0500402 iniset $GLANCE_CACHE_CONF DEFAULT image_cache_dir $GLANCE_CACHE_DIR/
Jens Harbott32c00892019-04-10 10:33:39 +0000403 iniset $GLANCE_CACHE_CONF DEFAULT auth_url $KEYSTONE_SERVICE_URI
Sean Dague7580a0c2016-02-17 06:23:36 -0500404 iniset $GLANCE_CACHE_CONF DEFAULT admin_tenant_name $SERVICE_PROJECT_NAME
Dean Troyer73f6f252012-09-17 11:22:21 -0500405 iniset $GLANCE_CACHE_CONF DEFAULT admin_user glance
Dean Troyer73f6f252012-09-17 11:22:21 -0500406 iniset $GLANCE_CACHE_CONF DEFAULT admin_password $SERVICE_PASSWORD
407
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200408 # Store specific confs
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200409 iniset $GLANCE_CACHE_CONF glance_store filesystem_store_datadir $GLANCE_IMAGE_DIR/
410
bhagyashris6a25fb92017-12-14 13:23:41 +0530411 # Set default configuration options for the glance-image-import
412 iniset $GLANCE_IMAGE_IMPORT_CONF image_import_opts image_import_plugins []
413 iniset $GLANCE_IMAGE_IMPORT_CONF inject_metadata_properties ignore_user_roles admin
414 iniset $GLANCE_IMAGE_IMPORT_CONF inject_metadata_properties inject
415
Dirk Mueller46d1ba62013-09-09 14:31:37 +0200416 cp -p $GLANCE_DIR/etc/schema-image.json $GLANCE_SCHEMA_JSON
Pawel Koniszewski76e39252014-09-06 07:06:46 -0400417
418 cp -p $GLANCE_DIR/etc/metadefs/*.json $GLANCE_METADEF_DIR
Rob Crittenden18d47782014-03-19 17:47:42 -0400419
Sean Daguef3b2f4c2017-04-13 10:11:48 -0400420 if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -0400421 CINDER_SERVICE_HOST=${CINDER_SERVICE_HOST:-$SERVICE_HOST}
422 CINDER_SERVICE_PORT=${CINDER_SERVICE_PORT:-8776}
423
Brian Rosmaitab43810a2019-02-07 16:46:49 -0500424 iniset $GLANCE_API_CONF DEFAULT cinder_endpoint_template "https://$CINDER_SERVICE_HOST:$CINDER_SERVICE_PORT/v3/%(project_id)s"
425 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 -0400426 fi
Matthew Treinish1fa65362017-06-23 22:32:37 +0000427
Dan Smith09eea0b2020-07-09 08:31:51 -0700428 if [[ "$GLANCE_STANDALONE" == False ]]; then
Matthew Treinish1fa65362017-06-23 22:32:37 +0000429 write_local_uwsgi_http_config "$GLANCE_UWSGI_CONF" "$GLANCE_UWSGI" "/image"
Dan Smith802259a2021-01-12 22:55:57 +0000430 # Grab our uwsgi listen address and use that to fill out our
431 # worker_self_reference_url config
432 iniset $GLANCE_API_CONF DEFAULT worker_self_reference_url \
433 $(awk '-F= ' '/^http-socket/ { print "http://"$2}' \
434 $GLANCE_UWSGI_CONF)
Matthew Treinish1fa65362017-06-23 22:32:37 +0000435 else
Dan Smith09eea0b2020-07-09 08:31:51 -0700436 write_local_proxy_http_config glance "http://$GLANCE_SERVICE_HOST:$GLANCE_SERVICE_PORT_INT" "/image"
Matthew Treinish1fa65362017-06-23 22:32:37 +0000437 iniset $GLANCE_API_CONF DEFAULT bind_host $GLANCE_SERVICE_LISTEN_ADDRESS
Dan Smithfcbf3e92020-07-17 10:14:14 -0700438 iniset $GLANCE_API_CONF DEFAULT bind_port $GLANCE_SERVICE_PORT_INT
Matthew Treinish1fa65362017-06-23 22:32:37 +0000439 iniset $GLANCE_API_CONF DEFAULT workers "$API_WORKERS"
440 fi
Ghanshyam Mann8c930492021-03-05 09:40:39 -0600441
442 if [[ "$GLANCE_ENFORCE_SCOPE" == True ]] ; then
443 iniset $GLANCE_API_CONF oslo_policy enforce_scope true
444 iniset $GLANCE_API_CONF oslo_policy enforce_new_defaults true
445 iniset $GLANCE_API_CONF DEFAULT enforce_secure_rbac true
446 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500447}
448
Dean Troyer42a59c22014-03-03 14:31:29 -0600449# create_glance_accounts() - Set up common required glance accounts
450
Wayne Okumadd622932015-03-31 00:28:39 -0700451# Project User Roles
452# ---------------------------------------------------------------------
Sean Dague7580a0c2016-02-17 06:23:36 -0500453# SERVICE_PROJECT_NAME glance service
454# SERVICE_PROJECT_NAME glance-swift ResellerAdmin (if Swift is enabled)
455# SERVICE_PROJECT_NAME glance-search search (if Search is enabled)
Dean Troyer42a59c22014-03-03 14:31:29 -0600456
457function create_glance_accounts {
458 if is_service_enabled g-api; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100459
Jamie Lennox85ff5322015-01-28 14:28:01 +1000460 create_service_user "glance"
Bartosz Górski0abde392014-02-28 14:15:19 +0100461
Dean Troyer42a59c22014-03-03 14:31:29 -0600462 # required for swift access
463 if is_service_enabled s-proxy; then
Jamie Lennoxcbcbd8f2016-01-21 16:08:14 -0600464 create_service_user "glance-swift" "ResellerAdmin"
Dean Troyer42a59c22014-03-03 14:31:29 -0600465 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100466
Sean Dague985e9582016-02-10 07:25:24 -0500467 get_or_create_service "glance" "image" "Glance Image Service"
Matt Riedemannae4578b2016-04-23 01:45:40 +0000468 get_or_create_endpoint \
Sean Dague985e9582016-02-10 07:25:24 -0500469 "image" \
470 "$REGION_NAME" \
Matthew Treinish1fa65362017-06-23 22:32:37 +0000471 "$GLANCE_URL"
Jens Rosenboom890342e2016-09-13 22:41:41 +0200472
473 # Note(frickler): Crude workaround for https://bugs.launchpad.net/glance-store/+bug/1620999
474 service_domain_id=$(get_or_create_domain $SERVICE_DOMAIN_NAME)
475 iniset $GLANCE_SWIFT_STORE_CONF ref1 project_domain_id $service_domain_id
476 iniset $GLANCE_SWIFT_STORE_CONF ref1 user_domain_id $service_domain_id
Dan Smith4e916ae2021-04-26 08:52:23 -0700477
478 if [[ "$GLANCE_ENABLE_QUOTAS" = True ]]; then
479 configure_glance_quotas
480 fi
481
Dean Troyer42a59c22014-03-03 14:31:29 -0600482 fi
483}
484
Dean Troyer73f6f252012-09-17 11:22:21 -0500485# init_glance() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100486function init_glance {
Dean Troyer73f6f252012-09-17 11:22:21 -0500487 # Delete existing images
488 rm -rf $GLANCE_IMAGE_DIR
489 mkdir -p $GLANCE_IMAGE_DIR
490
Radosław Piliszek09e860f2020-01-19 12:41:14 +0100491 # (Re)create glance database
492 recreate_database glance
Dean Troyer73f6f252012-09-17 11:22:21 -0500493
Radosław Piliszek09e860f2020-01-19 12:41:14 +0100494 time_start "dbsync"
495 # Migrate glance database
496 $GLANCE_BIN_DIR/glance-manage --config-file $GLANCE_CONF_DIR/glance-api.conf db_sync
Dean Troyerbc071bc2012-10-01 14:06:44 -0500497
Radosław Piliszek09e860f2020-01-19 12:41:14 +0100498 # Load metadata definitions
499 $GLANCE_BIN_DIR/glance-manage --config-file $GLANCE_CONF_DIR/glance-api.conf db_load_metadefs
500 time_stop "dbsync"
Dean Troyer73f6f252012-09-17 11:22:21 -0500501}
502
503# install_glanceclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100504function install_glanceclient {
Sean Daguee08ab102014-11-13 17:09:28 -0500505 if use_library_from_git "python-glanceclient"; then
506 git_clone_by_name "python-glanceclient"
507 setup_dev_lib "python-glanceclient"
Louis Taylor8df690c2014-11-20 13:09:03 +0000508 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 +0100509 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500510}
511
512# install_glance() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100513function install_glance {
Radosław Piliszekbe263062020-03-30 09:56:53 +0200514 local glance_store_extras=()
515
516 if is_service_enabled cinder; then
517 glance_store_extras=("cinder" "${glance_store_extras[@]}")
518 fi
519
520 if is_service_enabled swift; then
521 glance_store_extras=("swift" "${glance_store_extras[@]}")
522 fi
523
Flavio Percoco4f78f8f2014-09-09 09:37:42 +0200524 # Install glance_store from git so we make sure we're testing
525 # the latest code.
Sean Dagueee5ae7b2014-11-13 13:23:27 -0500526 if use_library_from_git "glance_store"; then
527 git_clone_by_name "glance_store"
Radosław Piliszekbe263062020-03-30 09:56:53 +0200528 setup_dev_lib "glance_store" $(join_extras "${glance_store_extras[@]}")
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000529 copy_rootwrap ${DEST}/glance_store/etc/glance
Radosław Piliszekbe263062020-03-30 09:56:53 +0200530 else
531 # we still need to pass extras
532 pip_install_gr_extras glance-store $(join_extras "${glance_store_extras[@]}")
Abhishek Kekane057aaa62020-07-29 07:37:16 +0000533 copy_rootwrap $GLANCE_STORE_ROOTWRAP_BASE_DIR
Sean Dagueee5ae7b2014-11-13 13:23:27 -0500534 fi
Flavio Percoco4f78f8f2014-09-09 09:37:42 +0200535
Dean Troyer73f6f252012-09-17 11:22:21 -0500536 git_clone $GLANCE_REPO $GLANCE_DIR $GLANCE_BRANCH
Wayne Okumadd622932015-03-31 00:28:39 -0700537
Wayne Okumadd622932015-03-31 00:28:39 -0700538 setup_develop $GLANCE_DIR
Dean Troyer73f6f252012-09-17 11:22:21 -0500539}
540
Dan Smith802259a2021-01-12 22:55:57 +0000541# glance_remote_conf() - Return the path to an alternate config file for
542# the remote glance clone
543function glance_remote_conf {
Dan Smith61b4fbf2021-03-09 08:05:37 -0800544 echo $(dirname "${GLANCE_CONF_DIR}")/glance-remote/$(basename "$1")
Dan Smith802259a2021-01-12 22:55:57 +0000545}
546
547# start_glance_remote_clone() - Clone the regular glance api worker
548function start_glance_remote_clone {
Dan Smith61b4fbf2021-03-09 08:05:37 -0800549 local glance_remote_conf_dir glance_remote_port remote_data
550 local glance_remote_uwsgi
Dan Smith802259a2021-01-12 22:55:57 +0000551
Dan Smith61b4fbf2021-03-09 08:05:37 -0800552 glance_remote_conf_dir="$(glance_remote_conf "")"
Dan Smith802259a2021-01-12 22:55:57 +0000553 glance_remote_port=$(get_random_port)
Dan Smith61b4fbf2021-03-09 08:05:37 -0800554 glance_remote_uwsgi="$(glance_remote_conf $GLANCE_UWSGI_CONF)"
Dan Smith802259a2021-01-12 22:55:57 +0000555
556 # Clone the existing ready-to-go glance-api setup
Dan Smith61b4fbf2021-03-09 08:05:37 -0800557 sudo rm -Rf "$glance_remote_conf_dir"
558 sudo cp -r "$GLANCE_CONF_DIR" "$glance_remote_conf_dir"
559 sudo chown $STACK_USER -R "$glance_remote_conf_dir"
Dan Smith802259a2021-01-12 22:55:57 +0000560
561 # Point this worker at different data dirs
562 remote_data="${DATA_DIR}/glance-remote"
563 mkdir -p $remote_data/os_glance_tasks_store \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800564 "${remote_data}/os_glance_staging_store"
565 iniset $(glance_remote_conf "$GLANCE_API_CONF") os_glance_staging_store \
566 filesystem_store_datadir "${remote_data}/os_glance_staging_store"
567 iniset $(glance_remote_conf "$GLANCE_API_CONF") os_glance_tasks_store \
568 filesystem_store_datadir "${remote_data}/os_glance_tasks_store"
Dan Smith802259a2021-01-12 22:55:57 +0000569
Abhishek Kekane00ac5472021-08-09 05:54:32 +0000570 # Point this worker to use different cache dir
571 mkdir -p "$remote_data/cache"
572 iniset $(glance_remote_conf "$GLANCE_API_CONF") DEFAULT \
573 image_cache_dir "${remote_data}/cache"
574
Dan Smith802259a2021-01-12 22:55:57 +0000575 # Change our uwsgi to our new port
576 sed -ri "s/^(http-socket.*):[0-9]+/\1:$glance_remote_port/" \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800577 "$glance_remote_uwsgi"
Dan Smith802259a2021-01-12 22:55:57 +0000578
579 # Update the self-reference url with our new port
580 iniset $(glance_remote_conf $GLANCE_API_CONF) DEFAULT \
581 worker_self_reference_url \
582 $(awk '-F= ' '/^http-socket/ { print "http://"$2 }' \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800583 "$glance_remote_uwsgi")
Dan Smith802259a2021-01-12 22:55:57 +0000584
585 # We need to create the systemd service for the clone, but then
586 # change it to include an Environment line to point the WSGI app
587 # at the alternate config directory.
588 write_uwsgi_user_unit_file devstack@g-api-r.service "$(which uwsgi) \
589 --procname-prefix \
590 glance-api-remote \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800591 --ini $glance_remote_uwsgi" \
Dan Smith802259a2021-01-12 22:55:57 +0000592 "" "$STACK_USER"
593 iniset -sudo ${SYSTEMD_DIR}/devstack@g-api-r.service \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800594 "Service" "Environment" \
595 "OS_GLANCE_CONFIG_DIR=$glance_remote_conf_dir"
Dan Smith802259a2021-01-12 22:55:57 +0000596
597 # Reload and restart with the new config
598 $SYSTEMCTL daemon-reload
599 $SYSTEMCTL restart devstack@g-api-r
600
601 get_or_create_service glance_remote image_remote "Alternate glance"
602 get_or_create_endpoint image_remote $REGION_NAME \
603 $(awk '-F= ' '/^http-socket/ { print "http://"$2 }' \
Dan Smith61b4fbf2021-03-09 08:05:37 -0800604 $glance_remote_uwsgi)
Dan Smith802259a2021-01-12 22:55:57 +0000605}
606
Sean Dague0eebeb42017-08-30 14:16:58 -0400607# start_glance() - Start running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100608function start_glance {
Rob Crittenden18d47782014-03-19 17:47:42 -0400609 local service_protocol=$GLANCE_SERVICE_PROTOCOL
610 if is_service_enabled tls-proxy; then
Matthew Treinish1fa65362017-06-23 22:32:37 +0000611 if [[ "$WSGI_MODE" != "uwsgi" ]]; then
612 start_tls_proxy glance-service '*' $GLANCE_SERVICE_PORT $GLANCE_SERVICE_HOST $GLANCE_SERVICE_PORT_INT
613 fi
Rob Crittenden18d47782014-03-19 17:47:42 -0400614 fi
615
Dan Smith09eea0b2020-07-09 08:31:51 -0700616 if [[ "$GLANCE_STANDALONE" == False ]]; then
Ian Wienand312517d2018-06-22 22:23:29 +1000617 run_process g-api "$(which uwsgi) --procname-prefix glance-api --ini $GLANCE_UWSGI_CONF"
Matthew Treinish1fa65362017-06-23 22:32:37 +0000618 else
Brian Rosmaita96269d82018-12-17 10:38:42 -0500619 run_process g-api "$GLANCE_BIN_DIR/glance-api --config-dir=$GLANCE_CONF_DIR"
Matthew Treinish1fa65362017-06-23 22:32:37 +0000620 fi
Rob Crittenden18d47782014-03-19 17:47:42 -0400621
Dan Smith802259a2021-01-12 22:55:57 +0000622 if is_service_enabled g-api-r; then
623 echo "Starting the g-api-r clone service..."
624 start_glance_remote_clone
625 fi
626
Matthew Treinish1fa65362017-06-23 22:32:37 +0000627 echo "Waiting for g-api ($GLANCE_SERVICE_HOST) to start..."
628 if ! wait_for_service $SERVICE_TIMEOUT $GLANCE_URL; then
Sean Dague101b4242013-10-22 08:47:11 -0400629 die $LINENO "g-api did not start"
Dean Troyer73f6f252012-09-17 11:22:21 -0500630 fi
631}
632
Dean Troyer699a29f2012-09-10 14:10:27 -0500633# stop_glance() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100634function stop_glance {
Chris Dent2f27a0e2014-09-09 13:46:02 +0100635 stop_process g-api
Dan Smith802259a2021-01-12 22:55:57 +0000636 stop_process g-api-r
Dean Troyer73f6f252012-09-17 11:22:21 -0500637}
638
639# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100640$_XTRACE_GLANCE
Sean Dague584d90e2013-03-29 14:34:53 -0400641
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100642# Tell emacs to use shell-script-mode
643## Local variables:
644## mode: shell-script
645## End: