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

Install and configure

This section describes how to install and configure the Image service, code-named glance, on the controller node. For simplicity, this configuration stores images on the local file system.

Note

This section assumes proper installation, configuration, and operation of the Identity service as described in the "keystone-install" section and the "keystone-verify" section as well as setup of the admin-openrc.sh script as described in the "keystone-openrc" section.

To configure prerequisites

Before you install and configure the Image service, you must create a database, service credentials, and API endpoint.

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 -u root -p

   2. Create the glance database:

      CREATE DATABASE glance;

   3. Grant proper access to the glance database:

      GRANT ALL PRIVILEGES ON glance.* TO 'glance'@'localhost' \
        IDENTIFIED BY 'GLANCE_DBPASS';
      GRANT ALL PRIVILEGES ON glance.* TO 'glance'@'%' \
        IDENTIFIED BY 'GLANCE_DBPASS';

      Replace GLANCE_DBPASS with a suitable password.

   4. Exit the database access client.

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

   $ source admin-openrc.sh

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

   1. Create the glance user:

      $ openstack user create --password-prompt glance
      User Password:
      Repeat User Password:
      +----------+----------------------------------+
      | Field    | Value                            |
      +----------+----------------------------------+
      | email    | None                             |
      | enabled  | True                             |
      | id       | 1dc206e084334db2bee88363745da014 |
      | name     | glance                           |
      | username | glance                           |
      +----------+----------------------------------+

   2. Add the admin role to the glance user and service project:

      $ openstack role add --project service --user glance admin
      +-------+----------------------------------+
      | Field | Value                            |
      +-------+----------------------------------+
      | id    | cd2cb9a39e874ea69e5d4b896eb16128 |
      | name  | admin                            |
      +-------+----------------------------------+

   3. Create the glance service entity:

      $ openstack service create --name glance \
        --description "OpenStack Image service" image
      +-------------+----------------------------------+
      | Field       | Value                            |
      +-------------+----------------------------------+
      | description | OpenStack Image service          |
      | enabled     | True                             |
      | id          | 178124d6081c441b80d79972614149c6 |
      | name        | glance                           |
      | type        | image                            |
      +-------------+----------------------------------+

4. Create the Image service API endpoint:

   $ openstack endpoint create \
     --publicurl http://controller:9292 \
     --internalurl http://controller:9292 \
     --adminurl http://controller:9292 \
     --region RegionOne \
     image
   +--------------+----------------------------------+
   | Field        | Value                            |
   +--------------+----------------------------------+
   | adminurl     | http://controller:9292           |
   | id           | 805b1dbc90ab47479111102bc6423313 |
   | internalurl  | http://controller:9292           |
   | publicurl    | http://controller:9292           |
   | region       | RegionOne                        |
   | service_id   | 178124d6081c441b80d79972614149c6 |
   | service_name | glance                           |
   | service_type | image                            |
   +--------------+----------------------------------+

To install and configure the Image service components

Note

Default configuration files vary by distribution. You might need to add these sections and options rather than modifying existing sections and options. Also, an ellipsis (...) in the configuration snippets indicates potential default configuration options that you should retain.

obs

1. Install the packages:

   # zypper install openstack-glance python-glanceclient

rdo

1. Install the packages:

   # yum install openstack-glance python-glance python-glanceclient

ubuntu

1. Install the packages:

   # apt-get install glance python-glanceclient

2. Edit the /etc/glance/glance-api.conf file and complete the following actions:

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

      [database]
      ...
      connection = mysql://glance:GLANCE_DBPASS@controller/glance

      Replace GLANCE_DBPASS with the password you chose for the Image service database.

   2. In the [keystone_authtoken] and [paste_deploy] sections, configure Identity service access:

      [keystone_authtoken]
      ...
      auth_uri = http://controller:5000
      auth_url = http://controller:35357
      auth_plugin = password
      project_domain_id = default
      user_domain_id = default
      project_name = service
      username = glance
      password = GLANCE_PASS
      
      [paste_deploy]
      ...
      flavor = keystone

      Replace GLANCE_PASS with the password you chose for the glance user in the Identity service.

      Note

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

   3. In the [glance_store] section, configure the local file system store and location of image files:

      [glance_store]
      ...
      default_store = file
      filesystem_store_datadir = /var/lib/glance/images/

   4. In the [DEFAULT] section, configure the noop notification driver to disable notifications because they only pertain to the optional Telemetry service:

      [DEFAULT]
      ...
      notification_driver = noop

      The Telemetry chapter provides an Image service configuration that enables notifications.

   5. (Optional) To assist with troubleshooting, enable verbose logging in the [DEFAULT] section:

      [DEFAULT]
      ...
      verbose = True

3. Edit the /etc/glance/glance-registry.conf file and complete the following actions:

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

      [database]
      ...
      connection = mysql://glance:GLANCE_DBPASS@controller/glance

      Replace GLANCE_DBPASS with the password you chose for the Image service database.

   2. In the [keystone_authtoken] and [paste_deploy] sections, configure Identity service access:

      [keystone_authtoken]
      ...
      auth_uri = http://controller:5000
      auth_url = http://controller:35357
      auth_plugin = password
      project_domain_id = default
      user_domain_id = default
      project_name = service
      username = glance
      password = GLANCE_PASS
      
      [paste_deploy]
      ...
      flavor = keystone

      Replace GLANCE_PASS with the password you chose for the glance user in the Identity service.

      Note

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

   3. In the [DEFAULT] section, configure the noop notification driver to disable notifications because they only pertain to the optional Telemetry service:

      [DEFAULT]
      ...
      notification_driver = noop

      The Telemetry chapter provides an Image service configuration that enables notifications.

   4. (Optional) To assist with troubleshooting, enable verbose logging in the [DEFAULT] section:

      [DEFAULT]
      ...
      verbose = True

rdo or ubuntu

4. Populate the Image service database:

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

To finalize installation

obs or rdo

1. Start the Image service services and configure them to start when the system boots:

   # systemctl enable openstack-glance-api.service openstack-glance-registry.service
   # systemctl start openstack-glance-api.service openstack-glance-registry.service

ubuntu

1. Restart the Image service services:

   # service glance-registry restart
   # service glance-api restart

2. By default, the Ubuntu packages create an SQLite database.

   Because this configuration uses a SQL database server, you can remove the SQLite database file:

   # rm -f /var/lib/glance/glance.sqlite