From a7cd611c78ebe2aa8d35f93fe2b40326f058b0aa Mon Sep 17 00:00:00 2001 From: csatari Date: Wed, 5 Jul 2017 17:25:45 +0200 Subject: [PATCH] Applying Pike document structure This change aligns the Mistral documents folder structure to the one specified for Pike [1]. Documents were move to thir appropriate folder, but the different guides do not follow their cookie cutted structure yet. Install guide is in a separate change [2], while I could not found the cookie cutter for the rest of the guides. test-requirements.txt updated with the missing modules. tox_install.sh modified to do not pass $MODULE_NAME and -e parameter to edit-constraints. [1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html [2]: https://review.openstack.org/#/c/476499/ [3]: https://etherpad.openstack.org/p/doc-migration-tracking Change-Id: Ia1101fa2eada446d8eebfefa9bd15d8facd8b3b0 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Signed-off-by: csatari --- doc/README.md | 24 ---------------- doc/source/README.rst | 1 - doc/source/{dsl => admin}/dsl_v2.rst | 1 + doc/source/{dsl => admin}/index.rst | 1 + .../{guides => admin}/upgrade_guide.rst | 0 .../{developer/webapi => api}/index.rst | 0 doc/source/{developer/webapi => api}/v2.rst | 0 .../{guides/cli_guide.rst => cli/index.rst} | 0 .../index.rst} | 0 .../asynchronous_actions.rst | 0 .../creating_custom_action.rst | 0 .../{developer => contributor}/debug.rst | 0 .../{developer => contributor}/devstack.rst | 0 .../extending_yaql.rst | 0 .../{developer => contributor}/index.rst | 0 .../troubleshooting.rst | 0 doc/source/index.rst | 28 +++++++++++-------- .../{guides => install}/dashboard_guide.rst | 4 +-- doc/source/install/index.rst | 9 ++++++ .../installation_guide.rst | 14 +++++----- .../mistralclient_guide.rst | 2 +- doc/source/quickstart.rst | 6 ++-- doc/source/terminology/actions.rst | 4 +-- doc/source/terminology/workbooks.rst | 2 +- doc/source/terminology/workflows.rst | 2 +- test-requirements.txt | 16 +++++++++-- tools/tox_install.sh | 3 +- 27 files changed, 61 insertions(+), 56 deletions(-) delete mode 100644 doc/README.md delete mode 100644 doc/source/README.rst rename doc/source/{dsl => admin}/dsl_v2.rst (99%) rename doc/source/{dsl => admin}/index.rst (89%) rename doc/source/{guides => admin}/upgrade_guide.rst (100%) rename doc/source/{developer/webapi => api}/index.rst (100%) rename doc/source/{developer/webapi => api}/v2.rst (100%) rename doc/source/{guides/cli_guide.rst => cli/index.rst} (100%) rename doc/source/{guides/configuration_guide.rst => configuration/index.rst} (100%) rename doc/source/{developer => contributor}/asynchronous_actions.rst (100%) rename doc/source/{developer => contributor}/creating_custom_action.rst (100%) rename doc/source/{developer => contributor}/debug.rst (100%) rename doc/source/{developer => contributor}/devstack.rst (100%) rename doc/source/{developer => contributor}/extending_yaql.rst (100%) rename doc/source/{developer => contributor}/index.rst (100%) rename doc/source/{developer => contributor}/troubleshooting.rst (100%) rename doc/source/{guides => install}/dashboard_guide.rst (95%) create mode 100644 doc/source/install/index.rst rename doc/source/{guides => install}/installation_guide.rst (95%) rename doc/source/{guides => install}/mistralclient_guide.rst (98%) diff --git a/doc/README.md b/doc/README.md deleted file mode 100644 index 00513063..00000000 --- a/doc/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# Sphinx DOC hints - -## Migrating from OpenStack Wiki - -* Install pandoc -* Copy wiki code into a file, e.g. `source.mw` -* Convert to .rst - - pandoc --from=mediawiki --to=rst --output=doc/source/dsl/dsl_v1.rst doc/source/dsl/source.mw - -* To make code samples fancy: - - TODO: figure how to make YAML samples look nicer with `code::` directive - -## Using autodoc with sphinxcontrib.pecanwsme.rest and wsmeext.sphinxext plugins - - TODO: why REST URL is not generated with parameters? - -## Running sphinx-autobuild - -[auto-loader](https://pypi.python.org/pypi/sphinx-autobuild/0.2.3) - rules for convenient development https://pypi.python.org/pypi/sphinx-autobuild/0.2.3. install, and run: - - sphinx-autobuild doc/source doc/build - diff --git a/doc/source/README.rst b/doc/source/README.rst deleted file mode 100644 index a6210d3d..00000000 --- a/doc/source/README.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/dsl/dsl_v2.rst b/doc/source/admin/dsl_v2.rst similarity index 99% rename from doc/source/dsl/dsl_v2.rst rename to doc/source/admin/dsl_v2.rst index 7fa542f7..79d598e2 100644 --- a/doc/source/dsl/dsl_v2.rst +++ b/doc/source/admin/dsl_v2.rst @@ -855,6 +855,7 @@ Input parameters: - **password** - User password to to authenticate on the host. *Optional*. - **private_key_filename** - Private key file name which will be used for authentication on remote host. + All private keys should be on executor host in **/.ssh/**. **** should refer to user directory under which service is running. *Optional*. diff --git a/doc/source/dsl/index.rst b/doc/source/admin/index.rst similarity index 89% rename from doc/source/dsl/index.rst rename to doc/source/admin/index.rst index 77bbb38b..c8468d3a 100644 --- a/doc/source/dsl/index.rst +++ b/doc/source/admin/index.rst @@ -4,4 +4,5 @@ Mistral Workflow Language Specification .. toctree:: :maxdepth: 1 + upgrade_guide Mistral Workflow Language v2 diff --git a/doc/source/guides/upgrade_guide.rst b/doc/source/admin/upgrade_guide.rst similarity index 100% rename from doc/source/guides/upgrade_guide.rst rename to doc/source/admin/upgrade_guide.rst diff --git a/doc/source/developer/webapi/index.rst b/doc/source/api/index.rst similarity index 100% rename from doc/source/developer/webapi/index.rst rename to doc/source/api/index.rst diff --git a/doc/source/developer/webapi/v2.rst b/doc/source/api/v2.rst similarity index 100% rename from doc/source/developer/webapi/v2.rst rename to doc/source/api/v2.rst diff --git a/doc/source/guides/cli_guide.rst b/doc/source/cli/index.rst similarity index 100% rename from doc/source/guides/cli_guide.rst rename to doc/source/cli/index.rst diff --git a/doc/source/guides/configuration_guide.rst b/doc/source/configuration/index.rst similarity index 100% rename from doc/source/guides/configuration_guide.rst rename to doc/source/configuration/index.rst diff --git a/doc/source/developer/asynchronous_actions.rst b/doc/source/contributor/asynchronous_actions.rst similarity index 100% rename from doc/source/developer/asynchronous_actions.rst rename to doc/source/contributor/asynchronous_actions.rst diff --git a/doc/source/developer/creating_custom_action.rst b/doc/source/contributor/creating_custom_action.rst similarity index 100% rename from doc/source/developer/creating_custom_action.rst rename to doc/source/contributor/creating_custom_action.rst diff --git a/doc/source/developer/debug.rst b/doc/source/contributor/debug.rst similarity index 100% rename from doc/source/developer/debug.rst rename to doc/source/contributor/debug.rst diff --git a/doc/source/developer/devstack.rst b/doc/source/contributor/devstack.rst similarity index 100% rename from doc/source/developer/devstack.rst rename to doc/source/contributor/devstack.rst diff --git a/doc/source/developer/extending_yaql.rst b/doc/source/contributor/extending_yaql.rst similarity index 100% rename from doc/source/developer/extending_yaql.rst rename to doc/source/contributor/extending_yaql.rst diff --git a/doc/source/developer/index.rst b/doc/source/contributor/index.rst similarity index 100% rename from doc/source/developer/index.rst rename to doc/source/contributor/index.rst diff --git a/doc/source/developer/troubleshooting.rst b/doc/source/contributor/troubleshooting.rst similarity index 100% rename from doc/source/developer/troubleshooting.rst rename to doc/source/contributor/troubleshooting.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index f6d7ea68..b2098de2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -24,34 +24,41 @@ User guide **Installation** .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - guides/installation_guide - guides/configuration_guide - guides/dashboard_guide - guides/upgrade_guide - guides/mistralclient_guide + install/index + configuration/index + admin/upgrade_guide **API** .. toctree:: :maxdepth: 2 - developer/webapi/index + api/index **Mistral Workflow Language** .. toctree:: :maxdepth: 2 - dsl/index + admin/dsl_v2 **CLI** .. toctree:: :maxdepth: 1 - guides/cli_guide + cli/index + +Admin guide +----------- + +.. toctree:: + :maxdepth: 1 + + admin/index + Developer guide --------------- @@ -59,11 +66,10 @@ Developer guide .. toctree:: :maxdepth: 2 - developer/index + contributor/index Indices and tables ================== * :ref:`genindex` * :ref:`search` - diff --git a/doc/source/guides/dashboard_guide.rst b/doc/source/install/dashboard_guide.rst similarity index 95% rename from doc/source/guides/dashboard_guide.rst rename to doc/source/install/dashboard_guide.rst index df94d6c6..ce9b5e8d 100644 --- a/doc/source/guides/dashboard_guide.rst +++ b/doc/source/install/dashboard_guide.rst @@ -42,7 +42,7 @@ The following should get you started: OPENSTACK_KEYSTONE_URL = "http://%s:5000/v3" % OPENSTACK_HOST 4. Also, make sure you have changed OPENSTACK_HOST to point to your Keystone - server and check all endpoints are accessible. You may want to change + server and check all endpoints are accessible. You may want to change OPENSTACK_ENDPOINT_TYPE to "publicURL" if some of them are not. 5. When you're ready, you would need to either restart your apache:: @@ -56,4 +56,4 @@ The following should get you started: Debug instructions ------------------ -Please refer to :doc:`Mistral Troubleshooting <../developer/troubleshooting>` +Please refer to :doc:`Mistral Troubleshooting <../contributor/troubleshooting>` diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst new file mode 100644 index 00000000..f56ebce7 --- /dev/null +++ b/doc/source/install/index.rst @@ -0,0 +1,9 @@ +Mistral User Guide +================== + +.. toctree:: + :maxdepth: 1 + + installation_guide + dashboard_guide + mistralclient_guide diff --git a/doc/source/guides/installation_guide.rst b/doc/source/install/installation_guide.rst similarity index 95% rename from doc/source/guides/installation_guide.rst rename to doc/source/install/installation_guide.rst index 92909d81..827bdefc 100644 --- a/doc/source/guides/installation_guide.rst +++ b/doc/source/install/installation_guide.rst @@ -31,7 +31,7 @@ sure **Keystone v3** is installed. Installation ------------ -**NOTE**: If it is needed to install Mistral using devstack, please refer to :doc:`Mistral Devstack Installation ` +**NOTE**: If it is needed to install Mistral using devstack, please refer to :doc:`Mistral Devstack Installation ` First of all, clone the repo and go to the repo directory:: @@ -45,7 +45,7 @@ Generate config:: Configure Mistral as needed. The configuration file is located in ``etc/mistral.conf.sample``. You will need to modify the configuration options and then copy it into ``/etc/mistral/mistral.conf``. -For details see :doc:`Mistral Configuration Guide ` +For details see :doc:`Mistral Configuration Guide ` **Virtualenv installation**:: @@ -76,7 +76,7 @@ After installation you will see **mistral-server** and **mistral-db-manage** com in your environment, either in system or virtual environment. **NOTE**: In case of using **virtualenv**, all Mistral related commands available via -**tox -evenv --**. For example, *mistral-server* is available via +**tox -evenv --**. For example, *mistral-server* is available via *tox -evenv -- mistral-server*. **mistral-db-manage** command can be used for migrations. @@ -91,7 +91,7 @@ workflows which Mistral provides for all Mistral users.:: $ mistral-db-manage --config-file populate -For more detailed information about *mistral-db-manage* script please see :doc:`Mistral Upgrade Guide `. +For more detailed information about *mistral-db-manage* script please see :doc:`Mistral Upgrade Guide `. **NOTE**: For users who want a dry run with **SQLite** database backend(not used in production), *mistral-db-manage* is not recommended for database @@ -136,7 +136,7 @@ perform the following command in a shell:: $ mistral-server --server api,engine --config-file -The --server command line option can be a comma delimited list. The valid +The --server command line option can be a comma delimited list. The valid options are "all" (by default if not specified) or any combination of "api", "engine", and "executor". It's important to note that the "fake" transport for the rpc_backend defined in the config file should only be used if "all" the @@ -159,7 +159,7 @@ To load this image to docker registry, please run following command:: $ docker load -i '' The Mistral Docker image is configured to store the database in the user's home -directory. For persistence of these data, you may want to keep this directory +directory. For persistence of these data, you may want to keep this directory outside of the container. This may be done by the following steps:: $ sudo mkdir '' @@ -174,4 +174,4 @@ then put customized mistral.conf to ''. Mistral Client Installation --------------------------- -Please refer to :doc:`Mistral Client / CLI Guide ` +Please refer to :doc:`Mistral Client / CLI Guide <../cli/index>` diff --git a/doc/source/guides/mistralclient_guide.rst b/doc/source/install/mistralclient_guide.rst similarity index 98% rename from doc/source/guides/mistralclient_guide.rst rename to doc/source/install/mistralclient_guide.rst index e9112caa..31c7f5bc 100644 --- a/doc/source/guides/mistralclient_guide.rst +++ b/doc/source/install/mistralclient_guide.rst @@ -76,7 +76,7 @@ Targeting non-preconfigured clouds Mistral is capable of executing workflows on external OpenStack clouds, different from the one defined in the `mistral.conf` file in the -`keystone_authtoken` section. (More detail in the :doc:`configuration_guide`). +`keystone_authtoken` section. (More detail in the :doc:`/configuration/index`). For example, if the mistral server is configured to authenticate with the `http://keystone1.example.com` cloud and the user wants to execute the workflow diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst index 049fc1bd..2f1b31d2 100644 --- a/doc/source/quickstart.rst +++ b/doc/source/quickstart.rst @@ -10,12 +10,12 @@ three prerequisites. Install and run Mistral ~~~~~~~~~~~~~~~~~~~~~~~ -Go through the installation manual: :doc:`Mistral Installation Guide ` +Go through the installation manual: :doc:`Mistral Installation Guide ` Install Mistral client ~~~~~~~~~~~~~~~~~~~~~~ -To install mistralclient, please refer to :doc:`Mistral Client / CLI Guide ` +To install mistralclient, please refer to :doc:`Mistral Client / CLI Guide ` Export Keystone credentials ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -62,7 +62,7 @@ This simple workflow iterates through a list of names in ``task1`` (using then stores the word "Done" as a result of the second task (`task2`). To learn more about the Mistral Workflows and what you can do, read the -:doc:`Mistral Workflow Language specification ` +:doc:`Mistral Workflow Language specification ` Upload the workflow ------------------- diff --git a/doc/source/terminology/actions.rst b/doc/source/terminology/actions.rst index 3866cf05..e0283a6e 100644 --- a/doc/source/terminology/actions.rst +++ b/doc/source/terminology/actions.rst @@ -19,7 +19,7 @@ its state and result. .. image:: /img/Mistral_actions.png -:doc:`How to work with asynchronous actions ` +:doc:`How to work with asynchronous actions ` System actions -------------- @@ -27,7 +27,7 @@ System actions System actions are provided by Mistral out of the box and are available to all users. Additional actions can be added via the custom action plugin mechanism. -:doc:`How to write an Action Plugin ` +:doc:`How to write an Action Plugin ` Ad-hoc actions diff --git a/doc/source/terminology/workbooks.rst b/doc/source/terminology/workbooks.rst index 97d98ce6..ff1e30fd 100644 --- a/doc/source/terminology/workbooks.rst +++ b/doc/source/terminology/workbooks.rst @@ -80,4 +80,4 @@ the original workbook. * **actions** - Dictionary containing ad-hoc action definitions. *Optional*. For more details about Mistral Workflow Language itself, please see -:doc:`Mistral Workflow Language specification ` +:doc:`Mistral Workflow Language specification ` diff --git a/doc/source/terminology/workflows.rst b/doc/source/terminology/workflows.rst index 8ad4fa73..10174bc0 100644 --- a/doc/source/terminology/workflows.rst +++ b/doc/source/terminology/workflows.rst @@ -137,4 +137,4 @@ YAML example       requires: [create_vm, associate_ip] For more details about Mistral Workflow Language itself, please see -:doc:`Mistral Workflow Language specification ` +:doc:`Mistral Workflow Language specification ` diff --git a/test-requirements.txt b/test-requirements.txt index 67e9a9ef..620b9648 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,20 +2,32 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. coverage!=4.4,>=4.0 # Apache-2.0 +croniter>=0.3.4 # MIT License +eventlet!=0.18.3,>=0.18.2,!=0.20.1,<0.21.0 # MIT fixtures>=3.0.0 # Apache-2.0/BSD hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 +keystonemiddleware>=4.12.0 # Apache-2.0 +mistral-lib>=0.2.0 # Apache-2.0 +mock>=2.0 # BSD +networkx>=1.10 # BSD nose # LGPL oslotest>=1.10.0 # Apache-2.0 +oslo.db>=4.23.0 # Apache-2.0 +oslo.messaging>=5.24.2,!=5.25.0 # Apache-2.0 +oslo.policy>=1.23.0 # Apache-2.0 +osprofiler>=1.4.0 # Apache-2.0 os-api-ref>=1.0.0 # Apache-2.0 +pecan>=1.0.0,!=1.0.2,!=1.0.3,!=1.0.4,!=1.2 # BSD pyflakes==0.8.1 # MIT -mock>=2.0 # BSD +reno!=2.3.1,>=1.8.0 # Apache-2.0 requests-mock>=1.1 # Apache-2.0 sphinx>=1.6.2 # BSD sphinxcontrib-httpdomain # BSD sphinxcontrib-pecanwsme>=0.8 # Apache-2.0 openstackdocstheme>=1.11.0 # Apache-2.0 +tooz>=1.47.0 # Apache-2.0 tempest>=14.0.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT unittest2 # BSD -reno!=2.3.1,>=1.8.0 # Apache-2.0 +WSME>=0.8 # MIT diff --git a/tools/tox_install.sh b/tools/tox_install.sh index 2cbbfbc9..72d75f66 100755 --- a/tools/tox_install.sh +++ b/tools/tox_install.sh @@ -50,7 +50,8 @@ fi # This is the main purpose of the script: Allow local installation of # the current repo. It is listed in constraints file and thus any # install will be constrained and we need to unconstrain it. -edit-constraints $localfile -- $MODULE_NAME "-e file://$PWD#egg=$MODULE_NAME" +#edit-constraints $localfile -- $MODULE_NAME "-e file://$PWD#egg=$MODULE_NAME" +edit-constraints $localfile -- -- $install_cmd -U $* exit $?