Skip to content

Commit

Permalink
fix various README typos
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel Matthews <d.matthews@ucl.ac.uk>
  • Loading branch information
p-j-smith and drmatthews authored Jan 12, 2024
1 parent 9048906 commit 9a2d911
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ molecule --base-config ../../molecule_configs/centos7_base_config.yml destroy -

Playbooks in the collection can also be tested using Molecule. The Molecule
configuration for playbooks is in the
`ansible_collections/mirsg/infrastructure/playbooks` folder.
`ansible_collections/mirsg/infrastructure/playbooks/molecule` folder.

An example of how to setup testing for a playbook can be seen by looking at
the tests for the `mirsg.install_monitoring` playbook in this collection.
Expand All @@ -174,7 +174,7 @@ This is tested on CentOS 7 and RockyLinux 9 using the

An inventory
and associated group variables can be found in
[resources/monitoring/inventory](./playbooks/molecule/resources/monitoring/inventory/).
[playbooks/molecule/resources/monitoring/inventory](./playbooks/molecule/resources/monitoring/inventory/).
Testing the playbook also requires its own
[converge.yml](./playbooks/molecule/resources/monitoring/converge.yml), and optional
`prepare.yml` and `verify.yml` playbooks.
Expand Down
11 changes: 5 additions & 6 deletions playbooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This collection contains playbooks for deploying XNAT and setting up monitoring

This collection is tested using Ansible Molecule.

Each playbooks has its own Molecule configuration, which can be found it the
Each playbook has its own Molecule configuration, which can be found in the
`ansible_collections/mirsg/infrastructure/playbooks/molecule/` folder.
Molecule base configurations are used to reduce to amount
of duplication in the setup for testing each playbook. There are two base configurations
Expand All @@ -17,7 +17,7 @@ are in the `ansible_collections/mirsg/infrastructure/molecule_configs` folder.

## Adding a new playbook

To add a new role to this collection, you will need to:
To add a new playbook to this collection, you will need to:

1. add the playbook to the `playbooks/` folder
2. add a molecule configuration for the playbook to the `playbooks/molecule/` folder
Expand All @@ -27,7 +27,7 @@ To add a new role to this collection, you will need to:

The playbooks in an Ansible Collection are the same as any other playbook - no special
setup is required. If you create a playbook
`ansible_collections/mirsg/infrastructure/playbooks/my_playbooks`, you will be able to
`ansible_collections/mirsg/infrastructure/playbooks/my_playbook.yml`, you will be able to
run the playbook using `ansible-playbook`:

```bash
Expand Down Expand Up @@ -57,7 +57,7 @@ If necessary, add inventory `group_vars` to the shared `resources` subfolder:
`molecule/resources/my_playbook/inventory/group_vars`. for your playbook.

You may also need to add `prepare` or `verify` playbooks. These can be added
to the the same shared `resources`.
to the the same shared `resources` folder.

You will need to update the `molecule.yml` configuration file with the correct paths
to these playbooks.
Expand All @@ -73,8 +73,7 @@ on:
pull_request:
paths:
- "playbooks/my_playbook.yml"
- ".github/workflows/molecule.yml"
- ".github/workflows/molecule-my-role.yml"
- ".github/workflows/molecule-role-used-in-playbook.yml"
jobs:
molecule-my_playbook:
Expand Down

0 comments on commit 9a2d911

Please sign in to comment.