blob: e30d410aae2e6201df0ebb5073fd02efd0066dbc [file] [log] [blame]
Dean Troyerd81a0272012-08-31 18:04:55 -05001# lib/keystone
2# Functions to control the configuration and operation of **Keystone**
3
4# Dependencies:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01005#
6# - ``functions`` file
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +10007# - ``tls`` file
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01008# - ``DEST``, ``STACK_USER``
9# - ``IDENTITY_API_VERSION``
10# - ``BASE_SQL_CONN``
11# - ``SERVICE_HOST``, ``SERVICE_PROTOCOL``
12# - ``SERVICE_TOKEN``
13# - ``S3_SERVICE_PORT`` (template backend only)
Dean Troyerd81a0272012-08-31 18:04:55 -050014
Dean Troyerd81a0272012-08-31 18:04:55 -050015# ``stack.sh`` calls the entry points in this order:
16#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010017# - install_keystone
18# - configure_keystone
19# - _config_keystone_apache_wsgi
20# - init_keystone
21# - start_keystone
22# - create_keystone_accounts
23# - stop_keystone
24# - cleanup_keystone
25# - _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -050026
Dean Troyer7903b792012-09-13 17:16:12 -050027# Save trace setting
28XTRACE=$(set +o | grep xtrace)
29set +o xtrace
Dean Troyerd81a0272012-08-31 18:04:55 -050030
Dean Troyerd81a0272012-08-31 18:04:55 -050031# Defaults
32# --------
33
Dean Troyerd81a0272012-08-31 18:04:55 -050034# Set up default directories
35KEYSTONE_DIR=$DEST/keystone
36KEYSTONE_CONF_DIR=${KEYSTONE_CONF_DIR:-/etc/keystone}
37KEYSTONE_CONF=$KEYSTONE_CONF_DIR/keystone.conf
Alan Pevece0bb4472013-03-12 11:10:52 +010038KEYSTONE_PASTE_INI=${KEYSTONE_PASTE_INI:-$KEYSTONE_CONF_DIR/keystone-paste.ini}
Dean Troyerbc071bc2012-10-01 14:06:44 -050039KEYSTONE_AUTH_CACHE_DIR=${KEYSTONE_AUTH_CACHE_DIR:-/var/cache/keystone}
Jamie Lennoxa00e5f82013-09-17 12:47:03 +100040KEYSTONE_WSGI_DIR=${KEYSTONE_WSGI_DIR:-/var/www/keystone}
Dean Troyerd81a0272012-08-31 18:04:55 -050041
Morgan Fainberg58936fd2014-06-24 12:26:07 -070042KEYSTONEMIDDLEWARE_DIR=$DEST/keystonemiddleware
Dean Troyerd81a0272012-08-31 18:04:55 -050043KEYSTONECLIENT_DIR=$DEST/python-keystoneclient
44
Julien Vey00da58a2014-05-27 15:51:49 +020045# Set up additional extensions, such as oauth1, federation
46# Example of KEYSTONE_EXTENSIONS=oauth1,federation
47KEYSTONE_EXTENSIONS=${KEYSTONE_EXTENSIONS:-}
48
Dean Troyerbc071bc2012-10-01 14:06:44 -050049# Select the backend for Keystone's service catalog
Dean Troyerb80379c2012-09-10 18:30:37 -050050KEYSTONE_CATALOG_BACKEND=${KEYSTONE_CATALOG_BACKEND:-sql}
Dean Troyerd81a0272012-08-31 18:04:55 -050051KEYSTONE_CATALOG=$KEYSTONE_CONF_DIR/default_catalog.templates
52
Davanum Srinivas5bd96f92013-01-29 15:12:20 -050053# Select the backend for Tokens
54KEYSTONE_TOKEN_BACKEND=${KEYSTONE_TOKEN_BACKEND:-sql}
55
Alex Rudenkocd770582013-09-01 16:26:03 +020056# Select the backend for Identity
57KEYSTONE_IDENTITY_BACKEND=${KEYSTONE_IDENTITY_BACKEND:-sql}
58
59# Select the backend for Assignment
60KEYSTONE_ASSIGNMENT_BACKEND=${KEYSTONE_ASSIGNMENT_BACKEND:-sql}
61
Dean Troyerbc071bc2012-10-01 14:06:44 -050062# Select Keystone's token format
Brant Knudson754c4402014-06-04 09:06:01 -050063# Choose from 'UUID', 'PKI', or 'PKIZ'
Brant Knudson1e1fce82014-06-19 16:55:45 -050064KEYSTONE_TOKEN_FORMAT=$(echo ${KEYSTONE_TOKEN_FORMAT} | tr '[:upper:]' '[:lower:]')
Dean Troyerbc071bc2012-10-01 14:06:44 -050065
Dean Troyerd81a0272012-08-31 18:04:55 -050066# Set Keystone interface configuration
Dean Troyerd81a0272012-08-31 18:04:55 -050067KEYSTONE_AUTH_HOST=${KEYSTONE_AUTH_HOST:-$SERVICE_HOST}
68KEYSTONE_AUTH_PORT=${KEYSTONE_AUTH_PORT:-35357}
Dean Troyerc83a7e12012-11-29 11:47:58 -060069KEYSTONE_AUTH_PORT_INT=${KEYSTONE_AUTH_PORT_INT:-35358}
70KEYSTONE_AUTH_PROTOCOL=${KEYSTONE_AUTH_PROTOCOL:-$SERVICE_PROTOCOL}
71
72# Public facing bits
Dean Troyerd81a0272012-08-31 18:04:55 -050073KEYSTONE_SERVICE_HOST=${KEYSTONE_SERVICE_HOST:-$SERVICE_HOST}
74KEYSTONE_SERVICE_PORT=${KEYSTONE_SERVICE_PORT:-5000}
Dean Troyerc83a7e12012-11-29 11:47:58 -060075KEYSTONE_SERVICE_PORT_INT=${KEYSTONE_SERVICE_PORT_INT:-5001}
76KEYSTONE_SERVICE_PROTOCOL=${KEYSTONE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Dean Troyerd81a0272012-08-31 18:04:55 -050077
David Kranz041fa712014-02-24 13:30:59 -050078# Bind hosts
79KEYSTONE_ADMIN_BIND_HOST=${KEYSTONE_ADMIN_BIND_HOST:-$KEYSTONE_SERVICE_HOST}
Dean Troyerb7490da2013-03-18 16:07:56 -050080# Set the tenant for service accounts in Keystone
81SERVICE_TENANT_NAME=${SERVICE_TENANT_NAME:-service}
82
Alex Rudenkocd770582013-09-01 16:26:03 +020083# valid identity backends as per dir keystone/identity/backends
84KEYSTONE_VALID_IDENTITY_BACKENDS=kvs,ldap,pam,sql
85
86# valid assignment backends as per dir keystone/identity/backends
87KEYSTONE_VALID_ASSIGNMENT_BACKENDS=kvs,ldap,sql
Dean Troyerd81a0272012-08-31 18:04:55 -050088
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100089# if we are running with SSL use https protocols
90if is_ssl_enabled_service "key"; then
91 KEYSTONE_AUTH_PROTOCOL="https"
92 KEYSTONE_SERVICE_PROTOCOL="https"
93fi
94
Jamie Lennox3561d7f2014-05-21 17:18:43 +100095# complete URIs
96KEYSTONE_AUTH_URI=${KEYSTONE_AUTH_PROTOCOL}://${KEYSTONE_AUTH_HOST}:${KEYSTONE_AUTH_PORT}
97KEYSTONE_SERVICE_URI=${KEYSTONE_SERVICE_PROTOCOL}://${KEYSTONE_SERVICE_HOST}:${KEYSTONE_SERVICE_PORT}
98
Dean Troyercc6b4432013-04-08 15:38:03 -050099# Functions
100# ---------
Dean Troyerd81a0272012-08-31 18:04:55 -0500101# cleanup_keystone() - Remove residual data files, anything left over from previous
102# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100103function cleanup_keystone {
Dean Troyerd81a0272012-08-31 18:04:55 -0500104 # kill instances (nova)
105 # delete image files (glance)
106 # This function intentionally left blank
107 :
108}
109
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000110# _cleanup_keystone_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
Ian Wienandaee18c72014-02-21 15:35:08 +1100111function _cleanup_keystone_apache_wsgi {
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000112 sudo rm -f $KEYSTONE_WSGI_DIR/*.wsgi
113 disable_apache_site keystone
Morgan Fainberg970ee902014-06-09 12:07:29 -0700114 sudo rm -f $(apache_site_config_for keystone)
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000115}
116
117# _config_keystone_apache_wsgi() - Set WSGI config files of Keystone
Ian Wienandaee18c72014-02-21 15:35:08 +1100118function _config_keystone_apache_wsgi {
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000119 sudo mkdir -p $KEYSTONE_WSGI_DIR
120
Morgan Fainberg970ee902014-06-09 12:07:29 -0700121 local keystone_apache_conf=$(apache_site_config_for keystone)
122
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000123 # copy proxy vhost and wsgi file
124 sudo cp $KEYSTONE_DIR/httpd/keystone.py $KEYSTONE_WSGI_DIR/main
125 sudo cp $KEYSTONE_DIR/httpd/keystone.py $KEYSTONE_WSGI_DIR/admin
126
Morgan Fainberg970ee902014-06-09 12:07:29 -0700127 sudo cp $FILES/apache-keystone.template $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000128 sudo sed -e "
129 s|%PUBLICPORT%|$KEYSTONE_SERVICE_PORT|g;
130 s|%ADMINPORT%|$KEYSTONE_AUTH_PORT|g;
131 s|%APACHE_NAME%|$APACHE_NAME|g;
132 s|%PUBLICWSGI%|$KEYSTONE_WSGI_DIR/main|g;
133 s|%ADMINWSGI%|$KEYSTONE_WSGI_DIR/admin|g;
134 s|%USER%|$STACK_USER|g
Morgan Fainberg970ee902014-06-09 12:07:29 -0700135 " -i $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000136 enable_apache_site keystone
137}
138
Dean Troyerd81a0272012-08-31 18:04:55 -0500139# configure_keystone() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100140function configure_keystone {
Dean Troyerd81a0272012-08-31 18:04:55 -0500141 if [[ ! -d $KEYSTONE_CONF_DIR ]]; then
142 sudo mkdir -p $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500143 fi
Attila Fazekas91b8d132013-01-06 22:40:09 +0100144 sudo chown $STACK_USER $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500145
146 if [[ "$KEYSTONE_CONF_DIR" != "$KEYSTONE_DIR/etc" ]]; then
147 cp -p $KEYSTONE_DIR/etc/keystone.conf.sample $KEYSTONE_CONF
Dean Troyerd561b702013-10-22 17:46:00 -0500148 chmod 600 $KEYSTONE_CONF
Dean Troyerd81a0272012-08-31 18:04:55 -0500149 cp -p $KEYSTONE_DIR/etc/policy.json $KEYSTONE_CONF_DIR
Alan Pevece0bb4472013-03-12 11:10:52 +0100150 if [[ -f "$KEYSTONE_DIR/etc/keystone-paste.ini" ]]; then
151 cp -p "$KEYSTONE_DIR/etc/keystone-paste.ini" "$KEYSTONE_PASTE_INI"
152 fi
153 fi
154 if [[ -f "$KEYSTONE_PASTE_INI" ]]; then
155 iniset "$KEYSTONE_CONF" paste_deploy config_file "$KEYSTONE_PASTE_INI"
156 else
157 # compatibility with mixed cfg and paste.deploy configuration
158 KEYSTONE_PASTE_INI="$KEYSTONE_CONF"
Dean Troyerd81a0272012-08-31 18:04:55 -0500159 fi
160
Julien Vey00da58a2014-05-27 15:51:49 +0200161 configure_keystone_extensions
162
Dean Troyerd81a0272012-08-31 18:04:55 -0500163 # Rewrite stock ``keystone.conf``
Dean Troyerc83a7e12012-11-29 11:47:58 -0600164
Brad Topolf127e2f2013-01-22 10:17:50 -0600165 if is_service_enabled ldap; then
166 #Set all needed ldap values
Dean Troyerb9e25132013-10-01 14:45:04 -0500167 iniset $KEYSTONE_CONF ldap password $LDAP_PASSWORD
168 iniset $KEYSTONE_CONF ldap user $LDAP_MANAGER_DN
169 iniset $KEYSTONE_CONF ldap suffix $LDAP_BASE_DN
Brad Topolf41024e2013-02-19 15:36:41 -0600170 iniset $KEYSTONE_CONF ldap use_dumb_member "True"
Morgan Fainberg2dc11fb2013-09-24 23:43:08 -0700171 iniset $KEYSTONE_CONF ldap user_attribute_ignore "enabled,email,tenants,default_project_id"
Brad Topolf41024e2013-02-19 15:36:41 -0600172 iniset $KEYSTONE_CONF ldap tenant_attribute_ignore "enabled"
173 iniset $KEYSTONE_CONF ldap tenant_domain_id_attribute "businessCategory"
174 iniset $KEYSTONE_CONF ldap tenant_desc_attribute "description"
Dean Troyerb9e25132013-10-01 14:45:04 -0500175 iniset $KEYSTONE_CONF ldap tenant_tree_dn "ou=Projects,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600176 iniset $KEYSTONE_CONF ldap user_domain_id_attribute "businessCategory"
Dean Troyerb9e25132013-10-01 14:45:04 -0500177 iniset $KEYSTONE_CONF ldap user_tree_dn "ou=Users,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600178 iniset $KEYSTONE_CONF DEFAULT member_role_id "9fe2ff9ee4384b1894a90878d3e92bab"
179 iniset $KEYSTONE_CONF DEFAULT member_role_name "_member_"
Brad Topolf127e2f2013-01-22 10:17:50 -0600180 fi
181
Alex Rudenkocd770582013-09-01 16:26:03 +0200182 # check if identity backend is valid
183 if [[ "$KEYSTONE_VALID_IDENTITY_BACKENDS" =~ "$KEYSTONE_IDENTITY_BACKEND" ]]; then
184 iniset $KEYSTONE_CONF identity driver "keystone.identity.backends.$KEYSTONE_IDENTITY_BACKEND.Identity"
185 fi
186
187 # check if assignment backend is valid
188 if [[ "$KEYSTONE_VALID_ASSIGNMENT_BACKENDS" =~ "$KEYSTONE_ASSIGNMENT_BACKEND" ]]; then
189 iniset $KEYSTONE_CONF assignment driver "keystone.assignment.backends.$KEYSTONE_ASSIGNMENT_BACKEND.Assignment"
Brad Topolf127e2f2013-01-22 10:17:50 -0600190 fi
191
Dean Troyer245a4312013-06-28 09:16:08 -0500192 # Set the URL advertised in the ``versions`` structure returned by the '/' route
193 iniset $KEYSTONE_CONF DEFAULT public_endpoint "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:%(public_port)s/"
194 iniset $KEYSTONE_CONF DEFAULT admin_endpoint "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:%(admin_port)s/"
David Kranz041fa712014-02-24 13:30:59 -0500195 iniset $KEYSTONE_CONF DEFAULT admin_bind_host "$KEYSTONE_ADMIN_BIND_HOST"
Dean Troyer245a4312013-06-28 09:16:08 -0500196
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000197 # Register SSL certificates if provided
198 if is_ssl_enabled_service key; then
199 ensure_certificates KEYSTONE
200
201 iniset $KEYSTONE_CONF ssl enable True
202 iniset $KEYSTONE_CONF ssl certfile $KEYSTONE_SSL_CERT
203 iniset $KEYSTONE_CONF ssl keyfile $KEYSTONE_SSL_KEY
204 fi
205
Dean Troyerc83a7e12012-11-29 11:47:58 -0600206 if is_service_enabled tls-proxy; then
207 # Set the service ports for a proxy to take the originals
208 iniset $KEYSTONE_CONF DEFAULT public_port $KEYSTONE_SERVICE_PORT_INT
209 iniset $KEYSTONE_CONF DEFAULT admin_port $KEYSTONE_AUTH_PORT_INT
210 fi
211
Dean Troyerd81a0272012-08-31 18:04:55 -0500212 iniset $KEYSTONE_CONF DEFAULT admin_token "$SERVICE_TOKEN"
Sudarshan Acharya37631412013-07-16 00:47:54 +0000213
Brant Knudson1e1fce82014-06-19 16:55:45 -0500214 if [[ "$KEYSTONE_TOKEN_FORMAT" != "" ]]; then
215 iniset $KEYSTONE_CONF token provider keystone.token.providers.$KEYSTONE_TOKEN_FORMAT.Provider
Sudarshan Acharya37631412013-07-16 00:47:54 +0000216 fi
217
Brant Knudson16d3ad02014-02-13 18:59:50 -0600218 iniset $KEYSTONE_CONF database connection `database_connection_url keystone`
Dean Troyerd81a0272012-08-31 18:04:55 -0500219 iniset $KEYSTONE_CONF ec2 driver "keystone.contrib.ec2.backends.sql.Ec2"
Dean Troyerd81a0272012-08-31 18:04:55 -0500220
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500221 if [[ "$KEYSTONE_TOKEN_BACKEND" = "sql" ]]; then
222 iniset $KEYSTONE_CONF token driver keystone.token.backends.sql.Token
Peter Feiner61ae7c12013-11-15 10:42:30 -0500223 elif [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
224 iniset $KEYSTONE_CONF token driver keystone.token.backends.memcache.Token
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500225 else
226 iniset $KEYSTONE_CONF token driver keystone.token.backends.kvs.Token
227 fi
228
Dean Troyerd81a0272012-08-31 18:04:55 -0500229 if [[ "$KEYSTONE_CATALOG_BACKEND" = "sql" ]]; then
230 # Configure ``keystone.conf`` to use sql
231 iniset $KEYSTONE_CONF catalog driver keystone.catalog.backends.sql.Catalog
232 inicomment $KEYSTONE_CONF catalog template_file
233 else
234 cp -p $FILES/default_catalog.templates $KEYSTONE_CATALOG
235
236 # Add swift endpoints to service catalog if swift is enabled
Chmouel Boudjnah0c3a5582013-03-06 10:58:33 +0100237 if is_service_enabled s-proxy; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500238 echo "catalog.RegionOne.object_store.publicURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
239 echo "catalog.RegionOne.object_store.adminURL = http://%SERVICE_HOST%:8080/" >> $KEYSTONE_CATALOG
240 echo "catalog.RegionOne.object_store.internalURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
241 echo "catalog.RegionOne.object_store.name = Swift Service" >> $KEYSTONE_CATALOG
242 fi
243
Mark McClainb05c8762013-07-06 23:29:39 -0400244 # Add neutron endpoints to service catalog if neutron is enabled
245 if is_service_enabled neutron; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500246 echo "catalog.RegionOne.network.publicURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
247 echo "catalog.RegionOne.network.adminURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
248 echo "catalog.RegionOne.network.internalURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
Mark McClainb05c8762013-07-06 23:29:39 -0400249 echo "catalog.RegionOne.network.name = Neutron Service" >> $KEYSTONE_CATALOG
Dean Troyerd81a0272012-08-31 18:04:55 -0500250 fi
251
Vincent Untz7e86dbe2012-12-13 08:50:37 +0100252 sed -e "
Dean Troyerd81a0272012-08-31 18:04:55 -0500253 s,%SERVICE_HOST%,$SERVICE_HOST,g;
254 s,%S3_SERVICE_PORT%,$S3_SERVICE_PORT,g;
255 " -i $KEYSTONE_CATALOG
256
257 # Configure ``keystone.conf`` to use templates
258 iniset $KEYSTONE_CONF catalog driver "keystone.catalog.backends.templated.TemplatedCatalog"
259 iniset $KEYSTONE_CONF catalog template_file "$KEYSTONE_CATALOG"
260 fi
261
262 # Set up logging
Dean Troyerd81a0272012-08-31 18:04:55 -0500263 if [ "$SYSLOG" != "False" ]; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600264 iniset $KEYSTONE_CONF DEFAULT use_syslog "True"
Dean Troyerd81a0272012-08-31 18:04:55 -0500265 fi
Brant Knudson4968d1a2014-01-22 19:06:44 -0600266
267 # Format logging
Morgan Fainberg2c2b1cc2014-05-01 22:05:41 -0700268 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && ! is_apache_enabled_service key ; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600269 setup_colorized_logging $KEYSTONE_CONF DEFAULT
270 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000271
272 if is_apache_enabled_service key; then
Morgan Fainberg2c2b1cc2014-05-01 22:05:41 -0700273 iniset $KEYSTONE_CONF DEFAULT debug "True"
274 # Eliminate the %(asctime)s.%(msecs)03d from the log format strings
275 iniset $KEYSTONE_CONF DEFAULT logging_context_format_string "%(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s"
276 iniset $KEYSTONE_CONF DEFAULT logging_default_format_string "%(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s"
277 iniset $KEYSTONE_CONF DEFAULT logging_debug_format_suffix "%(funcName)s %(pathname)s:%(lineno)d"
278 iniset $KEYSTONE_CONF DEFAULT logging_exception_prefix "%(process)d TRACE %(name)s %(instance)s"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000279 _config_keystone_apache_wsgi
280 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500281}
282
Julien Vey00da58a2014-05-27 15:51:49 +0200283function configure_keystone_extensions {
284 # Add keystone extension into keystone v3 application pipeline
285 local extension_value
286 local api_v3
287 local extension
288 local api_v3_extension
289 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
290 if [[ -z "${extension_value}" ]]; then
291 continue
292 fi
293 api_v3=$(iniget $KEYSTONE_PASTE_INI pipeline:api_v3 pipeline)
294 extension=$(echo $api_v3 | sed -ne "/${extension_value}/ p;" )
295 if [[ -z $extension ]]; then
296 api_v3_extension=$(echo $api_v3 | sed -ne "s/service_v3/${extension_value}_extension service_v3/p;" )
297 iniset $KEYSTONE_PASTE_INI pipeline:api_v3 pipeline "$api_v3_extension"
298 fi
299 done
300}
301
Dean Troyerd835de82012-11-29 17:11:35 -0600302# create_keystone_accounts() - Sets up common required keystone accounts
303
304# Tenant User Roles
305# ------------------------------------------------------------------
Dean Troyerd835de82012-11-29 17:11:35 -0600306# admin admin admin
Dean Troyer42a59c22014-03-03 14:31:29 -0600307# service -- --
308# -- -- service
309# -- -- ResellerAdmin
310# -- -- Member
Dean Troyerd835de82012-11-29 17:11:35 -0600311# demo admin admin
312# demo demo Member, anotherrole
313# invisible_to_admin demo Member
314
315# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100316function create_keystone_accounts {
Dean Troyerd835de82012-11-29 17:11:35 -0600317
318 # admin
Steve Martinelli19685422014-01-24 13:02:26 -0600319 ADMIN_TENANT=$(openstack project create \
320 admin \
Dean Troyerd835de82012-11-29 17:11:35 -0600321 | grep " id " | get_field 2)
Steve Martinelli19685422014-01-24 13:02:26 -0600322 ADMIN_USER=$(openstack user create \
323 admin \
324 --project "$ADMIN_TENANT" \
Dean Troyerd835de82012-11-29 17:11:35 -0600325 --email admin@example.com \
Steve Martinelli19685422014-01-24 13:02:26 -0600326 --password "$ADMIN_PASSWORD" \
Dean Troyerd835de82012-11-29 17:11:35 -0600327 | grep " id " | get_field 2)
Steve Martinelli19685422014-01-24 13:02:26 -0600328 ADMIN_ROLE=$(openstack role create \
329 admin \
Dean Troyerd835de82012-11-29 17:11:35 -0600330 | grep " id " | get_field 2)
Steve Martinelli19685422014-01-24 13:02:26 -0600331 openstack role add \
332 $ADMIN_ROLE \
333 --project $ADMIN_TENANT \
334 --user $ADMIN_USER
Dean Troyerd835de82012-11-29 17:11:35 -0600335
Dean Troyer42a59c22014-03-03 14:31:29 -0600336 # Create service project/role
337 openstack project create $SERVICE_TENANT_NAME
338
339 # Service role, so service users do not have to be admins
340 openstack role create service
341
342 # The ResellerAdmin role is used by Nova and Ceilometer so we need to keep it.
343 # The admin role in swift allows a user to act as an admin for their tenant,
344 # but ResellerAdmin is needed for a user to act as any tenant. The name of this
345 # role is also configurable in swift-proxy.conf
346 openstack role create ResellerAdmin
Dean Troyerd835de82012-11-29 17:11:35 -0600347
348 # The Member role is used by Horizon and Swift so we need to keep it:
Steve Martinelli19685422014-01-24 13:02:26 -0600349 MEMBER_ROLE=$(openstack role create \
350 Member \
351 | grep " id " | get_field 2)
Dean Troyerd835de82012-11-29 17:11:35 -0600352 # ANOTHER_ROLE demonstrates that an arbitrary role may be created and used
353 # TODO(sleepsonthefloor): show how this can be used for rbac in the future!
Steve Martinelli19685422014-01-24 13:02:26 -0600354 ANOTHER_ROLE=$(openstack role create \
355 anotherrole \
356 | grep " id " | get_field 2)
Dean Troyerd835de82012-11-29 17:11:35 -0600357
358 # invisible tenant - admin can't see this one
Steve Martinelli19685422014-01-24 13:02:26 -0600359 INVIS_TENANT=$(openstack project create \
360 invisible_to_admin \
361 | grep " id " | get_field 2)
Dean Troyerd835de82012-11-29 17:11:35 -0600362
363 # demo
Steve Martinelli19685422014-01-24 13:02:26 -0600364 DEMO_TENANT=$(openstack project create \
365 demo \
Dean Troyerd835de82012-11-29 17:11:35 -0600366 | grep " id " | get_field 2)
Steve Martinelli19685422014-01-24 13:02:26 -0600367 DEMO_USER=$(openstack user create \
368 demo \
369 --project $DEMO_TENANT \
Dean Troyerd835de82012-11-29 17:11:35 -0600370 --email demo@example.com \
Steve Martinelli19685422014-01-24 13:02:26 -0600371 --password "$ADMIN_PASSWORD" \
Dean Troyerd835de82012-11-29 17:11:35 -0600372 | grep " id " | get_field 2)
Steve Martinelli19685422014-01-24 13:02:26 -0600373
374 openstack role add --project $DEMO_TENANT --user $DEMO_USER $MEMBER_ROLE
375 openstack role add --project $DEMO_TENANT --user $ADMIN_USER $ADMIN_ROLE
376 openstack role add --project $DEMO_TENANT --user $DEMO_USER $ANOTHER_ROLE
377 openstack role add --project $INVIS_TENANT --user $DEMO_USER $MEMBER_ROLE
Dean Troyerd835de82012-11-29 17:11:35 -0600378
379 # Keystone
380 if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
Steve Martinelli19685422014-01-24 13:02:26 -0600381 KEYSTONE_SERVICE=$(openstack service create \
382 keystone \
Dean Troyerd835de82012-11-29 17:11:35 -0600383 --type identity \
384 --description "Keystone Identity Service" \
385 | grep " id " | get_field 2)
Steve Martinelli19685422014-01-24 13:02:26 -0600386 openstack endpoint create \
387 $KEYSTONE_SERVICE \
Dean Troyerd835de82012-11-29 17:11:35 -0600388 --region RegionOne \
Dean Troyer3005e172013-01-24 14:14:28 -0600389 --publicurl "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION" \
390 --adminurl "$KEYSTONE_AUTH_PROTOCOL://$KEYSTONE_AUTH_HOST:$KEYSTONE_AUTH_PORT/v$IDENTITY_API_VERSION" \
391 --internalurl "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION"
Dean Troyerd835de82012-11-29 17:11:35 -0600392 fi
Dean Troyerd835de82012-11-29 17:11:35 -0600393}
394
Vincent Hou21fe4e72013-11-21 03:10:27 -0500395# Configure the API version for the OpenStack projects.
396# configure_API_version conf_file version
Ian Wienandaee18c72014-02-21 15:35:08 +1100397function configure_API_version {
Vincent Hou21fe4e72013-11-21 03:10:27 -0500398 local conf_file=$1
399 local api_version=$2
400 iniset $conf_file keystone_authtoken auth_uri $KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$api_version
401}
402
Dean Troyerd81a0272012-08-31 18:04:55 -0500403# init_keystone() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100404function init_keystone {
Dean Troyerb9e25132013-10-01 14:45:04 -0500405 if is_service_enabled ldap; then
406 init_ldap
407 fi
408
Dean Troyerd81a0272012-08-31 18:04:55 -0500409 # (Re)create keystone database
Terry Wilson428af5a2012-11-01 16:12:39 -0400410 recreate_database keystone utf8
Dean Troyerd81a0272012-08-31 18:04:55 -0500411
412 # Initialize keystone database
413 $KEYSTONE_DIR/bin/keystone-manage db_sync
414
Julien Vey00da58a2014-05-27 15:51:49 +0200415 local extension_value
416 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
417 if [[ -z "${extension_value}" ]]; then
418 continue
419 fi
420 $KEYSTONE_DIR/bin/keystone-manage db_sync --extension "${extension_value}"
421 done
422
Brant Knudson1e1fce82014-06-19 16:55:45 -0500423 if [[ "$KEYSTONE_TOKEN_FORMAT" != "uuid" ]]; then
Dean Troyerbc071bc2012-10-01 14:06:44 -0500424 # Set up certificates
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800425 rm -rf $KEYSTONE_CONF_DIR/ssl
Dean Troyerbc071bc2012-10-01 14:06:44 -0500426 $KEYSTONE_DIR/bin/keystone-manage pki_setup
427
428 # Create cache dir
429 sudo mkdir -p $KEYSTONE_AUTH_CACHE_DIR
Attila Fazekas91b8d132013-01-06 22:40:09 +0100430 sudo chown $STACK_USER $KEYSTONE_AUTH_CACHE_DIR
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800431 rm -f $KEYSTONE_AUTH_CACHE_DIR/*
Dean Troyerbc071bc2012-10-01 14:06:44 -0500432 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500433}
434
435# install_keystoneclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100436function install_keystoneclient {
Dean Troyerd81a0272012-08-31 18:04:55 -0500437 git_clone $KEYSTONECLIENT_REPO $KEYSTONECLIENT_DIR $KEYSTONECLIENT_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400438 setup_develop $KEYSTONECLIENT_DIR
Attila Fazekasfac533e2013-08-14 16:04:01 +0200439 sudo install -D -m 0644 -o $STACK_USER {$KEYSTONECLIENT_DIR/tools/,/etc/bash_completion.d/}keystone.bash_completion
Dean Troyerd81a0272012-08-31 18:04:55 -0500440}
441
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700442# install_keystonemiddleware() - Collect source and prepare
443function install_keystonemiddleware {
444 git_clone $KEYSTONEMIDDLEWARE_REPO $KEYSTONEMIDDLEWARE_DIR $KEYSTONEMIDDLEWARE_BRANCH
445 setup_install $KEYSTONEMIDDLEWARE_DIR
446}
447
Dean Troyerd81a0272012-08-31 18:04:55 -0500448# install_keystone() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100449function install_keystone {
Brad Topolf127e2f2013-01-22 10:17:50 -0600450 # only install ldap if the service has been enabled
451 if is_service_enabled ldap; then
452 install_ldap
453 fi
Peter Feiner61ae7c12013-11-15 10:42:30 -0500454 if [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
455 # Install memcached and the memcache Python library that keystone uses.
456 # Unfortunately the Python library goes by different names in the .deb
457 # and .rpm circles.
458 install_package memcached
459 if is_ubuntu; then
460 install_package python-memcache
461 else
462 install_package python-memcached
463 fi
464 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500465 git_clone $KEYSTONE_REPO $KEYSTONE_DIR $KEYSTONE_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400466 setup_develop $KEYSTONE_DIR
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000467 if is_apache_enabled_service key; then
468 install_apache_wsgi
469 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500470}
471
472# start_keystone() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100473function start_keystone {
Dean Troyerc83a7e12012-11-29 11:47:58 -0600474 # Get right service port for testing
475 local service_port=$KEYSTONE_SERVICE_PORT
476 if is_service_enabled tls-proxy; then
477 service_port=$KEYSTONE_SERVICE_PORT_INT
478 fi
479
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000480 if is_apache_enabled_service key; then
481 restart_apache_server
482 screen_it key "cd $KEYSTONE_DIR && sudo tail -f /var/log/$APACHE_NAME/keystone"
483 else
484 # Start Keystone in a screen window
Brant Knudson4968d1a2014-01-22 19:06:44 -0600485 screen_it key "cd $KEYSTONE_DIR && $KEYSTONE_DIR/bin/keystone-all --config-file $KEYSTONE_CONF --debug"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000486 fi
487
Dean Troyerd835de82012-11-29 17:11:35 -0600488 echo "Waiting for keystone to start..."
Jamie Lennox06ba5192014-02-26 13:46:56 +1000489 if ! timeout $SERVICE_TIMEOUT sh -c "while ! curl --noproxy '*' -k -s $KEYSTONE_AUTH_PROTOCOL://$SERVICE_HOST:$service_port/v$IDENTITY_API_VERSION/ >/dev/null; do sleep 1; done"; then
Sean Dague101b4242013-10-22 08:47:11 -0400490 die $LINENO "keystone did not start"
Dean Troyerd835de82012-11-29 17:11:35 -0600491 fi
Dean Troyerc83a7e12012-11-29 11:47:58 -0600492
493 # Start proxies if enabled
494 if is_service_enabled tls-proxy; then
495 start_tls_proxy '*' $KEYSTONE_SERVICE_PORT $KEYSTONE_SERVICE_HOST $KEYSTONE_SERVICE_PORT_INT &
496 start_tls_proxy '*' $KEYSTONE_AUTH_PORT $KEYSTONE_AUTH_HOST $KEYSTONE_AUTH_PORT_INT &
497 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500498}
499
500# stop_keystone() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100501function stop_keystone {
Dean Troyerd81a0272012-08-31 18:04:55 -0500502 # Kill the Keystone screen window
Dean Troyer9fc87922013-05-22 17:19:06 -0500503 screen_stop key
Morgan Fainbergc11d6e02014-05-01 22:57:06 -0700504 # Cleanup the WSGI files and VHOST
505 _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -0500506}
Dean Troyer7903b792012-09-13 17:16:12 -0500507
Dean Troyer1a6d4492013-06-03 16:47:36 -0500508
Dean Troyer7903b792012-09-13 17:16:12 -0500509# Restore xtrace
510$XTRACE
Sean Dague584d90e2013-03-29 14:34:53 -0400511
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100512# Tell emacs to use shell-script-mode
513## Local variables:
514## mode: shell-script
515## End: