diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 24 insertions, 20 deletions
@@ -7,14 +7,18 @@ that it installs currently require a package that provides `docker`. Currently the RPMs provided from dockerproject.org do not provide this requirement, though they may in the future. -##Branches +##Branches and tags + The master branch tracks our current work and should be compatible with both -Origin master branch and the current Origin stable release, currently that's -v1.3 and v1.2. Enterprise branches exist where we coordinate with internal Red -Hat Quality Assurance teams. Fixes and backwards compatible feature improvements -are often backported to the more current enterprise branches. The enterprise -branches should also be compatible with the corresponding Origin release for -users who are looking for more conservative rate of change. +Origin master branch and the most recent Origin stable release. Currently that's +v1.4 and v1.3.x. In addition to the master branch we maintain stable branches +corresponding to upstream Origin releases, ie: release-1.2. The most recent of +branch will often receive minor feature backports and fixes. Older branches will +receive only critical fixes. + +Releases are tagged periodically from active branches and are versioned 3.x +corresponding to Origin releases 1.x. We unfortunately started with 3.0 and it's +not practical to start over at 1.0. ##Setup - Install base dependencies: @@ -28,27 +32,27 @@ users who are looking for more conservative rate of change. brew install ansible python ``` - Setup for a specific cloud: - - [AWS](README_AWS.md) - - [GCE](README_GCE.md) - - [local VMs](README_libvirt.md) + - [AWS](http://github.com/openshift/openshift-ansible/blob/master/README_AWS.md) + - [GCE](http://github.com/openshift/openshift-ansible/blob/master/README_GCE.md) + - [local VMs](http://github.com/openshift/openshift-ansible/blob/master/README_libvirt.md) - Bring your own host deployments: - [OpenShift Enterprise](https://docs.openshift.com/enterprise/latest/install_config/install/advanced_install.html) - [OpenShift Origin](https://docs.openshift.org/latest/install_config/install/advanced_install.html) - - [Atomic Enterprise](README_AEP.md) + - [Atomic Enterprise](http://github.com/openshift/openshift-ansible/blob/master/README_AEP.md) - Build - [How to build the openshift-ansible rpms](BUILD.md) - Directory Structure: - - [bin/cluster](bin/cluster) - python script to easily create clusters - - [docs](docs) - Documentation for the project - - [filter_plugins/](filter_plugins) - custom filters used to manipulate data in Ansible - - [inventory/](inventory) - houses Ansible dynamic inventory scripts - - [playbooks/](playbooks) - houses host-type Ansible playbooks (launch, config, destroy, vars) - - [roles/](roles) - shareable Ansible tasks + - [bin/cluster](https://github.com/openshift/openshift-ansible/tree/master/bin/cluster) - python script to easily create clusters + - [docs](https://github.com/openshift/openshift-ansible/tree/master/docs) - Documentation for the project + - [filter_plugins/](https://github.com/openshift/openshift-ansible/tree/master/filter_plugins) - custom filters used to manipulate data in Ansible + - [inventory/](https://github.com/openshift/openshift-ansible/tree/master/inventory) - houses Ansible dynamic inventory scripts + - [playbooks/](https://github.com/openshift/openshift-ansible/tree/master/playbooks) - houses host-type Ansible playbooks (launch, config, destroy, vars) + - [roles/](https://github.com/openshift/openshift-ansible/tree/master/roles) - shareable Ansible tasks ##Contributing -- [Best Practices Guide](docs/best_practices_guide.adoc) -- [Core Concepts](docs/core_concepts_guide.adoc) -- [Style Guide](docs/style_guide.adoc) +- [Best Practices Guide](https://github.com/openshift/openshift-ansible/blob/master/docs/best_practices_guide.adoc) +- [Core Concepts](https://github.com/openshift/openshift-ansible/blob/master/docs/core_concepts_guide.adoc) +- [Style Guide](https://github.com/openshift/openshift-ansible/blob/master/docs/style_guide.adoc) |