blob: 3c67693d9644491171740f83a9f54e9a87cfa111 [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``
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010015# - ``S3_SERVICE_PORT`` (template backend only)
Dean Troyerd81a0272012-08-31 18:04:55 -050016
Dean Troyerd81a0272012-08-31 18:04:55 -050017# ``stack.sh`` calls the entry points in this order:
18#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010019# - install_keystone
20# - configure_keystone
21# - _config_keystone_apache_wsgi
22# - init_keystone
23# - start_keystone
Steve Martinelli923be5f2015-12-20 00:24:19 -050024# - bootstrap_keystone
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010025# - 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
Sean Dague985e9582016-02-10 07:25:24 -050055# NOTE(sdague): remove in Newton
56KEYSTONE_CATALOG_BACKEND="sql"
57
Morgan Fainberg46455a32014-06-20 10:37:18 -070058# Toggle for deploying Keystone under HTTPD + mod_wsgi
Morgan Fainberge6dd4e62014-06-25 17:25:25 -070059KEYSTONE_USE_MOD_WSGI=${KEYSTONE_USE_MOD_WSGI:-${ENABLE_HTTPD_MOD_WSGI_SERVICES}}
Morgan Fainberg46455a32014-06-20 10:37:18 -070060
Brant Knudson331a64f2015-05-11 10:02:24 -050061# Select the token persistence backend driver
Davanum Srinivas5bd96f92013-01-29 15:12:20 -050062KEYSTONE_TOKEN_BACKEND=${KEYSTONE_TOKEN_BACKEND:-sql}
63
Brant Knudson331a64f2015-05-11 10:02:24 -050064# Select the Identity backend driver
Alex Rudenkocd770582013-09-01 16:26:03 +020065KEYSTONE_IDENTITY_BACKEND=${KEYSTONE_IDENTITY_BACKEND:-sql}
66
Brant Knudson331a64f2015-05-11 10:02:24 -050067# Select the Assignment backend driver
Alex Rudenkocd770582013-09-01 16:26:03 +020068KEYSTONE_ASSIGNMENT_BACKEND=${KEYSTONE_ASSIGNMENT_BACKEND:-sql}
69
Steve Martinelli35262762016-01-05 23:56:40 -050070# Select the Role backend driver
71KEYSTONE_ROLE_BACKEND=${KEYSTONE_ROLE_BACKEND:-sql}
72
73# Select the Resource backend driver
74KEYSTONE_RESOURCE_BACKEND=${KEYSTONE_RESOURCE_BACKEND:-sql}
75
Brant Knudson331a64f2015-05-11 10:02:24 -050076# Select Keystone's token provider (and format)
77# Choose from 'uuid', 'pki', 'pkiz', or 'fernet'
Sean Dague53753292014-12-04 19:38:15 -050078KEYSTONE_TOKEN_FORMAT=${KEYSTONE_TOKEN_FORMAT:-}
Brant Knudson1e1fce82014-06-19 16:55:45 -050079KEYSTONE_TOKEN_FORMAT=$(echo ${KEYSTONE_TOKEN_FORMAT} | tr '[:upper:]' '[:lower:]')
Dean Troyerbc071bc2012-10-01 14:06:44 -050080
Dean Troyerd81a0272012-08-31 18:04:55 -050081# Set Keystone interface configuration
Dean Troyerd81a0272012-08-31 18:04:55 -050082KEYSTONE_AUTH_HOST=${KEYSTONE_AUTH_HOST:-$SERVICE_HOST}
83KEYSTONE_AUTH_PORT=${KEYSTONE_AUTH_PORT:-35357}
Dean Troyerc83a7e12012-11-29 11:47:58 -060084KEYSTONE_AUTH_PORT_INT=${KEYSTONE_AUTH_PORT_INT:-35358}
85KEYSTONE_AUTH_PROTOCOL=${KEYSTONE_AUTH_PROTOCOL:-$SERVICE_PROTOCOL}
86
87# Public facing bits
Dean Troyerd81a0272012-08-31 18:04:55 -050088KEYSTONE_SERVICE_HOST=${KEYSTONE_SERVICE_HOST:-$SERVICE_HOST}
89KEYSTONE_SERVICE_PORT=${KEYSTONE_SERVICE_PORT:-5000}
Dean Troyerc83a7e12012-11-29 11:47:58 -060090KEYSTONE_SERVICE_PORT_INT=${KEYSTONE_SERVICE_PORT_INT:-5001}
91KEYSTONE_SERVICE_PROTOCOL=${KEYSTONE_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
Dean Troyerd81a0272012-08-31 18:04:55 -050092
David Kranz041fa712014-02-24 13:30:59 -050093# Bind hosts
94KEYSTONE_ADMIN_BIND_HOST=${KEYSTONE_ADMIN_BIND_HOST:-$KEYSTONE_SERVICE_HOST}
Dean Troyerb7490da2013-03-18 16:07:56 -050095# Set the tenant for service accounts in Keystone
96SERVICE_TENANT_NAME=${SERVICE_TENANT_NAME:-service}
97
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +100098# if we are running with SSL use https protocols
Rob Crittenden18d47782014-03-19 17:47:42 -040099if is_ssl_enabled_service "key" || is_service_enabled tls-proxy; then
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000100 KEYSTONE_AUTH_PROTOCOL="https"
101 KEYSTONE_SERVICE_PROTOCOL="https"
102fi
103
Jamie Lennox3561d7f2014-05-21 17:18:43 +1000104# complete URIs
105KEYSTONE_AUTH_URI=${KEYSTONE_AUTH_PROTOCOL}://${KEYSTONE_AUTH_HOST}:${KEYSTONE_AUTH_PORT}
106KEYSTONE_SERVICE_URI=${KEYSTONE_SERVICE_PROTOCOL}://${KEYSTONE_SERVICE_HOST}:${KEYSTONE_SERVICE_PORT}
107
Steve Martinellib74e01c2014-12-18 01:35:35 -0500108# V3 URIs
109KEYSTONE_AUTH_URI_V3=$KEYSTONE_AUTH_URI/v3
110KEYSTONE_SERVICE_URI_V3=$KEYSTONE_SERVICE_URI/v3
111
Dean Troyer5ce44cd2015-02-12 22:18:33 -0600112
Dean Troyercc6b4432013-04-08 15:38:03 -0500113# Functions
114# ---------
Dean Troyer5ce44cd2015-02-12 22:18:33 -0600115
116# Test if Keystone is enabled
117# is_keystone_enabled
118function is_keystone_enabled {
119 [[ ,${ENABLED_SERVICES}, =~ ,"key", ]] && return 0
120 return 1
121}
122
Dean Troyerd81a0272012-08-31 18:04:55 -0500123# cleanup_keystone() - Remove residual data files, anything left over from previous
124# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100125function cleanup_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700126 _cleanup_keystone_apache_wsgi
Dean Troyerd81a0272012-08-31 18:04:55 -0500127}
128
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000129# _cleanup_keystone_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
Ian Wienandaee18c72014-02-21 15:35:08 +1100130function _cleanup_keystone_apache_wsgi {
Morgan Fainberg970ee902014-06-09 12:07:29 -0700131 sudo rm -f $(apache_site_config_for keystone)
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000132}
133
134# _config_keystone_apache_wsgi() - Set WSGI config files of Keystone
Ian Wienandaee18c72014-02-21 15:35:08 +1100135function _config_keystone_apache_wsgi {
Ian Wienandada886d2015-10-07 14:06:26 +1100136 local keystone_apache_conf
137 keystone_apache_conf=$(apache_site_config_for keystone)
Rob Crittenden18d47782014-03-19 17:47:42 -0400138 local keystone_ssl=""
139 local keystone_certfile=""
140 local keystone_keyfile=""
141 local keystone_service_port=$KEYSTONE_SERVICE_PORT
142 local keystone_auth_port=$KEYSTONE_AUTH_PORT
Dean Troyerf8ae6472015-02-17 11:05:06 -0600143 local venv_path=""
Rob Crittenden18d47782014-03-19 17:47:42 -0400144
145 if is_ssl_enabled_service key; then
146 keystone_ssl="SSLEngine On"
147 keystone_certfile="SSLCertificateFile $KEYSTONE_SSL_CERT"
148 keystone_keyfile="SSLCertificateKeyFile $KEYSTONE_SSL_KEY"
149 fi
150 if is_service_enabled tls-proxy; then
151 keystone_service_port=$KEYSTONE_SERVICE_PORT_INT
152 keystone_auth_port=$KEYSTONE_AUTH_PORT_INT
153 fi
Dean Troyerf8ae6472015-02-17 11:05:06 -0600154 if [[ ${USE_VENV} = True ]]; then
Chris Dent3a2c86a2015-05-12 13:41:25 +0000155 venv_path="python-path=${PROJECT_VENV["keystone"]}/lib/$(python_version)/site-packages"
Dean Troyerf8ae6472015-02-17 11:05:06 -0600156 fi
Morgan Fainbergd074dc72014-06-24 21:33:39 -0700157
Morgan Fainberg970ee902014-06-09 12:07:29 -0700158 sudo cp $FILES/apache-keystone.template $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000159 sudo sed -e "
Rob Crittenden18d47782014-03-19 17:47:42 -0400160 s|%PUBLICPORT%|$keystone_service_port|g;
161 s|%ADMINPORT%|$keystone_auth_port|g;
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000162 s|%APACHE_NAME%|$APACHE_NAME|g;
Rob Crittenden18d47782014-03-19 17:47:42 -0400163 s|%SSLENGINE%|$keystone_ssl|g;
164 s|%SSLCERTFILE%|$keystone_certfile|g;
165 s|%SSLKEYFILE%|$keystone_keyfile|g;
Dean Troyerf8ae6472015-02-17 11:05:06 -0600166 s|%USER%|$STACK_USER|g;
167 s|%VIRTUALENV%|$venv_path|g
Brant Knudson2ad1a422015-06-23 10:53:50 -0500168 s|%KEYSTONE_BIN%|$KEYSTONE_BIN_DIR|g
Morgan Fainberg970ee902014-06-09 12:07:29 -0700169 " -i $keystone_apache_conf
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000170}
171
Dean Troyerd81a0272012-08-31 18:04:55 -0500172# configure_keystone() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +1100173function configure_keystone {
Dean Troyer8421c2b2015-03-16 13:52:19 -0500174 sudo install -d -o $STACK_USER $KEYSTONE_CONF_DIR
Dean Troyerd81a0272012-08-31 18:04:55 -0500175
176 if [[ "$KEYSTONE_CONF_DIR" != "$KEYSTONE_DIR/etc" ]]; then
Dean Troyer8421c2b2015-03-16 13:52:19 -0500177 install -m 600 $KEYSTONE_DIR/etc/keystone.conf.sample $KEYSTONE_CONF
Dean Troyerd81a0272012-08-31 18:04:55 -0500178 cp -p $KEYSTONE_DIR/etc/policy.json $KEYSTONE_CONF_DIR
Alan Pevece0bb4472013-03-12 11:10:52 +0100179 if [[ -f "$KEYSTONE_DIR/etc/keystone-paste.ini" ]]; then
180 cp -p "$KEYSTONE_DIR/etc/keystone-paste.ini" "$KEYSTONE_PASTE_INI"
181 fi
182 fi
183 if [[ -f "$KEYSTONE_PASTE_INI" ]]; then
184 iniset "$KEYSTONE_CONF" paste_deploy config_file "$KEYSTONE_PASTE_INI"
185 else
186 # compatibility with mixed cfg and paste.deploy configuration
187 KEYSTONE_PASTE_INI="$KEYSTONE_CONF"
Dean Troyerd81a0272012-08-31 18:04:55 -0500188 fi
189
Samuel de Medeiros Queiroz3fd71d62015-05-03 14:54:45 -0300190 if [ "$ENABLE_IDENTITY_V2" == "False" ]; then
191 # Only Identity v3 API should be available; then disable v2 pipelines
192 inidelete $KEYSTONE_PASTE_INI composite:main \\/v2.0
193 inidelete $KEYSTONE_PASTE_INI composite:admin \\/v2.0
194 fi
195
Dean Troyerd81a0272012-08-31 18:04:55 -0500196 # Rewrite stock ``keystone.conf``
Dean Troyerc83a7e12012-11-29 11:47:58 -0600197
Brad Topolf127e2f2013-01-22 10:17:50 -0600198 if is_service_enabled ldap; then
199 #Set all needed ldap values
Dean Troyerb9e25132013-10-01 14:45:04 -0500200 iniset $KEYSTONE_CONF ldap password $LDAP_PASSWORD
201 iniset $KEYSTONE_CONF ldap user $LDAP_MANAGER_DN
202 iniset $KEYSTONE_CONF ldap suffix $LDAP_BASE_DN
Brad Topolf41024e2013-02-19 15:36:41 -0600203 iniset $KEYSTONE_CONF ldap use_dumb_member "True"
Morgan Fainberg2dc11fb2013-09-24 23:43:08 -0700204 iniset $KEYSTONE_CONF ldap user_attribute_ignore "enabled,email,tenants,default_project_id"
Brad Topolf41024e2013-02-19 15:36:41 -0600205 iniset $KEYSTONE_CONF ldap tenant_attribute_ignore "enabled"
206 iniset $KEYSTONE_CONF ldap tenant_domain_id_attribute "businessCategory"
207 iniset $KEYSTONE_CONF ldap tenant_desc_attribute "description"
Dean Troyerb9e25132013-10-01 14:45:04 -0500208 iniset $KEYSTONE_CONF ldap tenant_tree_dn "ou=Projects,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600209 iniset $KEYSTONE_CONF ldap user_domain_id_attribute "businessCategory"
Dean Troyerb9e25132013-10-01 14:45:04 -0500210 iniset $KEYSTONE_CONF ldap user_tree_dn "ou=Users,$LDAP_BASE_DN"
Brad Topolf41024e2013-02-19 15:36:41 -0600211 iniset $KEYSTONE_CONF DEFAULT member_role_id "9fe2ff9ee4384b1894a90878d3e92bab"
212 iniset $KEYSTONE_CONF DEFAULT member_role_name "_member_"
Brad Topolf127e2f2013-01-22 10:17:50 -0600213 fi
214
Brant Knudson331a64f2015-05-11 10:02:24 -0500215 iniset $KEYSTONE_CONF identity driver "$KEYSTONE_IDENTITY_BACKEND"
216 iniset $KEYSTONE_CONF assignment driver "$KEYSTONE_ASSIGNMENT_BACKEND"
Steve Martinelli35262762016-01-05 23:56:40 -0500217 iniset $KEYSTONE_CONF role driver "$KEYSTONE_ROLE_BACKEND"
218 iniset $KEYSTONE_CONF resource driver "$KEYSTONE_RESOURCE_BACKEND"
Brad Topolf127e2f2013-01-22 10:17:50 -0600219
Morgan Fainberga8ffe8a2016-01-24 20:36:35 -0800220 # Enable caching
221 iniset $KEYSTONE_CONF cache enabled "True"
222 iniset $KEYSTONE_CONF cache backend "oslo_cache.memcache_pool"
223 iniset $KEYSTONE_CONF cache memcache_servers $SERVICE_HOST:11211
224
225 # Do not cache the catalog backend due to https://bugs.launchpad.net/keystone/+bug/1537617
226 iniset $KEYSTONE_CONF catalog caching "False"
227
Brant Knudson2dd110c2015-03-14 12:39:14 -0500228 iniset_rpc_backend keystone $KEYSTONE_CONF
Sergey Skripnick8464a4c2014-07-08 21:05:23 +0300229
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000230 # Register SSL certificates if provided
231 if is_ssl_enabled_service key; then
232 ensure_certificates KEYSTONE
233
Brant Knudson7448edb2015-03-11 20:06:26 -0500234 iniset $KEYSTONE_CONF eventlet_server_ssl enable True
235 iniset $KEYSTONE_CONF eventlet_server_ssl certfile $KEYSTONE_SSL_CERT
236 iniset $KEYSTONE_CONF eventlet_server_ssl keyfile $KEYSTONE_SSL_KEY
Jamie Lennoxbd24a8d2013-09-20 16:26:42 +1000237 fi
238
Dean Troyerc83a7e12012-11-29 11:47:58 -0600239 if is_service_enabled tls-proxy; then
240 # Set the service ports for a proxy to take the originals
Brant Knudson7448edb2015-03-11 20:06:26 -0500241 iniset $KEYSTONE_CONF eventlet_server public_port $KEYSTONE_SERVICE_PORT_INT
242 iniset $KEYSTONE_CONF eventlet_server admin_port $KEYSTONE_AUTH_PORT_INT
Rob Crittendencdba7b02015-05-26 15:33:45 -0400243
244 iniset $KEYSTONE_CONF DEFAULT public_endpoint $KEYSTONE_SERVICE_URI
245 iniset $KEYSTONE_CONF DEFAULT admin_endpoint $KEYSTONE_AUTH_URI
Dean Troyerc83a7e12012-11-29 11:47:58 -0600246 fi
247
Brant Knudson1e1fce82014-06-19 16:55:45 -0500248 if [[ "$KEYSTONE_TOKEN_FORMAT" != "" ]]; then
Brant Knudson331a64f2015-05-11 10:02:24 -0500249 iniset $KEYSTONE_CONF token provider $KEYSTONE_TOKEN_FORMAT
Sudarshan Acharya37631412013-07-16 00:47:54 +0000250 fi
251
Brant Knudson16d3ad02014-02-13 18:59:50 -0600252 iniset $KEYSTONE_CONF database connection `database_connection_url keystone`
Dean Troyerd81a0272012-08-31 18:04:55 -0500253
Brant Knudson331a64f2015-05-11 10:02:24 -0500254 iniset $KEYSTONE_CONF token driver "$KEYSTONE_TOKEN_BACKEND"
Davanum Srinivas5bd96f92013-01-29 15:12:20 -0500255
Dean Troyerd81a0272012-08-31 18:04:55 -0500256 # Set up logging
Dean Troyerd81a0272012-08-31 18:04:55 -0500257 if [ "$SYSLOG" != "False" ]; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600258 iniset $KEYSTONE_CONF DEFAULT use_syslog "True"
Dean Troyerd81a0272012-08-31 18:04:55 -0500259 fi
Brant Knudson4968d1a2014-01-22 19:06:44 -0600260
261 # Format logging
Morgan Fainberg46455a32014-06-20 10:37:18 -0700262 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && [ "$KEYSTONE_USE_MOD_WSGI" == "False" ] ; then
Brant Knudson4968d1a2014-01-22 19:06:44 -0600263 setup_colorized_logging $KEYSTONE_CONF DEFAULT
264 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000265
Brant Knudson0fc336d2015-02-08 11:03:02 -0600266 iniset $KEYSTONE_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
267
Morgan Fainberg46455a32014-06-20 10:37:18 -0700268 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Morgan Fainbergda1cc572016-02-02 09:09:28 -0800269 iniset $KEYSTONE_CONF DEFAULT logging_context_format_string "%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s"
270 iniset $KEYSTONE_CONF DEFAULT logging_default_format_string "%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s"
271 iniset $KEYSTONE_CONF DEFAULT logging_debug_format_suffix "%(asctime)s.%(msecs)03d %(funcName)s %(pathname)s:%(lineno)d"
272 iniset $KEYSTONE_CONF DEFAULT logging_exception_prefix "%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000273 _config_keystone_apache_wsgi
gordon chunge42306d2015-12-10 14:54:01 -0500274 else
275 iniset $KEYSTONE_CONF eventlet_server admin_bind_host "$KEYSTONE_ADMIN_BIND_HOST"
276 iniset $KEYSTONE_CONF eventlet_server admin_workers "$API_WORKERS"
277 # Public workers will use the server default, typically number of CPU.
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000278 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100279
280 iniset $KEYSTONE_CONF DEFAULT max_token_size 16384
Brant Knudson85a17ea2014-09-13 14:49:24 -0500281
Brant Knudsoncef5e402015-06-25 17:57:53 -0500282 iniset $KEYSTONE_CONF fernet_tokens key_repository "$KEYSTONE_CONF_DIR/fernet-keys/"
Dean Troyerd81a0272012-08-31 18:04:55 -0500283}
284
Dean Troyerd835de82012-11-29 17:11:35 -0600285# create_keystone_accounts() - Sets up common required keystone accounts
286
287# Tenant User Roles
288# ------------------------------------------------------------------
Dean Troyerd835de82012-11-29 17:11:35 -0600289# admin admin admin
Dean Troyer42a59c22014-03-03 14:31:29 -0600290# service -- --
291# -- -- service
292# -- -- ResellerAdmin
293# -- -- Member
Dean Troyerd835de82012-11-29 17:11:35 -0600294# demo admin admin
295# demo demo Member, anotherrole
Sean Daguec67d22e2016-02-02 05:51:14 -0500296# alt_demo admin admin
297# alt_demo alt_demo Member, anotherrole
Dean Troyerd835de82012-11-29 17:11:35 -0600298# invisible_to_admin demo Member
299
Steve Martinelli4599fd12015-03-12 21:30:58 -0400300# Group Users Roles Tenant
301# ------------------------------------------------------------------
302# admins admin admin admin
Hidekazu Nakamura17fe88a2015-09-11 19:50:26 +0900303# nonadmins demo Member, anotherrole demo
Steve Martinelli4599fd12015-03-12 21:30:58 -0400304
305
Dean Troyerd835de82012-11-29 17:11:35 -0600306# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100307function create_keystone_accounts {
Dean Troyerd835de82012-11-29 17:11:35 -0600308
Steve Martinelli923be5f2015-12-20 00:24:19 -0500309 # The keystone bootstrapping process (performed via keystone-manage bootstrap)
310 # creates an admin user, admin role and admin project. As a sanity check
311 # we exercise the CLI to retrieve the IDs for these values.
Ian Wienandada886d2015-10-07 14:06:26 +1100312 local admin_tenant
Steve Martinelli923be5f2015-12-20 00:24:19 -0500313 admin_tenant=$(openstack project show "admin" -f value -c id)
Ian Wienandada886d2015-10-07 14:06:26 +1100314 local admin_user
Steve Martinelli923be5f2015-12-20 00:24:19 -0500315 admin_user=$(openstack user show "admin" -f value -c id)
Ian Wienandada886d2015-10-07 14:06:26 +1100316 local admin_role
Steve Martinelli923be5f2015-12-20 00:24:19 -0500317 admin_role=$(openstack role show "admin" -f value -c id)
318
Roxana Gherle59c63772015-09-09 18:22:31 -0700319 get_or_add_user_domain_role $admin_role $admin_user default
Dean Troyerd835de82012-11-29 17:11:35 -0600320
Dean Troyer42a59c22014-03-03 14:31:29 -0600321 # Create service project/role
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000322 get_or_create_project "$SERVICE_TENANT_NAME" default
Dean Troyer42a59c22014-03-03 14:31:29 -0600323
324 # Service role, so service users do not have to be admins
Bartosz Górski0abde392014-02-28 14:15:19 +0100325 get_or_create_role service
Dean Troyer42a59c22014-03-03 14:31:29 -0600326
327 # The ResellerAdmin role is used by Nova and Ceilometer so we need to keep it.
328 # The admin role in swift allows a user to act as an admin for their tenant,
329 # but ResellerAdmin is needed for a user to act as any tenant. The name of this
330 # role is also configurable in swift-proxy.conf
Bartosz Górski0abde392014-02-28 14:15:19 +0100331 get_or_create_role ResellerAdmin
Dean Troyerd835de82012-11-29 17:11:35 -0600332
333 # The Member role is used by Horizon and Swift so we need to keep it:
Ian Wienandada886d2015-10-07 14:06:26 +1100334 local member_role
335 member_role=$(get_or_create_role "Member")
Bartosz Górski0abde392014-02-28 14:15:19 +0100336
Masayuki Igawad3654052014-09-01 17:30:05 +0900337 # another_role demonstrates that an arbitrary role may be created and used
Dean Troyerd835de82012-11-29 17:11:35 -0600338 # TODO(sleepsonthefloor): show how this can be used for rbac in the future!
Ian Wienandada886d2015-10-07 14:06:26 +1100339 local another_role
340 another_role=$(get_or_create_role "anotherrole")
Dean Troyerd835de82012-11-29 17:11:35 -0600341
342 # invisible tenant - admin can't see this one
Ian Wienandada886d2015-10-07 14:06:26 +1100343 local invis_tenant
344 invis_tenant=$(get_or_create_project "invisible_to_admin" default)
Dean Troyerd835de82012-11-29 17:11:35 -0600345
346 # demo
Ian Wienandada886d2015-10-07 14:06:26 +1100347 local demo_tenant
348 demo_tenant=$(get_or_create_project "demo" default)
349 local demo_user
350 demo_user=$(get_or_create_user "demo" \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000351 "$ADMIN_PASSWORD" "default" "demo@example.com")
Steve Martinelli19685422014-01-24 13:02:26 -0600352
Jamie Lennox9b215db2015-02-10 18:19:57 +1100353 get_or_add_user_project_role $member_role $demo_user $demo_tenant
354 get_or_add_user_project_role $admin_role $admin_user $demo_tenant
355 get_or_add_user_project_role $another_role $demo_user $demo_tenant
356 get_or_add_user_project_role $member_role $demo_user $invis_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600357
Sean Daguec67d22e2016-02-02 05:51:14 -0500358 # alt_demo
359 local alt_demo_tenant
360 alt_demo_tenant=$(get_or_create_project "alt_demo" default)
361 local alt_demo_user
362 alt_demo_user=$(get_or_create_user "alt_demo" \
363 "$ADMIN_PASSWORD" "default" "alt_demo@example.com")
364
365 get_or_add_user_project_role $member_role $alt_demo_user $alt_demo_tenant
366 get_or_add_user_project_role $admin_role $admin_user $alt_demo_tenant
367 get_or_add_user_project_role $another_role $alt_demo_user $alt_demo_tenant
368
369 # groups
Ian Wienandada886d2015-10-07 14:06:26 +1100370 local admin_group
371 admin_group=$(get_or_create_group "admins" \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400372 "default" "openstack admin group")
Ian Wienandada886d2015-10-07 14:06:26 +1100373 local non_admin_group
374 non_admin_group=$(get_or_create_group "nonadmins" \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400375 "default" "non-admin group")
376
377 get_or_add_group_project_role $member_role $non_admin_group $demo_tenant
378 get_or_add_group_project_role $another_role $non_admin_group $demo_tenant
Sean Daguec67d22e2016-02-02 05:51:14 -0500379 get_or_add_group_project_role $member_role $non_admin_group $alt_demo_tenant
380 get_or_add_group_project_role $another_role $non_admin_group $alt_demo_tenant
Steve Martinelli4599fd12015-03-12 21:30:58 -0400381 get_or_add_group_project_role $admin_role $admin_group $admin_tenant
Dean Troyerd835de82012-11-29 17:11:35 -0600382}
383
Jamie Lennox85ff5322015-01-28 14:28:01 +1000384# Create a user that is capable of verifying keystone tokens for use with auth_token middleware.
385#
386# create_service_user <name> [role]
387#
388# The role defaults to the service role. It is allowed to be provided as optional as historically
389# a lot of projects have configured themselves with the admin or other role here if they are
390# using this user for other purposes beyond simply auth_token middleware.
391function create_service_user {
392 local role=${2:-service}
393
Ian Wienandada886d2015-10-07 14:06:26 +1100394 local user
395 user=$(get_or_create_user "$1" "$SERVICE_PASSWORD" default)
Jamie Lennox9b215db2015-02-10 18:19:57 +1100396 get_or_add_user_project_role "$role" "$user" "$SERVICE_TENANT_NAME"
Jamie Lennox85ff5322015-01-28 14:28:01 +1000397}
398
Brant Knudson05952372014-09-19 17:22:22 -0500399# Configure the service to use the auth token middleware.
400#
401# configure_auth_token_middleware conf_file admin_user signing_dir [section]
402#
403# section defaults to keystone_authtoken, which is where auth_token looks in
404# the .conf file. If the paste config file is used (api-paste.ini) then
405# provide the section name for the auth_token filter.
406function configure_auth_token_middleware {
407 local conf_file=$1
408 local admin_user=$2
409 local signing_dir=$3
410 local section=${4:-keystone_authtoken}
411
Hua Wangf7dc06c2015-12-23 12:15:59 +0800412 iniset $conf_file $section auth_type password
Jamie Lennox78b77262014-12-19 12:56:01 +1000413 iniset $conf_file $section auth_url $KEYSTONE_AUTH_URI
414 iniset $conf_file $section username $admin_user
415 iniset $conf_file $section password $SERVICE_PASSWORD
416 iniset $conf_file $section user_domain_id default
417 iniset $conf_file $section project_name $SERVICE_TENANT_NAME
418 iniset $conf_file $section project_domain_id default
419
420 iniset $conf_file $section auth_uri $KEYSTONE_SERVICE_URI
Rob Crittenden18d47782014-03-19 17:47:42 -0400421 iniset $conf_file $section cafile $SSL_BUNDLE_FILE
Brant Knudson05952372014-09-19 17:22:22 -0500422 iniset $conf_file $section signing_dir $signing_dir
Morgan Fainberg5997ce32016-01-20 12:43:22 -0800423 iniset $conf_file $section memcache_servers $SERVICE_HOST:11211
Vincent Hou21fe4e72013-11-21 03:10:27 -0500424}
425
Dean Troyerd81a0272012-08-31 18:04:55 -0500426# init_keystone() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100427function init_keystone {
Dean Troyerb9e25132013-10-01 14:45:04 -0500428 if is_service_enabled ldap; then
429 init_ldap
430 fi
431
Dean Troyerd81a0272012-08-31 18:04:55 -0500432 # (Re)create keystone database
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +0200433 recreate_database keystone
Dean Troyerd81a0272012-08-31 18:04:55 -0500434
435 # Initialize keystone database
Dean Troyerf8ae6472015-02-17 11:05:06 -0600436 $KEYSTONE_BIN_DIR/keystone-manage db_sync
Dean Troyerd81a0272012-08-31 18:04:55 -0500437
Brant Knudsoncef5e402015-06-25 17:57:53 -0500438 if [[ "$KEYSTONE_TOKEN_FORMAT" == "pki" || "$KEYSTONE_TOKEN_FORMAT" == "pkiz" ]]; then
Dean Troyerbc071bc2012-10-01 14:06:44 -0500439 # Set up certificates
Vishvananda Ishaya23431f32012-12-12 15:57:33 -0800440 rm -rf $KEYSTONE_CONF_DIR/ssl
Dean Troyerf8ae6472015-02-17 11:05:06 -0600441 $KEYSTONE_BIN_DIR/keystone-manage pki_setup
Dean Troyerbc071bc2012-10-01 14:06:44 -0500442 fi
Brant Knudsoncef5e402015-06-25 17:57:53 -0500443 if [[ "$KEYSTONE_TOKEN_FORMAT" == "fernet" ]]; then
444 rm -rf "$KEYSTONE_CONF_DIR/fernet-keys/"
445 $KEYSTONE_BIN_DIR/keystone-manage fernet_setup
446 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500447}
448
Jamie Lennox21a90772015-07-03 11:54:38 +1000449# install_keystoneauth() - Collect source and prepare
450function install_keystoneauth {
451 if use_library_from_git "keystoneauth"; then
452 git_clone_by_name "keystoneauth"
453 setup_dev_lib "keystoneauth"
454 fi
455}
456
Dean Troyerd81a0272012-08-31 18:04:55 -0500457# install_keystoneclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100458function install_keystoneclient {
Sean Daguee08ab102014-11-13 17:09:28 -0500459 if use_library_from_git "python-keystoneclient"; then
460 git_clone_by_name "python-keystoneclient"
461 setup_dev_lib "python-keystoneclient"
462 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 +0100463 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500464}
465
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700466# install_keystonemiddleware() - Collect source and prepare
467function install_keystonemiddleware {
Dean Troyerf8ae6472015-02-17 11:05:06 -0600468 # install_keystonemiddleware() is called when keystonemiddleware is needed
469 # to provide an opportunity to install it from the source repo
Sean Dague658312c2014-11-14 11:35:56 -0500470 if use_library_from_git "keystonemiddleware"; then
471 git_clone_by_name "keystonemiddleware"
472 setup_dev_lib "keystonemiddleware"
Dean Troyerf8ae6472015-02-17 11:05:06 -0600473 else
474 # When not installing from repo, keystonemiddleware is still needed...
Sean Dague60996b12015-04-08 09:06:49 -0400475 pip_install_gr keystonemiddleware
Sean Dague658312c2014-11-14 11:35:56 -0500476 fi
Morgan Fainberg5997ce32016-01-20 12:43:22 -0800477 # Install the memcache library so keystonemiddleware can cache tokens in a
478 # shared location.
479 pip_install_gr python-memcached
Morgan Fainberg58936fd2014-06-24 12:26:07 -0700480}
481
Dean Troyerd81a0272012-08-31 18:04:55 -0500482# install_keystone() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100483function install_keystone {
Brad Topolf127e2f2013-01-22 10:17:50 -0600484 # only install ldap if the service has been enabled
485 if is_service_enabled ldap; then
486 install_ldap
487 fi
Morgan Fainberg5997ce32016-01-20 12:43:22 -0800488
Dean Troyerd81a0272012-08-31 18:04:55 -0500489 git_clone $KEYSTONE_REPO $KEYSTONE_DIR $KEYSTONE_BRANCH
Sean Dague1b4b4be2013-04-01 16:44:31 -0400490 setup_develop $KEYSTONE_DIR
Brant Knudson6a4d3eb2015-08-01 09:19:18 -0500491
492 if is_service_enabled ldap; then
493 setup_develop $KEYSTONE_DIR ldap
494 fi
495
Morgan Fainberg46455a32014-06-20 10:37:18 -0700496 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000497 install_apache_wsgi
Rob Crittenden18d47782014-03-19 17:47:42 -0400498 if is_ssl_enabled_service "key"; then
499 enable_mod_ssl
500 fi
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000501 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500502}
503
504# start_keystone() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100505function start_keystone {
Dean Troyerc83a7e12012-11-29 11:47:58 -0600506 # Get right service port for testing
507 local service_port=$KEYSTONE_SERVICE_PORT
Rob Crittenden18d47782014-03-19 17:47:42 -0400508 local auth_protocol=$KEYSTONE_AUTH_PROTOCOL
Dean Troyerc83a7e12012-11-29 11:47:58 -0600509 if is_service_enabled tls-proxy; then
510 service_port=$KEYSTONE_SERVICE_PORT_INT
Rob Crittenden18d47782014-03-19 17:47:42 -0400511 auth_protocol="http"
Dean Troyerc83a7e12012-11-29 11:47:58 -0600512 fi
513
Morgan Fainberg46455a32014-06-20 10:37:18 -0700514 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700515 enable_apache_site keystone
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000516 restart_apache_server
Chris Dent2f27a0e2014-09-09 13:46:02 +0100517 tail_log key /var/log/$APACHE_NAME/keystone.log
518 tail_log key-access /var/log/$APACHE_NAME/keystone_access.log
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000519 else
520 # Start Keystone in a screen window
Dean Troyerf8ae6472015-02-17 11:05:06 -0600521 run_process key "$KEYSTONE_BIN_DIR/keystone-all --config-file $KEYSTONE_CONF"
Jamie Lennoxa00e5f82013-09-17 12:47:03 +1000522 fi
523
Dean Troyerd835de82012-11-29 17:11:35 -0600524 echo "Waiting for keystone to start..."
Stanislaw Pituchabe4c9532014-06-11 17:52:49 +0100525 # Check that the keystone service is running. Even if the tls tunnel
526 # should be enabled, make sure the internal port is checked using
527 # unencryted traffic at this point.
sridhargaddamb5ab6462015-02-24 07:23:24 +0000528 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 -0400529 die $LINENO "keystone did not start"
Dean Troyerd835de82012-11-29 17:11:35 -0600530 fi
Dean Troyerc83a7e12012-11-29 11:47:58 -0600531
532 # Start proxies if enabled
533 if is_service_enabled tls-proxy; then
534 start_tls_proxy '*' $KEYSTONE_SERVICE_PORT $KEYSTONE_SERVICE_HOST $KEYSTONE_SERVICE_PORT_INT &
535 start_tls_proxy '*' $KEYSTONE_AUTH_PORT $KEYSTONE_AUTH_HOST $KEYSTONE_AUTH_PORT_INT &
536 fi
Morgan Fainberg5997ce32016-01-20 12:43:22 -0800537
538 # (re)start memcached to make sure we have a clean memcache.
539 restart_service memcached
Dean Troyerd81a0272012-08-31 18:04:55 -0500540}
541
542# stop_keystone() - Stop running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100543function stop_keystone {
Adam Gandelmanc4b06712014-09-03 11:44:31 -0700544 if [ "$KEYSTONE_USE_MOD_WSGI" == "True" ]; then
545 disable_apache_site keystone
546 restart_apache_server
547 fi
Dean Troyerd81a0272012-08-31 18:04:55 -0500548 # Kill the Keystone screen window
Chris Dent2f27a0e2014-09-09 13:46:02 +0100549 stop_process key
Dean Troyerd81a0272012-08-31 18:04:55 -0500550}
Dean Troyer7903b792012-09-13 17:16:12 -0500551
Steve Martinelli923be5f2015-12-20 00:24:19 -0500552# bootstrap_keystone() - Initialize user, role and project
553# This function uses the following GLOBAL variables:
554# - ``KEYSTONE_BIN_DIR``
555# - ``ADMIN_PASSWORD``
556# - ``IDENTITY_API_VERSION``
Steve Martinelli923be5f2015-12-20 00:24:19 -0500557# - ``KEYSTONE_AUTH_URI``
558# - ``REGION_NAME``
559# - ``KEYSTONE_SERVICE_PROTOCOL``
560# - ``KEYSTONE_SERVICE_HOST``
561# - ``KEYSTONE_SERVICE_PORT``
562function bootstrap_keystone {
563
564 # Initialize keystone, this will create an 'admin' user, 'admin' project,
565 # 'admin' role, and assign the user the role on the project. These resources
566 # are created only if they do not already exist.
567 $KEYSTONE_BIN_DIR/keystone-manage bootstrap --bootstrap-password $ADMIN_PASSWORD
568
569 # Create the keystone service and endpoints. To do this with the new
570 # bootstrapping process, we need to get a token and use that token to
571 # interact with the new APIs. The token will only be used to create services
572 # and endpoints, thus creating a minimal service catalog.
573 # They are unset immediately after.
574 # TODO(stevemar): OpenStackClient and KeystoneClient do not have support to
575 # handle interactions that not return service catalogs. Eventually remove
576 # this section when the support is in place. Use token based auth for now.
577 local token_id
578 token_id=$(openstack token issue -c id -f value \
579 --os-username admin --os-project-name admin \
580 --os-user-domain-id default --os-project-domain-id default \
581 --os-identity-api-version 3 --os-auth-url $KEYSTONE_AUTH_URI \
582 --os-password $ADMIN_PASSWORD)
583
Sean Dague985e9582016-02-10 07:25:24 -0500584 export OS_TOKEN=$token_id
585 export OS_URL=$KEYSTONE_AUTH_URI/v3
586 export OS_IDENTITY_API_VERSION=3
Steve Martinelli923be5f2015-12-20 00:24:19 -0500587
Sean Dague985e9582016-02-10 07:25:24 -0500588 get_or_create_service "keystone" "identity" "Keystone Identity Service"
589 get_or_create_endpoint \
590 "identity" \
591 "$REGION_NAME" \
592 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION" \
593 "$KEYSTONE_AUTH_URI/v$IDENTITY_API_VERSION" \
594 "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v$IDENTITY_API_VERSION"
Steve Martinelli923be5f2015-12-20 00:24:19 -0500595
596 unset OS_TOKEN OS_URL OS_IDENTITY_API_VERSION
597}
Dean Troyer1a6d4492013-06-03 16:47:36 -0500598
Dean Troyer7903b792012-09-13 17:16:12 -0500599# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100600$_XTRACE_KEYSTONE
Sean Dague584d90e2013-03-29 14:34:53 -0400601
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100602# Tell emacs to use shell-script-mode
603## Local variables:
604## mode: shell-script
605## End: