blob: c33d466c6cbda507c780837553a1a149513a4f59 [file] [log] [blame]
Sean Daguee263c822014-12-05 14:25:28 -05001#!/bin/bash
2#
Dean Troyerd81a0272012-08-31 18:04:55 -05003# lib/keystone
4# Functions to control the configuration and operation of **Keystone**
5
6# Dependencies:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01007#
8# - ``functions`` file
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +10009# - ``tls`` file
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010010# - ``DEST``, ``STACK_USER``
Adam Gandelmanc4b06712014-09-03 11:44:31 -070011# - ``FILES``
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010012# - ``IDENTITY_API_VERSION``
13# - ``BASE_SQL_CONN``
14# - ``SERVICE_HOST``, ``SERVICE_PROTOCOL``
15# - ``SERVICE_TOKEN``
16# - ``S3_SERVICE_PORT`` (template backend only)
Dean Troyerd81a0272012-08-31 18:04:55 -050017
Dean Troyerd81a0272012-08-31 18:04:55 -050018# ``stack.sh`` calls the entry points in this order:
19#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010020# - install_keystone
21# - configure_keystone
22# - _config_keystone_apache_wsgi
23# - init_keystone
24# - start_keystone
25# - create_keystone_accounts
26# - stop_keystone
27# - cleanup_keystone
28# - _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -050029
Dean Troyer7903b792012-09-13 17:16:12 -050030# Save trace setting
31XTRACE=$(set +o | grep xtrace)
32set +o xtrace
Dean Troyerd81a0272012-08-31 18:04:55 -050033
Dean Troyerd81a0272012-08-31 18:04:55 -050034# Defaults
35# --------
36
Dean Troyerd81a0272012-08-31 18:04:55 -050037# Set up default directories
Sean Daguee08ab102014-11-13 17:09:28 -050038GITDIR["python-keystoneclient"]=$DEST/python-keystoneclient
Sean Dague658312c2014-11-14 11:35:56 -050039GITDIR["keystonemiddleware"]=$DEST/keystonemiddleware
Dean Troyerd81a0272012-08-31 18:04:55 -050040KEYSTONE_DIR=$DEST/keystone
Dean Troyerf8ae6472015-02-17 11:05:06 -060041
42# Keystone virtual environment
43if [[ ${USE_VENV} = True ]]; then
44 PROJECT_VENV["keystone"]=${KEYSTONE_DIR}.venv
45 KEYSTONE_BIN_DIR=${PROJECT_VENV["keystone"]}/bin
46else
47 KEYSTONE_BIN_DIR=$(get_python_exec_prefix)
48fi
49
Dean Troyerd81a0272012-08-31 18:04:55 -050050KEYSTONE_CONF_DIR=${KEYSTONE_CONF_DIR:-/etc/keystone}
51KEYSTONE_CONF=$KEYSTONE_CONF_DIR/keystone.conf
Alan Pevece0bb4472013-03-12 11:10:52 +010052KEYSTONE_PASTE_INI=${KEYSTONE_PASTE_INI:-$KEYSTONE_CONF_DIR/keystone-paste.ini}
Thomas Bechtold8732afe2014-09-22 19:04:05 +020053if is_suse; then
54 KEYSTONE_WSGI_DIR=${KEYSTONE_WSGI_DIR:-/srv/www/htdocs/keystone}
55else
56 KEYSTONE_WSGI_DIR=${KEYSTONE_WSGI_DIR:-/var/www/keystone}
57fi
Dean Troyerd81a0272012-08-31 18:04:55 -050058
Julien Vey00da58a2014-05-27 15:51:49 +020059# Set up additional extensions, such as oauth1, federation
60# Example of KEYSTONE_EXTENSIONS=oauth1,federation
61KEYSTONE_EXTENSIONS=${KEYSTONE_EXTENSIONS:-}
62
Morgan Fainberg46455a32014-06-20 10:37:18 -070063# Toggle for deploying Keystone under HTTPD + mod_wsgi
Morgan Fainberge6dd4e62014-06-25 17:25:25 -070064KEYSTONE_USE_MOD_WSGI=${KEYSTONE_USE_MOD_WSGI:-${ENABLE_HTTPD_MOD_WSGI_SERVICES}}
Morgan Fainberg46455a32014-06-20 10:37:18 -070065
Brant Knudson331a64f2015-05-11 10:02:24 -050066# Select the Catalog backend driver
Dean Troyerb80379c2012-09-10 18:30:37 -050067KEYSTONE_CATALOG_BACKEND=${KEYSTONE_CATALOG_BACKEND:-sql}
Dean Troyerd81a0272012-08-31 18:04:55 -050068KEYSTONE_CATALOG=$KEYSTONE_CONF_DIR/default_catalog.templates
69
Brant Knudson331a64f2015-05-11 10:02:24 -050070# Select the token persistence backend driver
Davanum Srinivas5bd96f92013-01-29 15:12:20 -050071KEYSTONE_TOKEN_BACKEND=${KEYSTONE_TOKEN_BACKEND:-sql}
72
Brant Knudson331a64f2015-05-11 10:02:24 -050073# Select the Identity backend driver
Alex Rudenkocd770582013-09-01 16:26:03 +020074KEYSTONE_IDENTITY_BACKEND=${KEYSTONE_IDENTITY_BACKEND:-sql}
75
Brant Knudson331a64f2015-05-11 10:02:24 -050076# Select the Assignment backend driver
Alex Rudenkocd770582013-09-01 16:26:03 +020077KEYSTONE_ASSIGNMENT_BACKEND=${KEYSTONE_ASSIGNMENT_BACKEND:-sql}
78
Brant Knudson331a64f2015-05-11 10:02:24 -050079# Select Keystone's token provider (and format)
80# Choose from 'uuid', 'pki', 'pkiz', or 'fernet'
Sean Dague53753292014-12-04 19:38:15 -050081KEYSTONE_TOKEN_FORMAT=${KEYSTONE_TOKEN_FORMAT:-}
Brant Knudson1e1fce82014-06-19 16:55:45 -050082KEYSTONE_TOKEN_FORMAT=$(echo ${KEYSTONE_TOKEN_FORMAT} | tr '[:upper:]' '[:lower:]')
Dean Troyerbc071bc2012-10-01 14:06:44 -050083
Dean Troyerd81a0272012-08-31 18:04:55 -050084# Set Keystone interface configuration
Dean Troyerd81a0272012-08-31 18:04:55 -050085KEYSTONE_AUTH_HOST=${KEYSTONE_AUTH_HOST:-$SERVICE_HOST}
86KEYSTONE_AUTH_PORT=${KEYSTONE_AUTH_PORT:-35357}
Dean Troyerc83a7e12012-11-29 11:47:58 -060087KEYSTONE_AUTH_PORT_INT=${KEYSTONE_AUTH_PORT_INT:-35358}
88KEYSTONE_AUTH_PROTOCOL=${KEYSTONE_AUTH_PROTOCOL:-$SERVICE_PROTOCOL}
89
90# Public facing bits
Dean Troyerd81a0272012-08-31 18:04:55 -050091KEYSTONE_SERVICE_HOST=${KEYSTONE_SERVICE_HOST:-$SERVICE_HOST}
92KEYSTONE_SERVICE_PORT=${KEYSTONE_SERVICE_PORT:-5000}
Dean Troyerc83a7e12012-11-29 11:47:58 -060093KEYSTONE_SERVICE_PORT_INT=${KEYSTONE_SERVICE_PORT_INT:-5001}
94KEYSTONE_SERVICE_PROTOCOL=${KEYSTONE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Dean Troyerd81a0272012-08-31 18:04:55 -050095
David Kranz041fa712014-02-24 13:30:59 -050096# Bind hosts
97KEYSTONE_ADMIN_BIND_HOST=${KEYSTONE_ADMIN_BIND_HOST:-$KEYSTONE_SERVICE_HOST}
Dean Troyerb7490da2013-03-18 16:07:56 -050098# Set the tenant for service accounts in Keystone
99SERVICE_TENANT_NAME=${SERVICE_TENANT_NAME:-service}
100
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000101# if we are running with SSL use https protocols
Rob Crittenden18d47782014-03-19 17:47:42 -0400102if is_ssl_enabled_service "key" || is_service_enabled tls-proxy; then
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000103 KEYSTONE_AUTH_PROTOCOL="https"
104 KEYSTONE_SERVICE_PROTOCOL="https"
105fi
106
Jamie Lennox3561d7f2014-05-21 17:18:43 +1000107# complete URIs
108KEYSTONE_AUTH_URI=${KEYSTONE_AUTH_PROTOCOL}://${KEYSTONE_AUTH_HOST}:${KEYSTONE_AUTH_PORT}
109KEYSTONE_SERVICE_URI=${KEYSTONE_SERVICE_PROTOCOL}://${KEYSTONE_SERVICE_HOST}:${KEYSTONE_SERVICE_PORT}
110
Steve Martinellib74e01c2014-12-18 01:35:35 -0500111# V3 URIs
112KEYSTONE_AUTH_URI_V3=$KEYSTONE_AUTH_URI/v3
113KEYSTONE_SERVICE_URI_V3=$KEYSTONE_SERVICE_URI/v3
114
Dean Troyer5ce44cd2015-02-12 22:18:33 -0600115
Dean Troyercc6b4432013-04-08 15:38:03 -0500116# Functions
117# ---------
Dean Troyer5ce44cd2015-02-12 22:18:33 -0600118
119# Test if Keystone is enabled
120# is_keystone_enabled
121function is_keystone_enabled {
122 [[ ,${ENABLED_SERVICES}, =~ ,"key", ]] && return 0
123 return 1
124}
125
Dean Troyerd81a0272012-08-31 18:04:55 -0500126# cleanup_keystone() - Remove residual data files, anything left over from previous
127# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100128function cleanup_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700129 _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -0500130}
131
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000132# _cleanup_keystone_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
Ian Wienandaee18c72014-02-21 15:35:08 +1100133function _cleanup_keystone_apache_wsgi {
Dean Troyer305c4de2014-12-18 17:11:07 -0600134 sudo rm -f $KEYSTONE_WSGI_DIR/*
Morgan Fainberg970ee902014-06-09 12:07:29 -0700135 sudo rm -f $(apache_site_config_for keystone)
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000136}
137
138# _config_keystone_apache_wsgi() - Set WSGI config files of Keystone
Ian Wienandaee18c72014-02-21 15:35:08 +1100139function _config_keystone_apache_wsgi {
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000140 sudo mkdir -p $KEYSTONE_WSGI_DIR
141
Morgan Fainberg970ee902014-06-09 12:07:29 -0700142 local keystone_apache_conf=$(apache_site_config_for keystone)
Rob Crittenden18d47782014-03-19 17:47:42 -0400143 local keystone_ssl=""
144 local keystone_certfile=""
145 local keystone_keyfile=""
146 local keystone_service_port=$KEYSTONE_SERVICE_PORT
147 local keystone_auth_port=$KEYSTONE_AUTH_PORT
Dean Troyerf8ae6472015-02-17 11:05:06 -0600148 local venv_path=""
Rob Crittenden18d47782014-03-19 17:47:42 -0400149
150 if is_ssl_enabled_service key; then
151 keystone_ssl="SSLEngine On"
152 keystone_certfile="SSLCertificateFile $KEYSTONE_SSL_CERT"
153 keystone_keyfile="SSLCertificateKeyFile $KEYSTONE_SSL_KEY"
154 fi
155 if is_service_enabled tls-proxy; then
156 keystone_service_port=$KEYSTONE_SERVICE_PORT_INT
157 keystone_auth_port=$KEYSTONE_AUTH_PORT_INT
158 fi
Dean Troyerf8ae6472015-02-17 11:05:06 -0600159 if [[ ${USE_VENV} = True ]]; then
Chris Dent3a2c86a2015-05-12 13:41:25 +0000160 venv_path="python-path=${PROJECT_VENV["keystone"]}/lib/$(python_version)/site-packages"
Dean Troyerf8ae6472015-02-17 11:05:06 -0600161 fi
Morgan Fainbergd074dc72014-06-24 21:33:39 -0700162
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000163 # copy proxy vhost and wsgi file
164 sudo cp $KEYSTONE_DIR/httpd/keystone.py $KEYSTONE_WSGI_DIR/main
165 sudo cp $KEYSTONE_DIR/httpd/keystone.py $KEYSTONE_WSGI_DIR/admin
166
Morgan Fainberg970ee902014-06-09 12:07:29 -0700167 sudo cp $FILES/apache-keystone.template $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000168 sudo sed -e "
Rob Crittenden18d47782014-03-19 17:47:42 -0400169 s|%PUBLICPORT%|$keystone_service_port|g;
170 s|%ADMINPORT%|$keystone_auth_port|g;
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000171 s|%APACHE_NAME%|$APACHE_NAME|g;
172 s|%PUBLICWSGI%|$KEYSTONE_WSGI_DIR/main|g;
173 s|%ADMINWSGI%|$KEYSTONE_WSGI_DIR/admin|g;
Rob Crittenden18d47782014-03-19 17:47:42 -0400174 s|%SSLENGINE%|$keystone_ssl|g;
175 s|%SSLCERTFILE%|$keystone_certfile|g;
176 s|%SSLKEYFILE%|$keystone_keyfile|g;
Dean Troyerf8ae6472015-02-17 11:05:06 -0600177 s|%USER%|$STACK_USER|g;
178 s|%VIRTUALENV%|$venv_path|g
Morgan Fainberg970ee902014-06-09 12:07:29 -0700179 " -i $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000180}
181
Dean Troyerd81a0272012-08-31 18:04:55 -0500182# configure_keystone() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100183function configure_keystone {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500184 sudo install -d -o $STACK_USER $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500185
186 if [[ "$KEYSTONE_CONF_DIR" != "$KEYSTONE_DIR/etc" ]]; then
Dean Troyer8421c2b2015-03-16 13:52:19 -0500187 install -m 600 $KEYSTONE_DIR/etc/keystone.conf.sample $KEYSTONE_CONF
Dean Troyerd81a0272012-08-31 18:04:55 -0500188 cp -p $KEYSTONE_DIR/etc/policy.json $KEYSTONE_CONF_DIR
Alan Pevece0bb4472013-03-12 11:10:52 +0100189 if [[ -f "$KEYSTONE_DIR/etc/keystone-paste.ini" ]]; then
190 cp -p "$KEYSTONE_DIR/etc/keystone-paste.ini" "$KEYSTONE_PASTE_INI"
191 fi
192 fi
193 if [[ -f "$KEYSTONE_PASTE_INI" ]]; then
194 iniset "$KEYSTONE_CONF" paste_deploy config_file "$KEYSTONE_PASTE_INI"
195 else
196 # compatibility with mixed cfg and paste.deploy configuration
197 KEYSTONE_PASTE_INI="$KEYSTONE_CONF"
Dean Troyerd81a0272012-08-31 18:04:55 -0500198 fi
199
Samuel de Medeiros Queiroz3fd71d62015-05-03 14:54:45 -0300200 if [ "$ENABLE_IDENTITY_V2" == "False" ]; then
201 # Only Identity v3 API should be available; then disable v2 pipelines
202 inidelete $KEYSTONE_PASTE_INI composite:main \\/v2.0
203 inidelete $KEYSTONE_PASTE_INI composite:admin \\/v2.0
204 fi
205
Julien Vey00da58a2014-05-27 15:51:49 +0200206 configure_keystone_extensions
207
Dean Troyerd81a0272012-08-31 18:04:55 -0500208 # Rewrite stock ``keystone.conf``
Dean Troyerc83a7e12012-11-29 11:47:58 -0600209
Brad Topolf127e2f2013-01-22 10:17:50 -0600210 if is_service_enabled ldap; then
211 #Set all needed ldap values
Dean Troyerb9e25132013-10-01 14:45:04 -0500212 iniset $KEYSTONE_CONF ldap password $LDAP_PASSWORD
213 iniset $KEYSTONE_CONF ldap user $LDAP_MANAGER_DN
214 iniset $KEYSTONE_CONF ldap suffix $LDAP_BASE_DN
Brad Topolf41024e2013-02-19 15:36:41 -0600215 iniset $KEYSTONE_CONF ldap use_dumb_member "True"
Morgan Fainberg2dc11fb2013-09-24 23:43:08 -0700216 iniset $KEYSTONE_CONF ldap user_attribute_ignore "enabled,email,tenants,default_project_id"
Brad Topolf41024e2013-02-19 15:36:41 -0600217 iniset $KEYSTONE_CONF ldap tenant_attribute_ignore "enabled"
218 iniset $KEYSTONE_CONF ldap tenant_domain_id_attribute "businessCategory"
219 iniset $KEYSTONE_CONF ldap tenant_desc_attribute "description"
Dean Troyerb9e25132013-10-01 14:45:04 -0500220 iniset $KEYSTONE_CONF ldap tenant_tree_dn "ou=Projects,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600221 iniset $KEYSTONE_CONF ldap user_domain_id_attribute "businessCategory"
Dean Troyerb9e25132013-10-01 14:45:04 -0500222 iniset $KEYSTONE_CONF ldap user_tree_dn "ou=Users,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600223 iniset $KEYSTONE_CONF DEFAULT member_role_id "9fe2ff9ee4384b1894a90878d3e92bab"
224 iniset $KEYSTONE_CONF DEFAULT member_role_name "_member_"
Brad Topolf127e2f2013-01-22 10:17:50 -0600225 fi
226
Brant Knudson331a64f2015-05-11 10:02:24 -0500227 iniset $KEYSTONE_CONF identity driver "$KEYSTONE_IDENTITY_BACKEND"
228 iniset $KEYSTONE_CONF assignment driver "$KEYSTONE_ASSIGNMENT_BACKEND"
Brad Topolf127e2f2013-01-22 10:17:50 -0600229
Brant Knudson2dd110c2015-03-14 12:39:14 -0500230 iniset_rpc_backend keystone $KEYSTONE_CONF
Sergey Skripnick8464a4c2014-07-08 21:05:23 +0300231
Brant Knudson7448edb2015-03-11 20:06:26 -0500232 iniset $KEYSTONE_CONF eventlet_server admin_bind_host "$KEYSTONE_ADMIN_BIND_HOST"
Dean Troyer245a4312013-06-28 09:16:08 -0500233
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000234 # Register SSL certificates if provided
235 if is_ssl_enabled_service key; then
236 ensure_certificates KEYSTONE
237
Brant Knudson7448edb2015-03-11 20:06:26 -0500238 iniset $KEYSTONE_CONF eventlet_server_ssl enable True
239 iniset $KEYSTONE_CONF eventlet_server_ssl certfile $KEYSTONE_SSL_CERT
240 iniset $KEYSTONE_CONF eventlet_server_ssl keyfile $KEYSTONE_SSL_KEY
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000241 fi
242
Dean Troyerc83a7e12012-11-29 11:47:58 -0600243 if is_service_enabled tls-proxy; then
244 # Set the service ports for a proxy to take the originals
Brant Knudson7448edb2015-03-11 20:06:26 -0500245 iniset $KEYSTONE_CONF eventlet_server public_port $KEYSTONE_SERVICE_PORT_INT
246 iniset $KEYSTONE_CONF eventlet_server admin_port $KEYSTONE_AUTH_PORT_INT
Dean Troyerc83a7e12012-11-29 11:47:58 -0600247 fi
248
Dean Troyerd81a0272012-08-31 18:04:55 -0500249 iniset $KEYSTONE_CONF DEFAULT admin_token "$SERVICE_TOKEN"
Sudarshan Acharya37631412013-07-16 00:47:54 +0000250
Brant Knudson1e1fce82014-06-19 16:55:45 -0500251 if [[ "$KEYSTONE_TOKEN_FORMAT" != "" ]]; then
Brant Knudson331a64f2015-05-11 10:02:24 -0500252 iniset $KEYSTONE_CONF token provider $KEYSTONE_TOKEN_FORMAT
Sudarshan Acharya37631412013-07-16 00:47:54 +0000253 fi
254
Brant Knudson16d3ad02014-02-13 18:59:50 -0600255 iniset $KEYSTONE_CONF database connection `database_connection_url keystone`
Dean Troyerd81a0272012-08-31 18:04:55 -0500256
Brant Knudson331a64f2015-05-11 10:02:24 -0500257 iniset $KEYSTONE_CONF token driver "$KEYSTONE_TOKEN_BACKEND"
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500258
Brant Knudson331a64f2015-05-11 10:02:24 -0500259 iniset $KEYSTONE_CONF catalog driver "$KEYSTONE_CATALOG_BACKEND"
Dean Troyerd81a0272012-08-31 18:04:55 -0500260 if [[ "$KEYSTONE_CATALOG_BACKEND" = "sql" ]]; then
261 # Configure ``keystone.conf`` to use sql
Dean Troyerd81a0272012-08-31 18:04:55 -0500262 inicomment $KEYSTONE_CONF catalog template_file
263 else
264 cp -p $FILES/default_catalog.templates $KEYSTONE_CATALOG
265
266 # Add swift endpoints to service catalog if swift is enabled
Chmouel Boudjnah0c3a5582013-03-06 10:58:33 +0100267 if is_service_enabled s-proxy; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500268 echo "catalog.RegionOne.object_store.publicURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
269 echo "catalog.RegionOne.object_store.adminURL = http://%SERVICE_HOST%:8080/" >> $KEYSTONE_CATALOG
270 echo "catalog.RegionOne.object_store.internalURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
271 echo "catalog.RegionOne.object_store.name = Swift Service" >> $KEYSTONE_CATALOG
272 fi
273
Mark McClainb05c8762013-07-06 23:29:39 -0400274 # Add neutron endpoints to service catalog if neutron is enabled
275 if is_service_enabled neutron; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500276 echo "catalog.RegionOne.network.publicURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
277 echo "catalog.RegionOne.network.adminURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
278 echo "catalog.RegionOne.network.internalURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
Mark McClainb05c8762013-07-06 23:29:39 -0400279 echo "catalog.RegionOne.network.name = Neutron Service" >> $KEYSTONE_CATALOG
Dean Troyerd81a0272012-08-31 18:04:55 -0500280 fi
281
Vincent Untz7e86dbe2012-12-13 08:50:37 +0100282 sed -e "
Dean Troyerd81a0272012-08-31 18:04:55 -0500283 s,%SERVICE_HOST%,$SERVICE_HOST,g;
284 s,%S3_SERVICE_PORT%,$S3_SERVICE_PORT,g;
285 " -i $KEYSTONE_CATALOG
286
287 # Configure ``keystone.conf`` to use templates
Dean Troyerd81a0272012-08-31 18:04:55 -0500288 iniset $KEYSTONE_CONF catalog template_file "$KEYSTONE_CATALOG"
289 fi
290
291 # Set up logging
Dean Troyerd81a0272012-08-31 18:04:55 -0500292 if [ "$SYSLOG" != "False" ]; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600293 iniset $KEYSTONE_CONF DEFAULT use_syslog "True"
Dean Troyerd81a0272012-08-31 18:04:55 -0500294 fi
Brant Knudson4968d1a2014-01-22 19:06:44 -0600295
296 # Format logging
Morgan Fainberg46455a32014-06-20 10:37:18 -0700297 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && [ "$KEYSTONE_USE_MOD_WSGI" == "False" ] ; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600298 setup_colorized_logging $KEYSTONE_CONF DEFAULT
299 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000300
Brant Knudson0fc336d2015-02-08 11:03:02 -0600301 iniset $KEYSTONE_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
302
Morgan Fainberg46455a32014-06-20 10:37:18 -0700303 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Morgan Fainberg2c2b1cc2014-05-01 22:05:41 -0700304 # Eliminate the %(asctime)s.%(msecs)03d from the log format strings
305 iniset $KEYSTONE_CONF DEFAULT logging_context_format_string "%(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s"
306 iniset $KEYSTONE_CONF DEFAULT logging_default_format_string "%(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s"
307 iniset $KEYSTONE_CONF DEFAULT logging_debug_format_suffix "%(funcName)s %(pathname)s:%(lineno)d"
308 iniset $KEYSTONE_CONF DEFAULT logging_exception_prefix "%(process)d TRACE %(name)s %(instance)s"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000309 _config_keystone_apache_wsgi
310 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100311
312 iniset $KEYSTONE_CONF DEFAULT max_token_size 16384
Brant Knudson85a17ea2014-09-13 14:49:24 -0500313
Brant Knudson7448edb2015-03-11 20:06:26 -0500314 iniset $KEYSTONE_CONF eventlet_server admin_workers "$API_WORKERS"
Brant Knudson85a17ea2014-09-13 14:49:24 -0500315 # Public workers will use the server default, typically number of CPU.
Dean Troyerd81a0272012-08-31 18:04:55 -0500316}
317
Julien Vey00da58a2014-05-27 15:51:49 +0200318function configure_keystone_extensions {
319 # Add keystone extension into keystone v3 application pipeline
320 local extension_value
321 local api_v3
322 local extension
323 local api_v3_extension
324 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
325 if [[ -z "${extension_value}" ]]; then
326 continue
327 fi
328 api_v3=$(iniget $KEYSTONE_PASTE_INI pipeline:api_v3 pipeline)
329 extension=$(echo $api_v3 | sed -ne "/${extension_value}/ p;" )
330 if [[ -z $extension ]]; then
331 api_v3_extension=$(echo $api_v3 | sed -ne "s/service_v3/${extension_value}_extension service_v3/p;" )
332 iniset $KEYSTONE_PASTE_INI pipeline:api_v3 pipeline "$api_v3_extension"
333 fi
334 done
335}
336
Dean Troyerd835de82012-11-29 17:11:35 -0600337# create_keystone_accounts() - Sets up common required keystone accounts
338
339# Tenant User Roles
340# ------------------------------------------------------------------
Dean Troyerd835de82012-11-29 17:11:35 -0600341# admin admin admin
Dean Troyer42a59c22014-03-03 14:31:29 -0600342# service -- --
343# -- -- service
344# -- -- ResellerAdmin
345# -- -- Member
Dean Troyerd835de82012-11-29 17:11:35 -0600346# demo admin admin
347# demo demo Member, anotherrole
348# invisible_to_admin demo Member
349
Steve Martinelli4599fd12015-03-12 21:30:58 -0400350# Group Users Roles Tenant
351# ------------------------------------------------------------------
352# admins admin admin admin
353# nonadmin demo Member, anotherrole demo
354
355
Dean Troyerd835de82012-11-29 17:11:35 -0600356# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100357function create_keystone_accounts {
Dean Troyerd835de82012-11-29 17:11:35 -0600358
359 # admin
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000360 local admin_tenant=$(get_or_create_project "admin" default)
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000361 local admin_user=$(get_or_create_user "admin" "$ADMIN_PASSWORD" default)
Dean Troyerc50c9832014-07-25 13:40:25 -0500362 local admin_role=$(get_or_create_role "admin")
Jamie Lennox9b215db2015-02-10 18:19:57 +1100363 get_or_add_user_project_role $admin_role $admin_user $admin_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600364
Dean Troyer42a59c22014-03-03 14:31:29 -0600365 # Create service project/role
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000366 get_or_create_project "$SERVICE_TENANT_NAME" default
Dean Troyer42a59c22014-03-03 14:31:29 -0600367
368 # Service role, so service users do not have to be admins
Bartosz Górski0abde392014-02-28 14:15:19 +0100369 get_or_create_role service
Dean Troyer42a59c22014-03-03 14:31:29 -0600370
371 # The ResellerAdmin role is used by Nova and Ceilometer so we need to keep it.
372 # The admin role in swift allows a user to act as an admin for their tenant,
373 # but ResellerAdmin is needed for a user to act as any tenant. The name of this
374 # role is also configurable in swift-proxy.conf
Bartosz Górski0abde392014-02-28 14:15:19 +0100375 get_or_create_role ResellerAdmin
Dean Troyerd835de82012-11-29 17:11:35 -0600376
377 # The Member role is used by Horizon and Swift so we need to keep it:
Dean Troyerc50c9832014-07-25 13:40:25 -0500378 local member_role=$(get_or_create_role "Member")
Bartosz Górski0abde392014-02-28 14:15:19 +0100379
Masayuki Igawad3654052014-09-01 17:30:05 +0900380 # another_role demonstrates that an arbitrary role may be created and used
Dean Troyerd835de82012-11-29 17:11:35 -0600381 # TODO(sleepsonthefloor): show how this can be used for rbac in the future!
Dean Troyerc50c9832014-07-25 13:40:25 -0500382 local another_role=$(get_or_create_role "anotherrole")
Dean Troyerd835de82012-11-29 17:11:35 -0600383
384 # invisible tenant - admin can't see this one
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000385 local invis_tenant=$(get_or_create_project "invisible_to_admin" default)
Dean Troyerd835de82012-11-29 17:11:35 -0600386
387 # demo
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000388 local demo_tenant=$(get_or_create_project "demo" default)
Dean Troyerc50c9832014-07-25 13:40:25 -0500389 local demo_user=$(get_or_create_user "demo" \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000390 "$ADMIN_PASSWORD" "default" "demo@example.com")
Steve Martinelli19685422014-01-24 13:02:26 -0600391
Jamie Lennox9b215db2015-02-10 18:19:57 +1100392 get_or_add_user_project_role $member_role $demo_user $demo_tenant
393 get_or_add_user_project_role $admin_role $admin_user $demo_tenant
394 get_or_add_user_project_role $another_role $demo_user $demo_tenant
395 get_or_add_user_project_role $member_role $demo_user $invis_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600396
Steve Martinelli4599fd12015-03-12 21:30:58 -0400397 local admin_group=$(get_or_create_group "admins" \
398 "default" "openstack admin group")
399 local non_admin_group=$(get_or_create_group "nonadmins" \
400 "default" "non-admin group")
401
402 get_or_add_group_project_role $member_role $non_admin_group $demo_tenant
403 get_or_add_group_project_role $another_role $non_admin_group $demo_tenant
404 get_or_add_group_project_role $admin_role $admin_group $admin_tenant
Steve Martinellib74e01c2014-12-18 01:35:35 -0500405
Dean Troyerd835de82012-11-29 17:11:35 -0600406 # Keystone
407 if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100408
409 KEYSTONE_SERVICE=$(get_or_create_service "keystone" \
410 "identity" "Keystone Identity Service")
411 get_or_create_endpoint $KEYSTONE_SERVICE \
412 "$REGION_NAME" \
413 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION" \
414 "$KEYSTONE_AUTH_PROTOCOL://$KEYSTONE_AUTH_HOST:$KEYSTONE_AUTH_PORT/v$IDENTITY_API_VERSION" \
415 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION"
Dean Troyerd835de82012-11-29 17:11:35 -0600416 fi
Dean Troyerd835de82012-11-29 17:11:35 -0600417}
418
Jamie Lennox85ff5322015-01-28 14:28:01 +1000419# Create a user that is capable of verifying keystone tokens for use with auth_token middleware.
420#
421# create_service_user <name> [role]
422#
423# The role defaults to the service role. It is allowed to be provided as optional as historically
424# a lot of projects have configured themselves with the admin or other role here if they are
425# using this user for other purposes beyond simply auth_token middleware.
426function create_service_user {
427 local role=${2:-service}
428
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000429 local user=$(get_or_create_user "$1" "$SERVICE_PASSWORD" default)
Jamie Lennox9b215db2015-02-10 18:19:57 +1100430 get_or_add_user_project_role "$role" "$user" "$SERVICE_TENANT_NAME"
Jamie Lennox85ff5322015-01-28 14:28:01 +1000431}
432
Brant Knudson05952372014-09-19 17:22:22 -0500433# Configure the service to use the auth token middleware.
434#
435# configure_auth_token_middleware conf_file admin_user signing_dir [section]
436#
437# section defaults to keystone_authtoken, which is where auth_token looks in
438# the .conf file. If the paste config file is used (api-paste.ini) then
439# provide the section name for the auth_token filter.
440function configure_auth_token_middleware {
441 local conf_file=$1
442 local admin_user=$2
443 local signing_dir=$3
444 local section=${4:-keystone_authtoken}
445
Jamie Lennox78b77262014-12-19 12:56:01 +1000446 iniset $conf_file $section auth_plugin password
447 iniset $conf_file $section auth_url $KEYSTONE_AUTH_URI
448 iniset $conf_file $section username $admin_user
449 iniset $conf_file $section password $SERVICE_PASSWORD
450 iniset $conf_file $section user_domain_id default
451 iniset $conf_file $section project_name $SERVICE_TENANT_NAME
452 iniset $conf_file $section project_domain_id default
453
454 iniset $conf_file $section auth_uri $KEYSTONE_SERVICE_URI
Rob Crittenden18d47782014-03-19 17:47:42 -0400455 iniset $conf_file $section cafile $SSL_BUNDLE_FILE
Brant Knudson05952372014-09-19 17:22:22 -0500456 iniset $conf_file $section signing_dir $signing_dir
Vincent Hou21fe4e72013-11-21 03:10:27 -0500457}
458
Dean Troyerd81a0272012-08-31 18:04:55 -0500459# init_keystone() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100460function init_keystone {
Dean Troyerb9e25132013-10-01 14:45:04 -0500461 if is_service_enabled ldap; then
462 init_ldap
463 fi
464
Dean Troyerd81a0272012-08-31 18:04:55 -0500465 # (Re)create keystone database
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +0200466 recreate_database keystone
Dean Troyerd81a0272012-08-31 18:04:55 -0500467
468 # Initialize keystone database
Dean Troyerf8ae6472015-02-17 11:05:06 -0600469 $KEYSTONE_BIN_DIR/keystone-manage db_sync
Dean Troyerd81a0272012-08-31 18:04:55 -0500470
Julien Vey00da58a2014-05-27 15:51:49 +0200471 local extension_value
472 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
473 if [[ -z "${extension_value}" ]]; then
474 continue
475 fi
Dean Troyerf8ae6472015-02-17 11:05:06 -0600476 $KEYSTONE_BIN_DIR/keystone-manage db_sync --extension "${extension_value}"
Julien Vey00da58a2014-05-27 15:51:49 +0200477 done
478
Brant Knudson1e1fce82014-06-19 16:55:45 -0500479 if [[ "$KEYSTONE_TOKEN_FORMAT" != "uuid" ]]; then
Dean Troyerbc071bc2012-10-01 14:06:44 -0500480 # Set up certificates
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800481 rm -rf $KEYSTONE_CONF_DIR/ssl
Dean Troyerf8ae6472015-02-17 11:05:06 -0600482 $KEYSTONE_BIN_DIR/keystone-manage pki_setup
Dean Troyerbc071bc2012-10-01 14:06:44 -0500483 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500484}
485
486# install_keystoneclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100487function install_keystoneclient {
Sean Daguee08ab102014-11-13 17:09:28 -0500488 if use_library_from_git "python-keystoneclient"; then
489 git_clone_by_name "python-keystoneclient"
490 setup_dev_lib "python-keystoneclient"
491 sudo install -D -m 0644 -o $STACK_USER {${GITDIR["python-keystoneclient"]}/tools/,/etc/bash_completion.d/}keystone.bash_completion
Sean Dague5cb19062014-11-01 01:37:45 +0100492 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500493}
494
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700495# install_keystonemiddleware() - Collect source and prepare
496function install_keystonemiddleware {
Dean Troyerf8ae6472015-02-17 11:05:06 -0600497 # install_keystonemiddleware() is called when keystonemiddleware is needed
498 # to provide an opportunity to install it from the source repo
Sean Dague658312c2014-11-14 11:35:56 -0500499 if use_library_from_git "keystonemiddleware"; then
500 git_clone_by_name "keystonemiddleware"
501 setup_dev_lib "keystonemiddleware"
Dean Troyerf8ae6472015-02-17 11:05:06 -0600502 else
503 # When not installing from repo, keystonemiddleware is still needed...
Sean Dague60996b12015-04-08 09:06:49 -0400504 pip_install_gr keystonemiddleware
Sean Dague658312c2014-11-14 11:35:56 -0500505 fi
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700506}
507
Dean Troyerd81a0272012-08-31 18:04:55 -0500508# install_keystone() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100509function install_keystone {
Brad Topolf127e2f2013-01-22 10:17:50 -0600510 # only install ldap if the service has been enabled
511 if is_service_enabled ldap; then
512 install_ldap
513 fi
Peter Feiner61ae7c12013-11-15 10:42:30 -0500514 if [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
515 # Install memcached and the memcache Python library that keystone uses.
516 # Unfortunately the Python library goes by different names in the .deb
517 # and .rpm circles.
518 install_package memcached
519 if is_ubuntu; then
520 install_package python-memcache
521 else
522 install_package python-memcached
523 fi
524 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500525 git_clone $KEYSTONE_REPO $KEYSTONE_DIR $KEYSTONE_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400526 setup_develop $KEYSTONE_DIR
Morgan Fainberg46455a32014-06-20 10:37:18 -0700527 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000528 install_apache_wsgi
Rob Crittenden18d47782014-03-19 17:47:42 -0400529 if is_ssl_enabled_service "key"; then
530 enable_mod_ssl
531 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000532 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500533}
534
535# start_keystone() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100536function start_keystone {
Dean Troyerc83a7e12012-11-29 11:47:58 -0600537 # Get right service port for testing
538 local service_port=$KEYSTONE_SERVICE_PORT
Rob Crittenden18d47782014-03-19 17:47:42 -0400539 local auth_protocol=$KEYSTONE_AUTH_PROTOCOL
Dean Troyerc83a7e12012-11-29 11:47:58 -0600540 if is_service_enabled tls-proxy; then
541 service_port=$KEYSTONE_SERVICE_PORT_INT
Rob Crittenden18d47782014-03-19 17:47:42 -0400542 auth_protocol="http"
Dean Troyerc83a7e12012-11-29 11:47:58 -0600543 fi
544
Morgan Fainberg46455a32014-06-20 10:37:18 -0700545 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700546 enable_apache_site keystone
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000547 restart_apache_server
Chris Dent2f27a0e2014-09-09 13:46:02 +0100548 tail_log key /var/log/$APACHE_NAME/keystone.log
549 tail_log key-access /var/log/$APACHE_NAME/keystone_access.log
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000550 else
551 # Start Keystone in a screen window
Dean Troyerf8ae6472015-02-17 11:05:06 -0600552 run_process key "$KEYSTONE_BIN_DIR/keystone-all --config-file $KEYSTONE_CONF"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000553 fi
554
Dean Troyerd835de82012-11-29 17:11:35 -0600555 echo "Waiting for keystone to start..."
Stanislaw Pituchabe4c9532014-06-11 17:52:49 +0100556 # Check that the keystone service is running. Even if the tls tunnel
557 # should be enabled, make sure the internal port is checked using
558 # unencryted traffic at this point.
sridhargaddamb5ab6462015-02-24 07:23:24 +0000559 if ! wait_for_service $SERVICE_TIMEOUT $auth_protocol://$KEYSTONE_SERVICE_HOST:$service_port/v$IDENTITY_API_VERSION/; then
Sean Dague101b4242013-10-22 08:47:11 -0400560 die $LINENO "keystone did not start"
Dean Troyerd835de82012-11-29 17:11:35 -0600561 fi
Dean Troyerc83a7e12012-11-29 11:47:58 -0600562
563 # Start proxies if enabled
564 if is_service_enabled tls-proxy; then
565 start_tls_proxy '*' $KEYSTONE_SERVICE_PORT $KEYSTONE_SERVICE_HOST $KEYSTONE_SERVICE_PORT_INT &
566 start_tls_proxy '*' $KEYSTONE_AUTH_PORT $KEYSTONE_AUTH_HOST $KEYSTONE_AUTH_PORT_INT &
567 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500568}
569
570# stop_keystone() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100571function stop_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700572 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
573 disable_apache_site keystone
574 restart_apache_server
575 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500576 # Kill the Keystone screen window
Chris Dent2f27a0e2014-09-09 13:46:02 +0100577 stop_process key
Dean Troyerd81a0272012-08-31 18:04:55 -0500578}
Dean Troyer7903b792012-09-13 17:16:12 -0500579
Dean Troyer1a6d4492013-06-03 16:47:36 -0500580
Dean Troyer7903b792012-09-13 17:16:12 -0500581# Restore xtrace
582$XTRACE
Sean Dague584d90e2013-03-29 14:34:53 -0400583
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100584# Tell emacs to use shell-script-mode
585## Local variables:
586## mode: shell-script
587## End: