manila/doc/source/install/common/controller-node-prerequisites.rst
Goutham Pacha Ravi de29398128 [doc] remove project_id from api endpoints
As of API version 2.60, a project_id is no
longer needed in the API URLs.

Fix the docs to indicate that.

Also fix up a few quota parameters that use
project_id in a different place in the API path.

Change-Id: I24b32c8521805a7d67d512d36d644c0f07c532ea
Implements: bp remove-project-id-from-urls
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-02-09 21:59:07 -08:00

9.6 KiB

Prerequisites

Before you install and configure the Shared File Systems service, you must create a database, service credentials, and API endpoints.

  1. To create the database, complete these steps:

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

      $ mysql -u root -p
    • Create the manila database:

      CREATE DATABASE manila;
    • Grant proper access to the manila database:

      GRANT ALL PRIVILEGES ON manila.* TO 'manila'@'localhost' \
        IDENTIFIED BY 'MANILA_DBPASS';
      GRANT ALL PRIVILEGES ON manila.* TO 'manila'@'%' \
        IDENTIFIED BY 'MANILA_DBPASS';

      Replace MANILA_DBPASS with a suitable password.

    • Exit the database access client.

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

    $ . admin-openrc.sh
  3. To create the service credentials, complete these steps:

    • Create a manila user:

      $ openstack user create --domain default --password-prompt manila
      User Password:
      Repeat User Password:
      +---------------------+----------------------------------+
      | Field               | Value                            |
      +---------------------+----------------------------------+
      | domain_id           | e0353a670a9e496da891347c589539e9 |
      | enabled             | True                             |
      | id                  | 83a3990fc2144100ba0e2e23886d8acc |
      | name                | manila                           |
      | options             | {}                               |
      | password_expires_at | None                             |
      +---------------------+----------------------------------+
    • Add the admin role to the manila user:

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

      Note

      This command provides no output.

    • Create the manila and manilav2 service entities:

      $ openstack service create --name manila \
        --description "OpenStack Shared File Systems" share
        +-------------+----------------------------------+
        | Field       | Value                            |
        +-------------+----------------------------------+
        | description | OpenStack Shared File Systems    |
        | enabled     | True                             |
        | id          | 82378b5a16b340aa9cc790cdd46a03ba |
        | name        | manila                           |
        | type        | share                            |
        +-------------+----------------------------------+
      $ openstack service create --name manilav2 \
        --description "OpenStack Shared File Systems V2" sharev2
        +-------------+----------------------------------+
        | Field       | Value                            |
        +-------------+----------------------------------+
        | description | OpenStack Shared File Systems V2 |
        | enabled     | True                             |
        | id          | 30d92a97a81a4e5d8fd97a32bafd7b88 |
        | name        | manilav2                         |
        | type        | sharev2                          |
        +-------------+----------------------------------+

      Note

      The Shared File Systems services require two service entities.

  4. Create the Shared File Systems service API endpoints:

    $ openstack endpoint create --region RegionOne \
      share public http://controller:8786/v1/%\(tenant_id\)s
      +--------------+------------------------------------------+
      | Field        | Value                                    |
      +--------------+------------------------------------------+
      | enabled      | True                                     |
      | id           | 0bd2bbf8d28b433aaea56a254c69f69d         |
      | interface    | public                                   |
      | region       | RegionOne                                |
      | region_id    | RegionOne                                |
      | service_id   | 82378b5a16b340aa9cc790cdd46a03ba         |
      | service_name | manila                                   |
      | service_type | share                                    |
      | url          | http://controller:8786/v1/%(project_id)s |
      +--------------+------------------------------------------+
    
    $ openstack endpoint create --region RegionOne \
      share internal http://controller:8786/v1/%\(tenant_id\)s
      +--------------+------------------------------------------+
      | Field        | Value                                    |
      +--------------+------------------------------------------+
      | enabled      | True                                     |
      | id           | a2859b5732cc48b5b083dd36dafb6fd9         |
      | interface    | internal                                 |
      | region       | RegionOne                                |
      | region_id    | RegionOne                                |
      | service_id   | 82378b5a16b340aa9cc790cdd46a03ba         |
      | service_name | manila                                   |
      | service_type | share                                    |
      | url          | http://controller:8786/v1/%(project_id)s |
      +--------------+------------------------------------------+
    
    $ openstack endpoint create --region RegionOne \
      share admin http://controller:8786/v1/%\(tenant_id\)s
      +--------------+------------------------------------------+
      | Field        | Value                                    |
      +--------------+------------------------------------------+
      | enabled      | True                                     |
      | id           | f7f46df93a374cc49c0121bef41da03c         |
      | interface    | admin                                    |
      | region       | RegionOne                                |
      | region_id    | RegionOne                                |
      | service_id   | 82378b5a16b340aa9cc790cdd46a03ba         |
      | service_name | manila                                   |
      | service_type | share                                    |
      | url          | http://controller:8786/v1/%(project_id)s |
      +--------------+------------------------------------------+
    $ openstack endpoint create --region RegionOne \
      sharev2 public http://controller:8786/v2
      +--------------+-----------------------------------------+
      | Field        | Value                                   |
      +--------------+-----------------------------------------+
      | enabled      | True                                    |
      | id           | d63cc0d358da4ea680178657291eddc1        |
      | interface    | public                                  |
      | region       | RegionOne                               |
      | region_id    | RegionOne                               |
      | service_id   | 30d92a97a81a4e5d8fd97a32bafd7b88        |
      | service_name | manilav2                                |
      | service_type | sharev2                                 |
      | url          | http://controller:8786/v2               |
      +--------------+-----------------------------------------+
    
    $ openstack endpoint create --region RegionOne \
      sharev2 internal http://controller:8786/v2
      +--------------+-----------------------------------------+
      | Field        | Value                                   |
      +--------------+-----------------------------------------+
      | enabled      | True                                    |
      | id           | afc86e5f50804008add349dba605da54        |
      | interface    | internal                                |
      | region       | RegionOne                               |
      | region_id    | RegionOne                               |
      | service_id   | 30d92a97a81a4e5d8fd97a32bafd7b88        |
      | service_name | manilav2                                |
      | service_type | sharev2                                 |
      | url          | http://controller:8786/v2               |
      +--------------+-----------------------------------------+
    
    $ openstack endpoint create --region RegionOne \
      sharev2 admin http://controller:8786/v2
      +--------------+-----------------------------------------+
      | Field        | Value                                   |
      +--------------+-----------------------------------------+
      | enabled      | True                                    |
      | id           | e814a0cec40546e98cf0c25a82498483        |
      | interface    | admin                                   |
      | region       | RegionOne                               |
      | region_id    | RegionOne                               |
      | service_id   | 30d92a97a81a4e5d8fd97a32bafd7b88        |
      | service_name | manilav2                                |
      | service_type | sharev2                                 |
      | url          | http://controller:8786/v2               |
      +--------------+-----------------------------------------+

    Note

    The Shared File Systems services require endpoints for each service entity.