cded1f6317
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I3532fe039e754c3518a25b72094bf421d1f1c299 |
||
---|---|---|
container-images | ||
contrib | ||
doc/source | ||
healthcheck | ||
heat_docker_agent | ||
image-yaml | ||
releasenotes | ||
scripts | ||
tools | ||
tripleo_common | ||
undercloud_heat_plugins | ||
workbooks | ||
zuul.d | ||
.coveragerc | ||
.gitignore | ||
.gitreview | ||
.mailmap | ||
.pre-commit-config.yaml | ||
.stestr.conf | ||
CONTRIBUTING.rst | ||
HACKING.rst | ||
LICENSE | ||
README.rst | ||
babel.cfg | ||
bindep.txt | ||
lower-constraints.txt | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
sudoers | ||
test-requirements.txt | ||
tox.ini |
README.rst
Team and repository tags
tripleo-common
A common library for TripleO workflows.
- Free software: Apache license
- Documentation: https://docs.openstack.org/tripleo-common/latest/
- 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