Metadata-Version: 1.2
Name: tripleo-common
Version: 14.0.0
Summary: A common library for TripleO workflows.
Home-page: https://docs.openstack.org/tripleo-common/latest/
Author: OpenStack
Author-email: openstack-discuss@lists.openstack.org
License: UNKNOWN
Description: ========================
        Team and repository tags
        ========================
        
        .. image:: https://governance.openstack.org/tc/badges/tripleo-common.svg
            :target: https://governance.openstack.org/tc/reference/tags/index.html
        
        .. Change things from this point on
        
        ==============
        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
        
        
Platform: UNKNOWN
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
