openstack-manuals/doc/install-guide/source/keystone-install.rst

Install and configure

This section describes how to install and configure the OpenStack Identity service, code-named keystone, on the controller node. For scalability purposes, this configuration deploys Fernet tokens and the Apache HTTP server to handle requests.

Prerequisites

Before you configure the OpenStack Identity service, you must create a database and an administration token.

1. To create the database, complete the following actions:

   • Use the database access client to connect to the database server as the root user:

     $ mysql -u root -p

   • Create the keystone database:

     mysql> CREATE DATABASE keystone;

   • Grant proper access to the keystone database:

     mysql> GRANT ALL PRIVILEGES ON keystone.* TO 'keystone'@'localhost' \
       IDENTIFIED BY 'KEYSTONE_DBPASS';
     mysql> GRANT ALL PRIVILEGES ON keystone.* TO 'keystone'@'%' \
       IDENTIFIED BY 'KEYSTONE_DBPASS';

     Replace KEYSTONE_DBPASS with a suitable password.

   • Exit the database access client.

Install and configure components

obs or rdo

Note

This guide uses the Apache HTTP server with mod_wsgi to serve Identity service requests on ports 5000 and 35357. By default, the keystone service still listens on these ports. Therefore, this guide manually disables the keystone service.

ubuntu or debian

Note

This guide uses the Apache HTTP server with mod_wsgi to serve Identity service requests on ports 5000 and 35357. By default, the keystone service still listens on these ports. The package handles all of the Apache configuration for you (including the activation of the mod_wsgi apache2 module and keystone configuration in Apache).

1. Run the following command to install the packages:

   # apt install keystone

rdo

1. Run the following command to install the packages:

   # yum install openstack-keystone httpd mod_wsgi

obs

1. Run the following command to install the packages:

   # zypper install openstack-keystone apache2-mod_wsgi

2. Edit the /etc/keystone/keystone.conf file and complete the following actions:

   • In the [database] section, configure database access:

     [database]
     ...
     connection = mysql+pymysql://keystone:KEYSTONE_DBPASS@controller/keystone

     Replace KEYSTONE_DBPASS with the password you chose for the database.

     Note

     Comment out or remove any other connection options in the [database] section.

   • In the [token] section, configure the Fernet token provider:

     [token]
     ...
     provider = fernet

3. Populate the Identity service database:

   # su -s /bin/sh -c "keystone-manage db_sync" keystone

4. Initialize Fernet key repositories:

   # keystone-manage fernet_setup --keystone-user keystone --keystone-group keystone
   # keystone-manage credential_setup --keystone-user keystone --keystone-group keystone

5. Bootstrap the Identity service:

   # keystone-manage bootstrap --bootstrap-password ADMIN_PASS \
     --bootstrap-admin-url http://controller:35357/v3/ \
     --bootstrap-internal-url http://controller:35357/v3/ \
     --bootstrap-public-url http://controller:5000/v3/ \
     --bootstrap-region-id RegionOne

   Replace ADMIN_PASS with a suitable password for an administrative user.

Configure the Apache HTTP server

rdo

1. Edit the /etc/httpd/conf/httpd.conf file and configure the ServerName option to reference the controller node:

   ServerName controller

2. Create a link to the /usr/share/keystone/wsgi-keystone.conf file:

   # ln -s /usr/share/keystone/wsgi-keystone.conf /etc/httpd/conf.d/

ubuntu or debian

1. Edit the /etc/apache2/apache2.conf file and configure the ServerName option to reference the controller node:

   ServerName controller

debian

Note

The Debian package will perform the below operations for you:

# a2enmod wsgi
# a2ensite wsgi-keystone.conf
# invoke-rc.d apache2 restart

obs

1. Edit the /etc/sysconfig/apache2 file and configure the APACHE_SERVERNAME option to reference the controller node:

   APACHE_SERVERNAME="controller"

2. Create the /etc/apache2/conf.d/wsgi-keystone.conf file with the following content:

   Listen 5000
   Listen 35357
   
   <VirtualHost *:5000>
       WSGIDaemonProcess keystone-public processes=5 threads=1 user=keystone group=keystone display-name=%{GROUP}
       WSGIProcessGroup keystone-public
       WSGIScriptAlias / /usr/bin/keystone-wsgi-public
       WSGIApplicationGroup %{GLOBAL}
       WSGIPassAuthorization On
       ErrorLogFormat "%{cu}t %M"
       ErrorLog /var/log/apache2/keystone.log
       CustomLog /var/log/apache2/keystone_access.log combined
   
       <Directory /usr/bin>
           Require all granted
       </Directory>
   </VirtualHost>
   
   <VirtualHost *:35357>
       WSGIDaemonProcess keystone-admin processes=5 threads=1 user=keystone group=keystone display-name=%{GROUP}
       WSGIProcessGroup keystone-admin
       WSGIScriptAlias / /usr/bin/keystone-wsgi-admin
       WSGIApplicationGroup %{GLOBAL}
       WSGIPassAuthorization On
       ErrorLogFormat "%{cu}t %M"
       ErrorLog /var/log/apache2/keystone.log
       CustomLog /var/log/apache2/keystone_access.log combined
   
       <Directory /usr/bin>
           Require all granted
       </Directory>
   </VirtualHost>

3. Recursively change the ownership of the /etc/keystone directory:

   # chown -R keystone:keystone /etc/keystone

Finalize the installation

ubuntu

1. Restart the Apache service and remove the default SQLite database:

   # service apache2 restart
   # rm -f /var/lib/keystone/keystone.db

rdo

1. Start the Apache HTTP service and configure it to start when the system boots:

   # systemctl enable httpd.service
   # systemctl start httpd.service

obs

1. Start the Apache HTTP service and configure it to start when the system boots:

   # systemctl enable apache2.service
   # systemctl start apache2.service

2. Configure the administrative account

   $ export OS_USERNAME=admin
   $ export OS_PASSWORD=ADMIN_PASS
   $ export OS_PROJECT_NAME=admin
   $ export OS_USER_DOMAIN_NAME=Default
   $ export OS_PROJECT_DOMAIN_NAME=Default
   $ export OS_AUTH_URL=http://controller:35357/v3
   $ export OS_IDENTITY_API_VERSION=3

   Replace ADMIN_PASS with the password used in the keystone-manage bootstrap command from the section called keystone-install.