Update docs for ansible-opendaylight

Change-Id: If7bffc0de096a27961f0815c357d380ddad75807
Signed-off-by: Akshita Jha <zenith158@gmail.com>
Signed-off-by: Daniel Farrell <dfarrell@redhat.com>

diff --git a/README.markdown b/README.markdown
index 3616c0a916b3be7d6bd9d041bb120bd0c63a692d..7aa85c98d2ed0f86fe3aa59dbf1a2be699de72fc 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -4,12 +4,35 @@
 
 Ansible role for the [OpenDaylight SDN controller][1].
 
-Releases of this role can also be installed available via [Ansible Galaxy][5].
+#### Ansible Dependencies: `ansible-galaxy`
 
-## Requirements
+Releases of this role can also be installed available via [Ansible Galaxy][5]
+which ships with Ansible.
 
-The OpenDaylight Ansible role handles the installation and configuration of
-all of its dependences.
+To install the latest version of ansible on RedHat based OSs:
+
+```
+$ sudo yum install -y ansible
+```
+
+To install the latest version of ansible on Debian based OSs:
+
+```
+$ sudo apt-add-repository ppa:ansible/ansible
+$ sudo apt-get update
+$ sudo apt-get install -y ansible
+```
+
+#### Ansible Dependencies: Roles
+
+After you install the `ansible-galaxy` tool, point it at the project's
+`requirements.yml` file to install ODL's role.
+
+```
+[~/ansible-opendaylight]$ ansible-galaxy install -r requirements.yml
+```
+
+The OpenDaylight Ansible role doesn't depend on any other Ansible roles.
 
 ## Role Variables
 
@@ -33,9 +56,32 @@ Swift project uses a conflicting port.
 
 The Ansible role will handle opening this port in FirewallD if it's active.
 
-## Dependencies
+### Install Method
 
-The OpenDaylight Ansible role doesn't depend on any other Ansible roles.
+OpenDaylight can be installed either via an RPM or a .deb depending on the operating system.
+For RedHat based OSs, the valid options for `install_method` are `rpm_repo` or `rpm_path`.
+For Debian based OSs, `install_method` can accept either `deb_repo` or `deb_path`.
+
+## Installing OpenDaylight
+
+To install OpenDaylight on your system, you can make use of `ansible-playbook`.
+
+On RedHat based OSs, you can install OpenDaylight from RPM repo (recommended) using
+the playbook `examples/all_defaults_playbook.yml` or from a local/remote path to an ODL rpm via
+`examples/rpm_path_install_playbook.yml`.
+
+```Shellsession
+sudo ansible-playbook -i "localhost," -c local examples/<playbook>
+```
+
+On a Debian based OS, you can install OpenDaylight either from a Debian repo using the
+playbook `examples/deb_repo_install_playbook.yml` or from a local/remote Deb path using
+`examples/deb_path_install_playbook.yml`.
+
+```Shellsession
+sudo ansible-playbook -i "localhost," -c local examples/<playbook>
+```
+You can also use ansible-opendaylight using [Vagrant base box examples of Ansible ODL deployments][8].
 
 ## Example Playbook
 
@@ -58,13 +104,14 @@ To override default settings, pass variables to the `opendaylight` role.
   sudo: yes
   roles:
     - role: opendaylight
-      extra_features: ['odl-ovsdb-openstack']
+      extra_features: ['odl-netvirt-openstack']
 ```
 
 Results in:
 
-    opendaylight-user@root>feature:list | grep odl-ovsdb-openstack
-    odl-ovsdb-openstack | 1.1.0-Lithium | x | ovsdb-1.1.0-Lithium <snip>
+    opendaylight-user@root>feature:list | grep odl-netvirt-openstack
+    odl-netvirt-openstack | <odl-release> | x | odl-netvirt-<odl-release> | OpenDaylight :: NetVirt :: OpenStack
+
 
 ## License
 
@@ -88,3 +135,4 @@ OpenDaylight Ansible role.
 [5]: https://galaxy.ansible.com/list#/roles/3948 "OpenDaylight Ansible role on Ansible Galaxy"
 [6]: https://travis-ci.org/dfarrell07/ansible-opendaylight "OpenDaylight Ansible role Travis CI"
 [7]: https://travis-ci.org/dfarrell07/ansible-opendaylight.svg "Travis CI status image"
+[8]: https://github.com/dfarrell07/vagrant-opendaylight#ansible-deployments "Ansible Vagrant deployment"

diff --git a/vars/main.yml b/vars/main.yml
index 13b9ef1787bfd5e2ca71b2005a7b0068c1294550..46650561c012932f9af0ae9e5f88e37119b454a2 100755 (executable)
--- a/vars/main.yml
+++ b/vars/main.yml
@@ -38,8 +38,9 @@ nb_rest_port: 8080
 # Method to install ODL
 # Valid options:
 #   rpm_repo: Install ODL using its Yum repo config
-#   rpm_path: Install ODL from a local path or remote URL
+#   rpm_path: Install ODL rpm from a local path or remote URL
 #   dep_repo: Install ODL using a debian repository
+#   deb_path: Install ODL .deb from a local path or remote URL
 install_method: "rpm_repo"
 
 # URL of the .repo config to use when installing ODL from a repo