ansible-msvsphere.ci/README.md

# Ansible Collection - msvsphere.ci

The MSVSphere OS CI/CD collection.

## Roles

* [koji_tools](roles/koji_tools/README.md)
* [postgresql_server](roles/postgresql_server/README.md)

## Documentation

All bundled roles have a corresponding README.md file located at 
`roles/ROLE_NAME/README.md`.

You can also use the `ansible-doc` command, for example:

```shell
$ ansible-doc --type role postgresql_server
```

## Development

### Development environment configuration

You must use a specific directory layout
`collections/ansible_collections/msvsphere/ci` to make molecule work.
For example:

```
$ mkdir -p ~/work/collections/ansible_collections/msvsphere/ci
$ git clone https://git.inferitos.ru/msvsphere/ansible-msvsphere.ci.git \
      ~/work/collections/ansible_collections/msvsphere/ci
```

In order to create and initialize a Python virtual environment run the
following commands in the project root:

```shell
$ virtualenv .venv
$ . .venv/bin/activate
$ pip install -r requirements-devel.txt
```

### Testing

Use the following commands to run molecule tests:

```shell
# run all available test scenarios
$ molecule test --all

# run the "postgresql_server-13" test scenario
$ molecule test -s postgresql_server-13
```

### Releasing

Update changelog entries:

```shell
$ antsibull-changelog release
```

Build a release tarball:

```shell
$ ansible-galaxy collection build
```

## License

MIT.

## Authors

* [Eugene Zamriy](mailto:ezamriy@msvsphere-os.ru)

## References

* [Ansible Molecule](https://ansible.readthedocs.io/projects/molecule/)