diff --git a/doc/source/install/controller-install-obs.rst b/doc/source/install/controller-install-obs.rst index 9e29d7d88..6d6211188 100644 --- a/doc/source/install/controller-install-obs.rst +++ b/doc/source/install/controller-install-obs.rst @@ -10,6 +10,9 @@ Prerequisites Before you install and configure the placement service, you must create a database, service credentials, and API endpoints. +Create Database +^^^^^^^^^^^^^^^ + #. To create the database, complete these steps: * Use the database access client to connect to the database server @@ -38,112 +41,10 @@ a database, service credentials, and API endpoints. * Exit the database access client. -#. Source the ``admin`` credentials to gain access to admin-only CLI commands: +Configure User and Endpoints +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. code-block:: console - - $ . admin-openrc - -#. Create a Placement service user using your chosen ``PLACEMENT_PASS``: - - .. code-block:: console - - $ openstack user create --domain default --password-prompt placement - - User Password: - Repeat User Password: - +---------------------+----------------------------------+ - | Field | Value | - +---------------------+----------------------------------+ - | domain_id | default | - | enabled | True | - | id | fa742015a6494a949f67629884fc7ec8 | - | name | placement | - | options | {} | - | password_expires_at | None | - +---------------------+----------------------------------+ - -#. Add the Placement user to the service project with the admin role: - - .. code-block:: console - - $ openstack role add --project service --user placement admin - - .. note:: - - This command provides no output. - -#. Create the Placement API entry in the service catalog: - - .. code-block:: console - - $ openstack service create --name placement \ - --description "Placement API" placement - - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | Placement API | - | enabled | True | - | id | 2d1a27022e6e4185b86adac4444c495f | - | name | placement | - | type | placement | - +-------------+----------------------------------+ - -#. Create the Placement API service endpoints: - - .. code-block:: console - - $ openstack endpoint create --region RegionOne \ - placement public http://controller:8780 - - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 2b1b2637908b4137a9c2e0470487cbc0 | - | interface | public | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 2d1a27022e6e4185b86adac4444c495f | - | service_name | placement | - | service_type | placement | - | url | http://controller:8780 | - +--------------+----------------------------------+ - - $ openstack endpoint create --region RegionOne \ - placement internal http://controller:8780 - - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 02bcda9a150a4bd7993ff4879df971ab | - | interface | internal | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 2d1a27022e6e4185b86adac4444c495f | - | service_name | placement | - | service_type | placement | - | url | http://controller:8780 | - +--------------+----------------------------------+ - - $ openstack endpoint create --region RegionOne \ - placement admin http://controller:8780 - - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 3d71177b9e0f406f98cbff198d74b182 | - | interface | admin | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 2d1a27022e6e4185b86adac4444c495f | - | service_name | placement | - | service_type | placement | - | url | http://controller:8780 | - +--------------+----------------------------------+ +.. include:: endpoints.rst Install and configure components -------------------------------- diff --git a/doc/source/install/controller-install-rdo.rst b/doc/source/install/controller-install-rdo.rst index 203ecd984..3044a37f1 100644 --- a/doc/source/install/controller-install-rdo.rst +++ b/doc/source/install/controller-install-rdo.rst @@ -10,6 +10,9 @@ Prerequisites Before you install and configure the placement service, you must create a database, service credentials, and API endpoints. +Create Database +^^^^^^^^^^^^^^^ + #. To create the databases, complete these steps: * Use the database access client to connect to the database server @@ -38,112 +41,10 @@ a database, service credentials, and API endpoints. * Exit the database access client. -#. Source the ``admin`` credentials to gain access to admin-only CLI commands: +Configure User and Endpoints +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. code-block:: console - - $ . admin-openrc - -#. Create a Placement service user using your chosen ``PLACEMENT_PASS``: - - .. code-block:: console - - $ openstack user create --domain default --password-prompt placement - - User Password: - Repeat User Password: - +---------------------+----------------------------------+ - | Field | Value | - +---------------------+----------------------------------+ - | domain_id | default | - | enabled | True | - | id | fa742015a6494a949f67629884fc7ec8 | - | name | placement | - | options | {} | - | password_expires_at | None | - +---------------------+----------------------------------+ - -#. Add the Placement user to the service project with the admin role: - - .. code-block:: console - - $ openstack role add --project service --user placement admin - - .. note:: - - This command provides no output. - -#. Create the Placement API entry in the service catalog: - - .. code-block:: console - - $ openstack service create --name placement \ - --description "Placement API" placement - - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | Placement API | - | enabled | True | - | id | 2d1a27022e6e4185b86adac4444c495f | - | name | placement | - | type | placement | - +-------------+----------------------------------+ - -#. Create the Placement API service endpoints: - - .. code-block:: console - - $ openstack endpoint create --region RegionOne \ - placement public http://controller:8778 - - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 2b1b2637908b4137a9c2e0470487cbc0 | - | interface | public | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 2d1a27022e6e4185b86adac4444c495f | - | service_name | placement | - | service_type | placement | - | url | http://controller:8778 | - +--------------+----------------------------------+ - - $ openstack endpoint create --region RegionOne \ - placement internal http://controller:8778 - - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 02bcda9a150a4bd7993ff4879df971ab | - | interface | internal | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 2d1a27022e6e4185b86adac4444c495f | - | service_name | placement | - | service_type | placement | - | url | http://controller:8778 | - +--------------+----------------------------------+ - - $ openstack endpoint create --region RegionOne \ - placement admin http://controller:8778 - - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 3d71177b9e0f406f98cbff198d74b182 | - | interface | admin | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 2d1a27022e6e4185b86adac4444c495f | - | service_name | placement | - | service_type | placement | - | url | http://controller:8778 | - +--------------+----------------------------------+ +.. include:: endpoints.rst Install and configure components -------------------------------- diff --git a/doc/source/install/controller-install-ubuntu.rst b/doc/source/install/controller-install-ubuntu.rst index 8fdef4cd8..6f46bff5b 100644 --- a/doc/source/install/controller-install-ubuntu.rst +++ b/doc/source/install/controller-install-ubuntu.rst @@ -10,6 +10,9 @@ Prerequisites Before you install and configure the placement service, you must create a database, service credentials, and API endpoints. +Create Database +^^^^^^^^^^^^^^^ + #. To create the database, complete these steps: * Use the database access client to connect to the database server @@ -38,112 +41,10 @@ a database, service credentials, and API endpoints. * Exit the database access client. -#. Source the ``admin`` credentials to gain access to admin-only CLI commands: +Configure User and Endpoints +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. code-block:: console - - $ . admin-openrc - -#. Create a Placement service user using your chosen ``PLACEMENT_PASS``: - - .. code-block:: console - - $ openstack user create --domain default --password-prompt placement - - User Password: - Repeat User Password: - +---------------------+----------------------------------+ - | Field | Value | - +---------------------+----------------------------------+ - | domain_id | default | - | enabled | True | - | id | fa742015a6494a949f67629884fc7ec8 | - | name | placement | - | options | {} | - | password_expires_at | None | - +---------------------+----------------------------------+ - -#. Add the Placement user to the service project with the admin role: - - .. code-block:: console - - $ openstack role add --project service --user placement admin - - .. note:: - - This command provides no output. - -#. Create the Placement API entry in the service catalog: - - .. code-block:: console - - $ openstack service create --name placement \ - --description "Placement API" placement - - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | Placement API | - | enabled | True | - | id | 2d1a27022e6e4185b86adac4444c495f | - | name | placement | - | type | placement | - +-------------+----------------------------------+ - -#. Create the Placement API service endpoints: - - .. code-block:: console - - $ openstack endpoint create --region RegionOne \ - placement public http://controller:8778 - - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 2b1b2637908b4137a9c2e0470487cbc0 | - | interface | public | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 2d1a27022e6e4185b86adac4444c495f | - | service_name | placement | - | service_type | placement | - | url | http://controller:8778 | - +--------------+----------------------------------+ - - $ openstack endpoint create --region RegionOne \ - placement internal http://controller:8778 - - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 02bcda9a150a4bd7993ff4879df971ab | - | interface | internal | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 2d1a27022e6e4185b86adac4444c495f | - | service_name | placement | - | service_type | placement | - | url | http://controller:8778 | - +--------------+----------------------------------+ - - $ openstack endpoint create --region RegionOne \ - placement admin http://controller:8778 - - +--------------+----------------------------------+ - | Field | Value | - +--------------+----------------------------------+ - | enabled | True | - | id | 3d71177b9e0f406f98cbff198d74b182 | - | interface | admin | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 2d1a27022e6e4185b86adac4444c495f | - | service_name | placement | - | service_type | placement | - | url | http://controller:8778 | - +--------------+----------------------------------+ +.. include:: endpoints.rst Install and configure components -------------------------------- diff --git a/doc/source/install/endpoints.rst b/doc/source/install/endpoints.rst new file mode 100644 index 000000000..0c22ff0e1 --- /dev/null +++ b/doc/source/install/endpoints.rst @@ -0,0 +1,111 @@ + +#. Source the ``admin`` credentials to gain access to admin-only CLI commands: + + .. code-block:: console + + $ . admin-openrc + +#. Create a Placement service user using your chosen ``PLACEMENT_PASS``: + + .. code-block:: console + + $ openstack user create --domain default --password-prompt placement + + User Password: + Repeat User Password: + +---------------------+----------------------------------+ + | Field | Value | + +---------------------+----------------------------------+ + | domain_id | default | + | enabled | True | + | id | fa742015a6494a949f67629884fc7ec8 | + | name | placement | + | options | {} | + | password_expires_at | None | + +---------------------+----------------------------------+ + +#. Add the Placement user to the service project with the admin role: + + .. code-block:: console + + $ openstack role add --project service --user placement admin + + .. note:: + + This command provides no output. + +#. Create the Placement API entry in the service catalog: + + .. code-block:: console + + $ openstack service create --name placement \ + --description "Placement API" placement + + +-------------+----------------------------------+ + | Field | Value | + +-------------+----------------------------------+ + | description | Placement API | + | enabled | True | + | id | 2d1a27022e6e4185b86adac4444c495f | + | name | placement | + | type | placement | + +-------------+----------------------------------+ + +#. Create the Placement API service endpoints: + + .. note:: Depending on your environment, the URL for the endpoint will vary + by port (possibly 8780 instead of 8778, or no port at all) and + hostname. You are responsible for determining the correct URL. + + .. code-block:: console + + $ openstack endpoint create --region RegionOne \ + placement public http://controller:8778 + + +--------------+----------------------------------+ + | Field | Value | + +--------------+----------------------------------+ + | enabled | True | + | id | 2b1b2637908b4137a9c2e0470487cbc0 | + | interface | public | + | region | RegionOne | + | region_id | RegionOne | + | service_id | 2d1a27022e6e4185b86adac4444c495f | + | service_name | placement | + | service_type | placement | + | url | http://controller:8778 | + +--------------+----------------------------------+ + + $ openstack endpoint create --region RegionOne \ + placement internal http://controller:8778 + + +--------------+----------------------------------+ + | Field | Value | + +--------------+----------------------------------+ + | enabled | True | + | id | 02bcda9a150a4bd7993ff4879df971ab | + | interface | internal | + | region | RegionOne | + | region_id | RegionOne | + | service_id | 2d1a27022e6e4185b86adac4444c495f | + | service_name | placement | + | service_type | placement | + | url | http://controller:8778 | + +--------------+----------------------------------+ + + $ openstack endpoint create --region RegionOne \ + placement admin http://controller:8778 + + +--------------+----------------------------------+ + | Field | Value | + +--------------+----------------------------------+ + | enabled | True | + | id | 3d71177b9e0f406f98cbff198d74b182 | + | interface | admin | + | region | RegionOne | + | region_id | RegionOne | + | service_id | 2d1a27022e6e4185b86adac4444c495f | + | service_name | placement | + | service_type | placement | + | url | http://controller:8778 | + +--------------+----------------------------------+