blob: 0c2722c526b20f21401a8c624151d0fceb77cb88 [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
Steve Martinelli35262762016-01-05 23:56:40 -050071# Select the Role backend driver
72KEYSTONE_ROLE_BACKEND=${KEYSTONE_ROLE_BACKEND:-sql}
73
74# Select the Resource backend driver
75KEYSTONE_RESOURCE_BACKEND=${KEYSTONE_RESOURCE_BACKEND:-sql}
76
Brant Knudson331a64f2015-05-11 10:02:24 -050077# Select Keystone's token provider (and format)
78# Choose from 'uuid', 'pki', 'pkiz', or 'fernet'
Sean Dague53753292014-12-04 19:38:15 -050079KEYSTONE_TOKEN_FORMAT=${KEYSTONE_TOKEN_FORMAT:-}
Brant Knudson1e1fce82014-06-19 16:55:45 -050080KEYSTONE_TOKEN_FORMAT=$(echo ${KEYSTONE_TOKEN_FORMAT} | tr '[:upper:]' '[:lower:]')
Dean Troyerbc071bc2012-10-01 14:06:44 -050081
Dean Troyerd81a0272012-08-31 18:04:55 -050082# Set Keystone interface configuration
Dean Troyerd81a0272012-08-31 18:04:55 -050083KEYSTONE_AUTH_HOST=${KEYSTONE_AUTH_HOST:-$SERVICE_HOST}
84KEYSTONE_AUTH_PORT=${KEYSTONE_AUTH_PORT:-35357}
Dean Troyerc83a7e12012-11-29 11:47:58 -060085KEYSTONE_AUTH_PORT_INT=${KEYSTONE_AUTH_PORT_INT:-35358}
86KEYSTONE_AUTH_PROTOCOL=${KEYSTONE_AUTH_PROTOCOL:-$SERVICE_PROTOCOL}
87
88# Public facing bits
Dean Troyerd81a0272012-08-31 18:04:55 -050089KEYSTONE_SERVICE_HOST=${KEYSTONE_SERVICE_HOST:-$SERVICE_HOST}
90KEYSTONE_SERVICE_PORT=${KEYSTONE_SERVICE_PORT:-5000}
Dean Troyerc83a7e12012-11-29 11:47:58 -060091KEYSTONE_SERVICE_PORT_INT=${KEYSTONE_SERVICE_PORT_INT:-5001}
92KEYSTONE_SERVICE_PROTOCOL=${KEYSTONE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Dean Troyerd81a0272012-08-31 18:04:55 -050093
David Kranz041fa712014-02-24 13:30:59 -050094# Bind hosts
95KEYSTONE_ADMIN_BIND_HOST=${KEYSTONE_ADMIN_BIND_HOST:-$KEYSTONE_SERVICE_HOST}
Dean Troyerb7490da2013-03-18 16:07:56 -050096# Set the tenant for service accounts in Keystone
97SERVICE_TENANT_NAME=${SERVICE_TENANT_NAME:-service}
98
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100099# if we are running with SSL use https protocols
Rob Crittenden18d47782014-03-19 17:47:42 -0400100if is_ssl_enabled_service "key" || is_service_enabled tls-proxy; then
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000101 KEYSTONE_AUTH_PROTOCOL="https"
102 KEYSTONE_SERVICE_PROTOCOL="https"
103fi
104
Jamie Lennox3561d7f2014-05-21 17:18:43 +1000105# complete URIs
106KEYSTONE_AUTH_URI=${KEYSTONE_AUTH_PROTOCOL}://${KEYSTONE_AUTH_HOST}:${KEYSTONE_AUTH_PORT}
107KEYSTONE_SERVICE_URI=${KEYSTONE_SERVICE_PROTOCOL}://${KEYSTONE_SERVICE_HOST}:${KEYSTONE_SERVICE_PORT}
108
Steve Martinellib74e01c2014-12-18 01:35:35 -0500109# V3 URIs
110KEYSTONE_AUTH_URI_V3=$KEYSTONE_AUTH_URI/v3
111KEYSTONE_SERVICE_URI_V3=$KEYSTONE_SERVICE_URI/v3
112
Dean Troyer5ce44cd2015-02-12 22:18:33 -0600113
Dean Troyercc6b4432013-04-08 15:38:03 -0500114# Functions
115# ---------
Dean Troyer5ce44cd2015-02-12 22:18:33 -0600116
117# Test if Keystone is enabled
118# is_keystone_enabled
119function is_keystone_enabled {
120 [[ ,${ENABLED_SERVICES}, =~ ,"key", ]] && return 0
121 return 1
122}
123
Dean Troyerd81a0272012-08-31 18:04:55 -0500124# cleanup_keystone() - Remove residual data files, anything left over from previous
125# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100126function cleanup_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700127 _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -0500128}
129
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000130# _cleanup_keystone_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
Ian Wienandaee18c72014-02-21 15:35:08 +1100131function _cleanup_keystone_apache_wsgi {
Morgan Fainberg970ee902014-06-09 12:07:29 -0700132 sudo rm -f $(apache_site_config_for keystone)
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000133}
134
135# _config_keystone_apache_wsgi() - Set WSGI config files of Keystone
Ian Wienandaee18c72014-02-21 15:35:08 +1100136function _config_keystone_apache_wsgi {
Ian Wienandada886d2015-10-07 14:06:26 +1100137 local keystone_apache_conf
138 keystone_apache_conf=$(apache_site_config_for keystone)
Rob Crittenden18d47782014-03-19 17:47:42 -0400139 local keystone_ssl=""
140 local keystone_certfile=""
141 local keystone_keyfile=""
142 local keystone_service_port=$KEYSTONE_SERVICE_PORT
143 local keystone_auth_port=$KEYSTONE_AUTH_PORT
Dean Troyerf8ae6472015-02-17 11:05:06 -0600144 local venv_path=""
Rob Crittenden18d47782014-03-19 17:47:42 -0400145
146 if is_ssl_enabled_service key; then
147 keystone_ssl="SSLEngine On"
148 keystone_certfile="SSLCertificateFile $KEYSTONE_SSL_CERT"
149 keystone_keyfile="SSLCertificateKeyFile $KEYSTONE_SSL_KEY"
150 fi
151 if is_service_enabled tls-proxy; then
152 keystone_service_port=$KEYSTONE_SERVICE_PORT_INT
153 keystone_auth_port=$KEYSTONE_AUTH_PORT_INT
154 fi
Dean Troyerf8ae6472015-02-17 11:05:06 -0600155 if [[ ${USE_VENV} = True ]]; then
Chris Dent3a2c86a2015-05-12 13:41:25 +0000156 venv_path="python-path=${PROJECT_VENV["keystone"]}/lib/$(python_version)/site-packages"
Dean Troyerf8ae6472015-02-17 11:05:06 -0600157 fi
Morgan Fainbergd074dc72014-06-24 21:33:39 -0700158
Morgan Fainberg970ee902014-06-09 12:07:29 -0700159 sudo cp $FILES/apache-keystone.template $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000160 sudo sed -e "
Rob Crittenden18d47782014-03-19 17:47:42 -0400161 s|%PUBLICPORT%|$keystone_service_port|g;
162 s|%ADMINPORT%|$keystone_auth_port|g;
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000163 s|%APACHE_NAME%|$APACHE_NAME|g;
Rob Crittenden18d47782014-03-19 17:47:42 -0400164 s|%SSLENGINE%|$keystone_ssl|g;
165 s|%SSLCERTFILE%|$keystone_certfile|g;
166 s|%SSLKEYFILE%|$keystone_keyfile|g;
Dean Troyerf8ae6472015-02-17 11:05:06 -0600167 s|%USER%|$STACK_USER|g;
168 s|%VIRTUALENV%|$venv_path|g
Brant Knudson2ad1a422015-06-23 10:53:50 -0500169 s|%KEYSTONE_BIN%|$KEYSTONE_BIN_DIR|g
Morgan Fainberg970ee902014-06-09 12:07:29 -0700170 " -i $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000171}
172
Dean Troyerd81a0272012-08-31 18:04:55 -0500173# configure_keystone() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100174function configure_keystone {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500175 sudo install -d -o $STACK_USER $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500176
177 if [[ "$KEYSTONE_CONF_DIR" != "$KEYSTONE_DIR/etc" ]]; then
Dean Troyer8421c2b2015-03-16 13:52:19 -0500178 install -m 600 $KEYSTONE_DIR/etc/keystone.conf.sample $KEYSTONE_CONF
Dean Troyerd81a0272012-08-31 18:04:55 -0500179 cp -p $KEYSTONE_DIR/etc/policy.json $KEYSTONE_CONF_DIR
Alan Pevece0bb4472013-03-12 11:10:52 +0100180 if [[ -f "$KEYSTONE_DIR/etc/keystone-paste.ini" ]]; then
181 cp -p "$KEYSTONE_DIR/etc/keystone-paste.ini" "$KEYSTONE_PASTE_INI"
182 fi
183 fi
184 if [[ -f "$KEYSTONE_PASTE_INI" ]]; then
185 iniset "$KEYSTONE_CONF" paste_deploy config_file "$KEYSTONE_PASTE_INI"
186 else
187 # compatibility with mixed cfg and paste.deploy configuration
188 KEYSTONE_PASTE_INI="$KEYSTONE_CONF"
Dean Troyerd81a0272012-08-31 18:04:55 -0500189 fi
190
Samuel de Medeiros Queiroz3fd71d62015-05-03 14:54:45 -0300191 if [ "$ENABLE_IDENTITY_V2" == "False" ]; then
192 # Only Identity v3 API should be available; then disable v2 pipelines
193 inidelete $KEYSTONE_PASTE_INI composite:main \\/v2.0
194 inidelete $KEYSTONE_PASTE_INI composite:admin \\/v2.0
195 fi
196
Dean Troyerd81a0272012-08-31 18:04:55 -0500197 # Rewrite stock ``keystone.conf``
Dean Troyerc83a7e12012-11-29 11:47:58 -0600198
Brad Topolf127e2f2013-01-22 10:17:50 -0600199 if is_service_enabled ldap; then
200 #Set all needed ldap values
Dean Troyerb9e25132013-10-01 14:45:04 -0500201 iniset $KEYSTONE_CONF ldap password $LDAP_PASSWORD
202 iniset $KEYSTONE_CONF ldap user $LDAP_MANAGER_DN
203 iniset $KEYSTONE_CONF ldap suffix $LDAP_BASE_DN
Brad Topolf41024e2013-02-19 15:36:41 -0600204 iniset $KEYSTONE_CONF ldap use_dumb_member "True"
Morgan Fainberg2dc11fb2013-09-24 23:43:08 -0700205 iniset $KEYSTONE_CONF ldap user_attribute_ignore "enabled,email,tenants,default_project_id"
Brad Topolf41024e2013-02-19 15:36:41 -0600206 iniset $KEYSTONE_CONF ldap tenant_attribute_ignore "enabled"
207 iniset $KEYSTONE_CONF ldap tenant_domain_id_attribute "businessCategory"
208 iniset $KEYSTONE_CONF ldap tenant_desc_attribute "description"
Dean Troyerb9e25132013-10-01 14:45:04 -0500209 iniset $KEYSTONE_CONF ldap tenant_tree_dn "ou=Projects,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600210 iniset $KEYSTONE_CONF ldap user_domain_id_attribute "businessCategory"
Dean Troyerb9e25132013-10-01 14:45:04 -0500211 iniset $KEYSTONE_CONF ldap user_tree_dn "ou=Users,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600212 iniset $KEYSTONE_CONF DEFAULT member_role_id "9fe2ff9ee4384b1894a90878d3e92bab"
213 iniset $KEYSTONE_CONF DEFAULT member_role_name "_member_"
Brad Topolf127e2f2013-01-22 10:17:50 -0600214 fi
215
Brant Knudson331a64f2015-05-11 10:02:24 -0500216 iniset $KEYSTONE_CONF identity driver "$KEYSTONE_IDENTITY_BACKEND"
217 iniset $KEYSTONE_CONF assignment driver "$KEYSTONE_ASSIGNMENT_BACKEND"
Steve Martinelli35262762016-01-05 23:56:40 -0500218 iniset $KEYSTONE_CONF role driver "$KEYSTONE_ROLE_BACKEND"
219 iniset $KEYSTONE_CONF resource driver "$KEYSTONE_RESOURCE_BACKEND"
Brad Topolf127e2f2013-01-22 10:17:50 -0600220
Brant Knudson2dd110c2015-03-14 12:39:14 -0500221 iniset_rpc_backend keystone $KEYSTONE_CONF
Sergey Skripnick8464a4c2014-07-08 21:05:23 +0300222
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000223 # Register SSL certificates if provided
224 if is_ssl_enabled_service key; then
225 ensure_certificates KEYSTONE
226
Brant Knudson7448edb2015-03-11 20:06:26 -0500227 iniset $KEYSTONE_CONF eventlet_server_ssl enable True
228 iniset $KEYSTONE_CONF eventlet_server_ssl certfile $KEYSTONE_SSL_CERT
229 iniset $KEYSTONE_CONF eventlet_server_ssl keyfile $KEYSTONE_SSL_KEY
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000230 fi
231
Dean Troyerc83a7e12012-11-29 11:47:58 -0600232 if is_service_enabled tls-proxy; then
233 # Set the service ports for a proxy to take the originals
Brant Knudson7448edb2015-03-11 20:06:26 -0500234 iniset $KEYSTONE_CONF eventlet_server public_port $KEYSTONE_SERVICE_PORT_INT
235 iniset $KEYSTONE_CONF eventlet_server admin_port $KEYSTONE_AUTH_PORT_INT
Rob Crittendencdba7b02015-05-26 15:33:45 -0400236
237 iniset $KEYSTONE_CONF DEFAULT public_endpoint $KEYSTONE_SERVICE_URI
238 iniset $KEYSTONE_CONF DEFAULT admin_endpoint $KEYSTONE_AUTH_URI
Dean Troyerc83a7e12012-11-29 11:47:58 -0600239 fi
240
Dean Troyerd81a0272012-08-31 18:04:55 -0500241 iniset $KEYSTONE_CONF DEFAULT admin_token "$SERVICE_TOKEN"
Sudarshan Acharya37631412013-07-16 00:47:54 +0000242
Brant Knudson1e1fce82014-06-19 16:55:45 -0500243 if [[ "$KEYSTONE_TOKEN_FORMAT" != "" ]]; then
Brant Knudson331a64f2015-05-11 10:02:24 -0500244 iniset $KEYSTONE_CONF token provider $KEYSTONE_TOKEN_FORMAT
Sudarshan Acharya37631412013-07-16 00:47:54 +0000245 fi
246
Brant Knudson16d3ad02014-02-13 18:59:50 -0600247 iniset $KEYSTONE_CONF database connection `database_connection_url keystone`
Dean Troyerd81a0272012-08-31 18:04:55 -0500248
Brant Knudson331a64f2015-05-11 10:02:24 -0500249 iniset $KEYSTONE_CONF token driver "$KEYSTONE_TOKEN_BACKEND"
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500250
Brant Knudson331a64f2015-05-11 10:02:24 -0500251 iniset $KEYSTONE_CONF catalog driver "$KEYSTONE_CATALOG_BACKEND"
Dean Troyerd81a0272012-08-31 18:04:55 -0500252 if [[ "$KEYSTONE_CATALOG_BACKEND" = "sql" ]]; then
253 # Configure ``keystone.conf`` to use sql
Dean Troyerd81a0272012-08-31 18:04:55 -0500254 inicomment $KEYSTONE_CONF catalog template_file
255 else
256 cp -p $FILES/default_catalog.templates $KEYSTONE_CATALOG
257
258 # Add swift endpoints to service catalog if swift is enabled
Chmouel Boudjnah0c3a5582013-03-06 10:58:33 +0100259 if is_service_enabled s-proxy; then
Falk Reimann22f747b2015-08-28 12:40:19 +0200260 echo "catalog.RegionOne.object_store.publicURL = http://%SERVICE_HOST%:$SWIFT_DEFAULT_BIND_PORT/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
261 echo "catalog.RegionOne.object_store.adminURL = http://%SERVICE_HOST%:$SWIFT_DEFAULT_BIND_PORT/" >> $KEYSTONE_CATALOG
262 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 -0500263 echo "catalog.RegionOne.object_store.name = Swift Service" >> $KEYSTONE_CATALOG
264 fi
265
Mark McClainb05c8762013-07-06 23:29:39 -0400266 # Add neutron endpoints to service catalog if neutron is enabled
267 if is_service_enabled neutron; then
Dean Troyerd81a0272012-08-31 18:04:55 -0500268 echo "catalog.RegionOne.network.publicURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
269 echo "catalog.RegionOne.network.adminURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
270 echo "catalog.RegionOne.network.internalURL = http://%SERVICE_HOST%:$Q_PORT/" >> $KEYSTONE_CATALOG
Mark McClainb05c8762013-07-06 23:29:39 -0400271 echo "catalog.RegionOne.network.name = Neutron Service" >> $KEYSTONE_CATALOG
Dean Troyerd81a0272012-08-31 18:04:55 -0500272 fi
273
Vincent Untz7e86dbe2012-12-13 08:50:37 +0100274 sed -e "
Dean Troyerd81a0272012-08-31 18:04:55 -0500275 s,%SERVICE_HOST%,$SERVICE_HOST,g;
276 s,%S3_SERVICE_PORT%,$S3_SERVICE_PORT,g;
277 " -i $KEYSTONE_CATALOG
278
279 # Configure ``keystone.conf`` to use templates
Dean Troyerd81a0272012-08-31 18:04:55 -0500280 iniset $KEYSTONE_CONF catalog template_file "$KEYSTONE_CATALOG"
281 fi
282
283 # Set up logging
Dean Troyerd81a0272012-08-31 18:04:55 -0500284 if [ "$SYSLOG" != "False" ]; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600285 iniset $KEYSTONE_CONF DEFAULT use_syslog "True"
Dean Troyerd81a0272012-08-31 18:04:55 -0500286 fi
Brant Knudson4968d1a2014-01-22 19:06:44 -0600287
288 # Format logging
Morgan Fainberg46455a32014-06-20 10:37:18 -0700289 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && [ "$KEYSTONE_USE_MOD_WSGI" == "False" ] ; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600290 setup_colorized_logging $KEYSTONE_CONF DEFAULT
291 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000292
Brant Knudson0fc336d2015-02-08 11:03:02 -0600293 iniset $KEYSTONE_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
294
Morgan Fainberg46455a32014-06-20 10:37:18 -0700295 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Morgan Fainberg2c2b1cc2014-05-01 22:05:41 -0700296 # Eliminate the %(asctime)s.%(msecs)03d from the log format strings
297 iniset $KEYSTONE_CONF DEFAULT logging_context_format_string "%(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s"
298 iniset $KEYSTONE_CONF DEFAULT logging_default_format_string "%(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s"
299 iniset $KEYSTONE_CONF DEFAULT logging_debug_format_suffix "%(funcName)s %(pathname)s:%(lineno)d"
300 iniset $KEYSTONE_CONF DEFAULT logging_exception_prefix "%(process)d TRACE %(name)s %(instance)s"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000301 _config_keystone_apache_wsgi
gordon chunge42306d2015-12-10 14:54:01 -0500302 else
303 iniset $KEYSTONE_CONF eventlet_server admin_bind_host "$KEYSTONE_ADMIN_BIND_HOST"
304 iniset $KEYSTONE_CONF eventlet_server admin_workers "$API_WORKERS"
305 # Public workers will use the server default, typically number of CPU.
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000306 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100307
308 iniset $KEYSTONE_CONF DEFAULT max_token_size 16384
Brant Knudson85a17ea2014-09-13 14:49:24 -0500309
Brant Knudsoncef5e402015-06-25 17:57:53 -0500310 iniset $KEYSTONE_CONF fernet_tokens key_repository "$KEYSTONE_CONF_DIR/fernet-keys/"
Dean Troyerd81a0272012-08-31 18:04:55 -0500311}
312
Dean Troyerd835de82012-11-29 17:11:35 -0600313# create_keystone_accounts() - Sets up common required keystone accounts
314
315# Tenant User Roles
316# ------------------------------------------------------------------
Dean Troyerd835de82012-11-29 17:11:35 -0600317# admin admin admin
Dean Troyer42a59c22014-03-03 14:31:29 -0600318# service -- --
319# -- -- service
320# -- -- ResellerAdmin
321# -- -- Member
Dean Troyerd835de82012-11-29 17:11:35 -0600322# demo admin admin
323# demo demo Member, anotherrole
324# invisible_to_admin demo Member
325
Steve Martinelli4599fd12015-03-12 21:30:58 -0400326# Group Users Roles Tenant
327# ------------------------------------------------------------------
328# admins admin admin admin
Hidekazu Nakamura17fe88a2015-09-11 19:50:26 +0900329# nonadmins demo Member, anotherrole demo
Steve Martinelli4599fd12015-03-12 21:30:58 -0400330
331
Dean Troyerd835de82012-11-29 17:11:35 -0600332# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100333function create_keystone_accounts {
Dean Troyerd835de82012-11-29 17:11:35 -0600334
335 # admin
Ian Wienandada886d2015-10-07 14:06:26 +1100336 local admin_tenant
337 admin_tenant=$(get_or_create_project "admin" default)
338 local admin_user
339 admin_user=$(get_or_create_user "admin" "$ADMIN_PASSWORD" default)
340 local admin_role
341 admin_role=$(get_or_create_role "admin")
Jamie Lennox9b215db2015-02-10 18:19:57 +1100342 get_or_add_user_project_role $admin_role $admin_user $admin_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600343
Dean Troyer42a59c22014-03-03 14:31:29 -0600344 # Create service project/role
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000345 get_or_create_project "$SERVICE_TENANT_NAME" default
Dean Troyer42a59c22014-03-03 14:31:29 -0600346
347 # Service role, so service users do not have to be admins
Bartosz Górski0abde392014-02-28 14:15:19 +0100348 get_or_create_role service
Dean Troyer42a59c22014-03-03 14:31:29 -0600349
350 # The ResellerAdmin role is used by Nova and Ceilometer so we need to keep it.
351 # The admin role in swift allows a user to act as an admin for their tenant,
352 # but ResellerAdmin is needed for a user to act as any tenant. The name of this
353 # role is also configurable in swift-proxy.conf
Bartosz Górski0abde392014-02-28 14:15:19 +0100354 get_or_create_role ResellerAdmin
Dean Troyerd835de82012-11-29 17:11:35 -0600355
356 # The Member role is used by Horizon and Swift so we need to keep it:
Ian Wienandada886d2015-10-07 14:06:26 +1100357 local member_role
358 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!
Ian Wienandada886d2015-10-07 14:06:26 +1100362 local another_role
363 another_role=$(get_or_create_role "anotherrole")
Dean Troyerd835de82012-11-29 17:11:35 -0600364
365 # invisible tenant - admin can't see this one
Ian Wienandada886d2015-10-07 14:06:26 +1100366 local invis_tenant
367 invis_tenant=$(get_or_create_project "invisible_to_admin" default)
Dean Troyerd835de82012-11-29 17:11:35 -0600368
369 # demo
Ian Wienandada886d2015-10-07 14:06:26 +1100370 local demo_tenant
371 demo_tenant=$(get_or_create_project "demo" default)
372 local demo_user
373 demo_user=$(get_or_create_user "demo" \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000374 "$ADMIN_PASSWORD" "default" "demo@example.com")
Steve Martinelli19685422014-01-24 13:02:26 -0600375
Jamie Lennox9b215db2015-02-10 18:19:57 +1100376 get_or_add_user_project_role $member_role $demo_user $demo_tenant
377 get_or_add_user_project_role $admin_role $admin_user $demo_tenant
378 get_or_add_user_project_role $another_role $demo_user $demo_tenant
379 get_or_add_user_project_role $member_role $demo_user $invis_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600380
Ian Wienandada886d2015-10-07 14:06:26 +1100381 local admin_group
382 admin_group=$(get_or_create_group "admins" \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400383 "default" "openstack admin group")
Ian Wienandada886d2015-10-07 14:06:26 +1100384 local non_admin_group
385 non_admin_group=$(get_or_create_group "nonadmins" \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400386 "default" "non-admin group")
387
388 get_or_add_group_project_role $member_role $non_admin_group $demo_tenant
389 get_or_add_group_project_role $another_role $non_admin_group $demo_tenant
390 get_or_add_group_project_role $admin_role $admin_group $admin_tenant
Steve Martinellib74e01c2014-12-18 01:35:35 -0500391
Dean Troyerd835de82012-11-29 17:11:35 -0600392 # Keystone
393 if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100394
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000395 get_or_create_service "keystone" "identity" "Keystone Identity Service"
396 get_or_create_endpoint "identity" \
Bartosz Górski0abde392014-02-28 14:15:19 +0100397 "$REGION_NAME" \
398 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION" \
399 "$KEYSTONE_AUTH_PROTOCOL://$KEYSTONE_AUTH_HOST:$KEYSTONE_AUTH_PORT/v$IDENTITY_API_VERSION" \
400 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION"
Dean Troyerd835de82012-11-29 17:11:35 -0600401 fi
Dean Troyerd835de82012-11-29 17:11:35 -0600402}
403
Jamie Lennox85ff5322015-01-28 14:28:01 +1000404# Create a user that is capable of verifying keystone tokens for use with auth_token middleware.
405#
406# create_service_user <name> [role]
407#
408# The role defaults to the service role. It is allowed to be provided as optional as historically
409# a lot of projects have configured themselves with the admin or other role here if they are
410# using this user for other purposes beyond simply auth_token middleware.
411function create_service_user {
412 local role=${2:-service}
413
Ian Wienandada886d2015-10-07 14:06:26 +1100414 local user
415 user=$(get_or_create_user "$1" "$SERVICE_PASSWORD" default)
Jamie Lennox9b215db2015-02-10 18:19:57 +1100416 get_or_add_user_project_role "$role" "$user" "$SERVICE_TENANT_NAME"
Jamie Lennox85ff5322015-01-28 14:28:01 +1000417}
418
Brant Knudson05952372014-09-19 17:22:22 -0500419# Configure the service to use the auth token middleware.
420#
421# configure_auth_token_middleware conf_file admin_user signing_dir [section]
422#
423# section defaults to keystone_authtoken, which is where auth_token looks in
424# the .conf file. If the paste config file is used (api-paste.ini) then
425# provide the section name for the auth_token filter.
426function configure_auth_token_middleware {
427 local conf_file=$1
428 local admin_user=$2
429 local signing_dir=$3
430 local section=${4:-keystone_authtoken}
431
Jamie Lennox78b77262014-12-19 12:56:01 +1000432 iniset $conf_file $section auth_plugin password
433 iniset $conf_file $section auth_url $KEYSTONE_AUTH_URI
434 iniset $conf_file $section username $admin_user
435 iniset $conf_file $section password $SERVICE_PASSWORD
436 iniset $conf_file $section user_domain_id default
437 iniset $conf_file $section project_name $SERVICE_TENANT_NAME
438 iniset $conf_file $section project_domain_id default
439
440 iniset $conf_file $section auth_uri $KEYSTONE_SERVICE_URI
Rob Crittenden18d47782014-03-19 17:47:42 -0400441 iniset $conf_file $section cafile $SSL_BUNDLE_FILE
Brant Knudson05952372014-09-19 17:22:22 -0500442 iniset $conf_file $section signing_dir $signing_dir
Vincent Hou21fe4e72013-11-21 03:10:27 -0500443}
444
Dean Troyerd81a0272012-08-31 18:04:55 -0500445# init_keystone() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100446function init_keystone {
Dean Troyerb9e25132013-10-01 14:45:04 -0500447 if is_service_enabled ldap; then
448 init_ldap
449 fi
450
Dean Troyerd81a0272012-08-31 18:04:55 -0500451 # (Re)create keystone database
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +0200452 recreate_database keystone
Dean Troyerd81a0272012-08-31 18:04:55 -0500453
454 # Initialize keystone database
Dean Troyerf8ae6472015-02-17 11:05:06 -0600455 $KEYSTONE_BIN_DIR/keystone-manage db_sync
Dean Troyerd81a0272012-08-31 18:04:55 -0500456
Brant Knudsoncef5e402015-06-25 17:57:53 -0500457 if [[ "$KEYSTONE_TOKEN_FORMAT" == "pki" || "$KEYSTONE_TOKEN_FORMAT" == "pkiz" ]]; then
Dean Troyerbc071bc2012-10-01 14:06:44 -0500458 # Set up certificates
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800459 rm -rf $KEYSTONE_CONF_DIR/ssl
Dean Troyerf8ae6472015-02-17 11:05:06 -0600460 $KEYSTONE_BIN_DIR/keystone-manage pki_setup
Dean Troyerbc071bc2012-10-01 14:06:44 -0500461 fi
Brant Knudsoncef5e402015-06-25 17:57:53 -0500462 if [[ "$KEYSTONE_TOKEN_FORMAT" == "fernet" ]]; then
463 rm -rf "$KEYSTONE_CONF_DIR/fernet-keys/"
464 $KEYSTONE_BIN_DIR/keystone-manage fernet_setup
465 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500466}
467
Jamie Lennox21a90772015-07-03 11:54:38 +1000468# install_keystoneauth() - Collect source and prepare
469function install_keystoneauth {
470 if use_library_from_git "keystoneauth"; then
471 git_clone_by_name "keystoneauth"
472 setup_dev_lib "keystoneauth"
473 fi
474}
475
Dean Troyerd81a0272012-08-31 18:04:55 -0500476# install_keystoneclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100477function install_keystoneclient {
Sean Daguee08ab102014-11-13 17:09:28 -0500478 if use_library_from_git "python-keystoneclient"; then
479 git_clone_by_name "python-keystoneclient"
480 setup_dev_lib "python-keystoneclient"
481 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 +0100482 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500483}
484
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700485# install_keystonemiddleware() - Collect source and prepare
486function install_keystonemiddleware {
Dean Troyerf8ae6472015-02-17 11:05:06 -0600487 # install_keystonemiddleware() is called when keystonemiddleware is needed
488 # to provide an opportunity to install it from the source repo
Sean Dague658312c2014-11-14 11:35:56 -0500489 if use_library_from_git "keystonemiddleware"; then
490 git_clone_by_name "keystonemiddleware"
491 setup_dev_lib "keystonemiddleware"
Dean Troyerf8ae6472015-02-17 11:05:06 -0600492 else
493 # When not installing from repo, keystonemiddleware is still needed...
Sean Dague60996b12015-04-08 09:06:49 -0400494 pip_install_gr keystonemiddleware
Sean Dague658312c2014-11-14 11:35:56 -0500495 fi
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700496}
497
Dean Troyerd81a0272012-08-31 18:04:55 -0500498# install_keystone() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100499function install_keystone {
Brad Topolf127e2f2013-01-22 10:17:50 -0600500 # only install ldap if the service has been enabled
501 if is_service_enabled ldap; then
502 install_ldap
503 fi
Peter Feiner61ae7c12013-11-15 10:42:30 -0500504 if [[ "$KEYSTONE_TOKEN_BACKEND" = "memcache" ]]; then
505 # Install memcached and the memcache Python library that keystone uses.
506 # Unfortunately the Python library goes by different names in the .deb
507 # and .rpm circles.
508 install_package memcached
509 if is_ubuntu; then
510 install_package python-memcache
511 else
512 install_package python-memcached
513 fi
514 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500515 git_clone $KEYSTONE_REPO $KEYSTONE_DIR $KEYSTONE_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400516 setup_develop $KEYSTONE_DIR
Morgan Fainberg46455a32014-06-20 10:37:18 -0700517 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000518 install_apache_wsgi
Rob Crittenden18d47782014-03-19 17:47:42 -0400519 if is_ssl_enabled_service "key"; then
520 enable_mod_ssl
521 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000522 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500523}
524
525# start_keystone() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100526function start_keystone {
Dean Troyerc83a7e12012-11-29 11:47:58 -0600527 # Get right service port for testing
528 local service_port=$KEYSTONE_SERVICE_PORT
Rob Crittenden18d47782014-03-19 17:47:42 -0400529 local auth_protocol=$KEYSTONE_AUTH_PROTOCOL
Dean Troyerc83a7e12012-11-29 11:47:58 -0600530 if is_service_enabled tls-proxy; then
531 service_port=$KEYSTONE_SERVICE_PORT_INT
Rob Crittenden18d47782014-03-19 17:47:42 -0400532 auth_protocol="http"
Dean Troyerc83a7e12012-11-29 11:47:58 -0600533 fi
534
Morgan Fainberg46455a32014-06-20 10:37:18 -0700535 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700536 enable_apache_site keystone
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000537 restart_apache_server
Chris Dent2f27a0e2014-09-09 13:46:02 +0100538 tail_log key /var/log/$APACHE_NAME/keystone.log
539 tail_log key-access /var/log/$APACHE_NAME/keystone_access.log
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000540 else
541 # Start Keystone in a screen window
Dean Troyerf8ae6472015-02-17 11:05:06 -0600542 run_process key "$KEYSTONE_BIN_DIR/keystone-all --config-file $KEYSTONE_CONF"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000543 fi
544
Dean Troyerd835de82012-11-29 17:11:35 -0600545 echo "Waiting for keystone to start..."
Stanislaw Pituchabe4c9532014-06-11 17:52:49 +0100546 # Check that the keystone service is running. Even if the tls tunnel
547 # should be enabled, make sure the internal port is checked using
548 # unencryted traffic at this point.
sridhargaddamb5ab6462015-02-24 07:23:24 +0000549 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 -0400550 die $LINENO "keystone did not start"
Dean Troyerd835de82012-11-29 17:11:35 -0600551 fi
Dean Troyerc83a7e12012-11-29 11:47:58 -0600552
553 # Start proxies if enabled
554 if is_service_enabled tls-proxy; then
555 start_tls_proxy '*' $KEYSTONE_SERVICE_PORT $KEYSTONE_SERVICE_HOST $KEYSTONE_SERVICE_PORT_INT &
556 start_tls_proxy '*' $KEYSTONE_AUTH_PORT $KEYSTONE_AUTH_HOST $KEYSTONE_AUTH_PORT_INT &
557 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500558}
559
560# stop_keystone() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100561function stop_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700562 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
563 disable_apache_site keystone
564 restart_apache_server
565 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500566 # Kill the Keystone screen window
Chris Dent2f27a0e2014-09-09 13:46:02 +0100567 stop_process key
Dean Troyerd81a0272012-08-31 18:04:55 -0500568}
Dean Troyer7903b792012-09-13 17:16:12 -0500569
Dean Troyer1a6d4492013-06-03 16:47:36 -0500570
Dean Troyer7903b792012-09-13 17:16:12 -0500571# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100572$_XTRACE_KEYSTONE
Sean Dague584d90e2013-03-29 14:34:53 -0400573
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100574# Tell emacs to use shell-script-mode
575## Local variables:
576## mode: shell-script
577## End: