diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst deleted file mode 100644 index 67ddc11..0000000 --- a/doc/source/admin/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -==================== -Administrators guide -==================== - -Administrators guide of solum-tempest-plugin. diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst deleted file mode 100644 index b7d1cd9..0000000 --- a/doc/source/cli/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -================================ -Command line interface reference -================================ - -CLI reference of solum-tempest-plugin. diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst deleted file mode 100644 index b38721f..0000000 --- a/doc/source/configuration/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -============= -Configuration -============= - -Configuration of solum-tempest-plugin. diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst deleted file mode 100644 index 2aa0707..0000000 --- a/doc/source/contributor/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst deleted file mode 100644 index 036e449..0000000 --- a/doc/source/contributor/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -=========================== - Contributor Documentation -=========================== - -.. toctree:: - :maxdepth: 2 - - contributing - diff --git a/doc/source/index.rst b/doc/source/index.rst index d259af3..ac2e598 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ================== diff --git a/doc/source/install/common_configure.rst b/doc/source/install/common_configure.rst deleted file mode 100644 index fc68331..0000000 --- a/doc/source/install/common_configure.rst +++ /dev/null @@ -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 diff --git a/doc/source/install/common_prerequisites.rst b/doc/source/install/common_prerequisites.rst deleted file mode 100644 index f963286..0000000 --- a/doc/source/install/common_prerequisites.rst +++ /dev/null @@ -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 diff --git a/doc/source/install/get_started.rst b/doc/source/install/get_started.rst deleted file mode 100644 index 9a6dd2d..0000000 --- a/doc/source/install/get_started.rst +++ /dev/null @@ -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... diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst deleted file mode 100644 index f489ff9..0000000 --- a/doc/source/install/index.rst +++ /dev/null @@ -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 -`_. diff --git a/doc/source/install/install-obs.rst b/doc/source/install/install-obs.rst deleted file mode 100644 index f3c3f49..0000000 --- a/doc/source/install/install-obs.rst +++ /dev/null @@ -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 diff --git a/doc/source/install/install-rdo.rst b/doc/source/install/install-rdo.rst deleted file mode 100644 index 00eecd7..0000000 --- a/doc/source/install/install-rdo.rst +++ /dev/null @@ -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 diff --git a/doc/source/install/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst deleted file mode 100644 index 53bbdf0..0000000 --- a/doc/source/install/install-ubuntu.rst +++ /dev/null @@ -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 diff --git a/doc/source/install/install.rst b/doc/source/install/install.rst deleted file mode 100644 index c3e2cba..0000000 --- a/doc/source/install/install.rst +++ /dev/null @@ -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 diff --git a/doc/source/install/next-steps.rst b/doc/source/install/next-steps.rst deleted file mode 100644 index 081288b..0000000 --- a/doc/source/install/next-steps.rst +++ /dev/null @@ -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/. diff --git a/doc/source/install/verify.rst b/doc/source/install/verify.rst deleted file mode 100644 index b7018c9..0000000 --- a/doc/source/install/verify.rst +++ /dev/null @@ -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 diff --git a/doc/source/library/index.rst b/doc/source/library/index.rst deleted file mode 100644 index 1f7876b..0000000 --- a/doc/source/library/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -======== -Usage -======== - -To use solum-tempest-plugin in a project:: - - import solum_tempest_plugin diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst deleted file mode 100644 index 462c05c..0000000 --- a/doc/source/reference/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -========== -References -========== - -References of solum-tempest-plugin. diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst deleted file mode 100644 index 051d684..0000000 --- a/doc/source/user/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -=========== -Users guide -=========== - -Users guide of solum-tempest-plugin.