blob: f7736147a7a84516191926aa2d84b420608dc799 [file] [log] [blame]
Sean Daguee263c822014-12-05 14:25:28 -05001#!/bin/bash
2#
Dean Troyerd81a0272012-08-31 18:04:55 -05003# lib/keystone
4# Functions to control the configuration and operation of **Keystone**
5
6# Dependencies:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01007#
8# - ``functions`` file
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +10009# - ``tls`` file
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010010# - ``DEST``, ``STACK_USER``
Adam Gandelmanc4b06712014-09-03 11:44:31 -070011# - ``FILES``
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010012# - ``IDENTITY_API_VERSION``
13# - ``BASE_SQL_CONN``
14# - ``SERVICE_HOST``, ``SERVICE_PROTOCOL``
15# - ``SERVICE_TOKEN``
16# - ``S3_SERVICE_PORT`` (template backend only)
Dean Troyerd81a0272012-08-31 18:04:55 -050017
Dean Troyerd81a0272012-08-31 18:04:55 -050018# ``stack.sh`` calls the entry points in this order:
19#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010020# - install_keystone
21# - configure_keystone
22# - _config_keystone_apache_wsgi
23# - init_keystone
24# - start_keystone
25# - create_keystone_accounts
26# - stop_keystone
27# - cleanup_keystone
28# - _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -050029
Dean Troyer7903b792012-09-13 17:16:12 -050030# Save trace setting
Ian Wienand523f4882015-10-13 11:03:03 +110031_XTRACE_KEYSTONE=$(set +o | grep xtrace)
Dean Troyer7903b792012-09-13 17:16:12 -050032set +o xtrace
Dean Troyerd81a0272012-08-31 18:04:55 -050033
Dean Troyerd81a0272012-08-31 18:04:55 -050034# Defaults
35# --------
36
Dean Troyerd81a0272012-08-31 18:04:55 -050037# Set up default directories
Jamie Lennox21a90772015-07-03 11:54:38 +100038GITDIR["keystoneauth"]=$DEST/keystoneauth
Sean Daguee08ab102014-11-13 17:09:28 -050039GITDIR["python-keystoneclient"]=$DEST/python-keystoneclient
Sean Dague658312c2014-11-14 11:35:56 -050040GITDIR["keystonemiddleware"]=$DEST/keystonemiddleware
Dean Troyerd81a0272012-08-31 18:04:55 -050041KEYSTONE_DIR=$DEST/keystone
Dean Troyerf8ae6472015-02-17 11:05:06 -060042
43# Keystone virtual environment
44if [[ ${USE_VENV} = True ]]; then
45 PROJECT_VENV["keystone"]=${KEYSTONE_DIR}.venv
46 KEYSTONE_BIN_DIR=${PROJECT_VENV["keystone"]}/bin
47else
48 KEYSTONE_BIN_DIR=$(get_python_exec_prefix)
49fi
50
Dean Troyerd81a0272012-08-31 18:04:55 -050051KEYSTONE_CONF_DIR=${KEYSTONE_CONF_DIR:-/etc/keystone}
52KEYSTONE_CONF=$KEYSTONE_CONF_DIR/keystone.conf
Alan Pevece0bb4472013-03-12 11:10:52 +010053KEYSTONE_PASTE_INI=${KEYSTONE_PASTE_INI:-$KEYSTONE_CONF_DIR/keystone-paste.ini}
Dean Troyerd81a0272012-08-31 18:04:55 -050054
Morgan Fainberg46455a32014-06-20 10:37:18 -070055# Toggle for deploying Keystone under HTTPD + mod_wsgi
Morgan Fainberge6dd4e62014-06-25 17:25:25 -070056KEYSTONE_USE_MOD_WSGI=${KEYSTONE_USE_MOD_WSGI:-${ENABLE_HTTPD_MOD_WSGI_SERVICES}}
Morgan Fainberg46455a32014-06-20 10:37:18 -070057
Brant Knudson331a64f2015-05-11 10:02:24 -050058# Select the Catalog backend driver
Dean Troyerb80379c2012-09-10 18:30:37 -050059KEYSTONE_CATALOG_BACKEND=${KEYSTONE_CATALOG_BACKEND:-sql}
Dean Troyerd81a0272012-08-31 18:04:55 -050060KEYSTONE_CATALOG=$KEYSTONE_CONF_DIR/default_catalog.templates
61
Brant Knudson331a64f2015-05-11 10:02:24 -050062# Select the token persistence backend driver
Davanum Srinivas5bd96f92013-01-29 15:12:20 -050063KEYSTONE_TOKEN_BACKEND=${KEYSTONE_TOKEN_BACKEND:-sql}
64
Brant Knudson331a64f2015-05-11 10:02:24 -050065# Select the Identity backend driver
Alex Rudenkocd770582013-09-01 16:26:03 +020066KEYSTONE_IDENTITY_BACKEND=${KEYSTONE_IDENTITY_BACKEND:-sql}
67
Brant Knudson331a64f2015-05-11 10:02:24 -050068# Select the Assignment backend driver
Alex Rudenkocd770582013-09-01 16:26:03 +020069KEYSTONE_ASSIGNMENT_BACKEND=${KEYSTONE_ASSIGNMENT_BACKEND:-sql}
70
Brant Knudson331a64f2015-05-11 10:02:24 -050071# Select Keystone's token provider (and format)
72# Choose from 'uuid', 'pki', 'pkiz', or 'fernet'
Sean Dague53753292014-12-04 19:38:15 -050073KEYSTONE_TOKEN_FORMAT=${KEYSTONE_TOKEN_FORMAT:-}
Brant Knudson1e1fce82014-06-19 16:55:45 -050074KEYSTONE_TOKEN_FORMAT=$(echo ${KEYSTONE_TOKEN_FORMAT} | tr '[:upper:]' '[:lower:]')
Dean Troyerbc071bc2012-10-01 14:06:44 -050075
Dean Troyerd81a0272012-08-31 18:04:55 -050076# Set Keystone interface configuration
Dean Troyerd81a0272012-08-31 18:04:55 -050077KEYSTONE_AUTH_HOST=${KEYSTONE_AUTH_HOST:-$SERVICE_HOST}
78KEYSTONE_AUTH_PORT=${KEYSTONE_AUTH_PORT:-35357}
Dean Troyerc83a7e12012-11-29 11:47:58 -060079KEYSTONE_AUTH_PORT_INT=${KEYSTONE_AUTH_PORT_INT:-35358}
80KEYSTONE_AUTH_PROTOCOL=${KEYSTONE_AUTH_PROTOCOL:-$SERVICE_PROTOCOL}
81
82# Public facing bits
Dean Troyerd81a0272012-08-31 18:04:55 -050083KEYSTONE_SERVICE_HOST=${KEYSTONE_SERVICE_HOST:-$SERVICE_HOST}
84KEYSTONE_SERVICE_PORT=${KEYSTONE_SERVICE_PORT:-5000}
Dean Troyerc83a7e12012-11-29 11:47:58 -060085KEYSTONE_SERVICE_PORT_INT=${KEYSTONE_SERVICE_PORT_INT:-5001}
86KEYSTONE_SERVICE_PROTOCOL=${KEYSTONE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Dean Troyerd81a0272012-08-31 18:04:55 -050087
David Kranz041fa712014-02-24 13:30:59 -050088# Bind hosts
89KEYSTONE_ADMIN_BIND_HOST=${KEYSTONE_ADMIN_BIND_HOST:-$KEYSTONE_SERVICE_HOST}
Dean Troyerb7490da2013-03-18 16:07:56 -050090# Set the tenant for service accounts in Keystone
91SERVICE_TENANT_NAME=${SERVICE_TENANT_NAME:-service}
92
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100093# if we are running with SSL use https protocols
Rob Crittenden18d47782014-03-19 17:47:42 -040094if is_ssl_enabled_service "key" || is_service_enabled tls-proxy; then
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100095 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
Steve Martinellib74e01c2014-12-18 01:35:35 -0500103# V3 URIs
104KEYSTONE_AUTH_URI_V3=$KEYSTONE_AUTH_URI/v3
105KEYSTONE_SERVICE_URI_V3=$KEYSTONE_SERVICE_URI/v3
106
Dean Troyer5ce44cd2015-02-12 22:18:33 -0600107
Dean Troyercc6b4432013-04-08 15:38:03 -0500108# Functions
109# ---------
Dean Troyer5ce44cd2015-02-12 22:18:33 -0600110
111# Test if Keystone is enabled
112# is_keystone_enabled
113function is_keystone_enabled {
114 [[ ,${ENABLED_SERVICES}, =~ ,"key", ]] && return 0
115 return 1
116}
117
Dean Troyerd81a0272012-08-31 18:04:55 -0500118# cleanup_keystone() - Remove residual data files, anything left over from previous
119# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100120function cleanup_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700121 _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -0500122}
123
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000124# _cleanup_keystone_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
Ian Wienandaee18c72014-02-21 15:35:08 +1100125function _cleanup_keystone_apache_wsgi {
Morgan Fainberg970ee902014-06-09 12:07:29 -0700126 sudo rm -f $(apache_site_config_for keystone)
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000127}
128
129# _config_keystone_apache_wsgi() - Set WSGI config files of Keystone
Ian Wienandaee18c72014-02-21 15:35:08 +1100130function _config_keystone_apache_wsgi {
Ian Wienandada886d2015-10-07 14:06:26 +1100131 local keystone_apache_conf
132 keystone_apache_conf=$(apache_site_config_for keystone)
Rob Crittenden18d47782014-03-19 17:47:42 -0400133 local keystone_ssl=""
134 local keystone_certfile=""
135 local keystone_keyfile=""
136 local keystone_service_port=$KEYSTONE_SERVICE_PORT
137 local keystone_auth_port=$KEYSTONE_AUTH_PORT
Dean Troyerf8ae6472015-02-17 11:05:06 -0600138 local venv_path=""
Rob Crittenden18d47782014-03-19 17:47:42 -0400139
140 if is_ssl_enabled_service key; then
141 keystone_ssl="SSLEngine On"
142 keystone_certfile="SSLCertificateFile $KEYSTONE_SSL_CERT"
143 keystone_keyfile="SSLCertificateKeyFile $KEYSTONE_SSL_KEY"
144 fi
145 if is_service_enabled tls-proxy; then
146 keystone_service_port=$KEYSTONE_SERVICE_PORT_INT
147 keystone_auth_port=$KEYSTONE_AUTH_PORT_INT
148 fi
Dean Troyerf8ae6472015-02-17 11:05:06 -0600149 if [[ ${USE_VENV} = True ]]; then
Chris Dent3a2c86a2015-05-12 13:41:25 +0000150 venv_path="python-path=${PROJECT_VENV["keystone"]}/lib/$(python_version)/site-packages"
Dean Troyerf8ae6472015-02-17 11:05:06 -0600151 fi
Morgan Fainbergd074dc72014-06-24 21:33:39 -0700152
Morgan Fainberg970ee902014-06-09 12:07:29 -0700153 sudo cp $FILES/apache-keystone.template $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000154 sudo sed -e "
Rob Crittenden18d47782014-03-19 17:47:42 -0400155 s|%PUBLICPORT%|$keystone_service_port|g;
156 s|%ADMINPORT%|$keystone_auth_port|g;
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000157 s|%APACHE_NAME%|$APACHE_NAME|g;
Rob Crittenden18d47782014-03-19 17:47:42 -0400158 s|%SSLENGINE%|$keystone_ssl|g;
159 s|%SSLCERTFILE%|$keystone_certfile|g;
160 s|%SSLKEYFILE%|$keystone_keyfile|g;
Dean Troyerf8ae6472015-02-17 11:05:06 -0600161 s|%USER%|$STACK_USER|g;
162 s|%VIRTUALENV%|$venv_path|g
Brant Knudson2ad1a422015-06-23 10:53:50 -0500163 s|%KEYSTONE_BIN%|$KEYSTONE_BIN_DIR|g
Morgan Fainberg970ee902014-06-09 12:07:29 -0700164 " -i $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000165}
166
Dean Troyerd81a0272012-08-31 18:04:55 -0500167# configure_keystone() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100168function configure_keystone {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500169 sudo install -d -o $STACK_USER $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500170
171 if [[ "$KEYSTONE_CONF_DIR" != "$KEYSTONE_DIR/etc" ]]; then
Dean Troyer8421c2b2015-03-16 13:52:19 -0500172 install -m 600 $KEYSTONE_DIR/etc/keystone.conf.sample $KEYSTONE_CONF
Dean Troyerd81a0272012-08-31 18:04:55 -0500173 cp -p $KEYSTONE_DIR/etc/policy.json $KEYSTONE_CONF_DIR
Alan Pevece0bb4472013-03-12 11:10:52 +0100174 if [[ -f "$KEYSTONE_DIR/etc/keystone-paste.ini" ]]; then
175 cp -p "$KEYSTONE_DIR/etc/keystone-paste.ini" "$KEYSTONE_PASTE_INI"
176 fi
177 fi
178 if [[ -f "$KEYSTONE_PASTE_INI" ]]; then
179 iniset "$KEYSTONE_CONF" paste_deploy config_file "$KEYSTONE_PASTE_INI"
180 else
181 # compatibility with mixed cfg and paste.deploy configuration
182 KEYSTONE_PASTE_INI="$KEYSTONE_CONF"
Dean Troyerd81a0272012-08-31 18:04:55 -0500183 fi
184
Samuel de Medeiros Queiroz3fd71d62015-05-03 14:54:45 -0300185 if [ "$ENABLE_IDENTITY_V2" == "False" ]; then
186 # Only Identity v3 API should be available; then disable v2 pipelines
187 inidelete $KEYSTONE_PASTE_INI composite:main \\/v2.0
188 inidelete $KEYSTONE_PASTE_INI composite:admin \\/v2.0
189 fi
190
Dean Troyerd81a0272012-08-31 18:04:55 -0500191 # Rewrite stock ``keystone.conf``
Dean Troyerc83a7e12012-11-29 11:47:58 -0600192
Brad Topolf127e2f2013-01-22 10:17:50 -0600193 if is_service_enabled ldap; then
194 #Set all needed ldap values
Dean Troyerb9e25132013-10-01 14:45:04 -0500195 iniset $KEYSTONE_CONF ldap password $LDAP_PASSWORD
196 iniset $KEYSTONE_CONF ldap user $LDAP_MANAGER_DN
197 iniset $KEYSTONE_CONF ldap suffix $LDAP_BASE_DN
Brad Topolf41024e2013-02-19 15:36:41 -0600198 iniset $KEYSTONE_CONF ldap use_dumb_member "True"
Morgan Fainberg2dc11fb2013-09-24 23:43:08 -0700199 iniset $KEYSTONE_CONF ldap user_attribute_ignore "enabled,email,tenants,default_project_id"
Brad Topolf41024e2013-02-19 15:36:41 -0600200 iniset $KEYSTONE_CONF ldap tenant_attribute_ignore "enabled"
201 iniset $KEYSTONE_CONF ldap tenant_domain_id_attribute "businessCategory"
202 iniset $KEYSTONE_CONF ldap tenant_desc_attribute "description"
Dean Troyerb9e25132013-10-01 14:45:04 -0500203 iniset $KEYSTONE_CONF ldap tenant_tree_dn "ou=Projects,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600204 iniset $KEYSTONE_CONF ldap user_domain_id_attribute "businessCategory"
Dean Troyerb9e25132013-10-01 14:45:04 -0500205 iniset $KEYSTONE_CONF ldap user_tree_dn "ou=Users,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600206 iniset $KEYSTONE_CONF DEFAULT member_role_id "9fe2ff9ee4384b1894a90878d3e92bab"
207 iniset $KEYSTONE_CONF DEFAULT member_role_name "_member_"
Brad Topolf127e2f2013-01-22 10:17:50 -0600208 fi
209
Brant Knudson331a64f2015-05-11 10:02:24 -0500210 iniset $KEYSTONE_CONF identity driver "$KEYSTONE_IDENTITY_BACKEND"
211 iniset $KEYSTONE_CONF assignment driver "$KEYSTONE_ASSIGNMENT_BACKEND"
Brad Topolf127e2f2013-01-22 10:17:50 -0600212
Brant Knudson2dd110c2015-03-14 12:39:14 -0500213 iniset_rpc_backend keystone $KEYSTONE_CONF
Sergey Skripnick8464a4c2014-07-08 21:05:23 +0300214
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
Brant Knudson7448edb2015-03-11 20:06:26 -0500219 iniset $KEYSTONE_CONF eventlet_server_ssl enable True
220 iniset $KEYSTONE_CONF eventlet_server_ssl certfile $KEYSTONE_SSL_CERT
221 iniset $KEYSTONE_CONF eventlet_server_ssl keyfile $KEYSTONE_SSL_KEY
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000222 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
Brant Knudson7448edb2015-03-11 20:06:26 -0500226 iniset $KEYSTONE_CONF eventlet_server public_port $KEYSTONE_SERVICE_PORT_INT
227 iniset $KEYSTONE_CONF eventlet_server admin_port $KEYSTONE_AUTH_PORT_INT
Rob Crittendencdba7b02015-05-26 15:33:45 -0400228
229 iniset $KEYSTONE_CONF DEFAULT public_endpoint $KEYSTONE_SERVICE_URI
230 iniset $KEYSTONE_CONF DEFAULT admin_endpoint $KEYSTONE_AUTH_URI
Dean Troyerc83a7e12012-11-29 11:47:58 -0600231 fi
232
Dean Troyerd81a0272012-08-31 18:04:55 -0500233 iniset $KEYSTONE_CONF DEFAULT admin_token "$SERVICE_TOKEN"
Sudarshan Acharya37631412013-07-16 00:47:54 +0000234
Brant Knudson1e1fce82014-06-19 16:55:45 -0500235 if [[ "$KEYSTONE_TOKEN_FORMAT" != "" ]]; then
Brant Knudson331a64f2015-05-11 10:02:24 -0500236 iniset $KEYSTONE_CONF token provider $KEYSTONE_TOKEN_FORMAT
Sudarshan Acharya37631412013-07-16 00:47:54 +0000237 fi
238
Brant Knudson16d3ad02014-02-13 18:59:50 -0600239 iniset $KEYSTONE_CONF database connection `database_connection_url keystone`
Dean Troyerd81a0272012-08-31 18:04:55 -0500240
Brant Knudson331a64f2015-05-11 10:02:24 -0500241 iniset $KEYSTONE_CONF token driver "$KEYSTONE_TOKEN_BACKEND"
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500242
Brant Knudson331a64f2015-05-11 10:02:24 -0500243 iniset $KEYSTONE_CONF catalog driver "$KEYSTONE_CATALOG_BACKEND"
Dean Troyerd81a0272012-08-31 18:04:55 -0500244 if [[ "$KEYSTONE_CATALOG_BACKEND" = "sql" ]]; then
245 # Configure ``keystone.conf`` to use sql
Dean Troyerd81a0272012-08-31 18:04:55 -0500246 inicomment $KEYSTONE_CONF catalog template_file
247 else
248 cp -p $FILES/default_catalog.templates $KEYSTONE_CATALOG
249
250 # Add swift endpoints to service catalog if swift is enabled
Chmouel Boudjnah0c3a5582013-03-06 10:58:33 +0100251 if is_service_enabled s-proxy; then
Falk Reimann22f747b2015-08-28 12:40:19 +0200252 echo "catalog.RegionOne.object_store.publicURL = http://%SERVICE_HOST%:$SWIFT_DEFAULT_BIND_PORT/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
253 echo "catalog.RegionOne.object_store.adminURL = http://%SERVICE_HOST%:$SWIFT_DEFAULT_BIND_PORT/" >> $KEYSTONE_CATALOG
254 echo "catalog.RegionOne.object_store.internalURL = http://%SERVICE_HOST%:$SWIFT_DEFAULT_BIND_PORT/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
Dean Troyerd81a0272012-08-31 18:04:55 -0500255 echo "catalog.RegionOne.object_store.name = Swift Service" >> $KEYSTONE_CATALOG
256 fi
257
Mark McClainb05c8762013-07-06 23:29:39 -0400258 # Add neutron endpoints to service catalog if neutron is enabled
259 if is_service_enabled neutron; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500260 echo "catalog.RegionOne.network.publicURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
261 echo "catalog.RegionOne.network.adminURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
262 echo "catalog.RegionOne.network.internalURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
Mark McClainb05c8762013-07-06 23:29:39 -0400263 echo "catalog.RegionOne.network.name = Neutron Service" >> $KEYSTONE_CATALOG
Dean Troyerd81a0272012-08-31 18:04:55 -0500264 fi
265
Vincent Untz7e86dbe2012-12-13 08:50:37 +0100266 sed -e "
Dean Troyerd81a0272012-08-31 18:04:55 -0500267 s,%SERVICE_HOST%,$SERVICE_HOST,g;
268 s,%S3_SERVICE_PORT%,$S3_SERVICE_PORT,g;
269 " -i $KEYSTONE_CATALOG
270
271 # Configure ``keystone.conf`` to use templates
Dean Troyerd81a0272012-08-31 18:04:55 -0500272 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
Brant Knudson0fc336d2015-02-08 11:03:02 -0600285 iniset $KEYSTONE_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
286
Morgan Fainberg46455a32014-06-20 10:37:18 -0700287 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Morgan Fainberg2c2b1cc2014-05-01 22:05:41 -0700288 # Eliminate the %(asctime)s.%(msecs)03d from the log format strings
289 iniset $KEYSTONE_CONF DEFAULT logging_context_format_string "%(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s"
290 iniset $KEYSTONE_CONF DEFAULT logging_default_format_string "%(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s"
291 iniset $KEYSTONE_CONF DEFAULT logging_debug_format_suffix "%(funcName)s %(pathname)s:%(lineno)d"
292 iniset $KEYSTONE_CONF DEFAULT logging_exception_prefix "%(process)d TRACE %(name)s %(instance)s"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000293 _config_keystone_apache_wsgi
gordon chunge42306d2015-12-10 14:54:01 -0500294 else
295 iniset $KEYSTONE_CONF eventlet_server admin_bind_host "$KEYSTONE_ADMIN_BIND_HOST"
296 iniset $KEYSTONE_CONF eventlet_server admin_workers "$API_WORKERS"
297 # Public workers will use the server default, typically number of CPU.
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000298 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100299
300 iniset $KEYSTONE_CONF DEFAULT max_token_size 16384
Brant Knudson85a17ea2014-09-13 14:49:24 -0500301
Brant Knudsoncef5e402015-06-25 17:57:53 -0500302 iniset $KEYSTONE_CONF fernet_tokens key_repository "$KEYSTONE_CONF_DIR/fernet-keys/"
Dean Troyerd81a0272012-08-31 18:04:55 -0500303}
304
Dean Troyerd835de82012-11-29 17:11:35 -0600305# create_keystone_accounts() - Sets up common required keystone accounts
306
307# Tenant User Roles
308# ------------------------------------------------------------------
Dean Troyerd835de82012-11-29 17:11:35 -0600309# admin admin admin
Dean Troyer42a59c22014-03-03 14:31:29 -0600310# service -- --
311# -- -- service
312# -- -- ResellerAdmin
313# -- -- Member
Dean Troyerd835de82012-11-29 17:11:35 -0600314# demo admin admin
315# demo demo Member, anotherrole
316# invisible_to_admin demo Member
317
Steve Martinelli4599fd12015-03-12 21:30:58 -0400318# Group Users Roles Tenant
319# ------------------------------------------------------------------
320# admins admin admin admin
Hidekazu Nakamura17fe88a2015-09-11 19:50:26 +0900321# nonadmins demo Member, anotherrole demo
Steve Martinelli4599fd12015-03-12 21:30:58 -0400322
323
Dean Troyerd835de82012-11-29 17:11:35 -0600324# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100325function create_keystone_accounts {
Dean Troyerd835de82012-11-29 17:11:35 -0600326
327 # admin
Ian Wienandada886d2015-10-07 14:06:26 +1100328 local admin_tenant
329 admin_tenant=$(get_or_create_project "admin" default)
330 local admin_user
331 admin_user=$(get_or_create_user "admin" "$ADMIN_PASSWORD" default)
332 local admin_role
333 admin_role=$(get_or_create_role "admin")
Jamie Lennox9b215db2015-02-10 18:19:57 +1100334 get_or_add_user_project_role $admin_role $admin_user $admin_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600335
Dean Troyer42a59c22014-03-03 14:31:29 -0600336 # Create service project/role
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000337 get_or_create_project "$SERVICE_TENANT_NAME" default
Dean Troyer42a59c22014-03-03 14:31:29 -0600338
339 # Service role, so service users do not have to be admins
Bartosz Górski0abde392014-02-28 14:15:19 +0100340 get_or_create_role service
Dean Troyer42a59c22014-03-03 14:31:29 -0600341
342 # The ResellerAdmin role is used by Nova and Ceilometer so we need to keep it.
343 # The admin role in swift allows a user to act as an admin for their tenant,
344 # but ResellerAdmin is needed for a user to act as any tenant. The name of this
345 # role is also configurable in swift-proxy.conf
Bartosz Górski0abde392014-02-28 14:15:19 +0100346 get_or_create_role ResellerAdmin
Dean Troyerd835de82012-11-29 17:11:35 -0600347
348 # The Member role is used by Horizon and Swift so we need to keep it:
Ian Wienandada886d2015-10-07 14:06:26 +1100349 local member_role
350 member_role=$(get_or_create_role "Member")
Bartosz Górski0abde392014-02-28 14:15:19 +0100351
Masayuki Igawad3654052014-09-01 17:30:05 +0900352 # another_role demonstrates that an arbitrary role may be created and used
Dean Troyerd835de82012-11-29 17:11:35 -0600353 # TODO(sleepsonthefloor): show how this can be used for rbac in the future!
Ian Wienandada886d2015-10-07 14:06:26 +1100354 local another_role
355 another_role=$(get_or_create_role "anotherrole")
Dean Troyerd835de82012-11-29 17:11:35 -0600356
357 # invisible tenant - admin can't see this one
Ian Wienandada886d2015-10-07 14:06:26 +1100358 local invis_tenant
359 invis_tenant=$(get_or_create_project "invisible_to_admin" default)
Dean Troyerd835de82012-11-29 17:11:35 -0600360
361 # demo
Ian Wienandada886d2015-10-07 14:06:26 +1100362 local demo_tenant
363 demo_tenant=$(get_or_create_project "demo" default)
364 local demo_user
365 demo_user=$(get_or_create_user "demo" \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000366 "$ADMIN_PASSWORD" "default" "demo@example.com")
Steve Martinelli19685422014-01-24 13:02:26 -0600367
Jamie Lennox9b215db2015-02-10 18:19:57 +1100368 get_or_add_user_project_role $member_role $demo_user $demo_tenant
369 get_or_add_user_project_role $admin_role $admin_user $demo_tenant
370 get_or_add_user_project_role $another_role $demo_user $demo_tenant
371 get_or_add_user_project_role $member_role $demo_user $invis_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600372
Ian Wienandada886d2015-10-07 14:06:26 +1100373 local admin_group
374 admin_group=$(get_or_create_group "admins" \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400375 "default" "openstack admin group")
Ian Wienandada886d2015-10-07 14:06:26 +1100376 local non_admin_group
377 non_admin_group=$(get_or_create_group "nonadmins" \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400378 "default" "non-admin group")
379
380 get_or_add_group_project_role $member_role $non_admin_group $demo_tenant
381 get_or_add_group_project_role $another_role $non_admin_group $demo_tenant
382 get_or_add_group_project_role $admin_role $admin_group $admin_tenant
Steve Martinellib74e01c2014-12-18 01:35:35 -0500383
Dean Troyerd835de82012-11-29 17:11:35 -0600384 # Keystone
385 if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100386
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000387 get_or_create_service "keystone" "identity" "Keystone Identity Service"
388 get_or_create_endpoint "identity" \
Bartosz Górski0abde392014-02-28 14:15:19 +0100389 "$REGION_NAME" \
390 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION" \
391 "$KEYSTONE_AUTH_PROTOCOL://$KEYSTONE_AUTH_HOST:$KEYSTONE_AUTH_PORT/v$IDENTITY_API_VERSION" \
392 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION"
Dean Troyerd835de82012-11-29 17:11:35 -0600393 fi
Dean Troyerd835de82012-11-29 17:11:35 -0600394}
395
Jamie Lennox85ff5322015-01-28 14:28:01 +1000396# Create a user that is capable of verifying keystone tokens for use with auth_token middleware.
397#
398# create_service_user <name> [role]
399#
400# The role defaults to the service role. It is allowed to be provided as optional as historically
401# a lot of projects have configured themselves with the admin or other role here if they are
402# using this user for other purposes beyond simply auth_token middleware.
403function create_service_user {
404 local role=${2:-service}
405
Ian Wienandada886d2015-10-07 14:06:26 +1100406 local user
407 user=$(get_or_create_user "$1" "$SERVICE_PASSWORD" default)
Jamie Lennox9b215db2015-02-10 18:19:57 +1100408 get_or_add_user_project_role "$role" "$user" "$SERVICE_TENANT_NAME"
Jamie Lennox85ff5322015-01-28 14:28:01 +1000409}
410
Brant Knudson05952372014-09-19 17:22:22 -0500411# Configure the service to use the auth token middleware.
412#
413# configure_auth_token_middleware conf_file admin_user signing_dir [section]
414#
415# section defaults to keystone_authtoken, which is where auth_token looks in
416# the .conf file. If the paste config file is used (api-paste.ini) then
417# provide the section name for the auth_token filter.
418function configure_auth_token_middleware {
419 local conf_file=$1
420 local admin_user=$2
421 local signing_dir=$3
422 local section=${4:-keystone_authtoken}
423
Jamie Lennox78b77262014-12-19 12:56:01 +1000424 iniset $conf_file $section auth_plugin password
425 iniset $conf_file $section auth_url $KEYSTONE_AUTH_URI
426 iniset $conf_file $section username $admin_user
427 iniset $conf_file $section password $SERVICE_PASSWORD
428 iniset $conf_file $section user_domain_id default
429 iniset $conf_file $section project_name $SERVICE_TENANT_NAME
430 iniset $conf_file $section project_domain_id default
431
432 iniset $conf_file $section auth_uri $KEYSTONE_SERVICE_URI
Rob Crittenden18d47782014-03-19 17:47:42 -0400433 iniset $conf_file $section cafile $SSL_BUNDLE_FILE
Brant Knudson05952372014-09-19 17:22:22 -0500434 iniset $conf_file $section signing_dir $signing_dir
Vincent Hou21fe4e72013-11-21 03:10:27 -0500435}
436
Dean Troyerd81a0272012-08-31 18:04:55 -0500437# init_keystone() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100438function init_keystone {
Dean Troyerb9e25132013-10-01 14:45:04 -0500439 if is_service_enabled ldap; then
440 init_ldap
441 fi
442
Dean Troyerd81a0272012-08-31 18:04:55 -0500443 # (Re)create keystone database
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +0200444 recreate_database keystone
Dean Troyerd81a0272012-08-31 18:04:55 -0500445
446 # Initialize keystone database
Dean Troyerf8ae6472015-02-17 11:05:06 -0600447 $KEYSTONE_BIN_DIR/keystone-manage db_sync
Dean Troyerd81a0272012-08-31 18:04:55 -0500448
Brant Knudsoncef5e402015-06-25 17:57:53 -0500449 if [[ "$KEYSTONE_TOKEN_FORMAT" == "pki" || "$KEYSTONE_TOKEN_FORMAT" == "pkiz" ]]; 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 Troyerf8ae6472015-02-17 11:05:06 -0600452 $KEYSTONE_BIN_DIR/keystone-manage pki_setup
Dean Troyerbc071bc2012-10-01 14:06:44 -0500453 fi
Brant Knudsoncef5e402015-06-25 17:57:53 -0500454 if [[ "$KEYSTONE_TOKEN_FORMAT" == "fernet" ]]; then
455 rm -rf "$KEYSTONE_CONF_DIR/fernet-keys/"
456 $KEYSTONE_BIN_DIR/keystone-manage fernet_setup
457 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500458}
459
Jamie Lennox21a90772015-07-03 11:54:38 +1000460# install_keystoneauth() - Collect source and prepare
461function install_keystoneauth {
462 if use_library_from_git "keystoneauth"; then
463 git_clone_by_name "keystoneauth"
464 setup_dev_lib "keystoneauth"
465 fi
466}
467
Dean Troyerd81a0272012-08-31 18:04:55 -0500468# install_keystoneclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100469function install_keystoneclient {
Sean Daguee08ab102014-11-13 17:09:28 -0500470 if use_library_from_git "python-keystoneclient"; then
471 git_clone_by_name "python-keystoneclient"
472 setup_dev_lib "python-keystoneclient"
473 sudo install -D -m 0644 -o $STACK_USER {${GITDIR["python-keystoneclient"]}/tools/,/etc/bash_completion.d/}keystone.bash_completion
Sean Dague5cb19062014-11-01 01:37:45 +0100474 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500475}
476
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700477# install_keystonemiddleware() - Collect source and prepare
478function install_keystonemiddleware {
Dean Troyerf8ae6472015-02-17 11:05:06 -0600479 # install_keystonemiddleware() is called when keystonemiddleware is needed
480 # to provide an opportunity to install it from the source repo
Sean Dague658312c2014-11-14 11:35:56 -0500481 if use_library_from_git "keystonemiddleware"; then
482 git_clone_by_name "keystonemiddleware"
483 setup_dev_lib "keystonemiddleware"
Dean Troyerf8ae6472015-02-17 11:05:06 -0600484 else
485 # When not installing from repo, keystonemiddleware is still needed...
Sean Dague60996b12015-04-08 09:06:49 -0400486 pip_install_gr keystonemiddleware
Sean Dague658312c2014-11-14 11:35:56 -0500487 fi
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700488}
489
Dean Troyerd81a0272012-08-31 18:04:55 -0500490# install_keystone() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100491function install_keystone {
Brad Topolf127e2f2013-01-22 10:17:50 -0600492 # only install ldap if the service has been enabled
493 if is_service_enabled ldap; then
494 install_ldap
495 fi
Peter Feiner61ae7c12013-11-15 10:42:30 -0500496 if [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
497 # Install memcached and the memcache Python library that keystone uses.
498 # Unfortunately the Python library goes by different names in the .deb
499 # and .rpm circles.
500 install_package memcached
501 if is_ubuntu; then
502 install_package python-memcache
503 else
504 install_package python-memcached
505 fi
506 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500507 git_clone $KEYSTONE_REPO $KEYSTONE_DIR $KEYSTONE_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400508 setup_develop $KEYSTONE_DIR
Brant Knudson6a4d3eb2015-08-01 09:19:18 -0500509
510 if is_service_enabled ldap; then
511 setup_develop $KEYSTONE_DIR ldap
512 fi
513
Morgan Fainberg46455a32014-06-20 10:37:18 -0700514 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000515 install_apache_wsgi
Rob Crittenden18d47782014-03-19 17:47:42 -0400516 if is_ssl_enabled_service "key"; then
517 enable_mod_ssl
518 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000519 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500520}
521
522# start_keystone() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100523function start_keystone {
Dean Troyerc83a7e12012-11-29 11:47:58 -0600524 # Get right service port for testing
525 local service_port=$KEYSTONE_SERVICE_PORT
Rob Crittenden18d47782014-03-19 17:47:42 -0400526 local auth_protocol=$KEYSTONE_AUTH_PROTOCOL
Dean Troyerc83a7e12012-11-29 11:47:58 -0600527 if is_service_enabled tls-proxy; then
528 service_port=$KEYSTONE_SERVICE_PORT_INT
Rob Crittenden18d47782014-03-19 17:47:42 -0400529 auth_protocol="http"
Dean Troyerc83a7e12012-11-29 11:47:58 -0600530 fi
531
Morgan Fainberg46455a32014-06-20 10:37:18 -0700532 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700533 enable_apache_site keystone
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000534 restart_apache_server
Chris Dent2f27a0e2014-09-09 13:46:02 +0100535 tail_log key /var/log/$APACHE_NAME/keystone.log
536 tail_log key-access /var/log/$APACHE_NAME/keystone_access.log
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000537 else
538 # Start Keystone in a screen window
Dean Troyerf8ae6472015-02-17 11:05:06 -0600539 run_process key "$KEYSTONE_BIN_DIR/keystone-all --config-file $KEYSTONE_CONF"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000540 fi
541
Dean Troyerd835de82012-11-29 17:11:35 -0600542 echo "Waiting for keystone to start..."
Stanislaw Pituchabe4c9532014-06-11 17:52:49 +0100543 # Check that the keystone service is running. Even if the tls tunnel
544 # should be enabled, make sure the internal port is checked using
545 # unencryted traffic at this point.
sridhargaddamb5ab6462015-02-24 07:23:24 +0000546 if ! wait_for_service $SERVICE_TIMEOUT $auth_protocol://$KEYSTONE_SERVICE_HOST:$service_port/v$IDENTITY_API_VERSION/; then
Sean Dague101b4242013-10-22 08:47:11 -0400547 die $LINENO "keystone did not start"
Dean Troyerd835de82012-11-29 17:11:35 -0600548 fi
Dean Troyerc83a7e12012-11-29 11:47:58 -0600549
550 # Start proxies if enabled
551 if is_service_enabled tls-proxy; then
552 start_tls_proxy '*' $KEYSTONE_SERVICE_PORT $KEYSTONE_SERVICE_HOST $KEYSTONE_SERVICE_PORT_INT &
553 start_tls_proxy '*' $KEYSTONE_AUTH_PORT $KEYSTONE_AUTH_HOST $KEYSTONE_AUTH_PORT_INT &
554 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500555}
556
557# stop_keystone() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100558function stop_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700559 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
560 disable_apache_site keystone
561 restart_apache_server
562 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500563 # Kill the Keystone screen window
Chris Dent2f27a0e2014-09-09 13:46:02 +0100564 stop_process key
Dean Troyerd81a0272012-08-31 18:04:55 -0500565}
Dean Troyer7903b792012-09-13 17:16:12 -0500566
Dean Troyer1a6d4492013-06-03 16:47:36 -0500567
Dean Troyer7903b792012-09-13 17:16:12 -0500568# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100569$_XTRACE_KEYSTONE
Sean Dague584d90e2013-03-29 14:34:53 -0400570
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100571# Tell emacs to use shell-script-mode
572## Local variables:
573## mode: shell-script
574## End: