Linux Package Management (Distribute Your App)
|Title||Linux package management (distribute desktop apps) (build your own linux package)|
|Overview||Students will learn about rpm and dnf/yum package tooling and then actually create their own package from code, upload it to a public package repository and finally have a classmate install their compiled package. This can be advertised to students as being able to distribute their own linux-based application to the world.|
|Prerequisite Knowledge|| Students should be familiar with:
|Learning Objectives|| Upon completion, students should be able to:
Is there background reading material?
- Read about the various software installation methods on Linux: http://www.howtogeek.com/191245/beginner-geek-how-to-install-software-on-linux/
- https://wiki.archlinux.org/index.php/Arch_User_Repository, https://wiki.archlinux.org/index.php/Arch_packaging_standards
Are there other related activities?
- Linux_Beginner_Activity - Students can follow this to get command-line basics.
- Note that the requirements above ask for slightly more in-depth command-line experience via sudo and code compilation.
- Installing_a_Virtual_Machine - If Students need virtual linux machines for command-line access, they can use this activity.
- Introduction_to_building_open_source_software and Building_a_GnomeMusic_Clone both give linux compilation and build experience.
What is the rationale for this activity?
- Students may wonder how they can distribute linux-based code that they develop out to other everyday users. Not many users enjoy compiling code, so the RPM package structure allows easy installation of binary pre-compiled code packages. Basically, a student could have coded a small sample command-line application and now they can send it to others easily. The other side of it is that students, as users of Linux, will be interfacing with RPM packages not of their making and it will be good to have an understanding of the backends of how this works. Students will interface with the dnf and yum commands even if simply using linux for fun. Now, they can have knowledge into how it works and how they can employ it for their careers and personal uses.
Keep a working log
Log your shell commands, answers to questions, and commentary in a text file, wiki, or blog. You will be constructing and troubleshooting numerous linux shell command's and their outputs. Your assignment is to document these commands and the process you went through in an organized fashion. You might use bullet points or a new set of commands on each line. Make sure it is easily consumable by a human (your instructor), as well as yourself 10 years from now.
The data that is the output of the commands is not as interesting as a summary or comment of their output or on what the command has done - ex: failed, succeeded, why, what it did, what it changed, etc. Write these in complete sentences. Commentary is especially important if you run into problems. When this occurs, state the problem and how you intend to solve it. At the end, you should have a text document with all of the commands, right and wrong, that you went through to get this activity completed. It should read as a timeline of what you did and what your thoughts were, to get the assignment complete. After this is complete, you will summarize the most useful commands into a sort of cheatsheet - this can come in useful for years to come.
You might consider upping your terminal windows buffer for the number of lines it holds, to somewhere in the tens of thousands - just in case you decide you want to come back to something you learned a while back, or in case a command spits out thousands of lines of results - which can happen. Some terminal applications can record commands and output to text files. Either way, make your written log human readable, make it a story if you wish. When you come back to this years from now, needing to remind yourself how to package some newly minted code, you want a summary/cheatsheet and you want to be able to understand the context and follow your thoughts of why you tried certain things. You don't want to be parsing through lines and lines of shell input and output.
The activity will follow these general steps
- Learn about dnf/yum and rpm files.
- Learn about creating rpm's and the rpmbuild command.
- Use an existing, easy, mature, yet small project like htop (or something that doesn't come standard on most systems) to have students compile and make and package.
Step 1: dnf / yum and .rpm's
- First, lets do some learning before we jump into shell commands. Answer the following in your log:
- What is the difference between dnf and yum? Why was the change made?
- What are .rpm files? Where might you find them and how are they used?
- Use the dnf command to view what packages have been recently installed on your machine.
- Hint: There is a specific command for this. man dnf is your friend
- Attempting to list all packages will often be quite a long listing.
- Use the dnf command to install a .rpm package not currently installed on your machine.
- Pick something simple, as you will need to operate it in the next steps.
- Hint: If you dont find your own (more credit given for this), you can install screen
- Use dnf to show that the new package is now installed.
- Run or operate this newly installed utility. Where did dnf place the executable file?
Step 2: RPM's and rpmbuild
Required reading / watching:
- RPM Build Example Video - Watch, at least, the first 8 mins of this video from a recording of a local Linux User Group meeting
- RPM process Diagram from video - Find the diagram that the video references on the page labeled 12-17
- Document authored by Guru Labs, L.C. released under the CC-BY-NC-ND 2.0 license
- Packaging the `wget` command - Read this example in its entirety
- This will take some time to read through.
- If you were to try to follow along in the shell, there may be some hickups with wget.
- Instead, save it for Part 3; You will use this readings structure to RPM'ize the htop project.
- What is the rpmbuild command?
- Quickly summarize the directory structure when making your own RPM - you will stick this into your cheat sheet later, so make it short.
Step 3: Create your own 'htop' RPM
- Compile it to test that the code can be turned into binary form in your environment
- This is not outright a piece of turning code into an RPM, but code must compile before it can be turned into an RPM
- Anyway, there is always some odd ./configure setting or dependency that needs installing (other rpm package that this project uses)
- Create RPM dir structure
- Run rpmbuild command
See the above note about the working log. The working log, as well as a summary/cheatsheet of commands is what students will hand in at the end of the assignment.
|Criteria||Level 1 (fail)||Level 2 (pass)||Level 3 (good)||Level 4 (exceptional)|
|Installs and inspects RPMs with dnf/yum|
|Compiles code into binary RPM|
|Uploads RPM to COPR or other online repo|
|Installs colleagues RPM from COPR|
What should the instructor know before using this activity?
Students should know how to compile Linux software code before doing this activity.
- There exists an activity which covers this: Introduction_to_building_open_source_software
- Particularly, students should have experience using the configure, make, and make install commands
- If students have not compiled in the past, it is common to not have all of the required libraries and modules already installed for the compilation process to succeed. This is a major part of creating RPM's. This setup takes time to troubleshoot and setup, and it could be different on each system if students are not using identical operating systems.
If you wanted to do this activity in Ubuntu, Debian, etc:
- Students could optionally do this activity on Ubuntu or other Linux OS's which use a different Package Management toolset.
- Ubuntu is debian-based and uses the ``dpkg`` command. For more info on equivalent commands, see:
What are some likely difficulties that an instructor may encounter using this activity?
|ACM Knowledge Area/Knowledge Unit||PL - Programming Languages, SE - Software Engineering from ACM_Body_of_Knowledge|
|ACM Topic||PL/Compiler Semantic Analysis, PL/Code Generation, SE/Tools and Environments from https://www.acm.org/education/CS2013-final-report.pdf|
|Level of Difficulty||Easy-Medium, for students that meet the pre-req's|
|Estimated Time to Completion||2-3 hours|
|License||Creative Commons CC-BY|
Suggestions for Open Source Community:
Suggestions for an open source community member who is working in conjunction with the instructor:
- Why did your community decide to standardize on the autotools-based config/make building? Or, why not?
- Explain to students why packaging skills can be used on many open source linux-based projects, across their careers.
- Help students through the often-confusing build process
- Help students to find alternate examples to step through - aka, finding project code other than the ones listed above and making it into an RPM.
This work is licensed under a Creative Commons Attribution 4.0 International License
Consider breaking these additional steps into a new activity
- Have students host the package on a web source (ftp? Some free internet service that makes the .rpm accessible by URL)
- Have each student in the class pair up and try to install the other person's RPM and run the new command
Ideas on what to create into an RPM: