Thank you for contributing to OpenShift Ansible. This document explains how the repository is organized, and how to submit contributions.
Before submitting code changes, get familiarized with these documents:
.
├── inventory Contains dynamic inventory scripts, and examples of
│ Ansible inventories.
├── library Contains Python modules used by the playbooks.
├── playbooks Contains Ansible playbooks targeting multiple use cases.
└── roles Contains Ansible roles, units of shared behavior among
playbooks.
These are plugins used in playbooks and roles:
.
├── ansible-profile
├── callback_plugins
├── filter_plugins
└── lookup_plugins
.
├── bin [DEPRECATED] Contains the `bin/cluster` script, a
│ wrapper around the Ansible playbooks that ensures proper
│ configuration, and facilitates installing, updating,
│ destroying and configuring OpenShift clusters.
│ Note: this tool is kept in the repository for legacy
│ reasons and will be removed at some point.
└── utils Contains the `atomic-openshift-installer` command, an
interactive CLI utility to install OpenShift across a
set of hosts.
.
└── docs Contains documentation for this repository.
.
└── test Contains tests.
.
└── git Contains some helper scripts for repository maintenance.
See the RPM build instructions.
We use Nose as a test runner. Make sure it is installed along with other test dependencies:
pip install -r utils/test-requirements.txt
Run the tests with:
nosetests
- Go through the guides from the introduction.
- Fork this repository, and create a work branch in your fork.
- Make changes and commit. You may want to review your changes and run tests before pushing your branch.
- Open a Pull Request.
One of the repository maintainers will then review the PR and submit it for testing.
The default
test job is publicly accessible at
https://ci.openshift.redhat.com/jenkins/job/openshift-ansible/. The other jobs
are run on a different Jenkins host that is not publicly accessible, however the
test results are posted to S3 buckets when complete.
The test output of each job is also posted to the Pull Request as comments.