blob: 7a84e8ea0dac42b466a36a1621aee66356251a53 [file] [log] [blame]
Dean Troyer73f6f252012-09-17 11:22:21 -05001# lib/glance
Dean Troyer6d04fd72012-12-21 11:03:37 -06002# Functions to control the configuration and operation of the **Glance** service
Dean Troyer73f6f252012-09-17 11:22:21 -05003
4# Dependencies:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01005#
6# - ``functions`` file
7# - ``DEST``, ``DATA_DIR``, ``STACK_USER`` must be defined
8# - ``SERVICE_{TENANT_NAME|PASSWORD}`` must be defined
9# - ``SERVICE_HOST``
10# - ``KEYSTONE_TOKEN_FORMAT`` must be defined
Dean Troyer73f6f252012-09-17 11:22:21 -050011
12# ``stack.sh`` calls the entry points in this order:
13#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010014# - install_glance
15# - configure_glance
16# - init_glance
17# - start_glance
18# - stop_glance
19# - cleanup_glance
Dean Troyer73f6f252012-09-17 11:22:21 -050020
21# Save trace setting
22XTRACE=$(set +o | grep xtrace)
23set +o xtrace
24
25
26# Defaults
27# --------
28
Dean Troyer73f6f252012-09-17 11:22:21 -050029# Set up default directories
30GLANCE_DIR=$DEST/glance
31GLANCECLIENT_DIR=$DEST/python-glanceclient
32GLANCE_CACHE_DIR=${GLANCE_CACHE_DIR:=$DATA_DIR/glance/cache}
33GLANCE_IMAGE_DIR=${GLANCE_IMAGE_DIR:=$DATA_DIR/glance/images}
Dean Troyerbc071bc2012-10-01 14:06:44 -050034GLANCE_AUTH_CACHE_DIR=${GLANCE_AUTH_CACHE_DIR:-/var/cache/glance}
Dean Troyer73f6f252012-09-17 11:22:21 -050035
36GLANCE_CONF_DIR=${GLANCE_CONF_DIR:-/etc/glance}
37GLANCE_REGISTRY_CONF=$GLANCE_CONF_DIR/glance-registry.conf
38GLANCE_API_CONF=$GLANCE_CONF_DIR/glance-api.conf
39GLANCE_REGISTRY_PASTE_INI=$GLANCE_CONF_DIR/glance-registry-paste.ini
40GLANCE_API_PASTE_INI=$GLANCE_CONF_DIR/glance-api-paste.ini
41GLANCE_CACHE_CONF=$GLANCE_CONF_DIR/glance-cache.conf
42GLANCE_POLICY_JSON=$GLANCE_CONF_DIR/policy.json
Dirk Mueller46d1ba62013-09-09 14:31:37 +020043GLANCE_SCHEMA_JSON=$GLANCE_CONF_DIR/schema-image.json
Dean Troyer73f6f252012-09-17 11:22:21 -050044
45# Support entry points installation of console scripts
46if [[ -d $GLANCE_DIR/bin ]]; then
47 GLANCE_BIN_DIR=$GLANCE_DIR/bin
48else
Jakub Ruzicka4196d552013-01-30 15:35:54 +010049 GLANCE_BIN_DIR=$(get_python_exec_prefix)
Dean Troyer73f6f252012-09-17 11:22:21 -050050fi
51
52# Glance connection info. Note the port must be specified.
53GLANCE_HOSTPORT=${GLANCE_HOSTPORT:-$SERVICE_HOST:9292}
54
Dean Troyer4237f592014-01-29 16:22:11 -060055# Tell Tempest this project is present
56TEMPEST_SERVICES+=,glance
57
Dean Troyer73f6f252012-09-17 11:22:21 -050058
Dean Troyercc6b4432013-04-08 15:38:03 -050059# Functions
60# ---------
Dean Troyer73f6f252012-09-17 11:22:21 -050061
Dean Troyere4fa7212014-01-15 15:04:49 -060062# Test if any Glance services are enabled
63# is_glance_enabled
64function is_glance_enabled {
65 [[ ,${ENABLED_SERVICES} =~ ,"g-" ]] && return 0
66 return 1
67}
68
Dean Troyer73f6f252012-09-17 11:22:21 -050069# cleanup_glance() - Remove residual data files, anything left over from previous
70# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +110071function cleanup_glance {
Dean Troyer73f6f252012-09-17 11:22:21 -050072 # kill instances (nova)
73 # delete image files (glance)
Dean Troyer995eb922013-03-07 16:11:40 -060074 sudo rm -rf $GLANCE_CACHE_DIR $GLANCE_IMAGE_DIR $GLANCE_AUTH_CACHE_DIR
Dean Troyer73f6f252012-09-17 11:22:21 -050075}
76
Dean Troyer73f6f252012-09-17 11:22:21 -050077# configure_glance() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +110078function configure_glance {
Dean Troyer73f6f252012-09-17 11:22:21 -050079 if [[ ! -d $GLANCE_CONF_DIR ]]; then
80 sudo mkdir -p $GLANCE_CONF_DIR
81 fi
Attila Fazekas91b8d132013-01-06 22:40:09 +010082 sudo chown $STACK_USER $GLANCE_CONF_DIR
Dean Troyer73f6f252012-09-17 11:22:21 -050083
84 # Copy over our glance configurations and update them
85 cp $GLANCE_DIR/etc/glance-registry.conf $GLANCE_REGISTRY_CONF
Ben Nemec03997942013-08-10 09:56:16 -050086 iniset $GLANCE_REGISTRY_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Dean Troyer73f6f252012-09-17 11:22:21 -050087 inicomment $GLANCE_REGISTRY_CONF DEFAULT log_file
Attila Fazekas7e79d912013-03-03 12:23:04 +010088 local dburl=`database_connection_url glance`
Terry Wilson428af5a2012-11-01 16:12:39 -040089 iniset $GLANCE_REGISTRY_CONF DEFAULT sql_connection $dburl
Dean Troyer73f6f252012-09-17 11:22:21 -050090 iniset $GLANCE_REGISTRY_CONF DEFAULT use_syslog $SYSLOG
91 iniset $GLANCE_REGISTRY_CONF paste_deploy flavor keystone
Jamie Lennox3561d7f2014-05-21 17:18:43 +100092 iniset $GLANCE_REGISTRY_CONF keystone_authtoken identity_uri $KEYSTONE_AUTH_URI
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100093 iniset $GLANCE_REGISTRY_CONF keystone_authtoken cafile $KEYSTONE_SSL_CA
Vincent Hou21fe4e72013-11-21 03:10:27 -050094 configure_API_version $GLANCE_REGISTRY_CONF $IDENTITY_API_VERSION
Dean Troyer73f6f252012-09-17 11:22:21 -050095 iniset $GLANCE_REGISTRY_CONF keystone_authtoken admin_tenant_name $SERVICE_TENANT_NAME
96 iniset $GLANCE_REGISTRY_CONF keystone_authtoken admin_user glance
97 iniset $GLANCE_REGISTRY_CONF keystone_authtoken admin_password $SERVICE_PASSWORD
Akihiro MOTOKI5e3deb62012-12-11 17:09:02 +090098 iniset $GLANCE_REGISTRY_CONF keystone_authtoken signing_dir $GLANCE_AUTH_CACHE_DIR/registry
Dean Troyer73f6f252012-09-17 11:22:21 -050099
100 cp $GLANCE_DIR/etc/glance-api.conf $GLANCE_API_CONF
Ben Nemec03997942013-08-10 09:56:16 -0500101 iniset $GLANCE_API_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Dean Troyer73f6f252012-09-17 11:22:21 -0500102 inicomment $GLANCE_API_CONF DEFAULT log_file
Terry Wilson428af5a2012-11-01 16:12:39 -0400103 iniset $GLANCE_API_CONF DEFAULT sql_connection $dburl
Dean Troyer73f6f252012-09-17 11:22:21 -0500104 iniset $GLANCE_API_CONF DEFAULT use_syslog $SYSLOG
Dean Troyer73f6f252012-09-17 11:22:21 -0500105 iniset $GLANCE_API_CONF DEFAULT image_cache_dir $GLANCE_CACHE_DIR/
106 iniset $GLANCE_API_CONF paste_deploy flavor keystone+cachemanagement
Jamie Lennox3561d7f2014-05-21 17:18:43 +1000107 iniset $GLANCE_API_CONF keystone_authtoken identity_uri $KEYSTONE_AUTH_URI
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000108 iniset $GLANCE_API_CONF keystone_authtoken cafile $KEYSTONE_SSL_CA
Vincent Hou21fe4e72013-11-21 03:10:27 -0500109 configure_API_version $GLANCE_API_CONF $IDENTITY_API_VERSION
Dean Troyer73f6f252012-09-17 11:22:21 -0500110 iniset $GLANCE_API_CONF keystone_authtoken admin_tenant_name $SERVICE_TENANT_NAME
111 iniset $GLANCE_API_CONF keystone_authtoken admin_user glance
112 iniset $GLANCE_API_CONF keystone_authtoken admin_password $SERVICE_PASSWORD
Julien Danjou19a38142014-01-30 15:49:53 +0100113 if is_service_enabled qpid || [ -n "$RABBIT_HOST" ] && [ -n "$RABBIT_PASSWORD" ]; then
114 iniset $GLANCE_API_CONF DEFAULT notification_driver messaging
Eoghan Glynnad80ead2012-09-27 09:36:33 +0100115 fi
Eoghan Glynn8c11f562013-03-01 12:09:01 +0000116 iniset_rpc_backend glance $GLANCE_API_CONF DEFAULT
Akihiro MOTOKI5e3deb62012-12-11 17:09:02 +0900117 iniset $GLANCE_API_CONF keystone_authtoken signing_dir $GLANCE_AUTH_CACHE_DIR/api
Mate Lakatbc2ef922013-08-15 18:06:59 +0100118 if [ "$VIRT_DRIVER" = 'xenserver' ]; then
119 iniset $GLANCE_API_CONF DEFAULT container_formats "ami,ari,aki,bare,ovf,tgz"
120 iniset $GLANCE_API_CONF DEFAULT disk_formats "ami,ari,aki,vhd,raw,iso"
121 fi
Dean Troyer73f6f252012-09-17 11:22:21 -0500122
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200123 # Store specific configs
124 iniset $GLANCE_API_CONF DEFAULT filesystem_store_datadir $GLANCE_IMAGE_DIR/
125
126 # NOTE(flaper87): Until Glance is fully migrated, set these configs in both
127 # sections.
128 iniset $GLANCE_API_CONF glance_store filesystem_store_datadir $GLANCE_IMAGE_DIR/
129
Dean Troyerc77b9322013-03-29 10:51:01 -0500130 # Store the images in swift if enabled.
131 if is_service_enabled s-proxy; then
132 iniset $GLANCE_API_CONF DEFAULT default_store swift
Jamie Lennox3561d7f2014-05-21 17:18:43 +1000133 iniset $GLANCE_API_CONF DEFAULT swift_store_auth_address $KEYSTONE_SERVICE_URI/v2.0/
Attila Fazekas85a85f82014-01-21 11:13:55 +0100134 iniset $GLANCE_API_CONF DEFAULT swift_store_user $SERVICE_TENANT_NAME:glance-swift
Dean Troyerc77b9322013-03-29 10:51:01 -0500135 iniset $GLANCE_API_CONF DEFAULT swift_store_key $SERVICE_PASSWORD
136 iniset $GLANCE_API_CONF DEFAULT swift_store_create_container_on_put True
Flavio Percoco355fc862013-11-29 14:27:35 +0100137
Flavio Percococ3e5b772014-01-23 13:48:16 +0100138 iniset $GLANCE_API_CONF DEFAULT known_stores "glance.store.filesystem.Store, glance.store.http.Store, glance.store.swift.Store"
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200139
140 # NOTE(flaper87): Until Glance is fully migrated, set these configs in both
141 # sections.
142 iniset $GLANCE_API_CONF glance_store default_store swift
143 iniset $GLANCE_API_CONF glance_store swift_store_auth_address $KEYSTONE_SERVICE_URI/v2.0/
144 iniset $GLANCE_API_CONF glance_store swift_store_user $SERVICE_TENANT_NAME:glance-swift
145 iniset $GLANCE_API_CONF glance_store swift_store_key $SERVICE_PASSWORD
146 iniset $GLANCE_API_CONF glance_store swift_store_create_container_on_put True
147 iniset $GLANCE_API_CONF glance_store stores "file, http, swift"
Dean Troyerc77b9322013-03-29 10:51:01 -0500148 fi
149
Dean Troyer73f6f252012-09-17 11:22:21 -0500150 cp -p $GLANCE_DIR/etc/glance-registry-paste.ini $GLANCE_REGISTRY_PASTE_INI
151
152 cp -p $GLANCE_DIR/etc/glance-api-paste.ini $GLANCE_API_PASTE_INI
153
154 cp $GLANCE_DIR/etc/glance-cache.conf $GLANCE_CACHE_CONF
Ben Nemec03997942013-08-10 09:56:16 -0500155 iniset $GLANCE_CACHE_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Dean Troyer73f6f252012-09-17 11:22:21 -0500156 inicomment $GLANCE_CACHE_CONF DEFAULT log_file
157 iniset $GLANCE_CACHE_CONF DEFAULT use_syslog $SYSLOG
Dean Troyer73f6f252012-09-17 11:22:21 -0500158 iniset $GLANCE_CACHE_CONF DEFAULT image_cache_dir $GLANCE_CACHE_DIR/
159 iniuncomment $GLANCE_CACHE_CONF DEFAULT auth_url
Jamie Lennox3561d7f2014-05-21 17:18:43 +1000160 iniset $GLANCE_CACHE_CONF DEFAULT auth_url $KEYSTONE_AUTH_URI/v2.0
Dean Troyer73f6f252012-09-17 11:22:21 -0500161 iniuncomment $GLANCE_CACHE_CONF DEFAULT auth_tenant_name
162 iniset $GLANCE_CACHE_CONF DEFAULT admin_tenant_name $SERVICE_TENANT_NAME
163 iniuncomment $GLANCE_CACHE_CONF DEFAULT auth_user
164 iniset $GLANCE_CACHE_CONF DEFAULT admin_user glance
165 iniuncomment $GLANCE_CACHE_CONF DEFAULT auth_password
166 iniset $GLANCE_CACHE_CONF DEFAULT admin_password $SERVICE_PASSWORD
167
Flavio Percocofe65e2d2014-09-03 11:51:00 +0200168 # Store specific confs
169 # NOTE(flaper87): Until Glance is fully migrated, set these configs in both
170 # sections.
171 iniset $GLANCE_CACHE_CONF DEFAULT filesystem_store_datadir $GLANCE_IMAGE_DIR/
172 iniset $GLANCE_CACHE_CONF glance_store filesystem_store_datadir $GLANCE_IMAGE_DIR/
173
Dean Troyer73f6f252012-09-17 11:22:21 -0500174 cp -p $GLANCE_DIR/etc/policy.json $GLANCE_POLICY_JSON
Dirk Mueller46d1ba62013-09-09 14:31:37 +0200175 cp -p $GLANCE_DIR/etc/schema-image.json $GLANCE_SCHEMA_JSON
Dean Troyer73f6f252012-09-17 11:22:21 -0500176}
177
Dean Troyer42a59c22014-03-03 14:31:29 -0600178# create_glance_accounts() - Set up common required glance accounts
179
180# Project User Roles
181# ------------------------------------------------------------------
182# SERVICE_TENANT_NAME glance service
183# SERVICE_TENANT_NAME glance-swift ResellerAdmin (if Swift is enabled)
184
185function create_glance_accounts {
186 if is_service_enabled g-api; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100187
188 GLANCE_USER=$(get_or_create_user "glance" \
Gael Chamoulaud6dd8a8b2014-07-22 01:12:12 +0200189 "$SERVICE_PASSWORD" $SERVICE_TENANT_NAME)
Bartosz Górski0abde392014-02-28 14:15:19 +0100190 get_or_add_user_role service $GLANCE_USER $SERVICE_TENANT_NAME
191
Dean Troyer42a59c22014-03-03 14:31:29 -0600192 # required for swift access
193 if is_service_enabled s-proxy; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100194
195 GLANCE_SWIFT_USER=$(get_or_create_user "glance-swift" \
196 "$SERVICE_PASSWORD" $SERVICE_TENANT_NAME "glance-swift@example.com")
197 get_or_add_user_role "ResellerAdmin" $GLANCE_SWIFT_USER $SERVICE_TENANT_NAME
Dean Troyer42a59c22014-03-03 14:31:29 -0600198 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100199
Dean Troyer42a59c22014-03-03 14:31:29 -0600200 if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100201
202 GLANCE_SERVICE=$(get_or_create_service "glance" \
203 "image" "Glance Image Service")
204 get_or_create_endpoint $GLANCE_SERVICE \
205 "$REGION_NAME" \
206 "http://$GLANCE_HOSTPORT" \
207 "http://$GLANCE_HOSTPORT" \
208 "http://$GLANCE_HOSTPORT"
Dean Troyer42a59c22014-03-03 14:31:29 -0600209 fi
210 fi
211}
212
Dean Troyerf03bafe2013-02-12 10:58:28 -0600213# create_glance_cache_dir() - Part of the init_glance() process
Ian Wienandaee18c72014-02-21 15:35:08 +1100214function create_glance_cache_dir {
Dean Troyerf03bafe2013-02-12 10:58:28 -0600215 # Create cache dir
216 sudo mkdir -p $GLANCE_AUTH_CACHE_DIR/api
217 sudo chown $STACK_USER $GLANCE_AUTH_CACHE_DIR/api
218 rm -f $GLANCE_AUTH_CACHE_DIR/api/*
219 sudo mkdir -p $GLANCE_AUTH_CACHE_DIR/registry
220 sudo chown $STACK_USER $GLANCE_AUTH_CACHE_DIR/registry
221 rm -f $GLANCE_AUTH_CACHE_DIR/registry/*
222}
223
Dean Troyer73f6f252012-09-17 11:22:21 -0500224# init_glance() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100225function init_glance {
Dean Troyer73f6f252012-09-17 11:22:21 -0500226 # Delete existing images
227 rm -rf $GLANCE_IMAGE_DIR
228 mkdir -p $GLANCE_IMAGE_DIR
229
230 # Delete existing cache
231 rm -rf $GLANCE_CACHE_DIR
232 mkdir -p $GLANCE_CACHE_DIR
233
Dean Troyerf03bafe2013-02-12 10:58:28 -0600234 # (Re)create glance database
Terry Wilson428af5a2012-11-01 16:12:39 -0400235 recreate_database glance utf8
Dean Troyer73f6f252012-09-17 11:22:21 -0500236
Dean Troyerf03bafe2013-02-12 10:58:28 -0600237 # Migrate glance database
Jianing Yang16312732013-12-22 10:47:39 +0800238 $GLANCE_BIN_DIR/glance-manage db_sync
Dean Troyerbc071bc2012-10-01 14:06:44 -0500239
Dean Troyerf03bafe2013-02-12 10:58:28 -0600240 create_glance_cache_dir
Dean Troyer73f6f252012-09-17 11:22:21 -0500241}
242
243# install_glanceclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100244function install_glanceclient {
Dean Troyer73f6f252012-09-17 11:22:21 -0500245 git_clone $GLANCECLIENT_REPO $GLANCECLIENT_DIR $GLANCECLIENT_BRANCH
Sean Daguee4f0cd72013-04-01 15:56:07 -0400246 setup_develop $GLANCECLIENT_DIR
Dean Troyer73f6f252012-09-17 11:22:21 -0500247}
248
249# install_glance() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100250function install_glance {
Dean Troyer73f6f252012-09-17 11:22:21 -0500251 git_clone $GLANCE_REPO $GLANCE_DIR $GLANCE_BRANCH
Sean Daguee4f0cd72013-04-01 15:56:07 -0400252 setup_develop $GLANCE_DIR
Dean Troyer73f6f252012-09-17 11:22:21 -0500253}
254
255# start_glance() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100256function start_glance {
Dean Troyer73f6f252012-09-17 11:22:21 -0500257 screen_it g-reg "cd $GLANCE_DIR; $GLANCE_BIN_DIR/glance-registry --config-file=$GLANCE_CONF_DIR/glance-registry.conf"
258 screen_it g-api "cd $GLANCE_DIR; $GLANCE_BIN_DIR/glance-api --config-file=$GLANCE_CONF_DIR/glance-api.conf"
259 echo "Waiting for g-api ($GLANCE_HOSTPORT) to start..."
JUN JIE NAN0aa85342013-09-13 15:47:09 +0800260 if ! timeout $SERVICE_TIMEOUT sh -c "while ! wget --no-proxy -q -O- http://$GLANCE_HOSTPORT; do sleep 1; done"; then
Sean Dague101b4242013-10-22 08:47:11 -0400261 die $LINENO "g-api did not start"
Dean Troyer73f6f252012-09-17 11:22:21 -0500262 fi
263}
264
Dean Troyer699a29f2012-09-10 14:10:27 -0500265# stop_glance() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100266function stop_glance {
Dean Troyer73f6f252012-09-17 11:22:21 -0500267 # Kill the Glance screen windows
Dean Troyer9fc87922013-05-22 17:19:06 -0500268 screen_stop g-api
269 screen_stop g-reg
Dean Troyer73f6f252012-09-17 11:22:21 -0500270}
271
Dean Troyercc6b4432013-04-08 15:38:03 -0500272
Dean Troyer73f6f252012-09-17 11:22:21 -0500273# Restore xtrace
274$XTRACE
Sean Dague584d90e2013-03-29 14:34:53 -0400275
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100276# Tell emacs to use shell-script-mode
277## Local variables:
278## mode: shell-script
279## End: