diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2018-01-30 15:57:33 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-01-30 15:57:33 -0800 |
| commit | e7d32e9c20973468f51b8ae4fccbb4d6f107c15f (patch) | |
| tree | 9410c1db0ddb4ea3ab0929dbf2d637f5084e3552 /CONTRIBUTING.md | |
| parent | c7d95858489f9b058a6d3816421c0a36ea455276 (diff) | |
| parent | 70262d00b69fd100604fb8b25ffa2a39a23b87b8 (diff) | |
| download | openshift-e7d32e9c20973468f51b8ae4fccbb4d6f107c15f.tar.gz openshift-e7d32e9c20973468f51b8ae4fccbb4d6f107c15f.tar.bz2 openshift-e7d32e9c20973468f51b8ae4fccbb4d6f107c15f.tar.xz openshift-e7d32e9c20973468f51b8ae4fccbb4d6f107c15f.zip | |
Merge pull request #6129 from sdodson/contrib
Automatic merge from submit-queue.
Add a bare minimum localhost hosts file and docs
Hopefully this makes things easier for folks new to ansible
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c0fa73ad..ef0a302dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,6 +74,27 @@ If you are new to Git, these links might help: --- +## Simple all-in-one localhost installation +``` +git clone https://github.com/openshift/openshift-ansible +cd openshift-ansible +sudo ansible-playbook -i inventory/hosts.localhost playbooks/prerequisites.yml +sudo ansible-playbook -i inventory/hosts.localhost playbooks/deploy_cluster.yml +``` + +## Development process +Most changes can be applied by re-running the config playbook. However, while +the config playbook will run faster the second time through it's still going to +take a very long time. As such, you may wish to run a smaller subsection of the +installation playbooks. You can for instance run the node, master, or hosted +playbooks in playbooks/openshift-node/config.yml, +playbooks/openshift-master/config.yml, playbooks/openshift-hosted/config.yml +respectively. + +We're actively working to refactor the playbooks into smaller discrete +components and we'll be documenting that structure shortly, for now those are +the most sensible logical units of work. + ## Running tests and other verification tasks We use [`tox`](http://readthedocs.org/docs/tox/) to manage virtualenvs where |