ironic/install-guide/source/include/configure-ironic-api.rst
Mathieu Mitchell e26c71bcf6 [install-guide] Import Install and configure sections
The following sections of the legacy install guide were imported:

  * Install and configure prerequisites
  * Install the Bare Metal service
  * Configure the Bare Metal service

Only changes made to the documentation are the following:

  * Formatting changes (code-block, proper lists, etc.)
  * Structure changes (installation and configuration are now under a
    single section)
  * Heading titles formatting [0]

[0] http://docs.openstack.org/contributor-guide/rst-conv/titles.html

Change-Id: I0f1f5dacd4ed31ccfb4ac38c1ff2ecfc94e99ca4
Partial-bug: #1612278
2016-09-26 08:41:20 -04:00

96 lines
2.9 KiB
ReStructuredText

Configuring ironic-api service
------------------------------
#. The Bare Metal service stores information in a database. This guide uses the
MySQL database that is used by other OpenStack services.
Configure the location of the database via the ``connection`` option. In the
following, replace ``IRONIC_DBPASSWORD`` with the password of your
``ironic`` user, and replace ``DB_IP`` with the IP address where the DB
server is located:
.. code-block:: ini
[database]
# The SQLAlchemy connection string used to connect to the
# database (string value)
connection=mysql+pymysql://ironic:IRONIC_DBPASSWORD@DB_IP/ironic?charset=utf8
#. Configure the ironic-api service to use the RabbitMQ message broker by
setting one or more of these options. Replace ``RABBIT_HOST`` with the
address of the RabbitMQ server:
.. code-block:: ini
[DEFAULT]
# The messaging driver to use, defaults to rabbit. Other
# drivers include qpid and zmq. (string value)
#rpc_backend=rabbit
[oslo_messaging_rabbit]
# The RabbitMQ broker address where a single node is used
# (string value)
rabbit_host=RABBIT_HOST
# The RabbitMQ userid (string value)
#rabbit_userid=guest
# The RabbitMQ password (string value)
#rabbit_password=guest
#. Configure the ironic-api service to use these credentials with the Identity
service. Replace ``PUBLIC_IDENTITY_IP`` with the public IP of the Identity
server, ``PRIVATE_IDENTITY_IP`` with the private IP of the Identity server
and replace ``IRONIC_PASSWORD`` with the password you chose for the
``ironic`` user in the Identity service:
.. code-block:: ini
[DEFAULT]
# Authentication strategy used by ironic-api: one of
# "keystone" or "noauth". "noauth" should not be used in a
# production environment because all authentication will be
# disabled. (string value)
auth_strategy=keystone
[keystone_authtoken]
# Authentication type to load (string value)
auth_type=v3password
# Complete public Identity API endpoint (string value)
auth_uri=http://PUBLIC_IDENTITY_IP:5000/v3/
# Complete admin Identity API endpoint. (string value)
auth_url=http://PRIVATE_IDENTITY_IP:35357/v3/
# Service username. (string value)
admin_user=ironic
# Service account password. (string value)
admin_password=IRONIC_PASSWORD
# Service tenant name. (string value)
admin_tenant_name=service
#. Create the Bare Metal service database tables:
.. code-block:: bash
$ ironic-dbsync --config-file /etc/ironic/ironic.conf create_schema
#. Restart the ironic-api service:
.. TODO(mmitchell): Split this based on operating system
.. code-block:: console
Fedora/RHEL7/CentOS7:
sudo systemctl restart openstack-ironic-api
Ubuntu:
sudo service ironic-api restart