From ac42a0bb8c873ec95c9b99972fefec95127cd49b Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Fri, 4 Nov 2016 13:52:32 +0100 Subject: README: improve markdown formatting --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c3d78f5fe..b4c801a8d 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ [![Join the chat at https://gitter.im/openshift/openshift-ansible](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/openshift/openshift-ansible) -#OpenShift Ansible +# OpenShift Ansible This repo contains Ansible code for OpenShift. This repo and the origin RPMs 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 and tags +## Branches and tags The master branch tracks our current work and should be compatible with both Origin master branch and the most recent Origin stable release. Currently that's @@ -20,22 +20,24 @@ 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 +## Setup + - Install base dependencies: - Requirements: - Ansible >= 2.1.0 though 2.2 is preferred for performance reasons. - Jinja >= 2.7 - Fedora: - ``` + ``` dnf install -y ansible-2.1.0.0 pyOpenSSL python-cryptography - ``` + ``` - OSX: - ``` + ``` # Install ansible 2.1.0.0 and python 2 brew install ansible python - ``` + ``` + - Setup for a specific cloud: - [AWS](http://github.com/openshift/openshift-ansible/blob/master/README_AWS.md) - [GCE](http://github.com/openshift/openshift-ansible/blob/master/README_GCE.md) @@ -57,7 +59,8 @@ not practical to start over at 1.0. - [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 +## Contributing + - [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) -- cgit v1.2.1 From 9ba3bea14236147e094d7ba192d09b4a498689b7 Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Fri, 4 Nov 2016 13:53:07 +0100 Subject: README: add links, fix typos - Add links to improve experience of people understanding how the pieces fit together - s/ie/e.g./ - s/of // --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b4c801a8d..21798aa78 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,23 @@ # OpenShift Ansible -This repo contains Ansible code for OpenShift. This repo and the origin RPMs -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. +This repo contains [Ansible](https://www.ansible.com/) code for +[OpenShift](https://www.openshift.com/). This repo and the origin RPMs 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 and tags -The master branch tracks our current work and should be compatible with both -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. +The [master branch](https://github.com/openshift/openshift-ansible/tree/master) +tracks our current work and should be compatible with both [Origin master +branch](https://github.com/openshift/origin/tree/master) and the [most recent +Origin stable release](https://github.com/openshift/origin/releases). Currently +that's v1.4 and v1.3.x. In addition to the master branch, we maintain stable +branches corresponding to upstream Origin releases, e.g.: +[release-1.2](https://github.com/openshift/openshift-ansible/tree/release-1.2). +The most recent 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 -- cgit v1.2.1 From 410edffcf21560e30c4ecb3ffcd01fef704de791 Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Fri, 4 Nov 2016 14:27:00 +0100 Subject: README: improve first paragraph - Explain this repository can be used to install, upgrade and manage OpenShift clusters. - Move note about docker RPM to its own paragraph; link to issue. --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 21798aa78..13587f712 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,14 @@ # OpenShift Ansible -This repo contains [Ansible](https://www.ansible.com/) code for -[OpenShift](https://www.openshift.com/). This repo and the origin RPMs 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. +This repository contains [Ansible](https://www.ansible.com/) code to install, +upgrade and manage [OpenShift](https://www.openshift.com/) clusters. + +**Note**: the Ansible playbooks in this repository require an RPM package that +provides `docker`. Currently, the RPMs from +[dockerproject.org](https://dockerproject.org/) do not provide this requirement, +though they may in the future. This limitation is being tracked by +[#2720](https://github.com/openshift/openshift-ansible/issues/2720). ## Branches and tags -- cgit v1.2.1 From d81bf2d9f80d5ab208c2627be6aebdb700814602 Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Tue, 8 Nov 2016 15:28:15 +0100 Subject: README: remove OSX setup requirements OSX is not officially supported. --- README.md | 6 ------ 1 file changed, 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 13587f712..c36bb302e 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,6 @@ not practical to start over at 1.0. dnf install -y ansible-2.1.0.0 pyOpenSSL python-cryptography ``` - - OSX: - ``` - # Install ansible 2.1.0.0 and python 2 - brew install ansible python - ``` - - Setup for a specific cloud: - [AWS](http://github.com/openshift/openshift-ansible/blob/master/README_AWS.md) - [GCE](http://github.com/openshift/openshift-ansible/blob/master/README_GCE.md) -- cgit v1.2.1 From 3e9ee76d14d4baa9bc2649b617389c741445d381 Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Fri, 4 Nov 2016 15:28:34 +0100 Subject: README: cleanup setup steps --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c36bb302e..fedf7a0ab 100644 --- a/README.md +++ b/README.md @@ -29,25 +29,28 @@ not practical to start over at 1.0. ## Setup -- Install base dependencies: - - Requirements: - - Ansible >= 2.1.0 though 2.2 is preferred for performance reasons. +1. Install base dependencies: + + *** + Requirements: + - Ansible >= 2.1.0 (>= 2.2 is preferred for performance reasons) - Jinja >= 2.7 + *** - - Fedora: + Fedora: ``` - dnf install -y ansible-2.1.0.0 pyOpenSSL python-cryptography + dnf install -y ansible pyOpenSSL python-cryptography ``` -- Setup for a specific cloud: +2. Setup for a specific cloud: + - [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](http://github.com/openshift/openshift-ansible/blob/master/README_AEP.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](http://github.com/openshift/openshift-ansible/blob/master/README_AEP.md) - Build - [How to build the openshift-ansible rpms](BUILD.md) -- cgit v1.2.1 From 1bd271a644b2680f086fa7775013786e1b7a8cb7 Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Fri, 4 Nov 2016 15:06:10 +0100 Subject: README: move structure overview to the top It now appears in its own section, serving as a quick way to understand what is in the repository. --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index fedf7a0ab..b76aec494 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,15 @@ 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. +## Directory structure + +- [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) - Ansible dynamic inventory scripts +- [playbooks/](https://github.com/openshift/openshift-ansible/tree/master/playbooks) - host-type Ansible playbooks (launch, config, destroy, vars) +- [roles/](https://github.com/openshift/openshift-ansible/tree/master/roles) - shareable Ansible tasks + ## Setup 1. Install base dependencies: @@ -55,14 +64,6 @@ not practical to start over at 1.0. - Build - [How to build the openshift-ansible rpms](BUILD.md) -- Directory Structure: - - [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](https://github.com/openshift/openshift-ansible/blob/master/docs/best_practices_guide.adoc) -- cgit v1.2.1 From c942e4399d22347ad0fcc8e02e576ca056f1a118 Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Tue, 8 Nov 2016 15:33:49 +0100 Subject: Remove README_AEP.md Not supported in this repo now. --- README.md | 1 - 1 file changed, 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index b76aec494..cc25e5abc 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,6 @@ not practical to start over at 1.0. - 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](http://github.com/openshift/openshift-ansible/blob/master/README_AEP.md) - Build - [How to build the openshift-ansible rpms](BUILD.md) -- cgit v1.2.1 From 9c7e5894456aba245578fd9e5349ec0c08187c80 Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Fri, 4 Nov 2016 16:29:02 +0100 Subject: Create contribution guide --- README.md | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index cc25e5abc..950aea3ae 100644 --- a/README.md +++ b/README.md @@ -27,15 +27,6 @@ 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. -## Directory structure - -- [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) - Ansible dynamic inventory scripts -- [playbooks/](https://github.com/openshift/openshift-ansible/tree/master/playbooks) - host-type Ansible playbooks (launch, config, destroy, vars) -- [roles/](https://github.com/openshift/openshift-ansible/tree/master/roles) - shareable Ansible tasks - ## Setup 1. Install base dependencies: @@ -60,11 +51,6 @@ not practical to start over at 1.0. - [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) -- Build - - [How to build the openshift-ansible rpms](BUILD.md) - ## Contributing -- [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) +See the [contribution guide](CONTRIBUTING.md). -- cgit v1.2.1