blob: da5cf895a95fb68e2fddff752c190d0780a1405d [file] [log] [blame]
Dean Troyerd81a0272012-08-31 18:04:55 -05001# lib/keystone
2# Functions to control the configuration and operation of **Keystone**
3
4# Dependencies:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01005#
6# - ``functions`` file
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +10007# - ``tls`` file
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01008# - ``DEST``, ``STACK_USER``
9# - ``IDENTITY_API_VERSION``
10# - ``BASE_SQL_CONN``
11# - ``SERVICE_HOST``, ``SERVICE_PROTOCOL``
12# - ``SERVICE_TOKEN``
13# - ``S3_SERVICE_PORT`` (template backend only)
Dean Troyerd81a0272012-08-31 18:04:55 -050014
Dean Troyerd81a0272012-08-31 18:04:55 -050015# ``stack.sh`` calls the entry points in this order:
16#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010017# - install_keystone
18# - configure_keystone
19# - _config_keystone_apache_wsgi
20# - init_keystone
21# - start_keystone
22# - create_keystone_accounts
23# - stop_keystone
24# - cleanup_keystone
25# - _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -050026
Dean Troyer7903b792012-09-13 17:16:12 -050027# Save trace setting
28XTRACE=$(set +o | grep xtrace)
29set +o xtrace
Dean Troyerd81a0272012-08-31 18:04:55 -050030
Dean Troyerd81a0272012-08-31 18:04:55 -050031# Defaults
32# --------
33
Dean Troyerd81a0272012-08-31 18:04:55 -050034# Set up default directories
35KEYSTONE_DIR=$DEST/keystone
36KEYSTONE_CONF_DIR=${KEYSTONE_CONF_DIR:-/etc/keystone}
37KEYSTONE_CONF=$KEYSTONE_CONF_DIR/keystone.conf
Alan Pevece0bb4472013-03-12 11:10:52 +010038KEYSTONE_PASTE_INI=${KEYSTONE_PASTE_INI:-$KEYSTONE_CONF_DIR/keystone-paste.ini}
Dean Troyerbc071bc2012-10-01 14:06:44 -050039KEYSTONE_AUTH_CACHE_DIR=${KEYSTONE_AUTH_CACHE_DIR:-/var/cache/keystone}
Jamie Lennoxa00e5f82013-09-17 12:47:03 +100040KEYSTONE_WSGI_DIR=${KEYSTONE_WSGI_DIR:-/var/www/keystone}
Dean Troyerd81a0272012-08-31 18:04:55 -050041
Morgan Fainberg58936fd2014-06-24 12:26:07 -070042KEYSTONEMIDDLEWARE_DIR=$DEST/keystonemiddleware
Dean Troyerd81a0272012-08-31 18:04:55 -050043KEYSTONECLIENT_DIR=$DEST/python-keystoneclient
44
Julien Vey00da58a2014-05-27 15:51:49 +020045# Set up additional extensions, such as oauth1, federation
46# Example of KEYSTONE_EXTENSIONS=oauth1,federation
47KEYSTONE_EXTENSIONS=${KEYSTONE_EXTENSIONS:-}
48
Morgan Fainberg46455a32014-06-20 10:37:18 -070049# Toggle for deploying Keystone under HTTPD + mod_wsgi
Morgan Fainberge6dd4e62014-06-25 17:25:25 -070050KEYSTONE_USE_MOD_WSGI=${KEYSTONE_USE_MOD_WSGI:-${ENABLE_HTTPD_MOD_WSGI_SERVICES}}
Morgan Fainberg46455a32014-06-20 10:37:18 -070051
Dean Troyerbc071bc2012-10-01 14:06:44 -050052# Select the backend for Keystone's service catalog
Dean Troyerb80379c2012-09-10 18:30:37 -050053KEYSTONE_CATALOG_BACKEND=${KEYSTONE_CATALOG_BACKEND:-sql}
Dean Troyerd81a0272012-08-31 18:04:55 -050054KEYSTONE_CATALOG=$KEYSTONE_CONF_DIR/default_catalog.templates
55
Davanum Srinivas5bd96f92013-01-29 15:12:20 -050056# Select the backend for Tokens
57KEYSTONE_TOKEN_BACKEND=${KEYSTONE_TOKEN_BACKEND:-sql}
58
Alex Rudenkocd770582013-09-01 16:26:03 +020059# Select the backend for Identity
60KEYSTONE_IDENTITY_BACKEND=${KEYSTONE_IDENTITY_BACKEND:-sql}
61
62# Select the backend for Assignment
63KEYSTONE_ASSIGNMENT_BACKEND=${KEYSTONE_ASSIGNMENT_BACKEND:-sql}
64
Dean Troyerbc071bc2012-10-01 14:06:44 -050065# Select Keystone's token format
Brant Knudson754c4402014-06-04 09:06:01 -050066# Choose from 'UUID', 'PKI', or 'PKIZ'
Brant Knudson1e1fce82014-06-19 16:55:45 -050067KEYSTONE_TOKEN_FORMAT=$(echo ${KEYSTONE_TOKEN_FORMAT} | tr '[:upper:]' '[:lower:]')
Dean Troyerbc071bc2012-10-01 14:06:44 -050068
Dean Troyerd81a0272012-08-31 18:04:55 -050069# Set Keystone interface configuration
Dean Troyerd81a0272012-08-31 18:04:55 -050070KEYSTONE_AUTH_HOST=${KEYSTONE_AUTH_HOST:-$SERVICE_HOST}
71KEYSTONE_AUTH_PORT=${KEYSTONE_AUTH_PORT:-35357}
Dean Troyerc83a7e12012-11-29 11:47:58 -060072KEYSTONE_AUTH_PORT_INT=${KEYSTONE_AUTH_PORT_INT:-35358}
73KEYSTONE_AUTH_PROTOCOL=${KEYSTONE_AUTH_PROTOCOL:-$SERVICE_PROTOCOL}
74
75# Public facing bits
Dean Troyerd81a0272012-08-31 18:04:55 -050076KEYSTONE_SERVICE_HOST=${KEYSTONE_SERVICE_HOST:-$SERVICE_HOST}
77KEYSTONE_SERVICE_PORT=${KEYSTONE_SERVICE_PORT:-5000}
Dean Troyerc83a7e12012-11-29 11:47:58 -060078KEYSTONE_SERVICE_PORT_INT=${KEYSTONE_SERVICE_PORT_INT:-5001}
79KEYSTONE_SERVICE_PROTOCOL=${KEYSTONE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Dean Troyerd81a0272012-08-31 18:04:55 -050080
David Kranz041fa712014-02-24 13:30:59 -050081# Bind hosts
82KEYSTONE_ADMIN_BIND_HOST=${KEYSTONE_ADMIN_BIND_HOST:-$KEYSTONE_SERVICE_HOST}
Dean Troyerb7490da2013-03-18 16:07:56 -050083# Set the tenant for service accounts in Keystone
84SERVICE_TENANT_NAME=${SERVICE_TENANT_NAME:-service}
85
Alex Rudenkocd770582013-09-01 16:26:03 +020086# valid identity backends as per dir keystone/identity/backends
87KEYSTONE_VALID_IDENTITY_BACKENDS=kvs,ldap,pam,sql
88
89# valid assignment backends as per dir keystone/identity/backends
90KEYSTONE_VALID_ASSIGNMENT_BACKENDS=kvs,ldap,sql
Dean Troyerd81a0272012-08-31 18:04:55 -050091
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100092# if we are running with SSL use https protocols
93if is_ssl_enabled_service "key"; then
94 KEYSTONE_AUTH_PROTOCOL="https"
95 KEYSTONE_SERVICE_PROTOCOL="https"
96fi
97
Jamie Lennox3561d7f2014-05-21 17:18:43 +100098# complete URIs
99KEYSTONE_AUTH_URI=${KEYSTONE_AUTH_PROTOCOL}://${KEYSTONE_AUTH_HOST}:${KEYSTONE_AUTH_PORT}
100KEYSTONE_SERVICE_URI=${KEYSTONE_SERVICE_PROTOCOL}://${KEYSTONE_SERVICE_HOST}:${KEYSTONE_SERVICE_PORT}
101
Dean Troyercc6b4432013-04-08 15:38:03 -0500102# Functions
103# ---------
Dean Troyerd81a0272012-08-31 18:04:55 -0500104# cleanup_keystone() - Remove residual data files, anything left over from previous
105# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100106function cleanup_keystone {
Dean Troyerd81a0272012-08-31 18:04:55 -0500107 # kill instances (nova)
108 # delete image files (glance)
109 # This function intentionally left blank
110 :
111}
112
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000113# _cleanup_keystone_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
Ian Wienandaee18c72014-02-21 15:35:08 +1100114function _cleanup_keystone_apache_wsgi {
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000115 sudo rm -f $KEYSTONE_WSGI_DIR/*.wsgi
116 disable_apache_site keystone
Morgan Fainberg970ee902014-06-09 12:07:29 -0700117 sudo rm -f $(apache_site_config_for keystone)
Morgan Fainberg46455a32014-06-20 10:37:18 -0700118 restart_apache_server
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000119}
120
121# _config_keystone_apache_wsgi() - Set WSGI config files of Keystone
Ian Wienandaee18c72014-02-21 15:35:08 +1100122function _config_keystone_apache_wsgi {
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000123 sudo mkdir -p $KEYSTONE_WSGI_DIR
124
Morgan Fainberg970ee902014-06-09 12:07:29 -0700125 local keystone_apache_conf=$(apache_site_config_for keystone)
Morgan Fainbergd074dc72014-06-24 21:33:39 -0700126 local apache_version=$(get_apache_version)
127
128 if [[ ${apache_version#*\.} -ge 4 ]]; then
129 # Apache 2.4 supports custom error log formats
130 # this should mirror the original log formatting.
131 local errorlogformat='ErrorLogFormat "%{cu}t %M"'
132 fi
Morgan Fainberg970ee902014-06-09 12:07:29 -0700133
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000134 # copy proxy vhost and wsgi file
135 sudo cp $KEYSTONE_DIR/httpd/keystone.py $KEYSTONE_WSGI_DIR/main
136 sudo cp $KEYSTONE_DIR/httpd/keystone.py $KEYSTONE_WSGI_DIR/admin
137
Morgan Fainberg970ee902014-06-09 12:07:29 -0700138 sudo cp $FILES/apache-keystone.template $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000139 sudo sed -e "
140 s|%PUBLICPORT%|$KEYSTONE_SERVICE_PORT|g;
141 s|%ADMINPORT%|$KEYSTONE_AUTH_PORT|g;
142 s|%APACHE_NAME%|$APACHE_NAME|g;
143 s|%PUBLICWSGI%|$KEYSTONE_WSGI_DIR/main|g;
144 s|%ADMINWSGI%|$KEYSTONE_WSGI_DIR/admin|g;
145 s|%USER%|$STACK_USER|g
Morgan Fainbergd074dc72014-06-24 21:33:39 -0700146 s|%ERRORLOGFORMAT%|$errorlogformat|g;
Morgan Fainberg970ee902014-06-09 12:07:29 -0700147 " -i $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000148 enable_apache_site keystone
149}
150
Dean Troyerd81a0272012-08-31 18:04:55 -0500151# configure_keystone() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100152function configure_keystone {
Dean Troyerd81a0272012-08-31 18:04:55 -0500153 if [[ ! -d $KEYSTONE_CONF_DIR ]]; then
154 sudo mkdir -p $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500155 fi
Attila Fazekas91b8d132013-01-06 22:40:09 +0100156 sudo chown $STACK_USER $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500157
158 if [[ "$KEYSTONE_CONF_DIR" != "$KEYSTONE_DIR/etc" ]]; then
159 cp -p $KEYSTONE_DIR/etc/keystone.conf.sample $KEYSTONE_CONF
Dean Troyerd561b702013-10-22 17:46:00 -0500160 chmod 600 $KEYSTONE_CONF
Dean Troyerd81a0272012-08-31 18:04:55 -0500161 cp -p $KEYSTONE_DIR/etc/policy.json $KEYSTONE_CONF_DIR
Alan Pevece0bb4472013-03-12 11:10:52 +0100162 if [[ -f "$KEYSTONE_DIR/etc/keystone-paste.ini" ]]; then
163 cp -p "$KEYSTONE_DIR/etc/keystone-paste.ini" "$KEYSTONE_PASTE_INI"
164 fi
165 fi
166 if [[ -f "$KEYSTONE_PASTE_INI" ]]; then
167 iniset "$KEYSTONE_CONF" paste_deploy config_file "$KEYSTONE_PASTE_INI"
168 else
169 # compatibility with mixed cfg and paste.deploy configuration
170 KEYSTONE_PASTE_INI="$KEYSTONE_CONF"
Dean Troyerd81a0272012-08-31 18:04:55 -0500171 fi
172
Julien Vey00da58a2014-05-27 15:51:49 +0200173 configure_keystone_extensions
174
Dean Troyerd81a0272012-08-31 18:04:55 -0500175 # Rewrite stock ``keystone.conf``
Dean Troyerc83a7e12012-11-29 11:47:58 -0600176
Brad Topolf127e2f2013-01-22 10:17:50 -0600177 if is_service_enabled ldap; then
178 #Set all needed ldap values
Dean Troyerb9e25132013-10-01 14:45:04 -0500179 iniset $KEYSTONE_CONF ldap password $LDAP_PASSWORD
180 iniset $KEYSTONE_CONF ldap user $LDAP_MANAGER_DN
181 iniset $KEYSTONE_CONF ldap suffix $LDAP_BASE_DN
Brad Topolf41024e2013-02-19 15:36:41 -0600182 iniset $KEYSTONE_CONF ldap use_dumb_member "True"
Morgan Fainberg2dc11fb2013-09-24 23:43:08 -0700183 iniset $KEYSTONE_CONF ldap user_attribute_ignore "enabled,email,tenants,default_project_id"
Brad Topolf41024e2013-02-19 15:36:41 -0600184 iniset $KEYSTONE_CONF ldap tenant_attribute_ignore "enabled"
185 iniset $KEYSTONE_CONF ldap tenant_domain_id_attribute "businessCategory"
186 iniset $KEYSTONE_CONF ldap tenant_desc_attribute "description"
Dean Troyerb9e25132013-10-01 14:45:04 -0500187 iniset $KEYSTONE_CONF ldap tenant_tree_dn "ou=Projects,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600188 iniset $KEYSTONE_CONF ldap user_domain_id_attribute "businessCategory"
Dean Troyerb9e25132013-10-01 14:45:04 -0500189 iniset $KEYSTONE_CONF ldap user_tree_dn "ou=Users,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600190 iniset $KEYSTONE_CONF DEFAULT member_role_id "9fe2ff9ee4384b1894a90878d3e92bab"
191 iniset $KEYSTONE_CONF DEFAULT member_role_name "_member_"
Brad Topolf127e2f2013-01-22 10:17:50 -0600192 fi
193
Alex Rudenkocd770582013-09-01 16:26:03 +0200194 # check if identity backend is valid
195 if [[ "$KEYSTONE_VALID_IDENTITY_BACKENDS" =~ "$KEYSTONE_IDENTITY_BACKEND" ]]; then
196 iniset $KEYSTONE_CONF identity driver "keystone.identity.backends.$KEYSTONE_IDENTITY_BACKEND.Identity"
197 fi
198
199 # check if assignment backend is valid
200 if [[ "$KEYSTONE_VALID_ASSIGNMENT_BACKENDS" =~ "$KEYSTONE_ASSIGNMENT_BACKEND" ]]; then
201 iniset $KEYSTONE_CONF assignment driver "keystone.assignment.backends.$KEYSTONE_ASSIGNMENT_BACKEND.Assignment"
Brad Topolf127e2f2013-01-22 10:17:50 -0600202 fi
203
Sergey Skripnick8464a4c2014-07-08 21:05:23 +0300204 # Configure rabbitmq credentials
205 if is_service_enabled rabbit; then
206 iniset $KEYSTONE_CONF DEFAULT rabbit_password $RABBIT_PASSWORD
207 iniset $KEYSTONE_CONF DEFAULT rabbit_host $RABBIT_HOST
208 fi
209
Dean Troyer245a4312013-06-28 09:16:08 -0500210 # Set the URL advertised in the ``versions`` structure returned by the '/' route
211 iniset $KEYSTONE_CONF DEFAULT public_endpoint "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:%(public_port)s/"
212 iniset $KEYSTONE_CONF DEFAULT admin_endpoint "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:%(admin_port)s/"
David Kranz041fa712014-02-24 13:30:59 -0500213 iniset $KEYSTONE_CONF DEFAULT admin_bind_host "$KEYSTONE_ADMIN_BIND_HOST"
Dean Troyer245a4312013-06-28 09:16:08 -0500214
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000215 # Register SSL certificates if provided
216 if is_ssl_enabled_service key; then
217 ensure_certificates KEYSTONE
218
219 iniset $KEYSTONE_CONF ssl enable True
220 iniset $KEYSTONE_CONF ssl certfile $KEYSTONE_SSL_CERT
221 iniset $KEYSTONE_CONF ssl keyfile $KEYSTONE_SSL_KEY
222 fi
223
Dean Troyerc83a7e12012-11-29 11:47:58 -0600224 if is_service_enabled tls-proxy; then
225 # Set the service ports for a proxy to take the originals
226 iniset $KEYSTONE_CONF DEFAULT public_port $KEYSTONE_SERVICE_PORT_INT
227 iniset $KEYSTONE_CONF DEFAULT admin_port $KEYSTONE_AUTH_PORT_INT
228 fi
229
Dean Troyerd81a0272012-08-31 18:04:55 -0500230 iniset $KEYSTONE_CONF DEFAULT admin_token "$SERVICE_TOKEN"
Sudarshan Acharya37631412013-07-16 00:47:54 +0000231
Brant Knudson1e1fce82014-06-19 16:55:45 -0500232 if [[ "$KEYSTONE_TOKEN_FORMAT" != "" ]]; then
233 iniset $KEYSTONE_CONF token provider keystone.token.providers.$KEYSTONE_TOKEN_FORMAT.Provider
Sudarshan Acharya37631412013-07-16 00:47:54 +0000234 fi
235
Brant Knudson16d3ad02014-02-13 18:59:50 -0600236 iniset $KEYSTONE_CONF database connection `database_connection_url keystone`
Dean Troyerd81a0272012-08-31 18:04:55 -0500237 iniset $KEYSTONE_CONF ec2 driver "keystone.contrib.ec2.backends.sql.Ec2"
Dean Troyerd81a0272012-08-31 18:04:55 -0500238
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500239 if [[ "$KEYSTONE_TOKEN_BACKEND" = "sql" ]]; then
Morgan Fainberg947d7462014-08-29 13:26:31 -0700240 iniset $KEYSTONE_CONF token driver keystone.token.persistence.backends.sql.Token
Peter Feiner61ae7c12013-11-15 10:42:30 -0500241 elif [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
Morgan Fainberg947d7462014-08-29 13:26:31 -0700242 iniset $KEYSTONE_CONF token driver keystone.token.persistence.backends.memcache.Token
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500243 else
Morgan Fainberg947d7462014-08-29 13:26:31 -0700244 iniset $KEYSTONE_CONF token driver keystone.token.persistence.backends.kvs.Token
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500245 fi
246
Dean Troyerd81a0272012-08-31 18:04:55 -0500247 if [[ "$KEYSTONE_CATALOG_BACKEND" = "sql" ]]; then
248 # Configure ``keystone.conf`` to use sql
249 iniset $KEYSTONE_CONF catalog driver keystone.catalog.backends.sql.Catalog
250 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
276 iniset $KEYSTONE_CONF catalog driver "keystone.catalog.backends.templated.TemplatedCatalog"
277 iniset $KEYSTONE_CONF catalog template_file "$KEYSTONE_CATALOG"
278 fi
279
280 # Set up logging
Dean Troyerd81a0272012-08-31 18:04:55 -0500281 if [ "$SYSLOG" != "False" ]; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600282 iniset $KEYSTONE_CONF DEFAULT use_syslog "True"
Dean Troyerd81a0272012-08-31 18:04:55 -0500283 fi
Brant Knudson4968d1a2014-01-22 19:06:44 -0600284
285 # Format logging
Morgan Fainberg46455a32014-06-20 10:37:18 -0700286 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && [ "$KEYSTONE_USE_MOD_WSGI" == "False" ] ; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600287 setup_colorized_logging $KEYSTONE_CONF DEFAULT
288 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000289
Morgan Fainberg46455a32014-06-20 10:37:18 -0700290 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Morgan Fainberg2c2b1cc2014-05-01 22:05:41 -0700291 iniset $KEYSTONE_CONF DEFAULT debug "True"
292 # 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
Dean Troyerd81a0272012-08-31 18:04:55 -0500301}
302
Julien Vey00da58a2014-05-27 15:51:49 +0200303function configure_keystone_extensions {
304 # Add keystone extension into keystone v3 application pipeline
305 local extension_value
306 local api_v3
307 local extension
308 local api_v3_extension
309 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
310 if [[ -z "${extension_value}" ]]; then
311 continue
312 fi
313 api_v3=$(iniget $KEYSTONE_PASTE_INI pipeline:api_v3 pipeline)
314 extension=$(echo $api_v3 | sed -ne "/${extension_value}/ p;" )
315 if [[ -z $extension ]]; then
316 api_v3_extension=$(echo $api_v3 | sed -ne "s/service_v3/${extension_value}_extension service_v3/p;" )
317 iniset $KEYSTONE_PASTE_INI pipeline:api_v3 pipeline "$api_v3_extension"
318 fi
319 done
320}
321
Dean Troyerd835de82012-11-29 17:11:35 -0600322# create_keystone_accounts() - Sets up common required keystone accounts
323
324# Tenant User Roles
325# ------------------------------------------------------------------
Dean Troyerd835de82012-11-29 17:11:35 -0600326# admin admin admin
Dean Troyer42a59c22014-03-03 14:31:29 -0600327# service -- --
328# -- -- service
329# -- -- ResellerAdmin
330# -- -- Member
Dean Troyerd835de82012-11-29 17:11:35 -0600331# demo admin admin
332# demo demo Member, anotherrole
333# invisible_to_admin demo Member
334
335# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100336function create_keystone_accounts {
Dean Troyerd835de82012-11-29 17:11:35 -0600337
338 # admin
Dean Troyerc50c9832014-07-25 13:40:25 -0500339 local admin_tenant=$(get_or_create_project "admin")
340 local admin_user=$(get_or_create_user "admin" \
341 "$ADMIN_PASSWORD" "$admin_tenant")
342 local admin_role=$(get_or_create_role "admin")
343 get_or_add_user_role $admin_role $admin_user $admin_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600344
Dean Troyer42a59c22014-03-03 14:31:29 -0600345 # Create service project/role
Bartosz Górski0abde392014-02-28 14:15:19 +0100346 get_or_create_project "$SERVICE_TENANT_NAME"
Dean Troyer42a59c22014-03-03 14:31:29 -0600347
348 # Service role, so service users do not have to be admins
Bartosz Górski0abde392014-02-28 14:15:19 +0100349 get_or_create_role service
Dean Troyer42a59c22014-03-03 14:31:29 -0600350
351 # The ResellerAdmin role is used by Nova and Ceilometer so we need to keep it.
352 # The admin role in swift allows a user to act as an admin for their tenant,
353 # but ResellerAdmin is needed for a user to act as any tenant. The name of this
354 # role is also configurable in swift-proxy.conf
Bartosz Górski0abde392014-02-28 14:15:19 +0100355 get_or_create_role ResellerAdmin
Dean Troyerd835de82012-11-29 17:11:35 -0600356
357 # The Member role is used by Horizon and Swift so we need to keep it:
Dean Troyerc50c9832014-07-25 13:40:25 -0500358 local member_role=$(get_or_create_role "Member")
Bartosz Górski0abde392014-02-28 14:15:19 +0100359
Masayuki Igawad3654052014-09-01 17:30:05 +0900360 # another_role demonstrates that an arbitrary role may be created and used
Dean Troyerd835de82012-11-29 17:11:35 -0600361 # TODO(sleepsonthefloor): show how this can be used for rbac in the future!
Dean Troyerc50c9832014-07-25 13:40:25 -0500362 local another_role=$(get_or_create_role "anotherrole")
Dean Troyerd835de82012-11-29 17:11:35 -0600363
364 # invisible tenant - admin can't see this one
Dean Troyerc50c9832014-07-25 13:40:25 -0500365 local invis_tenant=$(get_or_create_project "invisible_to_admin")
Dean Troyerd835de82012-11-29 17:11:35 -0600366
367 # demo
Dean Troyerc50c9832014-07-25 13:40:25 -0500368 local demo_tenant=$(get_or_create_project "demo")
369 local demo_user=$(get_or_create_user "demo" \
370 "$ADMIN_PASSWORD" "$demo_tenant" "demo@example.com")
Steve Martinelli19685422014-01-24 13:02:26 -0600371
Dean Troyerc50c9832014-07-25 13:40:25 -0500372 get_or_add_user_role $member_role $demo_user $demo_tenant
373 get_or_add_user_role $admin_role $admin_user $demo_tenant
374 get_or_add_user_role $another_role $demo_user $demo_tenant
375 get_or_add_user_role $member_role $demo_user $invis_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600376
377 # Keystone
378 if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100379
380 KEYSTONE_SERVICE=$(get_or_create_service "keystone" \
381 "identity" "Keystone Identity Service")
382 get_or_create_endpoint $KEYSTONE_SERVICE \
383 "$REGION_NAME" \
384 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION" \
385 "$KEYSTONE_AUTH_PROTOCOL://$KEYSTONE_AUTH_HOST:$KEYSTONE_AUTH_PORT/v$IDENTITY_API_VERSION" \
386 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION"
Dean Troyerd835de82012-11-29 17:11:35 -0600387 fi
Dean Troyerd835de82012-11-29 17:11:35 -0600388}
389
Vincent Hou21fe4e72013-11-21 03:10:27 -0500390# Configure the API version for the OpenStack projects.
391# configure_API_version conf_file version
Ian Wienandaee18c72014-02-21 15:35:08 +1100392function configure_API_version {
Vincent Hou21fe4e72013-11-21 03:10:27 -0500393 local conf_file=$1
394 local api_version=$2
395 iniset $conf_file keystone_authtoken auth_uri $KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$api_version
396}
397
Dean Troyerd81a0272012-08-31 18:04:55 -0500398# init_keystone() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100399function init_keystone {
Dean Troyerb9e25132013-10-01 14:45:04 -0500400 if is_service_enabled ldap; then
401 init_ldap
402 fi
403
Dean Troyerd81a0272012-08-31 18:04:55 -0500404 # (Re)create keystone database
Terry Wilson428af5a2012-11-01 16:12:39 -0400405 recreate_database keystone utf8
Dean Troyerd81a0272012-08-31 18:04:55 -0500406
407 # Initialize keystone database
408 $KEYSTONE_DIR/bin/keystone-manage db_sync
409
Julien Vey00da58a2014-05-27 15:51:49 +0200410 local extension_value
411 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
412 if [[ -z "${extension_value}" ]]; then
413 continue
414 fi
415 $KEYSTONE_DIR/bin/keystone-manage db_sync --extension "${extension_value}"
416 done
417
Brant Knudson1e1fce82014-06-19 16:55:45 -0500418 if [[ "$KEYSTONE_TOKEN_FORMAT" != "uuid" ]]; then
Dean Troyerbc071bc2012-10-01 14:06:44 -0500419 # Set up certificates
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800420 rm -rf $KEYSTONE_CONF_DIR/ssl
Dean Troyerbc071bc2012-10-01 14:06:44 -0500421 $KEYSTONE_DIR/bin/keystone-manage pki_setup
422
423 # Create cache dir
424 sudo mkdir -p $KEYSTONE_AUTH_CACHE_DIR
Attila Fazekas91b8d132013-01-06 22:40:09 +0100425 sudo chown $STACK_USER $KEYSTONE_AUTH_CACHE_DIR
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800426 rm -f $KEYSTONE_AUTH_CACHE_DIR/*
Dean Troyerbc071bc2012-10-01 14:06:44 -0500427 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500428}
429
430# install_keystoneclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100431function install_keystoneclient {
Dean Troyerd81a0272012-08-31 18:04:55 -0500432 git_clone $KEYSTONECLIENT_REPO $KEYSTONECLIENT_DIR $KEYSTONECLIENT_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400433 setup_develop $KEYSTONECLIENT_DIR
Attila Fazekasfac533e2013-08-14 16:04:01 +0200434 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 -0500435}
436
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700437# install_keystonemiddleware() - Collect source and prepare
438function install_keystonemiddleware {
439 git_clone $KEYSTONEMIDDLEWARE_REPO $KEYSTONEMIDDLEWARE_DIR $KEYSTONEMIDDLEWARE_BRANCH
440 setup_install $KEYSTONEMIDDLEWARE_DIR
441}
442
Dean Troyerd81a0272012-08-31 18:04:55 -0500443# install_keystone() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100444function install_keystone {
Brad Topolf127e2f2013-01-22 10:17:50 -0600445 # only install ldap if the service has been enabled
446 if is_service_enabled ldap; then
447 install_ldap
448 fi
Peter Feiner61ae7c12013-11-15 10:42:30 -0500449 if [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
450 # Install memcached and the memcache Python library that keystone uses.
451 # Unfortunately the Python library goes by different names in the .deb
452 # and .rpm circles.
453 install_package memcached
454 if is_ubuntu; then
455 install_package python-memcache
456 else
457 install_package python-memcached
458 fi
459 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500460 git_clone $KEYSTONE_REPO $KEYSTONE_DIR $KEYSTONE_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400461 setup_develop $KEYSTONE_DIR
Morgan Fainberg46455a32014-06-20 10:37:18 -0700462 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000463 install_apache_wsgi
464 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500465}
466
467# start_keystone() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100468function start_keystone {
Dean Troyerc83a7e12012-11-29 11:47:58 -0600469 # Get right service port for testing
470 local service_port=$KEYSTONE_SERVICE_PORT
471 if is_service_enabled tls-proxy; then
472 service_port=$KEYSTONE_SERVICE_PORT_INT
473 fi
474
Morgan Fainberg46455a32014-06-20 10:37:18 -0700475 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000476 restart_apache_server
Brant Knudsoncfc94652014-08-21 18:25:29 -0500477 screen_it key "cd $KEYSTONE_DIR && sudo tail -f /var/log/$APACHE_NAME/keystone.log"
Brant Knudson966463c2014-08-21 18:24:42 -0500478 screen_it key-access "sudo tail -f /var/log/$APACHE_NAME/keystone_access.log"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000479 else
480 # Start Keystone in a screen window
Brant Knudson4968d1a2014-01-22 19:06:44 -0600481 screen_it key "cd $KEYSTONE_DIR && $KEYSTONE_DIR/bin/keystone-all --config-file $KEYSTONE_CONF --debug"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000482 fi
483
Dean Troyerd835de82012-11-29 17:11:35 -0600484 echo "Waiting for keystone to start..."
Stanislaw Pituchabe4c9532014-06-11 17:52:49 +0100485 # Check that the keystone service is running. Even if the tls tunnel
486 # should be enabled, make sure the internal port is checked using
487 # unencryted traffic at this point.
488 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 -0400489 die $LINENO "keystone did not start"
Dean Troyerd835de82012-11-29 17:11:35 -0600490 fi
Dean Troyerc83a7e12012-11-29 11:47:58 -0600491
492 # Start proxies if enabled
493 if is_service_enabled tls-proxy; then
494 start_tls_proxy '*' $KEYSTONE_SERVICE_PORT $KEYSTONE_SERVICE_HOST $KEYSTONE_SERVICE_PORT_INT &
495 start_tls_proxy '*' $KEYSTONE_AUTH_PORT $KEYSTONE_AUTH_HOST $KEYSTONE_AUTH_PORT_INT &
496 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500497}
498
499# stop_keystone() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100500function stop_keystone {
Dean Troyerd81a0272012-08-31 18:04:55 -0500501 # Kill the Keystone screen window
Dean Troyer9fc87922013-05-22 17:19:06 -0500502 screen_stop key
Morgan Fainbergc11d6e02014-05-01 22:57:06 -0700503 # Cleanup the WSGI files and VHOST
504 _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -0500505}
Dean Troyer7903b792012-09-13 17:16:12 -0500506
Sean Dague4f3b66f2014-07-23 16:45:12 -0400507function is_keystone_enabled {
508 return is_service_enabled key
509}
Dean Troyer1a6d4492013-06-03 16:47:36 -0500510
Dean Troyer7903b792012-09-13 17:16:12 -0500511# Restore xtrace
512$XTRACE
Sean Dague584d90e2013-03-29 14:34:53 -0400513
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100514# Tell emacs to use shell-script-mode
515## Local variables:
516## mode: shell-script
517## End: