blob: 921dc766dd9187cfd0822d7059071c983c05d018 [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
Jamie Lennox21a90772015-07-03 11:54:38 +100038GITDIR["keystoneauth"]=$DEST/keystoneauth
Sean Daguee08ab102014-11-13 17:09:28 -050039GITDIR["python-keystoneclient"]=$DEST/python-keystoneclient
Sean Dague658312c2014-11-14 11:35:56 -050040GITDIR["keystonemiddleware"]=$DEST/keystonemiddleware
Dean Troyerd81a0272012-08-31 18:04:55 -050041KEYSTONE_DIR=$DEST/keystone
Dean Troyerf8ae6472015-02-17 11:05:06 -060042
43# Keystone virtual environment
44if [[ ${USE_VENV} = True ]]; then
45 PROJECT_VENV["keystone"]=${KEYSTONE_DIR}.venv
46 KEYSTONE_BIN_DIR=${PROJECT_VENV["keystone"]}/bin
47else
48 KEYSTONE_BIN_DIR=$(get_python_exec_prefix)
49fi
50
Dean Troyerd81a0272012-08-31 18:04:55 -050051KEYSTONE_CONF_DIR=${KEYSTONE_CONF_DIR:-/etc/keystone}
52KEYSTONE_CONF=$KEYSTONE_CONF_DIR/keystone.conf
Alan Pevece0bb4472013-03-12 11:10:52 +010053KEYSTONE_PASTE_INI=${KEYSTONE_PASTE_INI:-$KEYSTONE_CONF_DIR/keystone-paste.ini}
Dean Troyerd81a0272012-08-31 18:04:55 -050054
Julien Vey00da58a2014-05-27 15:51:49 +020055# Set up additional extensions, such as oauth1, federation
56# Example of KEYSTONE_EXTENSIONS=oauth1,federation
57KEYSTONE_EXTENSIONS=${KEYSTONE_EXTENSIONS:-}
58
Morgan Fainberg46455a32014-06-20 10:37:18 -070059# Toggle for deploying Keystone under HTTPD + mod_wsgi
Morgan Fainberge6dd4e62014-06-25 17:25:25 -070060KEYSTONE_USE_MOD_WSGI=${KEYSTONE_USE_MOD_WSGI:-${ENABLE_HTTPD_MOD_WSGI_SERVICES}}
Morgan Fainberg46455a32014-06-20 10:37:18 -070061
Brant Knudson331a64f2015-05-11 10:02:24 -050062# Select the Catalog backend driver
Dean Troyerb80379c2012-09-10 18:30:37 -050063KEYSTONE_CATALOG_BACKEND=${KEYSTONE_CATALOG_BACKEND:-sql}
Dean Troyerd81a0272012-08-31 18:04:55 -050064KEYSTONE_CATALOG=$KEYSTONE_CONF_DIR/default_catalog.templates
65
Brant Knudson331a64f2015-05-11 10:02:24 -050066# Select the token persistence backend driver
Davanum Srinivas5bd96f92013-01-29 15:12:20 -050067KEYSTONE_TOKEN_BACKEND=${KEYSTONE_TOKEN_BACKEND:-sql}
68
Brant Knudson331a64f2015-05-11 10:02:24 -050069# Select the Identity backend driver
Alex Rudenkocd770582013-09-01 16:26:03 +020070KEYSTONE_IDENTITY_BACKEND=${KEYSTONE_IDENTITY_BACKEND:-sql}
71
Brant Knudson331a64f2015-05-11 10:02:24 -050072# Select the Assignment backend driver
Alex Rudenkocd770582013-09-01 16:26:03 +020073KEYSTONE_ASSIGNMENT_BACKEND=${KEYSTONE_ASSIGNMENT_BACKEND:-sql}
74
Brant Knudson331a64f2015-05-11 10:02:24 -050075# Select Keystone's token provider (and format)
76# Choose from 'uuid', 'pki', 'pkiz', or 'fernet'
Sean Dague53753292014-12-04 19:38:15 -050077KEYSTONE_TOKEN_FORMAT=${KEYSTONE_TOKEN_FORMAT:-}
Brant Knudson1e1fce82014-06-19 16:55:45 -050078KEYSTONE_TOKEN_FORMAT=$(echo ${KEYSTONE_TOKEN_FORMAT} | tr '[:upper:]' '[:lower:]')
Dean Troyerbc071bc2012-10-01 14:06:44 -050079
Dean Troyerd81a0272012-08-31 18:04:55 -050080# Set Keystone interface configuration
Dean Troyerd81a0272012-08-31 18:04:55 -050081KEYSTONE_AUTH_HOST=${KEYSTONE_AUTH_HOST:-$SERVICE_HOST}
82KEYSTONE_AUTH_PORT=${KEYSTONE_AUTH_PORT:-35357}
Dean Troyerc83a7e12012-11-29 11:47:58 -060083KEYSTONE_AUTH_PORT_INT=${KEYSTONE_AUTH_PORT_INT:-35358}
84KEYSTONE_AUTH_PROTOCOL=${KEYSTONE_AUTH_PROTOCOL:-$SERVICE_PROTOCOL}
85
86# Public facing bits
Dean Troyerd81a0272012-08-31 18:04:55 -050087KEYSTONE_SERVICE_HOST=${KEYSTONE_SERVICE_HOST:-$SERVICE_HOST}
88KEYSTONE_SERVICE_PORT=${KEYSTONE_SERVICE_PORT:-5000}
Dean Troyerc83a7e12012-11-29 11:47:58 -060089KEYSTONE_SERVICE_PORT_INT=${KEYSTONE_SERVICE_PORT_INT:-5001}
90KEYSTONE_SERVICE_PROTOCOL=${KEYSTONE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Dean Troyerd81a0272012-08-31 18:04:55 -050091
David Kranz041fa712014-02-24 13:30:59 -050092# Bind hosts
93KEYSTONE_ADMIN_BIND_HOST=${KEYSTONE_ADMIN_BIND_HOST:-$KEYSTONE_SERVICE_HOST}
Dean Troyerb7490da2013-03-18 16:07:56 -050094# Set the tenant for service accounts in Keystone
95SERVICE_TENANT_NAME=${SERVICE_TENANT_NAME:-service}
96
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100097# if we are running with SSL use https protocols
Rob Crittenden18d47782014-03-19 17:47:42 -040098if is_ssl_enabled_service "key" || is_service_enabled tls-proxy; then
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100099 KEYSTONE_AUTH_PROTOCOL="https"
100 KEYSTONE_SERVICE_PROTOCOL="https"
101fi
102
Jamie Lennox3561d7f2014-05-21 17:18:43 +1000103# complete URIs
104KEYSTONE_AUTH_URI=${KEYSTONE_AUTH_PROTOCOL}://${KEYSTONE_AUTH_HOST}:${KEYSTONE_AUTH_PORT}
105KEYSTONE_SERVICE_URI=${KEYSTONE_SERVICE_PROTOCOL}://${KEYSTONE_SERVICE_HOST}:${KEYSTONE_SERVICE_PORT}
106
Steve Martinellib74e01c2014-12-18 01:35:35 -0500107# V3 URIs
108KEYSTONE_AUTH_URI_V3=$KEYSTONE_AUTH_URI/v3
109KEYSTONE_SERVICE_URI_V3=$KEYSTONE_SERVICE_URI/v3
110
Dean Troyer5ce44cd2015-02-12 22:18:33 -0600111
Dean Troyercc6b4432013-04-08 15:38:03 -0500112# Functions
113# ---------
Dean Troyer5ce44cd2015-02-12 22:18:33 -0600114
115# Test if Keystone is enabled
116# is_keystone_enabled
117function is_keystone_enabled {
118 [[ ,${ENABLED_SERVICES}, =~ ,"key", ]] && return 0
119 return 1
120}
121
Dean Troyerd81a0272012-08-31 18:04:55 -0500122# cleanup_keystone() - Remove residual data files, anything left over from previous
123# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100124function cleanup_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700125 _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -0500126}
127
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000128# _cleanup_keystone_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
Ian Wienandaee18c72014-02-21 15:35:08 +1100129function _cleanup_keystone_apache_wsgi {
Morgan Fainberg970ee902014-06-09 12:07:29 -0700130 sudo rm -f $(apache_site_config_for keystone)
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000131}
132
133# _config_keystone_apache_wsgi() - Set WSGI config files of Keystone
Ian Wienandaee18c72014-02-21 15:35:08 +1100134function _config_keystone_apache_wsgi {
Morgan Fainberg970ee902014-06-09 12:07:29 -0700135 local keystone_apache_conf=$(apache_site_config_for keystone)
Rob Crittenden18d47782014-03-19 17:47:42 -0400136 local keystone_ssl=""
137 local keystone_certfile=""
138 local keystone_keyfile=""
139 local keystone_service_port=$KEYSTONE_SERVICE_PORT
140 local keystone_auth_port=$KEYSTONE_AUTH_PORT
Dean Troyerf8ae6472015-02-17 11:05:06 -0600141 local venv_path=""
Rob Crittenden18d47782014-03-19 17:47:42 -0400142
143 if is_ssl_enabled_service key; then
144 keystone_ssl="SSLEngine On"
145 keystone_certfile="SSLCertificateFile $KEYSTONE_SSL_CERT"
146 keystone_keyfile="SSLCertificateKeyFile $KEYSTONE_SSL_KEY"
147 fi
148 if is_service_enabled tls-proxy; then
149 keystone_service_port=$KEYSTONE_SERVICE_PORT_INT
150 keystone_auth_port=$KEYSTONE_AUTH_PORT_INT
151 fi
Dean Troyerf8ae6472015-02-17 11:05:06 -0600152 if [[ ${USE_VENV} = True ]]; then
Chris Dent3a2c86a2015-05-12 13:41:25 +0000153 venv_path="python-path=${PROJECT_VENV["keystone"]}/lib/$(python_version)/site-packages"
Dean Troyerf8ae6472015-02-17 11:05:06 -0600154 fi
Morgan Fainbergd074dc72014-06-24 21:33:39 -0700155
Morgan Fainberg970ee902014-06-09 12:07:29 -0700156 sudo cp $FILES/apache-keystone.template $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000157 sudo sed -e "
Rob Crittenden18d47782014-03-19 17:47:42 -0400158 s|%PUBLICPORT%|$keystone_service_port|g;
159 s|%ADMINPORT%|$keystone_auth_port|g;
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000160 s|%APACHE_NAME%|$APACHE_NAME|g;
Rob Crittenden18d47782014-03-19 17:47:42 -0400161 s|%SSLENGINE%|$keystone_ssl|g;
162 s|%SSLCERTFILE%|$keystone_certfile|g;
163 s|%SSLKEYFILE%|$keystone_keyfile|g;
Dean Troyerf8ae6472015-02-17 11:05:06 -0600164 s|%USER%|$STACK_USER|g;
165 s|%VIRTUALENV%|$venv_path|g
Brant Knudson2ad1a422015-06-23 10:53:50 -0500166 s|%KEYSTONE_BIN%|$KEYSTONE_BIN_DIR|g
Morgan Fainberg970ee902014-06-09 12:07:29 -0700167 " -i $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000168}
169
Dean Troyerd81a0272012-08-31 18:04:55 -0500170# configure_keystone() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100171function configure_keystone {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500172 sudo install -d -o $STACK_USER $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500173
174 if [[ "$KEYSTONE_CONF_DIR" != "$KEYSTONE_DIR/etc" ]]; then
Dean Troyer8421c2b2015-03-16 13:52:19 -0500175 install -m 600 $KEYSTONE_DIR/etc/keystone.conf.sample $KEYSTONE_CONF
Dean Troyerd81a0272012-08-31 18:04:55 -0500176 cp -p $KEYSTONE_DIR/etc/policy.json $KEYSTONE_CONF_DIR
Alan Pevece0bb4472013-03-12 11:10:52 +0100177 if [[ -f "$KEYSTONE_DIR/etc/keystone-paste.ini" ]]; then
178 cp -p "$KEYSTONE_DIR/etc/keystone-paste.ini" "$KEYSTONE_PASTE_INI"
179 fi
180 fi
181 if [[ -f "$KEYSTONE_PASTE_INI" ]]; then
182 iniset "$KEYSTONE_CONF" paste_deploy config_file "$KEYSTONE_PASTE_INI"
183 else
184 # compatibility with mixed cfg and paste.deploy configuration
185 KEYSTONE_PASTE_INI="$KEYSTONE_CONF"
Dean Troyerd81a0272012-08-31 18:04:55 -0500186 fi
187
Samuel de Medeiros Queiroz3fd71d62015-05-03 14:54:45 -0300188 if [ "$ENABLE_IDENTITY_V2" == "False" ]; then
189 # Only Identity v3 API should be available; then disable v2 pipelines
190 inidelete $KEYSTONE_PASTE_INI composite:main \\/v2.0
191 inidelete $KEYSTONE_PASTE_INI composite:admin \\/v2.0
192 fi
193
Julien Vey00da58a2014-05-27 15:51:49 +0200194 configure_keystone_extensions
195
Dean Troyerd81a0272012-08-31 18:04:55 -0500196 # Rewrite stock ``keystone.conf``
Dean Troyerc83a7e12012-11-29 11:47:58 -0600197
Brad Topolf127e2f2013-01-22 10:17:50 -0600198 if is_service_enabled ldap; then
199 #Set all needed ldap values
Dean Troyerb9e25132013-10-01 14:45:04 -0500200 iniset $KEYSTONE_CONF ldap password $LDAP_PASSWORD
201 iniset $KEYSTONE_CONF ldap user $LDAP_MANAGER_DN
202 iniset $KEYSTONE_CONF ldap suffix $LDAP_BASE_DN
Brad Topolf41024e2013-02-19 15:36:41 -0600203 iniset $KEYSTONE_CONF ldap use_dumb_member "True"
Morgan Fainberg2dc11fb2013-09-24 23:43:08 -0700204 iniset $KEYSTONE_CONF ldap user_attribute_ignore "enabled,email,tenants,default_project_id"
Brad Topolf41024e2013-02-19 15:36:41 -0600205 iniset $KEYSTONE_CONF ldap tenant_attribute_ignore "enabled"
206 iniset $KEYSTONE_CONF ldap tenant_domain_id_attribute "businessCategory"
207 iniset $KEYSTONE_CONF ldap tenant_desc_attribute "description"
Dean Troyerb9e25132013-10-01 14:45:04 -0500208 iniset $KEYSTONE_CONF ldap tenant_tree_dn "ou=Projects,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600209 iniset $KEYSTONE_CONF ldap user_domain_id_attribute "businessCategory"
Dean Troyerb9e25132013-10-01 14:45:04 -0500210 iniset $KEYSTONE_CONF ldap user_tree_dn "ou=Users,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600211 iniset $KEYSTONE_CONF DEFAULT member_role_id "9fe2ff9ee4384b1894a90878d3e92bab"
212 iniset $KEYSTONE_CONF DEFAULT member_role_name "_member_"
Brad Topolf127e2f2013-01-22 10:17:50 -0600213 fi
214
Brant Knudson331a64f2015-05-11 10:02:24 -0500215 iniset $KEYSTONE_CONF identity driver "$KEYSTONE_IDENTITY_BACKEND"
216 iniset $KEYSTONE_CONF assignment driver "$KEYSTONE_ASSIGNMENT_BACKEND"
Brad Topolf127e2f2013-01-22 10:17:50 -0600217
Brant Knudson2dd110c2015-03-14 12:39:14 -0500218 iniset_rpc_backend keystone $KEYSTONE_CONF
Sergey Skripnick8464a4c2014-07-08 21:05:23 +0300219
Brant Knudson7448edb2015-03-11 20:06:26 -0500220 iniset $KEYSTONE_CONF eventlet_server admin_bind_host "$KEYSTONE_ADMIN_BIND_HOST"
Dean Troyer245a4312013-06-28 09:16:08 -0500221
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000222 # Register SSL certificates if provided
223 if is_ssl_enabled_service key; then
224 ensure_certificates KEYSTONE
225
Brant Knudson7448edb2015-03-11 20:06:26 -0500226 iniset $KEYSTONE_CONF eventlet_server_ssl enable True
227 iniset $KEYSTONE_CONF eventlet_server_ssl certfile $KEYSTONE_SSL_CERT
228 iniset $KEYSTONE_CONF eventlet_server_ssl keyfile $KEYSTONE_SSL_KEY
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000229 fi
230
Dean Troyerc83a7e12012-11-29 11:47:58 -0600231 if is_service_enabled tls-proxy; then
232 # Set the service ports for a proxy to take the originals
Brant Knudson7448edb2015-03-11 20:06:26 -0500233 iniset $KEYSTONE_CONF eventlet_server public_port $KEYSTONE_SERVICE_PORT_INT
234 iniset $KEYSTONE_CONF eventlet_server admin_port $KEYSTONE_AUTH_PORT_INT
Dean Troyerc83a7e12012-11-29 11:47:58 -0600235 fi
236
Dean Troyerd81a0272012-08-31 18:04:55 -0500237 iniset $KEYSTONE_CONF DEFAULT admin_token "$SERVICE_TOKEN"
Sudarshan Acharya37631412013-07-16 00:47:54 +0000238
Brant Knudson1e1fce82014-06-19 16:55:45 -0500239 if [[ "$KEYSTONE_TOKEN_FORMAT" != "" ]]; then
Brant Knudson331a64f2015-05-11 10:02:24 -0500240 iniset $KEYSTONE_CONF token provider $KEYSTONE_TOKEN_FORMAT
Sudarshan Acharya37631412013-07-16 00:47:54 +0000241 fi
242
Brant Knudson16d3ad02014-02-13 18:59:50 -0600243 iniset $KEYSTONE_CONF database connection `database_connection_url keystone`
Dean Troyerd81a0272012-08-31 18:04:55 -0500244
Brant Knudson331a64f2015-05-11 10:02:24 -0500245 iniset $KEYSTONE_CONF token driver "$KEYSTONE_TOKEN_BACKEND"
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500246
Brant Knudson331a64f2015-05-11 10:02:24 -0500247 iniset $KEYSTONE_CONF catalog driver "$KEYSTONE_CATALOG_BACKEND"
Dean Troyerd81a0272012-08-31 18:04:55 -0500248 if [[ "$KEYSTONE_CATALOG_BACKEND" = "sql" ]]; then
249 # Configure ``keystone.conf`` to use sql
Dean Troyerd81a0272012-08-31 18:04:55 -0500250 inicomment $KEYSTONE_CONF catalog template_file
251 else
252 cp -p $FILES/default_catalog.templates $KEYSTONE_CATALOG
253
254 # Add swift endpoints to service catalog if swift is enabled
Chmouel Boudjnah0c3a5582013-03-06 10:58:33 +0100255 if is_service_enabled s-proxy; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500256 echo "catalog.RegionOne.object_store.publicURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
257 echo "catalog.RegionOne.object_store.adminURL = http://%SERVICE_HOST%:8080/" >> $KEYSTONE_CATALOG
258 echo "catalog.RegionOne.object_store.internalURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
259 echo "catalog.RegionOne.object_store.name = Swift Service" >> $KEYSTONE_CATALOG
260 fi
261
Mark McClainb05c8762013-07-06 23:29:39 -0400262 # Add neutron endpoints to service catalog if neutron is enabled
263 if is_service_enabled neutron; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500264 echo "catalog.RegionOne.network.publicURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
265 echo "catalog.RegionOne.network.adminURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
266 echo "catalog.RegionOne.network.internalURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
Mark McClainb05c8762013-07-06 23:29:39 -0400267 echo "catalog.RegionOne.network.name = Neutron Service" >> $KEYSTONE_CATALOG
Dean Troyerd81a0272012-08-31 18:04:55 -0500268 fi
269
Vincent Untz7e86dbe2012-12-13 08:50:37 +0100270 sed -e "
Dean Troyerd81a0272012-08-31 18:04:55 -0500271 s,%SERVICE_HOST%,$SERVICE_HOST,g;
272 s,%S3_SERVICE_PORT%,$S3_SERVICE_PORT,g;
273 " -i $KEYSTONE_CATALOG
274
275 # Configure ``keystone.conf`` to use templates
Dean Troyerd81a0272012-08-31 18:04:55 -0500276 iniset $KEYSTONE_CONF catalog template_file "$KEYSTONE_CATALOG"
277 fi
278
279 # Set up logging
Dean Troyerd81a0272012-08-31 18:04:55 -0500280 if [ "$SYSLOG" != "False" ]; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600281 iniset $KEYSTONE_CONF DEFAULT use_syslog "True"
Dean Troyerd81a0272012-08-31 18:04:55 -0500282 fi
Brant Knudson4968d1a2014-01-22 19:06:44 -0600283
284 # Format logging
Morgan Fainberg46455a32014-06-20 10:37:18 -0700285 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && [ "$KEYSTONE_USE_MOD_WSGI" == "False" ] ; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600286 setup_colorized_logging $KEYSTONE_CONF DEFAULT
287 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000288
Brant Knudson0fc336d2015-02-08 11:03:02 -0600289 iniset $KEYSTONE_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
290
Morgan Fainberg46455a32014-06-20 10:37:18 -0700291 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Morgan Fainberg2c2b1cc2014-05-01 22:05:41 -0700292 # Eliminate the %(asctime)s.%(msecs)03d from the log format strings
293 iniset $KEYSTONE_CONF DEFAULT logging_context_format_string "%(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s"
294 iniset $KEYSTONE_CONF DEFAULT logging_default_format_string "%(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s"
295 iniset $KEYSTONE_CONF DEFAULT logging_debug_format_suffix "%(funcName)s %(pathname)s:%(lineno)d"
296 iniset $KEYSTONE_CONF DEFAULT logging_exception_prefix "%(process)d TRACE %(name)s %(instance)s"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000297 _config_keystone_apache_wsgi
298 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100299
300 iniset $KEYSTONE_CONF DEFAULT max_token_size 16384
Brant Knudson85a17ea2014-09-13 14:49:24 -0500301
Brant Knudson7448edb2015-03-11 20:06:26 -0500302 iniset $KEYSTONE_CONF eventlet_server admin_workers "$API_WORKERS"
Brant Knudson85a17ea2014-09-13 14:49:24 -0500303 # Public workers will use the server default, typically number of CPU.
Brant Knudsoncef5e402015-06-25 17:57:53 -0500304
305 iniset $KEYSTONE_CONF fernet_tokens key_repository "$KEYSTONE_CONF_DIR/fernet-keys/"
Dean Troyerd81a0272012-08-31 18:04:55 -0500306}
307
Julien Vey00da58a2014-05-27 15:51:49 +0200308function configure_keystone_extensions {
309 # Add keystone extension into keystone v3 application pipeline
310 local extension_value
311 local api_v3
312 local extension
313 local api_v3_extension
314 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
315 if [[ -z "${extension_value}" ]]; then
316 continue
317 fi
318 api_v3=$(iniget $KEYSTONE_PASTE_INI pipeline:api_v3 pipeline)
319 extension=$(echo $api_v3 | sed -ne "/${extension_value}/ p;" )
320 if [[ -z $extension ]]; then
321 api_v3_extension=$(echo $api_v3 | sed -ne "s/service_v3/${extension_value}_extension service_v3/p;" )
322 iniset $KEYSTONE_PASTE_INI pipeline:api_v3 pipeline "$api_v3_extension"
323 fi
324 done
325}
326
Dean Troyerd835de82012-11-29 17:11:35 -0600327# create_keystone_accounts() - Sets up common required keystone accounts
328
329# Tenant User Roles
330# ------------------------------------------------------------------
Dean Troyerd835de82012-11-29 17:11:35 -0600331# admin admin admin
Dean Troyer42a59c22014-03-03 14:31:29 -0600332# service -- --
333# -- -- service
334# -- -- ResellerAdmin
335# -- -- Member
Dean Troyerd835de82012-11-29 17:11:35 -0600336# demo admin admin
337# demo demo Member, anotherrole
338# invisible_to_admin demo Member
339
Steve Martinelli4599fd12015-03-12 21:30:58 -0400340# Group Users Roles Tenant
341# ------------------------------------------------------------------
342# admins admin admin admin
343# nonadmin demo Member, anotherrole demo
344
345
Dean Troyerd835de82012-11-29 17:11:35 -0600346# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100347function create_keystone_accounts {
Dean Troyerd835de82012-11-29 17:11:35 -0600348
349 # admin
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000350 local admin_tenant=$(get_or_create_project "admin" default)
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000351 local admin_user=$(get_or_create_user "admin" "$ADMIN_PASSWORD" default)
Dean Troyerc50c9832014-07-25 13:40:25 -0500352 local admin_role=$(get_or_create_role "admin")
Jamie Lennox9b215db2015-02-10 18:19:57 +1100353 get_or_add_user_project_role $admin_role $admin_user $admin_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600354
Dean Troyer42a59c22014-03-03 14:31:29 -0600355 # Create service project/role
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000356 get_or_create_project "$SERVICE_TENANT_NAME" default
Dean Troyer42a59c22014-03-03 14:31:29 -0600357
358 # Service role, so service users do not have to be admins
Bartosz Górski0abde392014-02-28 14:15:19 +0100359 get_or_create_role service
Dean Troyer42a59c22014-03-03 14:31:29 -0600360
361 # The ResellerAdmin role is used by Nova and Ceilometer so we need to keep it.
362 # The admin role in swift allows a user to act as an admin for their tenant,
363 # but ResellerAdmin is needed for a user to act as any tenant. The name of this
364 # role is also configurable in swift-proxy.conf
Bartosz Górski0abde392014-02-28 14:15:19 +0100365 get_or_create_role ResellerAdmin
Dean Troyerd835de82012-11-29 17:11:35 -0600366
367 # The Member role is used by Horizon and Swift so we need to keep it:
Dean Troyerc50c9832014-07-25 13:40:25 -0500368 local member_role=$(get_or_create_role "Member")
Bartosz Górski0abde392014-02-28 14:15:19 +0100369
Masayuki Igawad3654052014-09-01 17:30:05 +0900370 # another_role demonstrates that an arbitrary role may be created and used
Dean Troyerd835de82012-11-29 17:11:35 -0600371 # TODO(sleepsonthefloor): show how this can be used for rbac in the future!
Dean Troyerc50c9832014-07-25 13:40:25 -0500372 local another_role=$(get_or_create_role "anotherrole")
Dean Troyerd835de82012-11-29 17:11:35 -0600373
374 # invisible tenant - admin can't see this one
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000375 local invis_tenant=$(get_or_create_project "invisible_to_admin" default)
Dean Troyerd835de82012-11-29 17:11:35 -0600376
377 # demo
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000378 local demo_tenant=$(get_or_create_project "demo" default)
Dean Troyerc50c9832014-07-25 13:40:25 -0500379 local demo_user=$(get_or_create_user "demo" \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000380 "$ADMIN_PASSWORD" "default" "demo@example.com")
Steve Martinelli19685422014-01-24 13:02:26 -0600381
Jamie Lennox9b215db2015-02-10 18:19:57 +1100382 get_or_add_user_project_role $member_role $demo_user $demo_tenant
383 get_or_add_user_project_role $admin_role $admin_user $demo_tenant
384 get_or_add_user_project_role $another_role $demo_user $demo_tenant
385 get_or_add_user_project_role $member_role $demo_user $invis_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600386
Steve Martinelli4599fd12015-03-12 21:30:58 -0400387 local admin_group=$(get_or_create_group "admins" \
388 "default" "openstack admin group")
389 local non_admin_group=$(get_or_create_group "nonadmins" \
390 "default" "non-admin group")
391
392 get_or_add_group_project_role $member_role $non_admin_group $demo_tenant
393 get_or_add_group_project_role $another_role $non_admin_group $demo_tenant
394 get_or_add_group_project_role $admin_role $admin_group $admin_tenant
Steve Martinellib74e01c2014-12-18 01:35:35 -0500395
Dean Troyerd835de82012-11-29 17:11:35 -0600396 # Keystone
397 if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100398
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000399 get_or_create_service "keystone" "identity" "Keystone Identity Service"
400 get_or_create_endpoint "identity" \
Bartosz Górski0abde392014-02-28 14:15:19 +0100401 "$REGION_NAME" \
402 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION" \
403 "$KEYSTONE_AUTH_PROTOCOL://$KEYSTONE_AUTH_HOST:$KEYSTONE_AUTH_PORT/v$IDENTITY_API_VERSION" \
404 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION"
Dean Troyerd835de82012-11-29 17:11:35 -0600405 fi
Dean Troyerd835de82012-11-29 17:11:35 -0600406}
407
Jamie Lennox85ff5322015-01-28 14:28:01 +1000408# Create a user that is capable of verifying keystone tokens for use with auth_token middleware.
409#
410# create_service_user <name> [role]
411#
412# The role defaults to the service role. It is allowed to be provided as optional as historically
413# a lot of projects have configured themselves with the admin or other role here if they are
414# using this user for other purposes beyond simply auth_token middleware.
415function create_service_user {
416 local role=${2:-service}
417
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000418 local user=$(get_or_create_user "$1" "$SERVICE_PASSWORD" default)
Jamie Lennox9b215db2015-02-10 18:19:57 +1100419 get_or_add_user_project_role "$role" "$user" "$SERVICE_TENANT_NAME"
Jamie Lennox85ff5322015-01-28 14:28:01 +1000420}
421
Brant Knudson05952372014-09-19 17:22:22 -0500422# Configure the service to use the auth token middleware.
423#
424# configure_auth_token_middleware conf_file admin_user signing_dir [section]
425#
426# section defaults to keystone_authtoken, which is where auth_token looks in
427# the .conf file. If the paste config file is used (api-paste.ini) then
428# provide the section name for the auth_token filter.
429function configure_auth_token_middleware {
430 local conf_file=$1
431 local admin_user=$2
432 local signing_dir=$3
433 local section=${4:-keystone_authtoken}
434
Jamie Lennox78b77262014-12-19 12:56:01 +1000435 iniset $conf_file $section auth_plugin password
436 iniset $conf_file $section auth_url $KEYSTONE_AUTH_URI
437 iniset $conf_file $section username $admin_user
438 iniset $conf_file $section password $SERVICE_PASSWORD
439 iniset $conf_file $section user_domain_id default
440 iniset $conf_file $section project_name $SERVICE_TENANT_NAME
441 iniset $conf_file $section project_domain_id default
442
443 iniset $conf_file $section auth_uri $KEYSTONE_SERVICE_URI
Rob Crittenden18d47782014-03-19 17:47:42 -0400444 iniset $conf_file $section cafile $SSL_BUNDLE_FILE
Brant Knudson05952372014-09-19 17:22:22 -0500445 iniset $conf_file $section signing_dir $signing_dir
Vincent Hou21fe4e72013-11-21 03:10:27 -0500446}
447
Dean Troyerd81a0272012-08-31 18:04:55 -0500448# init_keystone() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100449function init_keystone {
Dean Troyerb9e25132013-10-01 14:45:04 -0500450 if is_service_enabled ldap; then
451 init_ldap
452 fi
453
Dean Troyerd81a0272012-08-31 18:04:55 -0500454 # (Re)create keystone database
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +0200455 recreate_database keystone
Dean Troyerd81a0272012-08-31 18:04:55 -0500456
457 # Initialize keystone database
Dean Troyerf8ae6472015-02-17 11:05:06 -0600458 $KEYSTONE_BIN_DIR/keystone-manage db_sync
Dean Troyerd81a0272012-08-31 18:04:55 -0500459
Julien Vey00da58a2014-05-27 15:51:49 +0200460 local extension_value
461 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
462 if [[ -z "${extension_value}" ]]; then
463 continue
464 fi
Dean Troyerf8ae6472015-02-17 11:05:06 -0600465 $KEYSTONE_BIN_DIR/keystone-manage db_sync --extension "${extension_value}"
Julien Vey00da58a2014-05-27 15:51:49 +0200466 done
467
Brant Knudsoncef5e402015-06-25 17:57:53 -0500468 if [[ "$KEYSTONE_TOKEN_FORMAT" == "pki" || "$KEYSTONE_TOKEN_FORMAT" == "pkiz" ]]; then
Dean Troyerbc071bc2012-10-01 14:06:44 -0500469 # Set up certificates
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800470 rm -rf $KEYSTONE_CONF_DIR/ssl
Dean Troyerf8ae6472015-02-17 11:05:06 -0600471 $KEYSTONE_BIN_DIR/keystone-manage pki_setup
Dean Troyerbc071bc2012-10-01 14:06:44 -0500472 fi
Brant Knudsoncef5e402015-06-25 17:57:53 -0500473 if [[ "$KEYSTONE_TOKEN_FORMAT" == "fernet" ]]; then
474 rm -rf "$KEYSTONE_CONF_DIR/fernet-keys/"
475 $KEYSTONE_BIN_DIR/keystone-manage fernet_setup
476 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500477}
478
Jamie Lennox21a90772015-07-03 11:54:38 +1000479# install_keystoneauth() - Collect source and prepare
480function install_keystoneauth {
481 if use_library_from_git "keystoneauth"; then
482 git_clone_by_name "keystoneauth"
483 setup_dev_lib "keystoneauth"
484 fi
485}
486
Dean Troyerd81a0272012-08-31 18:04:55 -0500487# install_keystoneclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100488function install_keystoneclient {
Sean Daguee08ab102014-11-13 17:09:28 -0500489 if use_library_from_git "python-keystoneclient"; then
490 git_clone_by_name "python-keystoneclient"
491 setup_dev_lib "python-keystoneclient"
492 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 +0100493 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500494}
495
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700496# install_keystonemiddleware() - Collect source and prepare
497function install_keystonemiddleware {
Dean Troyerf8ae6472015-02-17 11:05:06 -0600498 # install_keystonemiddleware() is called when keystonemiddleware is needed
499 # to provide an opportunity to install it from the source repo
Sean Dague658312c2014-11-14 11:35:56 -0500500 if use_library_from_git "keystonemiddleware"; then
501 git_clone_by_name "keystonemiddleware"
502 setup_dev_lib "keystonemiddleware"
Dean Troyerf8ae6472015-02-17 11:05:06 -0600503 else
504 # When not installing from repo, keystonemiddleware is still needed...
Sean Dague60996b12015-04-08 09:06:49 -0400505 pip_install_gr keystonemiddleware
Sean Dague658312c2014-11-14 11:35:56 -0500506 fi
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700507}
508
Dean Troyerd81a0272012-08-31 18:04:55 -0500509# install_keystone() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100510function install_keystone {
Brad Topolf127e2f2013-01-22 10:17:50 -0600511 # only install ldap if the service has been enabled
512 if is_service_enabled ldap; then
513 install_ldap
514 fi
Peter Feiner61ae7c12013-11-15 10:42:30 -0500515 if [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
516 # Install memcached and the memcache Python library that keystone uses.
517 # Unfortunately the Python library goes by different names in the .deb
518 # and .rpm circles.
519 install_package memcached
520 if is_ubuntu; then
521 install_package python-memcache
522 else
523 install_package python-memcached
524 fi
525 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500526 git_clone $KEYSTONE_REPO $KEYSTONE_DIR $KEYSTONE_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400527 setup_develop $KEYSTONE_DIR
Morgan Fainberg46455a32014-06-20 10:37:18 -0700528 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000529 install_apache_wsgi
Rob Crittenden18d47782014-03-19 17:47:42 -0400530 if is_ssl_enabled_service "key"; then
531 enable_mod_ssl
532 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000533 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500534}
535
536# start_keystone() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100537function start_keystone {
Dean Troyerc83a7e12012-11-29 11:47:58 -0600538 # Get right service port for testing
539 local service_port=$KEYSTONE_SERVICE_PORT
Rob Crittenden18d47782014-03-19 17:47:42 -0400540 local auth_protocol=$KEYSTONE_AUTH_PROTOCOL
Dean Troyerc83a7e12012-11-29 11:47:58 -0600541 if is_service_enabled tls-proxy; then
542 service_port=$KEYSTONE_SERVICE_PORT_INT
Rob Crittenden18d47782014-03-19 17:47:42 -0400543 auth_protocol="http"
Dean Troyerc83a7e12012-11-29 11:47:58 -0600544 fi
545
Morgan Fainberg46455a32014-06-20 10:37:18 -0700546 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700547 enable_apache_site keystone
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000548 restart_apache_server
Chris Dent2f27a0e2014-09-09 13:46:02 +0100549 tail_log key /var/log/$APACHE_NAME/keystone.log
550 tail_log key-access /var/log/$APACHE_NAME/keystone_access.log
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000551 else
552 # Start Keystone in a screen window
Dean Troyerf8ae6472015-02-17 11:05:06 -0600553 run_process key "$KEYSTONE_BIN_DIR/keystone-all --config-file $KEYSTONE_CONF"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000554 fi
555
Dean Troyerd835de82012-11-29 17:11:35 -0600556 echo "Waiting for keystone to start..."
Stanislaw Pituchabe4c9532014-06-11 17:52:49 +0100557 # Check that the keystone service is running. Even if the tls tunnel
558 # should be enabled, make sure the internal port is checked using
559 # unencryted traffic at this point.
sridhargaddamb5ab6462015-02-24 07:23:24 +0000560 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 -0400561 die $LINENO "keystone did not start"
Dean Troyerd835de82012-11-29 17:11:35 -0600562 fi
Dean Troyerc83a7e12012-11-29 11:47:58 -0600563
564 # Start proxies if enabled
565 if is_service_enabled tls-proxy; then
566 start_tls_proxy '*' $KEYSTONE_SERVICE_PORT $KEYSTONE_SERVICE_HOST $KEYSTONE_SERVICE_PORT_INT &
567 start_tls_proxy '*' $KEYSTONE_AUTH_PORT $KEYSTONE_AUTH_HOST $KEYSTONE_AUTH_PORT_INT &
568 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500569}
570
571# stop_keystone() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100572function stop_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700573 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
574 disable_apache_site keystone
575 restart_apache_server
576 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500577 # Kill the Keystone screen window
Chris Dent2f27a0e2014-09-09 13:46:02 +0100578 stop_process key
Dean Troyerd81a0272012-08-31 18:04:55 -0500579}
Dean Troyer7903b792012-09-13 17:16:12 -0500580
Dean Troyer1a6d4492013-06-03 16:47:36 -0500581
Dean Troyer7903b792012-09-13 17:16:12 -0500582# Restore xtrace
583$XTRACE
Sean Dague584d90e2013-03-29 14:34:53 -0400584
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100585# Tell emacs to use shell-script-mode
586## Local variables:
587## mode: shell-script
588## End: