blob: 3998be90618de223d6b83f6089d2fb79b4484aa3 [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}
Thomas Bechtold8732afe2014-09-22 19:04:05 +020041if is_suse; then
42 KEYSTONE_WSGI_DIR=${KEYSTONE_WSGI_DIR:-/srv/www/htdocs/keystone}
43else
44 KEYSTONE_WSGI_DIR=${KEYSTONE_WSGI_DIR:-/var/www/keystone}
45fi
Dean Troyerd81a0272012-08-31 18:04:55 -050046
Morgan Fainberg58936fd2014-06-24 12:26:07 -070047KEYSTONEMIDDLEWARE_DIR=$DEST/keystonemiddleware
Dean Troyerd81a0272012-08-31 18:04:55 -050048KEYSTONECLIENT_DIR=$DEST/python-keystoneclient
49
Julien Vey00da58a2014-05-27 15:51:49 +020050# Set up additional extensions, such as oauth1, federation
51# Example of KEYSTONE_EXTENSIONS=oauth1,federation
52KEYSTONE_EXTENSIONS=${KEYSTONE_EXTENSIONS:-}
53
Morgan Fainberg46455a32014-06-20 10:37:18 -070054# Toggle for deploying Keystone under HTTPD + mod_wsgi
Morgan Fainberge6dd4e62014-06-25 17:25:25 -070055KEYSTONE_USE_MOD_WSGI=${KEYSTONE_USE_MOD_WSGI:-${ENABLE_HTTPD_MOD_WSGI_SERVICES}}
Morgan Fainberg46455a32014-06-20 10:37:18 -070056
Dean Troyerbc071bc2012-10-01 14:06:44 -050057# Select the backend for Keystone's service catalog
Dean Troyerb80379c2012-09-10 18:30:37 -050058KEYSTONE_CATALOG_BACKEND=${KEYSTONE_CATALOG_BACKEND:-sql}
Dean Troyerd81a0272012-08-31 18:04:55 -050059KEYSTONE_CATALOG=$KEYSTONE_CONF_DIR/default_catalog.templates
60
Davanum Srinivas5bd96f92013-01-29 15:12:20 -050061# Select the backend for Tokens
62KEYSTONE_TOKEN_BACKEND=${KEYSTONE_TOKEN_BACKEND:-sql}
63
Alex Rudenkocd770582013-09-01 16:26:03 +020064# Select the backend for Identity
65KEYSTONE_IDENTITY_BACKEND=${KEYSTONE_IDENTITY_BACKEND:-sql}
66
67# Select the backend for Assignment
68KEYSTONE_ASSIGNMENT_BACKEND=${KEYSTONE_ASSIGNMENT_BACKEND:-sql}
69
Dean Troyerbc071bc2012-10-01 14:06:44 -050070# Select Keystone's token format
Brant Knudson754c4402014-06-04 09:06:01 -050071# Choose from 'UUID', 'PKI', or 'PKIZ'
Brant Knudson1e1fce82014-06-19 16:55:45 -050072KEYSTONE_TOKEN_FORMAT=$(echo ${KEYSTONE_TOKEN_FORMAT} | tr '[:upper:]' '[:lower:]')
Dean Troyerbc071bc2012-10-01 14:06:44 -050073
Dean Troyerd81a0272012-08-31 18:04:55 -050074# Set Keystone interface configuration
Dean Troyerd81a0272012-08-31 18:04:55 -050075KEYSTONE_AUTH_HOST=${KEYSTONE_AUTH_HOST:-$SERVICE_HOST}
76KEYSTONE_AUTH_PORT=${KEYSTONE_AUTH_PORT:-35357}
Dean Troyerc83a7e12012-11-29 11:47:58 -060077KEYSTONE_AUTH_PORT_INT=${KEYSTONE_AUTH_PORT_INT:-35358}
78KEYSTONE_AUTH_PROTOCOL=${KEYSTONE_AUTH_PROTOCOL:-$SERVICE_PROTOCOL}
79
80# Public facing bits
Dean Troyerd81a0272012-08-31 18:04:55 -050081KEYSTONE_SERVICE_HOST=${KEYSTONE_SERVICE_HOST:-$SERVICE_HOST}
82KEYSTONE_SERVICE_PORT=${KEYSTONE_SERVICE_PORT:-5000}
Dean Troyerc83a7e12012-11-29 11:47:58 -060083KEYSTONE_SERVICE_PORT_INT=${KEYSTONE_SERVICE_PORT_INT:-5001}
84KEYSTONE_SERVICE_PROTOCOL=${KEYSTONE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Dean Troyerd81a0272012-08-31 18:04:55 -050085
David Kranz041fa712014-02-24 13:30:59 -050086# Bind hosts
87KEYSTONE_ADMIN_BIND_HOST=${KEYSTONE_ADMIN_BIND_HOST:-$KEYSTONE_SERVICE_HOST}
Dean Troyerb7490da2013-03-18 16:07:56 -050088# Set the tenant for service accounts in Keystone
89SERVICE_TENANT_NAME=${SERVICE_TENANT_NAME:-service}
90
Alex Rudenkocd770582013-09-01 16:26:03 +020091# valid identity backends as per dir keystone/identity/backends
92KEYSTONE_VALID_IDENTITY_BACKENDS=kvs,ldap,pam,sql
93
94# valid assignment backends as per dir keystone/identity/backends
95KEYSTONE_VALID_ASSIGNMENT_BACKENDS=kvs,ldap,sql
Dean Troyerd81a0272012-08-31 18:04:55 -050096
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100097# if we are running with SSL use https protocols
98if is_ssl_enabled_service "key"; then
99 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
Dean Troyercc6b4432013-04-08 15:38:03 -0500107# Functions
108# ---------
Dean Troyerd81a0272012-08-31 18:04:55 -0500109# cleanup_keystone() - Remove residual data files, anything left over from previous
110# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100111function cleanup_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700112 _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -0500113}
114
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000115# _cleanup_keystone_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
Ian Wienandaee18c72014-02-21 15:35:08 +1100116function _cleanup_keystone_apache_wsgi {
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000117 sudo rm -f $KEYSTONE_WSGI_DIR/*.wsgi
Morgan Fainberg970ee902014-06-09 12:07:29 -0700118 sudo rm -f $(apache_site_config_for keystone)
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}
149
Dean Troyerd81a0272012-08-31 18:04:55 -0500150# configure_keystone() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100151function configure_keystone {
Dean Troyerd81a0272012-08-31 18:04:55 -0500152 if [[ ! -d $KEYSTONE_CONF_DIR ]]; then
153 sudo mkdir -p $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500154 fi
Attila Fazekas91b8d132013-01-06 22:40:09 +0100155 sudo chown $STACK_USER $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500156
157 if [[ "$KEYSTONE_CONF_DIR" != "$KEYSTONE_DIR/etc" ]]; then
158 cp -p $KEYSTONE_DIR/etc/keystone.conf.sample $KEYSTONE_CONF
Dean Troyerd561b702013-10-22 17:46:00 -0500159 chmod 600 $KEYSTONE_CONF
Dean Troyerd81a0272012-08-31 18:04:55 -0500160 cp -p $KEYSTONE_DIR/etc/policy.json $KEYSTONE_CONF_DIR
Alan Pevece0bb4472013-03-12 11:10:52 +0100161 if [[ -f "$KEYSTONE_DIR/etc/keystone-paste.ini" ]]; then
162 cp -p "$KEYSTONE_DIR/etc/keystone-paste.ini" "$KEYSTONE_PASTE_INI"
163 fi
164 fi
165 if [[ -f "$KEYSTONE_PASTE_INI" ]]; then
166 iniset "$KEYSTONE_CONF" paste_deploy config_file "$KEYSTONE_PASTE_INI"
167 else
168 # compatibility with mixed cfg and paste.deploy configuration
169 KEYSTONE_PASTE_INI="$KEYSTONE_CONF"
Dean Troyerd81a0272012-08-31 18:04:55 -0500170 fi
171
Julien Vey00da58a2014-05-27 15:51:49 +0200172 configure_keystone_extensions
173
Dean Troyerd81a0272012-08-31 18:04:55 -0500174 # Rewrite stock ``keystone.conf``
Dean Troyerc83a7e12012-11-29 11:47:58 -0600175
Brad Topolf127e2f2013-01-22 10:17:50 -0600176 if is_service_enabled ldap; then
177 #Set all needed ldap values
Dean Troyerb9e25132013-10-01 14:45:04 -0500178 iniset $KEYSTONE_CONF ldap password $LDAP_PASSWORD
179 iniset $KEYSTONE_CONF ldap user $LDAP_MANAGER_DN
180 iniset $KEYSTONE_CONF ldap suffix $LDAP_BASE_DN
Brad Topolf41024e2013-02-19 15:36:41 -0600181 iniset $KEYSTONE_CONF ldap use_dumb_member "True"
Morgan Fainberg2dc11fb2013-09-24 23:43:08 -0700182 iniset $KEYSTONE_CONF ldap user_attribute_ignore "enabled,email,tenants,default_project_id"
Brad Topolf41024e2013-02-19 15:36:41 -0600183 iniset $KEYSTONE_CONF ldap tenant_attribute_ignore "enabled"
184 iniset $KEYSTONE_CONF ldap tenant_domain_id_attribute "businessCategory"
185 iniset $KEYSTONE_CONF ldap tenant_desc_attribute "description"
Dean Troyerb9e25132013-10-01 14:45:04 -0500186 iniset $KEYSTONE_CONF ldap tenant_tree_dn "ou=Projects,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600187 iniset $KEYSTONE_CONF ldap user_domain_id_attribute "businessCategory"
Dean Troyerb9e25132013-10-01 14:45:04 -0500188 iniset $KEYSTONE_CONF ldap user_tree_dn "ou=Users,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600189 iniset $KEYSTONE_CONF DEFAULT member_role_id "9fe2ff9ee4384b1894a90878d3e92bab"
190 iniset $KEYSTONE_CONF DEFAULT member_role_name "_member_"
Brad Topolf127e2f2013-01-22 10:17:50 -0600191 fi
192
Alex Rudenkocd770582013-09-01 16:26:03 +0200193 # check if identity backend is valid
194 if [[ "$KEYSTONE_VALID_IDENTITY_BACKENDS" =~ "$KEYSTONE_IDENTITY_BACKEND" ]]; then
195 iniset $KEYSTONE_CONF identity driver "keystone.identity.backends.$KEYSTONE_IDENTITY_BACKEND.Identity"
196 fi
197
198 # check if assignment backend is valid
199 if [[ "$KEYSTONE_VALID_ASSIGNMENT_BACKENDS" =~ "$KEYSTONE_ASSIGNMENT_BACKEND" ]]; then
200 iniset $KEYSTONE_CONF assignment driver "keystone.assignment.backends.$KEYSTONE_ASSIGNMENT_BACKEND.Assignment"
Brad Topolf127e2f2013-01-22 10:17:50 -0600201 fi
202
Sergey Skripnick8464a4c2014-07-08 21:05:23 +0300203 # Configure rabbitmq credentials
204 if is_service_enabled rabbit; then
205 iniset $KEYSTONE_CONF DEFAULT rabbit_password $RABBIT_PASSWORD
206 iniset $KEYSTONE_CONF DEFAULT rabbit_host $RABBIT_HOST
207 fi
208
Dean Troyer245a4312013-06-28 09:16:08 -0500209 # Set the URL advertised in the ``versions`` structure returned by the '/' route
210 iniset $KEYSTONE_CONF DEFAULT public_endpoint "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:%(public_port)s/"
211 iniset $KEYSTONE_CONF DEFAULT admin_endpoint "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:%(admin_port)s/"
David Kranz041fa712014-02-24 13:30:59 -0500212 iniset $KEYSTONE_CONF DEFAULT admin_bind_host "$KEYSTONE_ADMIN_BIND_HOST"
Dean Troyer245a4312013-06-28 09:16:08 -0500213
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000214 # Register SSL certificates if provided
215 if is_ssl_enabled_service key; then
216 ensure_certificates KEYSTONE
217
218 iniset $KEYSTONE_CONF ssl enable True
219 iniset $KEYSTONE_CONF ssl certfile $KEYSTONE_SSL_CERT
220 iniset $KEYSTONE_CONF ssl keyfile $KEYSTONE_SSL_KEY
221 fi
222
Dean Troyerc83a7e12012-11-29 11:47:58 -0600223 if is_service_enabled tls-proxy; then
224 # Set the service ports for a proxy to take the originals
225 iniset $KEYSTONE_CONF DEFAULT public_port $KEYSTONE_SERVICE_PORT_INT
226 iniset $KEYSTONE_CONF DEFAULT admin_port $KEYSTONE_AUTH_PORT_INT
227 fi
228
Dean Troyerd81a0272012-08-31 18:04:55 -0500229 iniset $KEYSTONE_CONF DEFAULT admin_token "$SERVICE_TOKEN"
Sudarshan Acharya37631412013-07-16 00:47:54 +0000230
Brant Knudson1e1fce82014-06-19 16:55:45 -0500231 if [[ "$KEYSTONE_TOKEN_FORMAT" != "" ]]; then
232 iniset $KEYSTONE_CONF token provider keystone.token.providers.$KEYSTONE_TOKEN_FORMAT.Provider
Sudarshan Acharya37631412013-07-16 00:47:54 +0000233 fi
234
Brant Knudson16d3ad02014-02-13 18:59:50 -0600235 iniset $KEYSTONE_CONF database connection `database_connection_url keystone`
Dean Troyerd81a0272012-08-31 18:04:55 -0500236 iniset $KEYSTONE_CONF ec2 driver "keystone.contrib.ec2.backends.sql.Ec2"
Dean Troyerd81a0272012-08-31 18:04:55 -0500237
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500238 if [[ "$KEYSTONE_TOKEN_BACKEND" = "sql" ]]; then
Morgan Fainberg947d7462014-08-29 13:26:31 -0700239 iniset $KEYSTONE_CONF token driver keystone.token.persistence.backends.sql.Token
Peter Feiner61ae7c12013-11-15 10:42:30 -0500240 elif [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
Morgan Fainberg947d7462014-08-29 13:26:31 -0700241 iniset $KEYSTONE_CONF token driver keystone.token.persistence.backends.memcache.Token
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500242 else
Morgan Fainberg947d7462014-08-29 13:26:31 -0700243 iniset $KEYSTONE_CONF token driver keystone.token.persistence.backends.kvs.Token
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500244 fi
245
Dean Troyerd81a0272012-08-31 18:04:55 -0500246 if [[ "$KEYSTONE_CATALOG_BACKEND" = "sql" ]]; then
247 # Configure ``keystone.conf`` to use sql
248 iniset $KEYSTONE_CONF catalog driver keystone.catalog.backends.sql.Catalog
249 inicomment $KEYSTONE_CONF catalog template_file
250 else
251 cp -p $FILES/default_catalog.templates $KEYSTONE_CATALOG
252
253 # Add swift endpoints to service catalog if swift is enabled
Chmouel Boudjnah0c3a5582013-03-06 10:58:33 +0100254 if is_service_enabled s-proxy; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500255 echo "catalog.RegionOne.object_store.publicURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
256 echo "catalog.RegionOne.object_store.adminURL = http://%SERVICE_HOST%:8080/" >> $KEYSTONE_CATALOG
257 echo "catalog.RegionOne.object_store.internalURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
258 echo "catalog.RegionOne.object_store.name = Swift Service" >> $KEYSTONE_CATALOG
259 fi
260
Mark McClainb05c8762013-07-06 23:29:39 -0400261 # Add neutron endpoints to service catalog if neutron is enabled
262 if is_service_enabled neutron; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500263 echo "catalog.RegionOne.network.publicURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
264 echo "catalog.RegionOne.network.adminURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
265 echo "catalog.RegionOne.network.internalURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
Mark McClainb05c8762013-07-06 23:29:39 -0400266 echo "catalog.RegionOne.network.name = Neutron Service" >> $KEYSTONE_CATALOG
Dean Troyerd81a0272012-08-31 18:04:55 -0500267 fi
268
Vincent Untz7e86dbe2012-12-13 08:50:37 +0100269 sed -e "
Dean Troyerd81a0272012-08-31 18:04:55 -0500270 s,%SERVICE_HOST%,$SERVICE_HOST,g;
271 s,%S3_SERVICE_PORT%,$S3_SERVICE_PORT,g;
272 " -i $KEYSTONE_CATALOG
273
274 # Configure ``keystone.conf`` to use templates
275 iniset $KEYSTONE_CONF catalog driver "keystone.catalog.backends.templated.TemplatedCatalog"
276 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
Morgan Fainberg46455a32014-06-20 10:37:18 -0700289 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Morgan Fainberg2c2b1cc2014-05-01 22:05:41 -0700290 iniset $KEYSTONE_CONF DEFAULT debug "True"
291 # Eliminate the %(asctime)s.%(msecs)03d from the log format strings
292 iniset $KEYSTONE_CONF DEFAULT logging_context_format_string "%(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s"
293 iniset $KEYSTONE_CONF DEFAULT logging_default_format_string "%(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s"
294 iniset $KEYSTONE_CONF DEFAULT logging_debug_format_suffix "%(funcName)s %(pathname)s:%(lineno)d"
295 iniset $KEYSTONE_CONF DEFAULT logging_exception_prefix "%(process)d TRACE %(name)s %(instance)s"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000296 _config_keystone_apache_wsgi
297 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100298
299 iniset $KEYSTONE_CONF DEFAULT max_token_size 16384
Brant Knudson85a17ea2014-09-13 14:49:24 -0500300
301 iniset $KEYSTONE_CONF DEFAULT admin_workers "$API_WORKERS"
302 # Public workers will use the server default, typically number of CPU.
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.
393# configure_API_version conf_file version
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
397 iniset $conf_file keystone_authtoken auth_uri $KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$api_version
398}
399
Dean Troyerd81a0272012-08-31 18:04:55 -0500400# init_keystone() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100401function init_keystone {
Dean Troyerb9e25132013-10-01 14:45:04 -0500402 if is_service_enabled ldap; then
403 init_ldap
404 fi
405
Dean Troyerd81a0272012-08-31 18:04:55 -0500406 # (Re)create keystone database
Terry Wilson428af5a2012-11-01 16:12:39 -0400407 recreate_database keystone utf8
Dean Troyerd81a0272012-08-31 18:04:55 -0500408
409 # Initialize keystone database
410 $KEYSTONE_DIR/bin/keystone-manage db_sync
411
Julien Vey00da58a2014-05-27 15:51:49 +0200412 local extension_value
413 for extension_value in ${KEYSTONE_EXTENSIONS//,/ }; do
414 if [[ -z "${extension_value}" ]]; then
415 continue
416 fi
417 $KEYSTONE_DIR/bin/keystone-manage db_sync --extension "${extension_value}"
418 done
419
Brant Knudson1e1fce82014-06-19 16:55:45 -0500420 if [[ "$KEYSTONE_TOKEN_FORMAT" != "uuid" ]]; then
Dean Troyerbc071bc2012-10-01 14:06:44 -0500421 # Set up certificates
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800422 rm -rf $KEYSTONE_CONF_DIR/ssl
Dean Troyerbc071bc2012-10-01 14:06:44 -0500423 $KEYSTONE_DIR/bin/keystone-manage pki_setup
424
425 # Create cache dir
426 sudo mkdir -p $KEYSTONE_AUTH_CACHE_DIR
Attila Fazekas91b8d132013-01-06 22:40:09 +0100427 sudo chown $STACK_USER $KEYSTONE_AUTH_CACHE_DIR
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800428 rm -f $KEYSTONE_AUTH_CACHE_DIR/*
Dean Troyerbc071bc2012-10-01 14:06:44 -0500429 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500430}
431
432# install_keystoneclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100433function install_keystoneclient {
Dean Troyerd81a0272012-08-31 18:04:55 -0500434 git_clone $KEYSTONECLIENT_REPO $KEYSTONECLIENT_DIR $KEYSTONECLIENT_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400435 setup_develop $KEYSTONECLIENT_DIR
Attila Fazekasfac533e2013-08-14 16:04:01 +0200436 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 -0500437}
438
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700439# install_keystonemiddleware() - Collect source and prepare
440function install_keystonemiddleware {
441 git_clone $KEYSTONEMIDDLEWARE_REPO $KEYSTONEMIDDLEWARE_DIR $KEYSTONEMIDDLEWARE_BRANCH
442 setup_install $KEYSTONEMIDDLEWARE_DIR
443}
444
Dean Troyerd81a0272012-08-31 18:04:55 -0500445# install_keystone() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100446function install_keystone {
Brad Topolf127e2f2013-01-22 10:17:50 -0600447 # only install ldap if the service has been enabled
448 if is_service_enabled ldap; then
449 install_ldap
450 fi
Peter Feiner61ae7c12013-11-15 10:42:30 -0500451 if [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
452 # Install memcached and the memcache Python library that keystone uses.
453 # Unfortunately the Python library goes by different names in the .deb
454 # and .rpm circles.
455 install_package memcached
456 if is_ubuntu; then
457 install_package python-memcache
458 else
459 install_package python-memcached
460 fi
461 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500462 git_clone $KEYSTONE_REPO $KEYSTONE_DIR $KEYSTONE_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400463 setup_develop $KEYSTONE_DIR
Morgan Fainberg46455a32014-06-20 10:37:18 -0700464 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000465 install_apache_wsgi
466 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500467}
468
469# start_keystone() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100470function start_keystone {
Dean Troyerc83a7e12012-11-29 11:47:58 -0600471 # Get right service port for testing
472 local service_port=$KEYSTONE_SERVICE_PORT
473 if is_service_enabled tls-proxy; then
474 service_port=$KEYSTONE_SERVICE_PORT_INT
475 fi
476
Morgan Fainberg46455a32014-06-20 10:37:18 -0700477 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700478 enable_apache_site keystone
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000479 restart_apache_server
Chris Dent2f27a0e2014-09-09 13:46:02 +0100480 tail_log key /var/log/$APACHE_NAME/keystone.log
481 tail_log key-access /var/log/$APACHE_NAME/keystone_access.log
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000482 else
483 # Start Keystone in a screen window
Chris Dent2f27a0e2014-09-09 13:46:02 +0100484 run_process key "$KEYSTONE_DIR/bin/keystone-all --config-file $KEYSTONE_CONF --debug"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000485 fi
486
Dean Troyerd835de82012-11-29 17:11:35 -0600487 echo "Waiting for keystone to start..."
Stanislaw Pituchabe4c9532014-06-11 17:52:49 +0100488 # Check that the keystone service is running. Even if the tls tunnel
489 # should be enabled, make sure the internal port is checked using
490 # unencryted traffic at this point.
491 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 -0400492 die $LINENO "keystone did not start"
Dean Troyerd835de82012-11-29 17:11:35 -0600493 fi
Dean Troyerc83a7e12012-11-29 11:47:58 -0600494
495 # Start proxies if enabled
496 if is_service_enabled tls-proxy; then
497 start_tls_proxy '*' $KEYSTONE_SERVICE_PORT $KEYSTONE_SERVICE_HOST $KEYSTONE_SERVICE_PORT_INT &
498 start_tls_proxy '*' $KEYSTONE_AUTH_PORT $KEYSTONE_AUTH_HOST $KEYSTONE_AUTH_PORT_INT &
499 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500500}
501
502# stop_keystone() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100503function stop_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700504 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
505 disable_apache_site keystone
506 restart_apache_server
507 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500508 # Kill the Keystone screen window
Chris Dent2f27a0e2014-09-09 13:46:02 +0100509 stop_process key
Dean Troyerd81a0272012-08-31 18:04:55 -0500510}
Dean Troyer7903b792012-09-13 17:16:12 -0500511
Sean Dague4f3b66f2014-07-23 16:45:12 -0400512function is_keystone_enabled {
513 return is_service_enabled key
514}
Dean Troyer1a6d4492013-06-03 16:47:36 -0500515
Dean Troyer7903b792012-09-13 17:16:12 -0500516# Restore xtrace
517$XTRACE
Sean Dague584d90e2013-03-29 14:34:53 -0400518
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100519# Tell emacs to use shell-script-mode
520## Local variables:
521## mode: shell-script
522## End: