blob: 06f673559e79e3259505b62974b108296f009f83 [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``
Adam Gandelmanc4b06712014-09-03 11:44:31 -07009# - ``FILES``
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010010# - ``IDENTITY_API_VERSION``
11# - ``BASE_SQL_CONN``
12# - ``SERVICE_HOST``, ``SERVICE_PROTOCOL``
13# - ``SERVICE_TOKEN``
14# - ``S3_SERVICE_PORT`` (template backend only)
Dean Troyerd81a0272012-08-31 18:04:55 -050015
Dean Troyerd81a0272012-08-31 18:04:55 -050016# ``stack.sh`` calls the entry points in this order:
17#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010018# - install_keystone
19# - configure_keystone
20# - _config_keystone_apache_wsgi
21# - init_keystone
22# - start_keystone
23# - create_keystone_accounts
24# - stop_keystone
25# - cleanup_keystone
26# - _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -050027
Dean Troyer7903b792012-09-13 17:16:12 -050028# Save trace setting
29XTRACE=$(set +o | grep xtrace)
30set +o xtrace
Dean Troyerd81a0272012-08-31 18:04:55 -050031
Dean Troyerd81a0272012-08-31 18:04:55 -050032# Defaults
33# --------
34
Dean Troyerd81a0272012-08-31 18:04:55 -050035# Set up default directories
36KEYSTONE_DIR=$DEST/keystone
37KEYSTONE_CONF_DIR=${KEYSTONE_CONF_DIR:-/etc/keystone}
38KEYSTONE_CONF=$KEYSTONE_CONF_DIR/keystone.conf
Alan Pevece0bb4472013-03-12 11:10:52 +010039KEYSTONE_PASTE_INI=${KEYSTONE_PASTE_INI:-$KEYSTONE_CONF_DIR/keystone-paste.ini}
Dean Troyerbc071bc2012-10-01 14:06:44 -050040KEYSTONE_AUTH_CACHE_DIR=${KEYSTONE_AUTH_CACHE_DIR:-/var/cache/keystone}
Jamie Lennoxa00e5f82013-09-17 12:47:03 +100041KEYSTONE_WSGI_DIR=${KEYSTONE_WSGI_DIR:-/var/www/keystone}
Dean Troyerd81a0272012-08-31 18:04:55 -050042
Morgan Fainberg58936fd2014-06-24 12:26:07 -070043KEYSTONEMIDDLEWARE_DIR=$DEST/keystonemiddleware
Dean Troyerd81a0272012-08-31 18:04:55 -050044KEYSTONECLIENT_DIR=$DEST/python-keystoneclient
45
Julien Vey00da58a2014-05-27 15:51:49 +020046# Set up additional extensions, such as oauth1, federation
47# Example of KEYSTONE_EXTENSIONS=oauth1,federation
48KEYSTONE_EXTENSIONS=${KEYSTONE_EXTENSIONS:-}
49
Morgan Fainberg46455a32014-06-20 10:37:18 -070050# Toggle for deploying Keystone under HTTPD + mod_wsgi
Morgan Fainberge6dd4e62014-06-25 17:25:25 -070051KEYSTONE_USE_MOD_WSGI=${KEYSTONE_USE_MOD_WSGI:-${ENABLE_HTTPD_MOD_WSGI_SERVICES}}
Morgan Fainberg46455a32014-06-20 10:37:18 -070052
Dean Troyerbc071bc2012-10-01 14:06:44 -050053# Select the backend for Keystone's service catalog
Dean Troyerb80379c2012-09-10 18:30:37 -050054KEYSTONE_CATALOG_BACKEND=${KEYSTONE_CATALOG_BACKEND:-sql}
Dean Troyerd81a0272012-08-31 18:04:55 -050055KEYSTONE_CATALOG=$KEYSTONE_CONF_DIR/default_catalog.templates
56
Davanum Srinivas5bd96f92013-01-29 15:12:20 -050057# Select the backend for Tokens
58KEYSTONE_TOKEN_BACKEND=${KEYSTONE_TOKEN_BACKEND:-sql}
59
Alex Rudenkocd770582013-09-01 16:26:03 +020060# Select the backend for Identity
61KEYSTONE_IDENTITY_BACKEND=${KEYSTONE_IDENTITY_BACKEND:-sql}
62
63# Select the backend for Assignment
64KEYSTONE_ASSIGNMENT_BACKEND=${KEYSTONE_ASSIGNMENT_BACKEND:-sql}
65
Dean Troyerbc071bc2012-10-01 14:06:44 -050066# Select Keystone's token format
Brant Knudson754c4402014-06-04 09:06:01 -050067# Choose from 'UUID', 'PKI', or 'PKIZ'
Brant Knudson1e1fce82014-06-19 16:55:45 -050068KEYSTONE_TOKEN_FORMAT=$(echo ${KEYSTONE_TOKEN_FORMAT} | tr '[:upper:]' '[:lower:]')
Dean Troyerbc071bc2012-10-01 14:06:44 -050069
Dean Troyerd81a0272012-08-31 18:04:55 -050070# Set Keystone interface configuration
Dean Troyerd81a0272012-08-31 18:04:55 -050071KEYSTONE_AUTH_HOST=${KEYSTONE_AUTH_HOST:-$SERVICE_HOST}
72KEYSTONE_AUTH_PORT=${KEYSTONE_AUTH_PORT:-35357}
Dean Troyerc83a7e12012-11-29 11:47:58 -060073KEYSTONE_AUTH_PORT_INT=${KEYSTONE_AUTH_PORT_INT:-35358}
74KEYSTONE_AUTH_PROTOCOL=${KEYSTONE_AUTH_PROTOCOL:-$SERVICE_PROTOCOL}
75
76# Public facing bits
Dean Troyerd81a0272012-08-31 18:04:55 -050077KEYSTONE_SERVICE_HOST=${KEYSTONE_SERVICE_HOST:-$SERVICE_HOST}
78KEYSTONE_SERVICE_PORT=${KEYSTONE_SERVICE_PORT:-5000}
Dean Troyerc83a7e12012-11-29 11:47:58 -060079KEYSTONE_SERVICE_PORT_INT=${KEYSTONE_SERVICE_PORT_INT:-5001}
80KEYSTONE_SERVICE_PROTOCOL=${KEYSTONE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Dean Troyerd81a0272012-08-31 18:04:55 -050081
David Kranz041fa712014-02-24 13:30:59 -050082# Bind hosts
83KEYSTONE_ADMIN_BIND_HOST=${KEYSTONE_ADMIN_BIND_HOST:-$KEYSTONE_SERVICE_HOST}
Dean Troyerb7490da2013-03-18 16:07:56 -050084# Set the tenant for service accounts in Keystone
85SERVICE_TENANT_NAME=${SERVICE_TENANT_NAME:-service}
86
Alex Rudenkocd770582013-09-01 16:26:03 +020087# valid identity backends as per dir keystone/identity/backends
88KEYSTONE_VALID_IDENTITY_BACKENDS=kvs,ldap,pam,sql
89
90# valid assignment backends as per dir keystone/identity/backends
91KEYSTONE_VALID_ASSIGNMENT_BACKENDS=kvs,ldap,sql
Dean Troyerd81a0272012-08-31 18:04:55 -050092
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100093# if we are running with SSL use https protocols
94if is_ssl_enabled_service "key"; then
95 KEYSTONE_AUTH_PROTOCOL="https"
96 KEYSTONE_SERVICE_PROTOCOL="https"
97fi
98
Jamie Lennox3561d7f2014-05-21 17:18:43 +100099# complete URIs
100KEYSTONE_AUTH_URI=${KEYSTONE_AUTH_PROTOCOL}://${KEYSTONE_AUTH_HOST}:${KEYSTONE_AUTH_PORT}
101KEYSTONE_SERVICE_URI=${KEYSTONE_SERVICE_PROTOCOL}://${KEYSTONE_SERVICE_HOST}:${KEYSTONE_SERVICE_PORT}
102
Dean Troyercc6b4432013-04-08 15:38:03 -0500103# Functions
104# ---------
Dean Troyerd81a0272012-08-31 18:04:55 -0500105# cleanup_keystone() - Remove residual data files, anything left over from previous
106# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100107function cleanup_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700108 _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -0500109}
110
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000111# _cleanup_keystone_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
Ian Wienandaee18c72014-02-21 15:35:08 +1100112function _cleanup_keystone_apache_wsgi {
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000113 sudo rm -f $KEYSTONE_WSGI_DIR/*.wsgi
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)
Morgan Fainbergd074dc72014-06-24 21:33:39 -0700122 local apache_version=$(get_apache_version)
123
124 if [[ ${apache_version#*\.} -ge 4 ]]; then
125 # Apache 2.4 supports custom error log formats
126 # this should mirror the original log formatting.
127 local errorlogformat='ErrorLogFormat "%{cu}t %M"'
128 fi
Morgan Fainberg970ee902014-06-09 12:07:29 -0700129
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000130 # copy proxy vhost and wsgi file
131 sudo cp $KEYSTONE_DIR/httpd/keystone.py $KEYSTONE_WSGI_DIR/main
132 sudo cp $KEYSTONE_DIR/httpd/keystone.py $KEYSTONE_WSGI_DIR/admin
133
Morgan Fainberg970ee902014-06-09 12:07:29 -0700134 sudo cp $FILES/apache-keystone.template $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000135 sudo sed -e "
136 s|%PUBLICPORT%|$KEYSTONE_SERVICE_PORT|g;
137 s|%ADMINPORT%|$KEYSTONE_AUTH_PORT|g;
138 s|%APACHE_NAME%|$APACHE_NAME|g;
139 s|%PUBLICWSGI%|$KEYSTONE_WSGI_DIR/main|g;
140 s|%ADMINWSGI%|$KEYSTONE_WSGI_DIR/admin|g;
141 s|%USER%|$STACK_USER|g
Morgan Fainbergd074dc72014-06-24 21:33:39 -0700142 s|%ERRORLOGFORMAT%|$errorlogformat|g;
Morgan Fainberg970ee902014-06-09 12:07:29 -0700143 " -i $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000144}
145
Dean Troyerd81a0272012-08-31 18:04:55 -0500146# configure_keystone() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100147function configure_keystone {
Dean Troyerd81a0272012-08-31 18:04:55 -0500148 if [[ ! -d $KEYSTONE_CONF_DIR ]]; then
149 sudo mkdir -p $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500150 fi
Attila Fazekas91b8d132013-01-06 22:40:09 +0100151 sudo chown $STACK_USER $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500152
153 if [[ "$KEYSTONE_CONF_DIR" != "$KEYSTONE_DIR/etc" ]]; then
154 cp -p $KEYSTONE_DIR/etc/keystone.conf.sample $KEYSTONE_CONF
Dean Troyerd561b702013-10-22 17:46:00 -0500155 chmod 600 $KEYSTONE_CONF
Dean Troyerd81a0272012-08-31 18:04:55 -0500156 cp -p $KEYSTONE_DIR/etc/policy.json $KEYSTONE_CONF_DIR
Alan Pevece0bb4472013-03-12 11:10:52 +0100157 if [[ -f "$KEYSTONE_DIR/etc/keystone-paste.ini" ]]; then
158 cp -p "$KEYSTONE_DIR/etc/keystone-paste.ini" "$KEYSTONE_PASTE_INI"
159 fi
160 fi
161 if [[ -f "$KEYSTONE_PASTE_INI" ]]; then
162 iniset "$KEYSTONE_CONF" paste_deploy config_file "$KEYSTONE_PASTE_INI"
163 else
164 # compatibility with mixed cfg and paste.deploy configuration
165 KEYSTONE_PASTE_INI="$KEYSTONE_CONF"
Dean Troyerd81a0272012-08-31 18:04:55 -0500166 fi
167
Julien Vey00da58a2014-05-27 15:51:49 +0200168 configure_keystone_extensions
169
Dean Troyerd81a0272012-08-31 18:04:55 -0500170 # Rewrite stock ``keystone.conf``
Dean Troyerc83a7e12012-11-29 11:47:58 -0600171
Brad Topolf127e2f2013-01-22 10:17:50 -0600172 if is_service_enabled ldap; then
173 #Set all needed ldap values
Dean Troyerb9e25132013-10-01 14:45:04 -0500174 iniset $KEYSTONE_CONF ldap password $LDAP_PASSWORD
175 iniset $KEYSTONE_CONF ldap user $LDAP_MANAGER_DN
176 iniset $KEYSTONE_CONF ldap suffix $LDAP_BASE_DN
Brad Topolf41024e2013-02-19 15:36:41 -0600177 iniset $KEYSTONE_CONF ldap use_dumb_member "True"
Morgan Fainberg2dc11fb2013-09-24 23:43:08 -0700178 iniset $KEYSTONE_CONF ldap user_attribute_ignore "enabled,email,tenants,default_project_id"
Brad Topolf41024e2013-02-19 15:36:41 -0600179 iniset $KEYSTONE_CONF ldap tenant_attribute_ignore "enabled"
180 iniset $KEYSTONE_CONF ldap tenant_domain_id_attribute "businessCategory"
181 iniset $KEYSTONE_CONF ldap tenant_desc_attribute "description"
Dean Troyerb9e25132013-10-01 14:45:04 -0500182 iniset $KEYSTONE_CONF ldap tenant_tree_dn "ou=Projects,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600183 iniset $KEYSTONE_CONF ldap user_domain_id_attribute "businessCategory"
Dean Troyerb9e25132013-10-01 14:45:04 -0500184 iniset $KEYSTONE_CONF ldap user_tree_dn "ou=Users,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600185 iniset $KEYSTONE_CONF DEFAULT member_role_id "9fe2ff9ee4384b1894a90878d3e92bab"
186 iniset $KEYSTONE_CONF DEFAULT member_role_name "_member_"
Brad Topolf127e2f2013-01-22 10:17:50 -0600187 fi
188
Alex Rudenkocd770582013-09-01 16:26:03 +0200189 # check if identity backend is valid
190 if [[ "$KEYSTONE_VALID_IDENTITY_BACKENDS" =~ "$KEYSTONE_IDENTITY_BACKEND" ]]; then
191 iniset $KEYSTONE_CONF identity driver "keystone.identity.backends.$KEYSTONE_IDENTITY_BACKEND.Identity"
192 fi
193
194 # check if assignment backend is valid
195 if [[ "$KEYSTONE_VALID_ASSIGNMENT_BACKENDS" =~ "$KEYSTONE_ASSIGNMENT_BACKEND" ]]; then
196 iniset $KEYSTONE_CONF assignment driver "keystone.assignment.backends.$KEYSTONE_ASSIGNMENT_BACKEND.Assignment"
Brad Topolf127e2f2013-01-22 10:17:50 -0600197 fi
198
Sergey Skripnick8464a4c2014-07-08 21:05:23 +0300199 # Configure rabbitmq credentials
200 if is_service_enabled rabbit; then
201 iniset $KEYSTONE_CONF DEFAULT rabbit_password $RABBIT_PASSWORD
202 iniset $KEYSTONE_CONF DEFAULT rabbit_host $RABBIT_HOST
203 fi
204
Dean Troyer245a4312013-06-28 09:16:08 -0500205 # Set the URL advertised in the ``versions`` structure returned by the '/' route
206 iniset $KEYSTONE_CONF DEFAULT public_endpoint "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:%(public_port)s/"
207 iniset $KEYSTONE_CONF DEFAULT admin_endpoint "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:%(admin_port)s/"
David Kranz041fa712014-02-24 13:30:59 -0500208 iniset $KEYSTONE_CONF DEFAULT admin_bind_host "$KEYSTONE_ADMIN_BIND_HOST"
Dean Troyer245a4312013-06-28 09:16:08 -0500209
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000210 # Register SSL certificates if provided
211 if is_ssl_enabled_service key; then
212 ensure_certificates KEYSTONE
213
214 iniset $KEYSTONE_CONF ssl enable True
215 iniset $KEYSTONE_CONF ssl certfile $KEYSTONE_SSL_CERT
216 iniset $KEYSTONE_CONF ssl keyfile $KEYSTONE_SSL_KEY
217 fi
218
Dean Troyerc83a7e12012-11-29 11:47:58 -0600219 if is_service_enabled tls-proxy; then
220 # Set the service ports for a proxy to take the originals
221 iniset $KEYSTONE_CONF DEFAULT public_port $KEYSTONE_SERVICE_PORT_INT
222 iniset $KEYSTONE_CONF DEFAULT admin_port $KEYSTONE_AUTH_PORT_INT
223 fi
224
Dean Troyerd81a0272012-08-31 18:04:55 -0500225 iniset $KEYSTONE_CONF DEFAULT admin_token "$SERVICE_TOKEN"
Sudarshan Acharya37631412013-07-16 00:47:54 +0000226
Brant Knudson1e1fce82014-06-19 16:55:45 -0500227 if [[ "$KEYSTONE_TOKEN_FORMAT" != "" ]]; then
228 iniset $KEYSTONE_CONF token provider keystone.token.providers.$KEYSTONE_TOKEN_FORMAT.Provider
Sudarshan Acharya37631412013-07-16 00:47:54 +0000229 fi
230
Brant Knudson16d3ad02014-02-13 18:59:50 -0600231 iniset $KEYSTONE_CONF database connection `database_connection_url keystone`
Dean Troyerd81a0272012-08-31 18:04:55 -0500232 iniset $KEYSTONE_CONF ec2 driver "keystone.contrib.ec2.backends.sql.Ec2"
Dean Troyerd81a0272012-08-31 18:04:55 -0500233
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500234 if [[ "$KEYSTONE_TOKEN_BACKEND" = "sql" ]]; then
Morgan Fainberg947d7462014-08-29 13:26:31 -0700235 iniset $KEYSTONE_CONF token driver keystone.token.persistence.backends.sql.Token
Peter Feiner61ae7c12013-11-15 10:42:30 -0500236 elif [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
Morgan Fainberg947d7462014-08-29 13:26:31 -0700237 iniset $KEYSTONE_CONF token driver keystone.token.persistence.backends.memcache.Token
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500238 else
Morgan Fainberg947d7462014-08-29 13:26:31 -0700239 iniset $KEYSTONE_CONF token driver keystone.token.persistence.backends.kvs.Token
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500240 fi
241
Dean Troyerd81a0272012-08-31 18:04:55 -0500242 if [[ "$KEYSTONE_CATALOG_BACKEND" = "sql" ]]; then
243 # Configure ``keystone.conf`` to use sql
244 iniset $KEYSTONE_CONF catalog driver keystone.catalog.backends.sql.Catalog
245 inicomment $KEYSTONE_CONF catalog template_file
246 else
247 cp -p $FILES/default_catalog.templates $KEYSTONE_CATALOG
248
249 # Add swift endpoints to service catalog if swift is enabled
Chmouel Boudjnah0c3a5582013-03-06 10:58:33 +0100250 if is_service_enabled s-proxy; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500251 echo "catalog.RegionOne.object_store.publicURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
252 echo "catalog.RegionOne.object_store.adminURL = http://%SERVICE_HOST%:8080/" >> $KEYSTONE_CATALOG
253 echo "catalog.RegionOne.object_store.internalURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
254 echo "catalog.RegionOne.object_store.name = Swift Service" >> $KEYSTONE_CATALOG
255 fi
256
Mark McClainb05c8762013-07-06 23:29:39 -0400257 # Add neutron endpoints to service catalog if neutron is enabled
258 if is_service_enabled neutron; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500259 echo "catalog.RegionOne.network.publicURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
260 echo "catalog.RegionOne.network.adminURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
261 echo "catalog.RegionOne.network.internalURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
Mark McClainb05c8762013-07-06 23:29:39 -0400262 echo "catalog.RegionOne.network.name = Neutron Service" >> $KEYSTONE_CATALOG
Dean Troyerd81a0272012-08-31 18:04:55 -0500263 fi
264
Vincent Untz7e86dbe2012-12-13 08:50:37 +0100265 sed -e "
Dean Troyerd81a0272012-08-31 18:04:55 -0500266 s,%SERVICE_HOST%,$SERVICE_HOST,g;
267 s,%S3_SERVICE_PORT%,$S3_SERVICE_PORT,g;
268 " -i $KEYSTONE_CATALOG
269
270 # Configure ``keystone.conf`` to use templates
271 iniset $KEYSTONE_CONF catalog driver "keystone.catalog.backends.templated.TemplatedCatalog"
272 iniset $KEYSTONE_CONF catalog template_file "$KEYSTONE_CATALOG"
273 fi
274
275 # Set up logging
Dean Troyerd81a0272012-08-31 18:04:55 -0500276 if [ "$SYSLOG" != "False" ]; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600277 iniset $KEYSTONE_CONF DEFAULT use_syslog "True"
Dean Troyerd81a0272012-08-31 18:04:55 -0500278 fi
Brant Knudson4968d1a2014-01-22 19:06:44 -0600279
280 # Format logging
Morgan Fainberg46455a32014-06-20 10:37:18 -0700281 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && [ "$KEYSTONE_USE_MOD_WSGI" == "False" ] ; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600282 setup_colorized_logging $KEYSTONE_CONF DEFAULT
283 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000284
Morgan Fainberg46455a32014-06-20 10:37:18 -0700285 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Morgan Fainberg2c2b1cc2014-05-01 22:05:41 -0700286 iniset $KEYSTONE_CONF DEFAULT debug "True"
287 # Eliminate the %(asctime)s.%(msecs)03d from the log format strings
288 iniset $KEYSTONE_CONF DEFAULT logging_context_format_string "%(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s"
289 iniset $KEYSTONE_CONF DEFAULT logging_default_format_string "%(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s"
290 iniset $KEYSTONE_CONF DEFAULT logging_debug_format_suffix "%(funcName)s %(pathname)s:%(lineno)d"
291 iniset $KEYSTONE_CONF DEFAULT logging_exception_prefix "%(process)d TRACE %(name)s %(instance)s"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000292 _config_keystone_apache_wsgi
293 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100294
295 iniset $KEYSTONE_CONF DEFAULT max_token_size 16384
Brant Knudson85a17ea2014-09-13 14:49:24 -0500296
297 iniset $KEYSTONE_CONF DEFAULT admin_workers "$API_WORKERS"
298 # Public workers will use the server default, typically number of CPU.
Brant Knudson3951a942014-08-24 18:54:51 -0500299
300 if [[ -n "$KEYSTONE_TOKEN_HASH_ALGORITHM" ]]; then
301 iniset $KEYSTONE_CONF token hash_algorithm "$KEYSTONE_TOKEN_HASH_ALGORITHM"
302 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500303}
304
Julien Vey00da58a2014-05-27 15:51:49 +0200305function configure_keystone_extensions {
306 # Add keystone extension into keystone v3 application pipeline
307 local extension_value
308 local api_v3
309 local extension
310 local api_v3_extension
311 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
312 if [[ -z "${extension_value}" ]]; then
313 continue
314 fi
315 api_v3=$(iniget $KEYSTONE_PASTE_INI pipeline:api_v3 pipeline)
316 extension=$(echo $api_v3 | sed -ne "/${extension_value}/ p;" )
317 if [[ -z $extension ]]; then
318 api_v3_extension=$(echo $api_v3 | sed -ne "s/service_v3/${extension_value}_extension service_v3/p;" )
319 iniset $KEYSTONE_PASTE_INI pipeline:api_v3 pipeline "$api_v3_extension"
320 fi
321 done
322}
323
Dean Troyerd835de82012-11-29 17:11:35 -0600324# create_keystone_accounts() - Sets up common required keystone accounts
325
326# Tenant User Roles
327# ------------------------------------------------------------------
Dean Troyerd835de82012-11-29 17:11:35 -0600328# admin admin admin
Dean Troyer42a59c22014-03-03 14:31:29 -0600329# service -- --
330# -- -- service
331# -- -- ResellerAdmin
332# -- -- Member
Dean Troyerd835de82012-11-29 17:11:35 -0600333# demo admin admin
334# demo demo Member, anotherrole
335# invisible_to_admin demo Member
336
337# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100338function create_keystone_accounts {
Dean Troyerd835de82012-11-29 17:11:35 -0600339
340 # admin
Dean Troyerc50c9832014-07-25 13:40:25 -0500341 local admin_tenant=$(get_or_create_project "admin")
342 local admin_user=$(get_or_create_user "admin" \
343 "$ADMIN_PASSWORD" "$admin_tenant")
344 local admin_role=$(get_or_create_role "admin")
345 get_or_add_user_role $admin_role $admin_user $admin_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600346
Dean Troyer42a59c22014-03-03 14:31:29 -0600347 # Create service project/role
Bartosz Górski0abde392014-02-28 14:15:19 +0100348 get_or_create_project "$SERVICE_TENANT_NAME"
Dean Troyer42a59c22014-03-03 14:31:29 -0600349
350 # Service role, so service users do not have to be admins
Bartosz Górski0abde392014-02-28 14:15:19 +0100351 get_or_create_role service
Dean Troyer42a59c22014-03-03 14:31:29 -0600352
353 # The ResellerAdmin role is used by Nova and Ceilometer so we need to keep it.
354 # The admin role in swift allows a user to act as an admin for their tenant,
355 # but ResellerAdmin is needed for a user to act as any tenant. The name of this
356 # role is also configurable in swift-proxy.conf
Bartosz Górski0abde392014-02-28 14:15:19 +0100357 get_or_create_role ResellerAdmin
Dean Troyerd835de82012-11-29 17:11:35 -0600358
359 # The Member role is used by Horizon and Swift so we need to keep it:
Dean Troyerc50c9832014-07-25 13:40:25 -0500360 local member_role=$(get_or_create_role "Member")
Bartosz Górski0abde392014-02-28 14:15:19 +0100361
Masayuki Igawad3654052014-09-01 17:30:05 +0900362 # another_role demonstrates that an arbitrary role may be created and used
Dean Troyerd835de82012-11-29 17:11:35 -0600363 # TODO(sleepsonthefloor): show how this can be used for rbac in the future!
Dean Troyerc50c9832014-07-25 13:40:25 -0500364 local another_role=$(get_or_create_role "anotherrole")
Dean Troyerd835de82012-11-29 17:11:35 -0600365
366 # invisible tenant - admin can't see this one
Dean Troyerc50c9832014-07-25 13:40:25 -0500367 local invis_tenant=$(get_or_create_project "invisible_to_admin")
Dean Troyerd835de82012-11-29 17:11:35 -0600368
369 # demo
Dean Troyerc50c9832014-07-25 13:40:25 -0500370 local demo_tenant=$(get_or_create_project "demo")
371 local demo_user=$(get_or_create_user "demo" \
372 "$ADMIN_PASSWORD" "$demo_tenant" "demo@example.com")
Steve Martinelli19685422014-01-24 13:02:26 -0600373
Dean Troyerc50c9832014-07-25 13:40:25 -0500374 get_or_add_user_role $member_role $demo_user $demo_tenant
375 get_or_add_user_role $admin_role $admin_user $demo_tenant
376 get_or_add_user_role $another_role $demo_user $demo_tenant
377 get_or_add_user_role $member_role $demo_user $invis_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600378
379 # Keystone
380 if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100381
382 KEYSTONE_SERVICE=$(get_or_create_service "keystone" \
383 "identity" "Keystone Identity Service")
384 get_or_create_endpoint $KEYSTONE_SERVICE \
385 "$REGION_NAME" \
386 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION" \
387 "$KEYSTONE_AUTH_PROTOCOL://$KEYSTONE_AUTH_HOST:$KEYSTONE_AUTH_PORT/v$IDENTITY_API_VERSION" \
388 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION"
Dean Troyerd835de82012-11-29 17:11:35 -0600389 fi
Dean Troyerd835de82012-11-29 17:11:35 -0600390}
391
Vincent Hou21fe4e72013-11-21 03:10:27 -0500392# Configure the API version for the OpenStack projects.
Brant Knudson05952372014-09-19 17:22:22 -0500393# configure_API_version conf_file version [section]
Ian Wienandaee18c72014-02-21 15:35:08 +1100394function configure_API_version {
Vincent Hou21fe4e72013-11-21 03:10:27 -0500395 local conf_file=$1
396 local api_version=$2
Brant Knudson05952372014-09-19 17:22:22 -0500397 local section=${3:-keystone_authtoken}
398 iniset $conf_file $section auth_uri $KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$api_version
399}
400
401# Configure the service to use the auth token middleware.
402#
403# configure_auth_token_middleware conf_file admin_user signing_dir [section]
404#
405# section defaults to keystone_authtoken, which is where auth_token looks in
406# the .conf file. If the paste config file is used (api-paste.ini) then
407# provide the section name for the auth_token filter.
408function configure_auth_token_middleware {
409 local conf_file=$1
410 local admin_user=$2
411 local signing_dir=$3
412 local section=${4:-keystone_authtoken}
413
414 iniset $conf_file $section auth_host $KEYSTONE_AUTH_HOST
415 iniset $conf_file $section auth_port $KEYSTONE_AUTH_PORT
416 iniset $conf_file $section auth_protocol $KEYSTONE_AUTH_PROTOCOL
417 iniset $conf_file $section identity_uri $KEYSTONE_AUTH_URI
418 iniset $conf_file $section cafile $KEYSTONE_SSL_CA
419 configure_API_version $conf_file $IDENTITY_API_VERSION $section
420 iniset $conf_file $section admin_tenant_name $SERVICE_TENANT_NAME
421 iniset $conf_file $section admin_user $admin_user
422 iniset $conf_file $section admin_password $SERVICE_PASSWORD
423 iniset $conf_file $section signing_dir $signing_dir
Brant Knudson3951a942014-08-24 18:54:51 -0500424 if [[ -n "$KEYSTONE_TOKEN_HASH_ALGORITHM" ]]; then
425 iniset $conf_file keystone_authtoken hash_algorithms "$KEYSTONE_TOKEN_HASH_ALGORITHM"
426 fi
Vincent Hou21fe4e72013-11-21 03:10:27 -0500427}
428
Dean Troyerd81a0272012-08-31 18:04:55 -0500429# init_keystone() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100430function init_keystone {
Dean Troyerb9e25132013-10-01 14:45:04 -0500431 if is_service_enabled ldap; then
432 init_ldap
433 fi
434
Dean Troyerd81a0272012-08-31 18:04:55 -0500435 # (Re)create keystone database
Terry Wilson428af5a2012-11-01 16:12:39 -0400436 recreate_database keystone utf8
Dean Troyerd81a0272012-08-31 18:04:55 -0500437
438 # Initialize keystone database
439 $KEYSTONE_DIR/bin/keystone-manage db_sync
440
Julien Vey00da58a2014-05-27 15:51:49 +0200441 local extension_value
442 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
443 if [[ -z "${extension_value}" ]]; then
444 continue
445 fi
446 $KEYSTONE_DIR/bin/keystone-manage db_sync --extension "${extension_value}"
447 done
448
Brant Knudson1e1fce82014-06-19 16:55:45 -0500449 if [[ "$KEYSTONE_TOKEN_FORMAT" != "uuid" ]]; then
Dean Troyerbc071bc2012-10-01 14:06:44 -0500450 # Set up certificates
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800451 rm -rf $KEYSTONE_CONF_DIR/ssl
Dean Troyerbc071bc2012-10-01 14:06:44 -0500452 $KEYSTONE_DIR/bin/keystone-manage pki_setup
453
454 # Create cache dir
455 sudo mkdir -p $KEYSTONE_AUTH_CACHE_DIR
Attila Fazekas91b8d132013-01-06 22:40:09 +0100456 sudo chown $STACK_USER $KEYSTONE_AUTH_CACHE_DIR
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800457 rm -f $KEYSTONE_AUTH_CACHE_DIR/*
Dean Troyerbc071bc2012-10-01 14:06:44 -0500458 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500459}
460
461# install_keystoneclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100462function install_keystoneclient {
Dean Troyerd81a0272012-08-31 18:04:55 -0500463 git_clone $KEYSTONECLIENT_REPO $KEYSTONECLIENT_DIR $KEYSTONECLIENT_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400464 setup_develop $KEYSTONECLIENT_DIR
Attila Fazekasfac533e2013-08-14 16:04:01 +0200465 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 -0500466}
467
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700468# install_keystonemiddleware() - Collect source and prepare
469function install_keystonemiddleware {
470 git_clone $KEYSTONEMIDDLEWARE_REPO $KEYSTONEMIDDLEWARE_DIR $KEYSTONEMIDDLEWARE_BRANCH
471 setup_install $KEYSTONEMIDDLEWARE_DIR
472}
473
Dean Troyerd81a0272012-08-31 18:04:55 -0500474# install_keystone() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100475function install_keystone {
Brad Topolf127e2f2013-01-22 10:17:50 -0600476 # only install ldap if the service has been enabled
477 if is_service_enabled ldap; then
478 install_ldap
479 fi
Peter Feiner61ae7c12013-11-15 10:42:30 -0500480 if [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
481 # Install memcached and the memcache Python library that keystone uses.
482 # Unfortunately the Python library goes by different names in the .deb
483 # and .rpm circles.
484 install_package memcached
485 if is_ubuntu; then
486 install_package python-memcache
487 else
488 install_package python-memcached
489 fi
490 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500491 git_clone $KEYSTONE_REPO $KEYSTONE_DIR $KEYSTONE_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400492 setup_develop $KEYSTONE_DIR
Morgan Fainberg46455a32014-06-20 10:37:18 -0700493 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000494 install_apache_wsgi
495 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500496}
497
498# start_keystone() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100499function start_keystone {
Dean Troyerc83a7e12012-11-29 11:47:58 -0600500 # Get right service port for testing
501 local service_port=$KEYSTONE_SERVICE_PORT
502 if is_service_enabled tls-proxy; then
503 service_port=$KEYSTONE_SERVICE_PORT_INT
504 fi
505
Morgan Fainberg46455a32014-06-20 10:37:18 -0700506 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700507 enable_apache_site keystone
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000508 restart_apache_server
Chris Dent2f27a0e2014-09-09 13:46:02 +0100509 tail_log key /var/log/$APACHE_NAME/keystone.log
510 tail_log key-access /var/log/$APACHE_NAME/keystone_access.log
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000511 else
512 # Start Keystone in a screen window
Chris Dent2f27a0e2014-09-09 13:46:02 +0100513 run_process key "$KEYSTONE_DIR/bin/keystone-all --config-file $KEYSTONE_CONF --debug"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000514 fi
515
Dean Troyerd835de82012-11-29 17:11:35 -0600516 echo "Waiting for keystone to start..."
Stanislaw Pituchabe4c9532014-06-11 17:52:49 +0100517 # Check that the keystone service is running. Even if the tls tunnel
518 # should be enabled, make sure the internal port is checked using
519 # unencryted traffic at this point.
520 if ! timeout $SERVICE_TIMEOUT sh -c "while ! curl --noproxy '*' -k -s http://$KEYSTONE_SERVICE_HOST:$service_port/v$IDENTITY_API_VERSION/ >/dev/null; do sleep 1; done"; then
Sean Dague101b4242013-10-22 08:47:11 -0400521 die $LINENO "keystone did not start"
Dean Troyerd835de82012-11-29 17:11:35 -0600522 fi
Dean Troyerc83a7e12012-11-29 11:47:58 -0600523
524 # Start proxies if enabled
525 if is_service_enabled tls-proxy; then
526 start_tls_proxy '*' $KEYSTONE_SERVICE_PORT $KEYSTONE_SERVICE_HOST $KEYSTONE_SERVICE_PORT_INT &
527 start_tls_proxy '*' $KEYSTONE_AUTH_PORT $KEYSTONE_AUTH_HOST $KEYSTONE_AUTH_PORT_INT &
528 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500529}
530
531# stop_keystone() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100532function stop_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700533 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
534 disable_apache_site keystone
535 restart_apache_server
536 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500537 # Kill the Keystone screen window
Chris Dent2f27a0e2014-09-09 13:46:02 +0100538 stop_process key
Dean Troyerd81a0272012-08-31 18:04:55 -0500539}
Dean Troyer7903b792012-09-13 17:16:12 -0500540
Sean Dague4f3b66f2014-07-23 16:45:12 -0400541function is_keystone_enabled {
542 return is_service_enabled key
543}
Dean Troyer1a6d4492013-06-03 16:47:36 -0500544
Dean Troyer7903b792012-09-13 17:16:12 -0500545# Restore xtrace
546$XTRACE
Sean Dague584d90e2013-03-29 14:34:53 -0400547
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100548# Tell emacs to use shell-script-mode
549## Local variables:
550## mode: shell-script
551## End: