Browse Source

Merge "Removed mentions of mistral from the doc"

changes/79/793079/1
Zuul 5 months ago
committed by Gerrit Code Review
parent
commit
86ba5af3a7
  1. 86
      README.rst
  2. 1
      doc/source/index.rst
  3. 85
      doc/source/tripleo-mistral.rst

86
README.rst

@ -18,89 +18,3 @@ A common library for TripleO workflows.
* Source: http://opendev.org/openstack/tripleo-common
* Bugs: https://bugs.launchpad.net/tripleo-common
* Release notes: https://docs.openstack.org/releasenotes/tripleo-common
Action Development
------------------
When developing new actions, you will checkout a copy of tripleo-common to an
undercloud machine and add actions as needed. To test the actions they need
to be installed and selected services need to be restarted. Use the following
code to accomplish these tasks. ::
sudo rm -Rf /usr/lib/python2.7/site-packages/tripleo_common*
sudo python setup.py install
sudo cp /usr/share/tripleo-common/sudoers /etc/sudoers.d/tripleo-common
sudo systemctl restart openstack-mistral-executor
sudo systemctl restart openstack-mistral-engine
# this loads the actions via entrypoints
sudo mistral-db-manage populate
# make sure the new actions got loaded
mistral action-list | grep tripleo
Workflow Development
--------------------
When developing new workflows, you will need to reload the modified workflows,
e.g the following will reload all the workflows from the default packaged
location, or you can use a similar approach to replace only a single workbook
while under development. ::
for workbook in $(openstack workbook list -f value -c Name | grep tripleo); do
openstack workbook delete $workbook
done
for workflow in $(openstack workflow list -f value -c Name | grep tripleo); do
openstack workflow delete $workflow
done
for workbook in $(ls /usr/share/openstack-tripleo-common/workbooks/*); do
openstack workbook create $workbook
done
Validations
-----------
Prerequisites
~~~~~~~~~~~~~
If you haven't installed the undercloud with the ``enable_validations`` set to
true, you will have to prepare your undercloud to run the validations::
$ sudo pip install git+https://opendev.org/openstack/tripleo-validations
$ sudo yum install ansible
$ sudo useradd validations
Finally you need to generate an SSH keypair for the validation user and copy
it to the overcloud's authorized_keys files::
$ mistral execution-create tripleo.validations.v1.copy_ssh_key
Running validations using the mistral workflow
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a context.json file containing the arguments passed to the workflow::
{
"validation_names": ["512e", "rabbitmq-limits"]
}
Run the ``tripleo.validations.v1.run_validations`` workflow with mistral
client::
mistral execution-create tripleo.validations.v1.run_validations context.json
Running groups of validations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a context.json file containing the arguments passed to the workflow::
{
"group_names": ["network", "post-deployment"]
}
Run the ``tripleo.validations.v1.run_groups`` workflow with mistral client::
mistral execution-create tripleo.validations.v1.run_groups context.json

1
doc/source/index.rst

@ -15,7 +15,6 @@ Contents:
installation
usage
images
tripleo-mistral
contributing
uploads

85
doc/source/tripleo-mistral.rst

@ -1,85 +0,0 @@
===================
TripleO and Mistral
===================
TripleO is in the process of developing Mistral workflows and actions to expose
TripleO business logic. This allows RESTful API access to TripleO functions.
- `Spec <https://specs.openstack.org/openstack/tripleo-specs/specs/mitaka/tripleo-mistral-deployment-library.html>`_
A high-level view of the overall workflow can be found in the `TripleO Overcloud
Deployment Library Spec
<https://specs.openstack.org/openstack/tripleo-specs/specs/mitaka/tripleo-overcloud-deployment-library.html>`_.
================
Undercloud Setup
================
To install the undercloud follow the `TripleO developer documentation
<https://docs.openstack.org/tripleo-docs/latest/install/environments/environments.html>`_.
=============
Code Location
=============
The relevant code is organized as below. Note that Mistral actions are exposed
through *setup.cfg*.
| tripleo-common/
| \|
| + setup.cfg
| \|
| + tripleo_common/
| \|
| + actions/
| \|
| + workbooks/
=============
Using Actions
=============
Mistral actions can be run through the CLI:
::
echo '{"container": "<container-name>"}' > input.json
openstack action execution run tripleo.plan.create_container input.json
For REST API usage please reference the `full Mistral documentation
<https://docs.openstack.org/mistral/latest/>`_.
===============
Using Workflows
===============
The undercloud install will automatically load the TripleO Mistral workbooks.
To manually load these workbooks during development, run the following:
::
openstack workbook create workbooks/plan_management.yaml
Workflow execution is asynchronous. The output of an execution is an ID that
can be used to get the status and output of that workflow execution.
::
echo '{"container": "<container-name>"}' > input.json
openstack workflow execution create tripleo.plan_management.v1.create_deployment_plan input.json
openstack workflow execution show <execution ID>
openstack workflow execution output show <execution ID>
For REST API usage please reference the `full Mistral documentation
<https://docs.openstack.org/mistral/latest/>`_.
By default a workflow execution expires after 48 hours. This can be configured
in /etc/mistral/mistral.conf.
::
[execution_expiration_policy]
evaluation_interval=120
older_than=2880
After modifying these values you will need to restart the mistral-engine service.
Loading…
Cancel
Save