cinder/doc/source/install/cinder-controller-install-ubuntu.rst

Install and configure controller node

This section describes how to install and configure the Block Storage service, code-named cinder, on the controller node. This service requires at least one additional storage node that provides volumes to instances.

Prerequisites

Before you install and configure the Block Storage service, you must create a database, service credentials, and API endpoints.

1. To create the database, complete these steps:

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

      # mysql

   2. Create the cinder database:

      MariaDB [(none)]> CREATE DATABASE cinder;

   3. Grant proper access to the cinder database:

      MariaDB [(none)]> GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'localhost' \
        IDENTIFIED BY 'CINDER_DBPASS';
      MariaDB [(none)]> GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'%' \
        IDENTIFIED BY 'CINDER_DBPASS';

      Replace CINDER_DBPASS with a suitable password.

   4. Exit the database access client.

2. Source the admin credentials to gain access to admin-only CLI commands:

   $ . admin-openrc

3. To create the service credentials, complete these steps:

   1. Create a cinder user:

      $ openstack user create --domain default --password-prompt cinder
      
      User Password:
      Repeat User Password:
      +---------------------+----------------------------------+
      | Field               | Value                            |
      +---------------------+----------------------------------+
      | domain_id           | default                          |
      | enabled             | True                             |
      | id                  | 9d7e33de3e1a498390353819bc7d245d |
      | name                | cinder                           |
      | options             | {}                               |
      | password_expires_at | None                             |
      +---------------------+----------------------------------+

   2. Add the admin role to the cinder user:

      $ openstack role add --project service --user cinder admin

      Note

      This command provides no output.

   3. Create the cinderv3 service entity:

      $ openstack service create --name cinderv3 \
        --description "OpenStack Block Storage" volumev3
      
      +-------------+----------------------------------+
      | Field       | Value                            |
      +-------------+----------------------------------+
      | description | OpenStack Block Storage          |
      | enabled     | True                             |
      | id          | ab3bbbef780845a1a283490d281e7fda |
      | name        | cinderv3                         |
      | type        | volumev3                         |
      +-------------+----------------------------------+

      Note

      Beginning with the Xena release, the Block Storage services require only one service entity. For prior releases, please consult the documentation for that specific release.

4. Create the Block Storage service API endpoints:

   $ openstack endpoint create --region RegionOne \
     volumev3 public http://controller:8776/v3/%\(project_id\)s
   
   +--------------+------------------------------------------+
   | Field        | Value                                    |
   +--------------+------------------------------------------+
   | enabled      | True                                     |
   | id           | 03fa2c90153546c295bf30ca86b1344b         |
   | interface    | public                                   |
   | region       | RegionOne                                |
   | region_id    | RegionOne                                |
   | service_id   | ab3bbbef780845a1a283490d281e7fda         |
   | service_name | cinderv3                                 |
   | service_type | volumev3                                 |
   | url          | http://controller:8776/v3/%(project_id)s |
   +--------------+------------------------------------------+
   
   $ openstack endpoint create --region RegionOne \
     volumev3 internal http://controller:8776/v3/%\(project_id\)s
   
   +--------------+------------------------------------------+
   | Field        | Value                                    |
   +--------------+------------------------------------------+
   | enabled      | True                                     |
   | id           | 94f684395d1b41068c70e4ecb11364b2         |
   | interface    | internal                                 |
   | region       | RegionOne                                |
   | region_id    | RegionOne                                |
   | service_id   | ab3bbbef780845a1a283490d281e7fda         |
   | service_name | cinderv3                                 |
   | service_type | volumev3                                 |
   | url          | http://controller:8776/v3/%(project_id)s |
   +--------------+------------------------------------------+
   
   $ openstack endpoint create --region RegionOne \
     volumev3 admin http://controller:8776/v3/%\(project_id\)s
   
   +--------------+------------------------------------------+
   | Field        | Value                                    |
   +--------------+------------------------------------------+
   | enabled      | True                                     |
   | id           | 4511c28a0f9840c78bacb25f10f62c98         |
   | interface    | admin                                    |
   | region       | RegionOne                                |
   | region_id    | RegionOne                                |
   | service_id   | ab3bbbef780845a1a283490d281e7fda         |
   | service_name | cinderv3                                 |
   | service_type | volumev3                                 |
   | url          | http://controller:8776/v3/%(project_id)s |
   +--------------+------------------------------------------+

Install and configure components

1. Install the packages:

   # apt install cinder-api cinder-scheduler

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

   1. In the [database] section, configure database access:

      [database]
      # ...
      connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder

      Replace CINDER_DBPASS with the password you chose for the Block Storage database.

   2. In the [DEFAULT] section, configure RabbitMQ message queue access:

      [DEFAULT]
      # ...
      transport_url = rabbit://openstack:RABBIT_PASS@controller

      Replace RABBIT_PASS with the password you chose for the openstack account in RabbitMQ.

   3. In the [DEFAULT] and [keystone_authtoken] sections, configure Identity service access:

      [DEFAULT]
      # ...
      auth_strategy = keystone
      
      [keystone_authtoken]
      # ...
      www_authenticate_uri = http://controller:5000
      auth_url = http://controller:5000
      memcached_servers = controller:11211
      auth_type = password
      project_domain_name = default
      user_domain_name = default
      project_name = service
      username = cinder
      password = CINDER_PASS

      Replace CINDER_PASS with the password you chose for the cinder user in the Identity service.

      Note

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

   4. In the [DEFAULT] section, configure the my_ip option to use the management interface IP address of the controller node:

      [DEFAULT]
      # ...
      my_ip = 10.0.0.11

3. In the [oslo_concurrency] section, configure the lock path:

   [oslo_concurrency]
   # ...
   lock_path = /var/lib/cinder/tmp

4. Populate the Block Storage database:

   # su -s /bin/sh -c "cinder-manage db sync" cinder

   Note

   Ignore any deprecation messages in this output.

Configure Compute to use Block Storage

1. Edit the /etc/nova/nova.conf file and add the following to it:

   [cinder]
   os_region_name = RegionOne

Finalize installation

1. Restart the Compute API service:

   # service nova-api restart

2. Restart the Block Storage services:

   # service cinder-scheduler restart
   # service apache2 restart