diff --git a/{{cookiecutter.repo_name}}/install-guide/source/install.rst b/{{cookiecutter.repo_name}}/install-guide/source/install.rst index d808b37..dc25af4 100644 --- a/{{cookiecutter.repo_name}}/install-guide/source/install.rst +++ b/{{cookiecutter.repo_name}}/install-guide/source/install.rst @@ -7,14 +7,14 @@ This section describes how to install and configure the {{cookiecutter.service}} service, code-named {{cookiecutter.codename}}, on the controller node. This section assumes that you already have a working OpenStack -environment with at least the following components installed: -Compute, Image Service, Identity. +environment with at least the Identity service, the Compute service, +and the Image service installed. Prerequisites ------------- -Before you install and configure the {{cookiecutter.service}} service, you must create a -database, service credentials, and API endpoints. +Before you install and configure the {{cookiecutter.service}} service, +you must create a database, service credentials, and API endpoints. #. To create the database, complete these steps: @@ -27,13 +27,13 @@ database, service credentials, and API endpoints. * Create the ``{{cookiecutter.codename}}`` database: - .. code-block:: console + .. code-block:: mysql CREATE DATABASE {{cookiecutter.codename}}; * Grant proper access to the ``{{cookiecutter.codename}}`` database: - .. code-block:: console + .. code-block:: mysql GRANT ALL PRIVILEGES ON {{cookiecutter.codename}}.* TO '{{cookiecutter.codename}}'@'localhost' \ IDENTIFIED BY '{{cookiecutter.codename|upper}}_DBPASS'; @@ -44,12 +44,16 @@ database, service credentials, and API endpoints. * Exit the database access client. + .. code-block:: mysql + + exit; + #. Source the ``admin`` credentials to gain access to admin-only CLI commands: .. code-block:: console - $ source admin-openrc.sh + $ source admin-openrc #. To create the service credentials, complete these steps: @@ -59,6 +63,29 @@ database, service credentials, and API endpoints. $ openstack user create --domain default --password-prompt {{cookiecutter.codename}} + * Add the ``admin`` role to the ``{{cookiecutter.codename}}`` user: + + .. code-block:: console + + $ openstack role add --project service --user {{cookiecutter.codename}} admin + + * Create the {{cookiecutter.codename}} service entities: + + .. code-block:: console + + $ openstack service create --name {{cookiecutter.codename}} --description "{{cookiecutter.service}}" {{cookiecutter.service|lower}} + +#. Create the {{cookiecutter.service}} service API endpoints: + + .. code-block:: console + + $ openstack endpoint create --region RegionOne \ + {{cookiecutter.service|lower}} public http://controller:XXXX/vY/%\(tenant_id\)s + $ openstack endpoint create --region RegionOne \ + {{cookiecutter.service|lower}} internal http://controller:XXXX/vY/%\(tenant_id\)s + $ openstack endpoint create --region RegionOne \ + {{cookiecutter.service|lower}} admin http://controller:XXXX/vY/%\(tenant_id\)s + Install and configure components --------------------------------