Merge "Remove the unused docs"
This commit is contained in:
Zuul
Gerrit Code Review
commit
900f4870a5
|
|
@ -1,5 +0,0 @@
|
|||
====================
|
||||
Administrators guide
|
||||
====================
|
||||
|
||||
Administrators guide of solum-tempest-plugin.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
================================
|
||||
Command line interface reference
|
||||
================================
|
||||
|
||||
CLI reference of solum-tempest-plugin.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
=============
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Configuration of solum-tempest-plugin.
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
============
|
||||
Contributing
|
||||
============
|
||||
.. include:: ../../../CONTRIBUTING.rst
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
===========================
|
||||
Contributor Documentation
|
||||
===========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
contributing
|
||||
|
||||
|
|
@ -13,14 +13,6 @@ Contents:
|
|||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
install/index
|
||||
library/index
|
||||
contributor/index
|
||||
configuration/index
|
||||
cli/index
|
||||
user/index
|
||||
admin/index
|
||||
reference/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
|
|
|||
|
|
@ -1,10 +0,0 @@
|
|||
2. Edit the ``/etc/solum_tempest_plugin/solum_tempest_plugin.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql+pymysql://solum_tempest_plugin:SOLUM_TEMPEST_PLUGIN_DBPASS@controller/solum_tempest_plugin
|
||||
|
|
@ -1,75 +0,0 @@
|
|||
Prerequisites
|
||||
-------------
|
||||
|
||||
Before you install and configure the solum-tempest-plugin 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 ``solum_tempest_plugin`` database:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
CREATE DATABASE solum_tempest_plugin;
|
||||
|
||||
* Grant proper access to the ``solum_tempest_plugin`` database:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
GRANT ALL PRIVILEGES ON solum_tempest_plugin.* TO 'solum_tempest_plugin'@'localhost' \
|
||||
IDENTIFIED BY 'SOLUM_TEMPEST_PLUGIN_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON solum_tempest_plugin.* TO 'solum_tempest_plugin'@'%' \
|
||||
IDENTIFIED BY 'SOLUM_TEMPEST_PLUGIN_DBPASS';
|
||||
|
||||
Replace ``SOLUM_TEMPEST_PLUGIN_DBPASS`` with a suitable password.
|
||||
|
||||
* Exit the database access client.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
exit;
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to
|
||||
admin-only CLI commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ . admin-openrc
|
||||
|
||||
#. To create the service credentials, complete these steps:
|
||||
|
||||
* Create the ``solum_tempest_plugin`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack user create --domain default --password-prompt solum_tempest_plugin
|
||||
|
||||
* Add the ``admin`` role to the ``solum_tempest_plugin`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack role add --project service --user solum_tempest_plugin admin
|
||||
|
||||
* Create the solum_tempest_plugin service entities:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack service create --name solum_tempest_plugin --description "solum-tempest-plugin" solum-tempest-plugin
|
||||
|
||||
#. Create the solum-tempest-plugin service API endpoints:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
solum-tempest-plugin public http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
solum-tempest-plugin internal http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
solum-tempest-plugin admin http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
=====================================
|
||||
solum-tempest-plugin service overview
|
||||
=====================================
|
||||
The solum-tempest-plugin service provides...
|
||||
|
||||
The solum-tempest-plugin service consists of the following components:
|
||||
|
||||
``solum_tempest_plugin-api`` service
|
||||
Accepts and responds to end user compute API calls...
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
===============================================
|
||||
solum-tempest-plugin service installation guide
|
||||
===============================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
get_started.rst
|
||||
install.rst
|
||||
verify.rst
|
||||
next-steps.rst
|
||||
|
||||
The solum-tempest-plugin service (solum_tempest_plugin) provides...
|
||||
|
||||
This chapter assumes a working setup of OpenStack following the
|
||||
`OpenStack Installation Tutorial
|
||||
<https://docs.openstack.org/project-install-guide/ocata/>`_.
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
.. _install-obs:
|
||||
|
||||
|
||||
Install and configure for openSUSE and SUSE Linux Enterprise
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the solum-tempest-plugin 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 solum-tempest-plugin services and configure them to start when
|
||||
the system boots:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl enable openstack-solum_tempest_plugin-api.service
|
||||
|
||||
# systemctl start openstack-solum_tempest_plugin-api.service
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
.. _install-rdo:
|
||||
|
||||
Install and configure for Red Hat Enterprise Linux and CentOS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
This section describes how to install and configure the solum-tempest-plugin 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 solum-tempest-plugin services and configure them to start when
|
||||
the system boots:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl enable openstack-solum_tempest_plugin-api.service
|
||||
|
||||
# systemctl start openstack-solum_tempest_plugin-api.service
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
.. _install-ubuntu:
|
||||
|
||||
Install and configure for Ubuntu
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the solum-tempest-plugin
|
||||
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 solum-tempest-plugin services:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# service openstack-solum_tempest_plugin-api restart
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
.. _install:
|
||||
|
||||
Install and configure
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the
|
||||
solum-tempest-plugin service, code-named solum_tempest_plugin, on the controller node.
|
||||
|
||||
This section assumes that you already have a working OpenStack
|
||||
environment with at least the following components installed:
|
||||
.. (add the appropriate services here and further notes)
|
||||
|
||||
Note that installation and configuration vary by distribution.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
install-obs.rst
|
||||
install-rdo.rst
|
||||
install-ubuntu.rst
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
.. _next-steps:
|
||||
|
||||
Next steps
|
||||
~~~~~~~~~~
|
||||
|
||||
Your OpenStack environment now includes the solum_tempest_plugin service.
|
||||
|
||||
To add additional services, see
|
||||
https://docs.openstack.org/project-install-guide/ocata/.
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
.. _verify:
|
||||
|
||||
Verify operation
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Verify operation of the solum-tempest-plugin service.
|
||||
|
||||
.. note::
|
||||
|
||||
Perform these commands on the controller node.
|
||||
|
||||
#. Source the ``admin`` project credentials to gain access to
|
||||
admin-only CLI commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ . admin-openrc
|
||||
|
||||
#. List service components to verify successful launch and registration
|
||||
of each process:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack solum-tempest-plugin service list
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
========
|
||||
Usage
|
||||
========
|
||||
|
||||
To use solum-tempest-plugin in a project::
|
||||
|
||||
import solum_tempest_plugin
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
==========
|
||||
References
|
||||
==========
|
||||
|
||||
References of solum-tempest-plugin.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
===========
|
||||
Users guide
|
||||
===========
|
||||
|
||||
Users guide of solum-tempest-plugin.
|
||||
Loading…
Reference in New Issue