Add install-{obs, rdo, ubuntu}.rst files
Add install-obs.rst, install-rdo.rst and install-ubuntu.rst for distro installations beacause the doc infrastructure is not set up to support conditional content. Factor out database setup, creation of service, creation of endpoints and service configuration. Partially-Implements: blueprint projectspecificinstallguides Change-Id: I064181f512961516c7c50844d04f1ad27eda928d
This commit is contained in:
parent
ee0bdb371f
commit
4c304c4fa1
|
@ -0,0 +1,10 @@
|
||||||
|
2. Edit the ``/etc/{{cookiecutter.codename}}/{{cookiecutter.codename}}.conf`` file and complete the following
|
||||||
|
actions:
|
||||||
|
|
||||||
|
* In the ``[database]`` section, configure database access:
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
[database]
|
||||||
|
...
|
||||||
|
connection = mysql+pymysql://{{cookiecutter.codename}}:{{cookiecutter.codename|upper}}_DBPASS@controller/{{cookiecutter.codename}}
|
|
@ -0,0 +1,75 @@
|
||||||
|
Prerequisites
|
||||||
|
-------------
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
* Use the database access client to connect to the database
|
||||||
|
server as the ``root`` user:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ mysql -u root -p
|
||||||
|
|
||||||
|
* Create the ``{{cookiecutter.codename}}`` database:
|
||||||
|
|
||||||
|
.. code-block:: mysql
|
||||||
|
|
||||||
|
CREATE DATABASE {{cookiecutter.codename}};
|
||||||
|
|
||||||
|
* Grant proper access to the ``{{cookiecutter.codename}}`` database:
|
||||||
|
|
||||||
|
.. code-block:: mysql
|
||||||
|
|
||||||
|
GRANT ALL PRIVILEGES ON {{cookiecutter.codename}}.* TO '{{cookiecutter.codename}}'@'localhost' \
|
||||||
|
IDENTIFIED BY '{{cookiecutter.codename|upper}}_DBPASS';
|
||||||
|
GRANT ALL PRIVILEGES ON {{cookiecutter.codename}}.* TO '{{cookiecutter.codename}}'@'%' \
|
||||||
|
IDENTIFIED BY '{{cookiecutter.codename|upper}}_DBPASS';
|
||||||
|
|
||||||
|
Replace ``{{cookiecutter.codename|upper}}_DBPASS`` with a suitable password.
|
||||||
|
|
||||||
|
* 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
|
||||||
|
|
||||||
|
#. To create the service credentials, complete these steps:
|
||||||
|
|
||||||
|
* Create the ``{{cookiecutter.codename}}`` user:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ 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
|
|
@ -91,7 +91,7 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
|
||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and
|
# List of patterns, relative to source directory, that match files and
|
||||||
# directories to ignore when looking for source files.
|
# directories to ignore when looking for source files.
|
||||||
exclude_patterns = []
|
exclude_patterns = ["common_prerequisites.rst", "common_configure.rst"]
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all
|
# The reST default role (used for this markup: `text`) to use for all
|
||||||
# documents.
|
# documents.
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
get_started.rst
|
get_started.rst
|
||||||
install.rst
|
install.rst
|
||||||
|
@ -11,6 +12,5 @@
|
||||||
|
|
||||||
The {{cookiecutter.service}} service ({{cookiecutter.codename}}) provides...
|
The {{cookiecutter.service}} service ({{cookiecutter.codename}}) provides...
|
||||||
|
|
||||||
This chapter assumes a working setup of OpenStack following the base
|
This chapter assumes a working setup of OpenStack following the
|
||||||
Installation Guide.
|
`OpenStack Installation Tutorial <http://docs.openstack.org/#install-guides>`_.
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,34 @@
|
||||||
|
.. _install-obs:
|
||||||
|
|
||||||
|
|
||||||
|
Install and configure for openSUSE and SUSE Linux Enterprise
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
This section describes how to install and configure the {{cookiecutter.service}} service
|
||||||
|
for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1.
|
||||||
|
|
||||||
|
.. include:: common_prerequisites.rst
|
||||||
|
|
||||||
|
Install and configure components
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
#. Install the packages:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
# zypper --quiet --non-interactive install
|
||||||
|
|
||||||
|
.. include:: common_configure.rst
|
||||||
|
|
||||||
|
|
||||||
|
Finalize installation
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Start the {{cookiecutter.service}} services and configure them to start when
|
||||||
|
the system boots:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
# systemctl enable openstack-{{cookiecutter.codename}}-api.service
|
||||||
|
|
||||||
|
# systemctl start openstack-{{cookiecutter.codename}}-api.service
|
|
@ -0,0 +1,33 @@
|
||||||
|
.. _install-rdo:
|
||||||
|
|
||||||
|
Install and configure for Red Hat Enterprise Linux and CentOS
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
This section describes how to install and configure the {{cookiecutter.service}} service
|
||||||
|
for Red Hat Enterprise Linux 7 and CentOS 7.
|
||||||
|
|
||||||
|
.. include:: common_prerequisites.rst
|
||||||
|
|
||||||
|
Install and configure components
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
#. Install the packages:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
# yum install
|
||||||
|
|
||||||
|
.. include:: common_configure.rst
|
||||||
|
|
||||||
|
Finalize installation
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Start the {{cookiecutter.service}} services and configure them to start when
|
||||||
|
the system boots:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
# systemctl enable openstack-{{cookiecutter.codename}}-api.service
|
||||||
|
|
||||||
|
# systemctl start openstack-{{cookiecutter.codename}}-api.service
|
|
@ -0,0 +1,31 @@
|
||||||
|
.. _install-ubuntu:
|
||||||
|
|
||||||
|
Install and configure for Ubuntu
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
This section describes how to install and configure the {{cookiecutter.service}}
|
||||||
|
service for Ubuntu 14.04 (LTS).
|
||||||
|
|
||||||
|
.. include:: common_prerequisites.rst
|
||||||
|
|
||||||
|
Install and configure components
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
#. Install the packages:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
# apt-get update
|
||||||
|
|
||||||
|
# apt-get install
|
||||||
|
|
||||||
|
.. include:: common_configure.rst
|
||||||
|
|
||||||
|
Finalize installation
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Restart the {{cookiecutter.service}} services:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
# service openstack-{{cookiecutter.codename}}-api restart
|
|
@ -7,89 +7,14 @@ This section describes how to install and configure the
|
||||||
{{cookiecutter.service}} service, code-named {{cookiecutter.codename}}, on the controller node.
|
{{cookiecutter.service}} service, code-named {{cookiecutter.codename}}, on the controller node.
|
||||||
|
|
||||||
This section assumes that you already have a working OpenStack
|
This section assumes that you already have a working OpenStack
|
||||||
environment with at least the Identity service, the Compute service,
|
environment with at least the following components installed:
|
||||||
and the Image service installed.
|
.. (add the appropriate services here and further notes)
|
||||||
|
|
||||||
Prerequisites
|
Note that installation and configuration vary by distribution.
|
||||||
-------------
|
|
||||||
|
|
||||||
Before you install and configure the {{cookiecutter.service}} service,
|
.. toctree::
|
||||||
you must create a database, service credentials, and API endpoints.
|
:maxdepth: 2
|
||||||
|
|
||||||
#. To create the database, complete these steps:
|
|
||||||
|
|
||||||
* Use the database access client to connect to the database
|
|
||||||
server as the ``root`` user:
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ mysql -u root -p
|
|
||||||
|
|
||||||
* Create the ``{{cookiecutter.codename}}`` database:
|
|
||||||
|
|
||||||
.. code-block:: mysql
|
|
||||||
|
|
||||||
CREATE DATABASE {{cookiecutter.codename}};
|
|
||||||
|
|
||||||
* Grant proper access to the ``{{cookiecutter.codename}}`` database:
|
|
||||||
|
|
||||||
.. code-block:: mysql
|
|
||||||
|
|
||||||
GRANT ALL PRIVILEGES ON {{cookiecutter.codename}}.* TO '{{cookiecutter.codename}}'@'localhost' \
|
|
||||||
IDENTIFIED BY '{{cookiecutter.codename|upper}}_DBPASS';
|
|
||||||
GRANT ALL PRIVILEGES ON {{cookiecutter.codename}}.* TO '{{cookiecutter.codename}}'@'%' \
|
|
||||||
IDENTIFIED BY '{{cookiecutter.codename|upper}}_DBPASS';
|
|
||||||
|
|
||||||
Replace ``{{cookiecutter.codename|upper}}_DBPASS`` with a suitable password.
|
|
||||||
|
|
||||||
* 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
|
|
||||||
|
|
||||||
#. To create the service credentials, complete these steps:
|
|
||||||
|
|
||||||
* Create the ``{{cookiecutter.codename}}`` user:
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ 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
|
|
||||||
--------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
Finalize installation
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
|
install-obs.rst
|
||||||
|
install-rdo.rst
|
||||||
|
install-ubuntu.rst
|
||||||
|
|
Loading…
Reference in New Issue