1,760
edits
Changes
no edit summary
= LAB OBJECTIVES =
:0. Review SSH setup and remote shell execution
:1. Explore the Fabric Python library and its command line tool "fab".
:2. Create Fabric scripts utilize utilizing Fabric's API to define tasks that can be executed by for the '''fab''' programcommand.:3. Use the '''fab''' command to execute fabric script to perform regular/administrative pre-defined tasks on remote Linux machines.
== Overview ==
:[http://www.fabfile.org/]
|}
: <font color='blue'>Please note that the version of Fabric we are going to use installed on matrix.senecacollege.ca for this lab is 1.14 and it supports only Python version 2.</font>The Fabric script files we are going to create in this lab have to meet Python version 2.x requirements. (e.g. print is a keyword, not a built-in function in Python 2.x)
:2. You should have some experience on the following topics in OPS235 and or OPS335. Please review them to prepare for the activities in this lab:
:* create and configure a regular user on a Linux system.
:* Retrieve current firewall setting using the iptables -L -n -v command
= INVESTIGATION 1: The Fabric Framework Environment =
: The Fabric framework environment consists of the following components: :# Controller workstation - the machine that has the Fabric package installed and runs the "fab" command:## the Fabric Python Library - the fabric package(already installed on matrix):## the Fabric API - fabric.apapi:## the Fabric CLI command - '''fab - ''': run Fabric script, name of the script is default to fabfile.py in the current working directoryunless specified otherwise with the '-f' option.:## Fabric script: contains fabric environment object value and Python functions (or tasks) to be executed by the "'''fab" CLI''' command. :# Controller workstation - the machine that has the Fabric package installed and will run the "fab" CLI:# Remote machine: the target machine on which a one or more Fabric task tasks will be executed.:## running the ssh server daemon:## use public key (or password based) authentication for ssh connection
== PART 1 - Configure and test your controller workstation ==: In this lab you will use your user login account on matrix.senecacollege.ca as your Fabric controller workstation.
: The Fabric package version 1.14.0 has already been installed on matrix.senecacollege.ca. You should have access to the '''fab''' command on matrix. Login to matrix.senecacollege.ca and run the following command to confirm the version of the fabric package:<presource lang='bash'> $ fab --version</presource>: Type the following command to get the command line option options of the fabcommand:<source lang='bash'>
fab --help
</source>
number of concurrent processes to use in parallel mode
</source>
<font color='green'><b>Please note and study the following command-line optionsas they will be used in some of the activities in this lab:
:# -H,
:# -f,
</b></font>
==PART 2: Connect to VM in myvmlab.senecacollege.ca = Set up =: You should have received an email from ITS containing the following information::* account name: (usually 'student'):* password: (let's assume it is 'P@ssw0rd' for the following instruction in this lab):* port number for SSH access via myvmlab.senecacollege.ca (e.g. 7200): This VM will be used as the remote Linux machine in our Fabric environment. Login to matrix and try the following SSH key command to test the connectivity between matrix and your assignment VM:<pre> [raymond.chan@mtrx-node05pd lab8]$ ssh -p 7200 student@myvmlab.senecacollege.ca student@myvmlab.senecacollege.ca's password: Last login : Fri Jul 3 11:06:24 2020 from mtrx-node05pd.dcm.senecacollege.ca</pre>: Once you are on your VM, try the following commands: hostname, id, and df, and record the results for later comparison with the results of other commands:<source lang='bash'>[student@centos7 ~]$ hostnamecentos7[student@centos7 ~]$ iduid=1002(student) gid=1002(student) groups=1002(student),10(wheel)[student@centos7 ~]$ dfFilesystem 1K-blocks Used Available Use% Mounted ondevtmpfs 878260 0 878260 0% /devtmpfs 889792 0 889792 0% /dev/shmtmpfs 889792 9492 880300 2% /runtmpfs 889792 0 889792 0% /sys/fs/cgroup/dev/mapper/centos-root 38680112 1745524 36934588 5% //dev/sda2 1038336 331228 707108 32% /boot/dev/sda1 204580 11296 193284 6% /boot/efi/dev/mapper/centos-home 18880512 33160 18847352 1% /hometmpfs 177960 0 177960 0% /run/user/1002</source>: In order for an automated system to be able to connect to Logout from your VM and administer get back to matrix.:The previous SSH command when executed successfully, created a login shell on the remote machine. If the previous SSH command is followed by a specific bash command, it - you will need to be able to connect to it using SSH keysexecuted on the remote host instead of creating a login shell. Consider the following:<source lang='bash'>[raymond.chan@mtrx-node05pd lab8]$ ssh -p 7200 student@myvmlab.senecacollege.ca 'hostname;id;df'student@myvmlab.senecacollege. Youca've done this s password:centos7uid=1002(student) gid=1002(student) groups=1002(student),10(wheel)Filesystem 1K-blocks Used Available Use% Mounted ondevtmpfs 878260 0 878260 0% /devtmpfs 889792 0 889792 0% /dev/shmtmpfs 889792 9492 880300 2% /runtmpfs 889792 0 889792 0% /sys/fs/cgroup/dev/mapper/centos-root 38680112 1745608 36934504 5% //dev/sda2 1038336 331228 707108 32% /boot/dev/sda1 204580 11296 193284 6% /boot/efi/dev/mapper/centos-home 18880512 33160 18847352 1% /hometmpfs 177960 0 177960 0% /run/user/1002</source>:The three shell commands: hostname, id, and df were executed sequentially. Compare the outputs above with the previous results when executing the corresponding commands in both OPS235 and OPS335the login shell.:Please note that you were asked to provide the user's password for every SSH connection.
==PART 3: Create a new Set up SSH login with public key pair (one private, and one public) on your main VM with your '''regular user''' (don't do it under root). Once you have both keys, set things up so thatauthentication ==:* In order for your regular user controller workstation to automate tasks execution on your '''controller VM''' can SSH , you need to the worker configure your VM as the same regular user without prompting for a to SSH public key authentication instead of passwordauthentication. (ie. add the contents of your pub key You've done this in both OPS235 and OPS335, and here is a summary on how to ~/.ssh/authorized_keys):* do it between your regular user account on matrix and your '''controller VM''' can SSH to the worker VM as root without propmting for a password. (ie. add the contents of your pub key to /root/.ssh/authorized_keys):
=INVESTIGATION 2 - Running the fab command in ad-hoc mode =: Make snapshots of all your workers so that you The fab command relies on SSH to make the connection to the remote machine before executing the intended commands. The fab command can easily restore them run in ad-hoc mode:<source lang='bash'>fab [options] -- [shell commands]</source>: When running the fab command in ad-hoc mode, it is very similar to running the SSH with commands attached at the end. == PART 1: running non-privileged shell commands on remote machines ==: In the following example, we use the '''fab''' to execute the "date", "hostname", and "id" command remotely on our VM. Try the following ad-hoc fab commands and record their results for later use, replace the port number with the original state after you modify themcorrect value for your VM:<source lang='bash'>[raymond.chan@mtrx-node05pd lab8]$ fab --host=myvmlab.senecacollege.ca --port=7200 --user=student -- 'date;hostname;id'[myvmlab.senecacollege.ca] Executing task '<remainder>'[myvmlab.senecacollege.ca] run: date;hostname;id[myvmlab.senecacollege.ca] out: Fri Jul 3 13:05:39 EDT 2020[myvmlab.senecacollege.ca] out: centos7[myvmlab.senecacollege.ca] out: uid=1002(student) gid=1002(student) groups=1002(student),10(wheel)[myvmlab.senecacollege.ca] out:
Done.Disconnecting from myvmlab.senecacollege.ca: The instructions are stored in 7200... done.[raymond.chan@mtrx-node05pd lab8]$</source>: Note that there is no password prompting if you complete part 3 successfully, otherwise, the SSH server daemon on your VM will prompt you for a python filepassword. LetThe output from the fab's start ad-hoc mode is not much different from the SSH command with a simple one named '''fabfile.py''' (shell command attached at the end, however, please note that the additional information on the output from the default filename used by fab without command can be very useful for record keeping purpose - what has been done and whether the '-f' optino):commands had been carried out successfully or not.
== PART 12: Simplest example =====Getting the hostname running privileged commands on the remote worker=machines ==: <source lang=We say that running an ad-hoc fab command is very similar to the SSH command with shell commands attached at the end. Let's try both with privileged commands, like the "pythonyum">from fabriccommand.api import *
</source>
: To check for syntax errorPlease note that the tree package is "Available", run but not yet installed.: Let't try to install the "tree" package with the following shell command in the same directory as your fabfile.py"yum install tree -y":<source lang="'bash"'>fab [raymond.chan@mtrx-node05pd lab8]$ ssh -p student@myvmlab.senecacollege.ca "yum install tree -ly"Loaded plugins: fastestmirrorYou need to be root to perform this command.
</source>
: Using the "yum" command to query rpm package doesn't need special privilege, however, it does when you should get a list of tasks stored in try to install or remove rpm packages. : Your "student" account on your fabfileVM was configured to allow you to run the "sudo" command to perform software management using the "yum" command.pyLet's login to your VM and try the following "sudo" command to install and then remove the "tree" rpm package:<source lang="'bash"'>[rchanraymond.chan@mtrx-node05pd lab8]$ ssh -p 7200 student@myvmlab.senecacollege.caLast login: Fri Jul 3 16:51:07 2020 from mtrx-node05pd.dcm.senecacollege.ca[student@centos7 lab8~]$ fab sudo yum install tree -f fabfiley[sudo] password for student:Loaded plugins: fastestmirrorLoading mirror speeds from cached hostfile * base: less.cogeco.net * extras: centos.mirror.colo-serv.net * updates: mirror.py calgah.comResolving Dependencies--l> Running transaction checkAvailable commands---> Package tree.x86_64 0:1.6.0-10.el7 will be installed--> Finished Dependency Resolution
Total download size: If you did all the setup right and you get a password prompt when execute the above command, read the prompt carefully and see who's password it prompted you for46 kInstalled size: 87 kDownloading packages:tree-1. If it is not the same as your [seneca_id], verify that you have the following line in your fabfile and you can ssh to your worker vm without password6.0-10.el7.x86_64.rpm | 46 kB 00:00:00Running transaction checkRunning transaction testTransaction test succeededRunning transaction Installing :tree-1.6.0-10.el7.x86_64 1/1 Verifying : tree-1.6.0-10.el7.x86_64 1/1
Installed:<source lang="python">env tree.user = '[seneca_id]'</source>x86_64 0:1.6.0-10.el7
== Part 2: Set up more administrative tasks====================================================================================================================== Package Arch Version Repository Size========================================================================================================================Removing: tree x86_64 1.6.0-10.el7 @base 87 k
Removed:Add a getDiskUsage() function to your fabfile tree.py filex86_64 0:1.6.0-10.el7
</source>
: The above error indicated that you need a tty for the SSH session to prompt you for the sudo password. Please look up the ssh man page to find out the option which turn on a tty for the SSH session.
=== Run the privileged yum command on remote machine using ad-hoc fab command ===:Note that each call to Let's try the corresponding ad-hoc fab command on your VM:<source lang='bash'>fab --host=myvmlab.senecacollege.ca --port=7200 --user=student -- 'sudo yum install tree -y'</source>: Type in your user student's password when prompted for "run()sudo password" will run a , the yum install command on to install the workertree rpm package should be executed successfully. In this function we get the date/time of If the remote worktree rpm package is already installed, and then get you can remove it with the disk usagefollowing ad-hoc fab command: <source lang='bash'>fab --host=myvmlab. The print() function print out both senecacollege.ca --port=7200 --user=student -- 'sudo yum remove tree -y'</source>: Try remove the values returned"tree" rpm package with the appropriate ad-hoc fab command.
= INVESTIGATION 3:Running the fab command in script mode =: From investigation 2, we can see that running '''fab''' in ad-hoc mode is quick, straight forward, and easy. However, the rich output generated can not be easily captured and processed. If you try have a need to capture and process the output generated by the commands executed on the remote machines, the solution is to run the '''fab''' command in script mode.: The first step in running the '''fab''' command in script mode is to create a fabric script file.: Let's start with a simple fabric script file to demonstrate some basic concepts that use the API from the Fabric python library.: On matrix, cd to your lab8 directory and create a simple fabric script file named '''fabfile.py''' (this is the default filename used by the fab command when you invoke it without the same way as before'-f' optino):
</source>
: you should get a list of tasks defined in your fabfile.py:<source lang="bash">
[rchan@centos7 lab8]$ fab -l
Available commands:
</source>
: Do a syntax check To perform the task of getHostname on your VM (replace with the "fab -l" command.: When you try actual port # for connecting to your VM), run it the same way as before, you encounter some issue as shown belowfab command on matrix:<source lang="bash">[rchanraymond.chan@centos7 mtrx-node05pd lab8]$ fab --fabfilehosts=fabfilemyvmlab.py senecacollege.ca -H 192.168.122.169 performSoftwareUpdate-port=7200 getHostname[192myvmlab.168senecacollege.122.169ca] Executing task 'performSoftwareUpdategetHostname'[192.168myvmlab.122senecacollege.169ca] run: yum update -yhostname[192myvmlab.168senecacollege.122.169ca] out: Loaded plugins: fastestmirror, langpacks[192.168.122.169] out: You need to be root to perform this command.centos7[192.168myvmlab.122senecacollege.169ca] out:
The host name is: centos7
</source>
: As you already know, you Notice that there is no need superuser privilege in order to perform software update on a Linux system. There are two ways to do specify the user name at the '''fab''' command line since we defined it on Fabric. The first one is simple. Edit you fabfile.py and change in the fabric script file (env.user line as shown below:<source lang='student'). Also notice that we can capture the host name returned from the "pythonhostname">command and print it out together with an descriptive text in a line.
: Recall that in our OPS courses we've been using iptables instead of firewalld, which is installed by default in CentOS. Let's make sure that our workers have that set up as well. In the same above output from the '''fabfile.pyfab''' command, you have::* Lines with the FQDN of the remote machine you've been using all alongare working on.:* Messages from the controller workstation (e.g. "Executing task...", add a new function like thisand "run:...").:* Output from the remote machine ("out: ..."):* Output generated on the controller workstation from your fab file (the print statement)
: <source lang="python"># Will uninstall firewalld and replace You should get used to the above messages from the '''fab''' command. It's a lot of output but it with iptablesdef setupFirewall(): run("yum -y -d1 remove firewalld") run("yum -y -d1 install iptables-services") run("systemctl enable iptables") run("systemctl start iptables")</source>'s important to understand where every part is coming from, so you are able to debug problems when they happen.
== PART 2: That should by now look pretty obvious. On Privileged Tasks Examples =====Creat privileged tasks: install and remove rpm package on remote machines===: Add the worker you're going following two new functions to uninstall firewalld, install iptables, and make sure that the iptables service is runningend of the fabric script "fabfile.py" in your lab8 directory:<source lang='bash'>
def installPackage(pkg='dummy'): Execute the function for worker1 and double-check that it worked.: <font color cmd ='redyum install '>+ pkg + '-y''**Warning**''' </font>Do not do this on your vm on myvmlab. If you do, you may lock yourself out for good. status = sudo(cmd) print(status)
def removePackage(pkg): if pkg =='': cmd = Check firewall configuration 'yum remove dummy -y' else: cmd ='yum remove ' + pkg + ' -y' status =sudo(cmd) print(status)</source>: Note that both functions take one function argument in different ways. However, if no function argument is passed when calling the function, both will default to a string value of "dummy". Both functions call the sudo() from the fabric.api to execute the command contained in the "cmd" object on the remote machine via sudo.: To check for any syntax error in your updated fabric script, run the following command in the same directory as the fabfile.py:<source lang='bash'>fab -l</source>: You should get a list of tasks defined similar to the following:<source lang='bash'>[raymond.chan@mtrx-node05pd lab8]$ fab -lAvailable commands:
</source>
: If you only need to connect to the same remote machine, you can specify the host and port number in the fabfile.py to save some typing when executing the fab command. Add the following two lines after the env.user line in your fabfile.py:<source lang='bash'>
env.port = '7200' # <-- please replace with the actual value of your VM's port number
env.hosts =['myvmlab.senecacollege.ca']
</source>
: You can also store the user's password in this file so that it will respond to the "sudo password" prompt for sudo() call. It is not safe to do so as you can configure the sudo module on the remote machine not to ask for sudo password.
: Now you can run the fab command without the "--host" and "--port" option.
: Run the following two fab commands, note the results and compare their difference:<source lang='bash'>
fab installPackage
fab installPackage: Try to run tree</source>: Run the getFirewallConfig() task following two fab commands, note the same way as before.results and compare their difference:<source lang='bash'>: Troubleshoot if you encounter any issue.fab removePackage
== Part 2: After completing Create remote task for updating rpm packages ==: Add a new function called "updatePackage" to your fabfile.py according to the following requirements::* Accept optional function argument as the rpm package name:* If no function argument was given when called, default to all the previous parts packages installed: The output of the lab - you updatePackage when executed, should have produce similar output as shown below::1. Update a working fabfilesingle package:<source lang='bash'>fab updatePackage:tree</source>: Sample output:<source lang='bash'>[raymond.chan@mtrx-node05pd lab8]$ fab updatePackage:tree[myvmlab.senecacollege.ca] Executing task 'updatePackage'[myvmlab.senecacollege.ca] sudo: yum update tree -y[myvmlab.senecacollege.ca] out: sudo password:[myvmlab.senecacollege.ca] out: Loaded plugins: fastestmirror[myvmlab.senecacollege.ca] out: Loading mirror speeds from cached hostfile[myvmlab.senecacollege.ca] out: * base: less.cogeco.net[myvmlab.senecacollege.ca] out: * extras: centos.mirror.ca.planethoster.net[myvmlab.senecacollege.ca] out: * updates: less.cogeco.net[myvmlab.senecacollege.py with three working functionsca] out: getDiskUsage(), performSoftwareUpdate() and getFirewallConfig()No packages marked for update[myvmlab.senecacollege.ca] out:
Done.Disconnecting from myvmlab.senecacollege.ca:7200... done.[raymond.chan@mtrx-node05pd lab8]$</source>:2. Update all installed package:<source lang="'bash"'>fab --fabfileupdatePackage:</source>: The following output had been trimmed, only showing the first few lines:<source lang=fabfile'bash'>[myvmlab.senecacollege.ca] Executing task 'updatePackage'[myvmlab.py senecacollege.ca] sudo: yum update -H 192y[myvmlab.senecacollege.ca] out: sudo password:[myvmlab.senecacollege.ca] out: Loaded plugins: fastestmirror[myvmlab.senecacollege.168ca] out: Loading mirror speeds from cached hostfile[myvmlab.122senecacollege.169,192ca] out: * base: less.cogeco.net[myvmlab.senecacollege.ca] out: * extras: centos.mirror.ca.168planethoster.122net[myvmlab.170,192senecacollege.168ca] out: * updates: less.122cogeco.171,192net.168.122.172 getDiskUsage</source>
Verifying : Again systemd- your IP addresses will be different but the command will be the same219-73.el7_8.5.x86_64 53/54 Verifying : systemd-libs-219-73.el7_8.5.x86_64 54/54
Removed: You can also run all three tasks on all the workers at the same time, by adding any task to your fabfile kernel.py:<source lang="python">def doAllThree(): getDiskUsage() getFirewallConfig() performSoftwareUpdate()</source>: And run the following command on your controllerx86_64 0:3.10.0-862.el7
</source>
= Lab Exercise: Test your updated fabfile.py until you get the same result as when you apply it to your own worker VM. == Create a Fabric task called makeUser() ==: Study the Fabric API run(), sudo(), and put() and utilize them to create a new task called makeUser()
: The makeUser() function should perform the following:
:Add the makeUser() to your final version of fabfile.py.
:Test Run the new task makeUser() on your local VM first, and deploy to your vm on myvmlab.:After the successful deployment of the Verify and confirm that your new makeUser() task on your vm on myvmlab, ask your professor to verify and confirm that the new user account "ops435p" on myvmlab has been created is working correctly.
= LAB 8 SIGN-OFF (SHOW INSTRUCTOR) =
:'''Have Ready to Show Your Instructor:'''* Complete all the parts of the lab and upload the version of your fabfile.py which works on your vm on myvmlab to Blackboardby the due date.
[[Category:OPS435-Python]][[Category:rchan]]