tripleo-ansible/doc/source/contributing.rst

Contributing

Adding roles into this project is easy and starts with a compatible skeleton.

From with the project root, creating a skeleton for the new role.

$ ansible-galaxy init --role-skeleton=_skeleton_role_ --init-path=tripleo_ansible/roles ${NEWROLENAME}

Once the new role has been created, and is ready for testing add the role into the tox.ini file as an test scenario.

[testenv:mol-${NEWROLENAME}]
basepython={[testenv:mol]basepython}
deps={[testenv:mol]deps}
changedir = {toxinidir}/tripleo_ansible/roles/${NEWROLENAME}
envdir = {toxworkdir}/mol
commands =
  python -m pytest --color=yes --html={envlogdir}/reports.html --self-contained-html {tty:-s} {toxinidir}/tests/test_molecule.py

If a given role has more than one scenario to test, the --scenario argument can be used to set the scenario accordingly.

[testenv:mol-${NEWROLENAME}-${SCENARIO_2}]
basepython={[testenv:mol-${NEWROLENAME}]basepython}
deps={[testenv:mol-${NEWROLENAME}]deps}
changedir = {[testenv:mol-${NEWROLENAME}]changedir}
envdir = {[testenv:mol-${NEWROLENAME}]envdir}
commands =
  python -m pytest --color=yes --html={envlogdir}/reports.html --self-contained-html {tty:-s} {toxinidir}/tests/test_molecule.py --scenario=${SCENARIO_2}

When the role is ready for CI add a jobs entry into the zuul.d/jobs.yaml.

- job:
    name: tripleo-ansible-centos:mol-${NEWROLENAME}
    parent: tripleo-ansible-centos
    files:
    - ^tripleo_ansible/roles/${NEWROLENAME}/.*
    vars:
      tox_envlist: mol-${NEWROLENAME}

Add the job into the zuul.d/layout.yaml file.

- project:
    check:
      jobs:
        - tripleo-ansible-centos:mol-${NEWROLENAME}

And finally add a role documentation file at doc/source/roles/role-${NEWROLENAME}.rst. This file will need to contain a title, a literal include of the defaults yaml and a literal include of the molecule playbook used to test the role, which is noted as an "example" playbook.

The role addition process is also automated using ansible. If ansible is available on the development workstation change directory to the root of the tripleo-ansible repository and run the the following command which will perform all of the tasks noted above.

$ ansible-playbook -i localhost, role-addition.yml -e role_name=${NEWROLENAME}

If this playbook is being executed from a virtual-environment be sure to activate the virtual environment before running the playbook.

$ . ~/bin/venvs/ansible/bin/activate
(ansible)$ ansible-playbook -i localhost, role-addition.yml -e role_name=${NEWROLENAME}