Changes between Initial Version and Version 1 of GENIExperimenter/Tutorials/SystematicExperimentationAnsible/Execute

Timestamp:

09/17/15 16:32:30 (9 years ago)

Author:

sedwards@bbn.com

Comment:

--

GENIExperimenter/Tutorials/SystematicExperimentationAnsible/Execute

@@ +1 @@
+= [..  Systematic Experimentation (with Ansible)] =
+{{{
+#!html
+
+<div style="text-align:center; width:495px; margin-left:auto; margin-right:auto;">
+<img id="Image-Maps_5201305222028436" src="http://groups.geni.net/geni/attachment/wiki/GENIExperimenter/Tutorials/Graphics/Execute.jpg?format=raw" usemap="#Image-Maps_5201305222028436" border="0" width="495" height="138" alt="" />
+<map id="_Image-Maps_5201305222028436" name="Image-Maps_5201305222028436">
+<area shape="rect" coords="18,18,135,110" href="./Design" alt="" title=""    />
+<area shape="rect" coords="180,18,297,111" href="./Execute" alt="" title=""    />
+<area shape="rect" coords="344,17,460,110" href="./Finish" alt="" title=""    />
+<area shape="rect" coords="493,136,495,138" href="http://www.image-maps.com/index.php?aff=mapped_users_5201305222028436" alt="Image Map" title="Image Map" />
+</map>
+<!-- Image map text links - End - -->
+
+</div>
+}}}
+
+
+== 4.  Configure and Initialize ==
+
+=== 4.1.  Download the Ansible playbook ===
+   a. Download the Ansible playbook, webpages, etc needed to configure the nodes.
+{{{
+#!div style="background: #ffd; border: 3px ridge; width: 800px;"
+Use `wget` to download the tarball of files onto your local machine and use `tar` to uncompress it:
+   {{{
+#!sh
+mkdir ansible
+cd ansible
+wget http://www.gpolab.bbn.com/exp/scalingup/ansible/ansible.tar.gz
+tar zxvf ansible.tar.gz
+   }}}
+}}}
+
+
+=== 4.2.  Create the Ansible inventory file ===
+
+`omni` comes with a script, `readyToLogin` which finds the login information for nodes in your slice.  As of `omni` version 2.8, `readyToLogin` has an `--ansible-inventory` flag which generates the Ansible inventory, which is a flat file which tells Ansible the name and login information for your nodes.
+
+ a. Create your Ansible inventory file:
+{{{
+#!div style="background: #ffd; border: 3px ridge; width: 800px;"
+On your local machine:
+
+   {{{
+#!sh
+$ readyToLogin MYSLICE --useSliceAggregates --ansible-inventory -o
+$ cat inventory
+   }}}
+
+Example output of running these commands:
+   {{{
+#!sh
+$ readyToLogin MYSLICE --useSliceAggregates --ansible-inventory -o
+Host info saved in inventory file: /Users/jdoe/projects/GENI/hellogeni/inventory
+
+$ cat inventory
+host-2  ansible_ssh_host=pc2.instageni.stanford.edu  ansible_ssh_port=31291
+host-1  ansible_ssh_host=pc2.instageni.stanford.edu  ansible_ssh_port=31290
+server-1  ansible_ssh_host=pcvm2-33.instageni.stanford.edu
+rt-1  ansible_ssh_host=pc2.instageni.stanford.edu  ansible_ssh_port=31292
+   }}}
+}}}
+{{{
+#!div style="background: #fdd; border: 3px ridge; width: 800px;"
+
+{{{
+#!html
+
+<table id="Table_03" border="0" cellpadding="5" cellspacing="0">
+        <tr>
+                <td>
+                        <img src="http://groups.geni.net/geni/attachment/wiki/GENIExperimenter/Tutorials/Graphics/Symbols-Tips-icon.png?format=raw" width="50" height="50" alt="Tip">
+               </td>
+               <td>
+                   Windows users should copy their 'inventory' file onto their node running the ansible client.
+               </td>
+        </tr>
+</table>
+}}}
+}}}  
+ b. Be sure your private key has been added to your SSH agent:
+{{{
+#!div style="background: #ffd; border: 3px ridge; width: 800px;"
+   {{{
+ssh-add /path/to/your/private/key
+   }}}
+}}}
+ c. Check to see if your nodes are up and ready.
+{{{
+#!div style="background: #ffd; border: 3px ridge; width: 800px;"
+This command uses the `ping` module to ping the specified nodes (in this case `all`) listed in the inventory file:
+   {{{
+#!sh
+$ ansible -i inventory all -m ping 
+   }}}
+
+Example output showing all of the nodes responding to ping:
+   {{{
+#!sh
+$ ansible -i inventory all -m ping 
+server-1 | success >> {
+    "changed": false,
+    "ping": "pong"
+}
+
+host-1 | success >> {
+    "changed": false,
+    "ping": "pong"
+}
+
+rt-1 | success >> {
+    "changed": false,
+    "ping": "pong"
+}
+
+host-2 | success >> {
+    "changed": false,
+    "ping": "pong"
+}
+}}}
+}}}
+ c. Try using the ping module in Ansible to only ping `server-1` or `host-1` by replacing `all` in the above with `server-1` or `host-1`.
+
+
+
+=== 4.3. Configure the nodes ===
+
+{{{
+#!div style="background: #ffd; border: 3px ridge; width: 800px;"
+
+{{{
+#!html
+
+<table id="Table_03" border="0" cellpadding="5" cellspacing="0">
+        <tr>
+                <td>
+                        <img src="http://groups.geni.net/geni/attachment/wiki/GENIExperimenter/Tutorials/Graphics/Symbols-Tips-icon.png?format=raw" width="50" height="50" alt="Tip">
+               </td>
+               <td>
+                   Ansible commands can be collected into files called <i>Playbooks</i>.  Playbooks are in a configuration file format called <i>YAML</i> which is very straightforward.   In particular, Ansible Ad Hoc commands easily map to commands used in an Ansible Playbook.  
+               </td>
+        </tr>
+</table>
+}}}
+The Playbook to configure the `server` node is in `server.yml`.  It links to other files.  For example, the code to tell the `server` node to run an `nmap` scan and post the results is in `roles/nmap/tasks/map.yml` and looks as follows:
+
+   {{{
+#!python
+---
+   - name: map network using nmap
+     command: nmap -sP -oX {{ nmap_xml_file }} {{ address_range }}
+   - name: convert nmap xml to html
+     shell:  xsltproc /usr/share/nmap/nmap.xsl {{ nmap_xml_file }} > {{ nmap_html_file }}
+   - name: create directory for nmap logs in WEB_ROOT/nmaplogs with permissions of 755
+     file: >
+        dest={{ WEB_ROOT }}/{{ nmap_dir }}
+        state=directory
+        mode=755
+   - name: copy nmap html file to a public place
+     command: mv {{ nmap_html_file }} {{ WEB_ROOT }}/{{ nmap_dir }}/nmap.html removes={{ nmap_html_file }}
+    }}}
+
+''Do these commands look like the Ad Hoc command (`ping`) from the previous step?''
+
+Run the playbook to configure the `server` with the following command on the local machine:
+
+   {{{
+#!python
+ansible-playbook server.yml -i inventory
+   }}}
+}}}
+ a. Browse to hostname of the server node in your browser.  Click on the `nmap` link.
+
+=== 4.4. Update a portion of the configuration ===
+ a. After some of your neighbors have brought up their nodes, run the following command to only update the `nmap` portion of the `server` configuration:
+   {{{
+#!python
+ansible-playbook update-map.yml -i inventory
+   }}}
+ a. If you repeatedly run the above command over time you should see more nodes found by the `nmap` scan.  
+ a. Feel free to change the value of `address_range` in `groups_vars/all.yml` and rerun `update-map.yml` to search for more nodes.
+
+
+== 5. Execute Experiment ==
+
+----
+
+= [wiki:GENIExperimenter/Tutorials/SystematicExperimentationAnsible/DesignSetup Setup] =
+= [wiki:GENIExperimenter/Tutorials/SystematicExperimentationAnsible/Finish Next:  Finish] =