├── README.md ├── articles └── rpi-clone │ └── main.html ├── sysmatt.rpi.backup.gtar └── sysmatt.rpi.restore.sd.card /README.md: -------------------------------------------------------------------------------- 1 | sysmatt-rpi-tools 2 | ================= 3 | 4 | Tools used to clone raspberry pi SD cards and OS images 5 | -------------------------------------------------------------------------------- /articles/rpi-clone/main.html: -------------------------------------------------------------------------------- 1 | 5 | 6 |
Image Credit:" Raspberry Pi B+ top" by Lucasbosch - Own work. Licensed under CC BY-SA 3.0 via Wikimedia Commons.
9 | 10 | Ladies and gentlemen, if you are like me, you probably have a few raspberry pi. (Piis?) I have found them to be great little Linux development boards supported by a huge community. Whenever I need a net connected microprocessor project, the pi is an easy win. I have used it in internet connected clocks, LED signs, RGB lighting projects and so many other crazy projects. They make a great internet gateway for Arduino projects. This use is the very definition of "embedded", a raspberry pi with no keyboard, mouse or monitor. It boots, connects and does it's programmed task. It would be a huge inconvenience to manually configure every one of these starting from a raspbian .img file. Even if your not into electronics, manipulating the SD cards directly will make your life a little easier.
11 | 12 | Now would be a great time to introduce my "day job". I am a professional *NIX system administrator and system architect. So when I see a raspberry pi I see a Linux box. UNIX/Linux systems are very easy to clone, it's just a pile of files. I will start with some basic theory and how to work with the SD card from the command line. Then, I will introduce you to my scripts which automate the process.
13 | 14 | 15 | 19 | 22 |
23 |
26 | 27 | So once we understand how it's using the SD card, we can duplicate it and pre-configure if before we even power it on. No magic, It's all just regular files and some *NIX know-how.
28 | 29 |
32 | Power on your Raspberry pi, and log in by whatever means you prefer (graphical, ssh, etc). Get to a command prompt and sudo to a root shell, everything we are going to do needs root privilege. You will also need to install the dosfstools package which is used later. Then, plug in your SD card to any free USB port. Use the "dmesg" utility to dump the kernel log, look at the output to determine what scsi device your new SD card has been assigned. (stuff you type is underlined)
33 | 34 |
35 |
52 | |
53 | From the above, we can see that our SD card has been assigned "sda" which means /dev/sda is how we will get to it.
54 | 55 | First, we need to create the two partitions to hold our /boot and / (slash) filesystems. We do this with the GNU parted utility.
56 | 57 |
|
79 | 80 | To summarize what we just did. First we use the "mklabel" to create a fresh msdos style partition table on /dev/sda, you will have to answer "y" to the warning. Next we create the partition to hold our FAT /boot filesystem, with a size of 64MB. Next we tell parted to create another partition to hold our slash (/) filesystem starting at the 64MB mark, and ending at the last available sector of the disk (-1s). We tell parted that these two partitions will be fat16 and ext4 respectively so it will set the correct partition type on each.
81 | 82 | Finally we "print" the resulting partition table so we can see it, then exit with "quit"
83 | 84 | The two partitions we just created are now available as devices /dev/sda1 and /dev/sda2. Next we need to format them. This is done with the mkfs.vfat and mkfs.ext4 commands:
85 | 86 |
|
114 | 115 |
|
134 | 135 | Nice! The output of the "df" command will show us that both slash and boot have been mounted and are the expected sizes. In my case I am using a 8gb SD card. Next, we will execute a command to copy our existing raspbian OS installed on our running pi into our mounted SD card. Now, a couple notes about live cloning. If you are running any services that keep data files open (like mysql, postgresql, apt-get, or other applications) these should be shutdown to insure you get a clean copy. We will use the rsync utility for this copy, we will tell it to only copy / (slash) and /boot, further, we will also tell rsync not to cross filesystem boundaries (--one-file-system). 136 | 137 |
138 | Why do we specify slash (/) and boot separately? If you look above at the df listing you can see lots of other filesystems mounted. Some of these are ramdisks and virtual filesystems (/sys, /dev, /tmp, and /proc for instance). We do not want to copy these at all. By using the --one-file-system and specifying explicitly slash (/) and /boot, we only capture the OS tree of files. ( Note, the rsync is sensitive to trailing slashes on the source and destination directory names, make sure you run it exactly as below) 139 | 140 |
|
172 | 173 |
178 |
182 |
187 | 188 | Example: Wireless /w DHCP: 189 |
202 | 203 | 204 | Example: Wireless /w static IP: 205 |
|
222 | 223 | These are just a few examples. When your ready to try out your cloned SD card, you should unmount it using the following commands. Make sure you close any shells or change your current working directory (cd) off the new devices or you will get an error when you try to unmount.
224 | 225 |
|
229 | 230 | You can now safely pull the SD card out and put it in your destination raspberry pi. It should boot and work just like any other SD card.
231 |
232 |
233 |
234 |
238 |
241 |
242 |
245 | 246 | We need to retrieve and install the scripts. You will find a link at the end of this article to the current version of the scripts. Download the latest tar archive and untar it into /usr/local/bin as shown below
247 | 248 | Download the latest zip from github
249 | 250 |
|
254 | 255 | Install to /usr/local/bin or any other location you prefer 256 | 257 |
|
263 | 264 |
If you so not have enough free disk space on your SD card to hold the tar archive you might want to write it to a flash drive or network mounted filesystem. You should be fine if your SD card is 8gb or larger and have not downloaded too software/data.
267 | 268 | To write the tar archive to /home/pi/backups: 269 |
|
274 | 275 | Or, to specify an alternate location, run it with a filename argument: 276 | 277 |
|
280 | 281 | Either of the above will result in a backup copy of the running system being stored in a tar archive file. Again, a note of caution, if you have any programs that are actively writing to data files (mysql/postgresql/apt-get/etc) these should be not run while you make this clone so you get a clean copy.
282 |
283 |
284 |
285 |
289 |
292 |
293 |
Tip: This script will also work just fine on any Linux box, so you can create SD cards from a workstation also.
296 | 297 |
|
315 | 316 | Ok, looks like this was assigned /dev/sda also. Don't assume!
317 | 318 | Now we run the sysmatt.rpi.restore.sd.card script passing the name of the SD device and the tar archive to restore from. Note, your specific filename will be different.
319 | 320 |
|
324 | Above listed is the tar archive we just created. We will now restore it using the next script. Note, it is interactive and will ask you for confirmation. Before the script exits it will give you the opportunity to modify the resulting SD card before it unmounts it. 325 | 326 |
|
398 | 399 | Now here, the script is paused waiting for input, and you have a choice. If you wish to make changes to the SD card you can open another terminal and modify it under the mountpoint shown (/tmp/pi.sd.324943213 in this example), for instance, change the hostname like we did previously:
400 | 401 |
|
404 | 405 | When you are done with your modifications, you can return to the session running the script and hit enter. It will unmount the SD card from it's temporary mountpoint. Make sure you have closed any programs or shells that might be holding the filesystems open. You can always try unmounting again with the "umount" command if necessary.
406 | 407 | After it is unmounted, you can pull and insert it into your raspberry pi and boot it up. If you want to make the script non-interactive, feel free to remove or comment out the "read" lines that ask for confirmation. But do so at your own risk!
408 | 409 | I hope you found this little tutorial helpful. Using these utilities and scripts you can build your own library of standard OS images, preconfigured for particular applications. This makes duplicating projects very easy and quick! If you have feedback on the tutorial or any of the scripts please let me know at matthoskins @ gmail.com or on twitter @sysmatt.
410 | 411 |
413 | 414 | Like this article? See more of Matt's published works 415 | 416 |
419 | Good article about the Raspberry Pi's bootstrap process: http://thekandyancode.wordpress.com/2013/09/21/how-the-raspberry-pi-boots-up/
420 |
421 |
422 |
423 |
427 |
430 |
431 |
432 |
433 |
434 |
435 |
436 |
437 |
438 |
439 |
440 |
441 |
442 |
443 |
444 |
445 |
--------------------------------------------------------------------------------
/sysmatt.rpi.backup.gtar:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | # 20140804-1708 Matthew E Hoskins / Twitter: @sysmatt (c) GNU GPL
3 |
4 | set -x # debugging
5 |
6 | bomb () {
7 | echo "BOMB: ${1}"
8 | exit 1
9 | }
10 |
11 | # Default destination directory
12 | DSTDIR=/home/pi/backups
13 | DEFAULT_DFILE="${DSTDIR}/pi.`uname -n`.`date +%Y%m%d%H%M%S`.backup.tar.gz"
14 |
15 | # If we get a filename on the command line, use it instead of the default.
16 | DFILE="${1:-$DEFAULT_DFILE}"
17 | DEST_DIR_SANITY=`dirname "${DFILE}"`
18 |
19 | # Make sure the destination exists
20 | [ -d "${DEST_DIR_SANITY}" ] || bomb "Destination directory ${DEST_DIR_SANITY} does not exist"
21 |
22 | # Run the tar archive
23 | tar --exclude="${DFILE}" --one-file-system -cvzf "${DFILE}" / /boot
24 |
25 | echo "Created archive: ${DFILE}"
26 |
--------------------------------------------------------------------------------
/sysmatt.rpi.restore.sd.card:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | # 20140804-1708 Matthew E Hoskins / Twitter: @sysmatt (c) GNU GPL
3 |
4 | SDCARD_DEVICE="${1:?You must specify one SD CARD DEVICE to destroy}"
5 | PI_BACKUP_SLASH="${2:?You must specify one PI BACKUP SLASH GTAR file}"
6 | shift; shift;
7 | # Any remaining args are added to TAR command line
8 |
9 | # Extra operations which can be done in ENV Vars
10 | # PI_OVERWRITE_ETC_HOSTNAME="new-hostname"
11 | # PI_OPENVPN_CONFIG_FILE="/some/source/client.conf"
12 |
13 |
14 |
15 | # Temp random mountpoint under /tmp
16 | MOUNTPOINT="/tmp/pi.sd.${RANDOM}${$}"
17 |
18 | bomb (){
19 | echo "BOMB: ${1}"
20 | exit 1
21 | }
22 |
23 | [ -x "/sbin/mkfs.vfat" ] || bomb "/sbin/mkfs.vfat Missing"
24 |
25 | echo ""
26 | echo "=== ${SDCARD_DEVICE} Current Partition Table - To be destroyed! ==="
27 | parted --script ${SDCARD_DEVICE} "print"
28 | echo ""
29 | read -p "PRESS ENTER to DESTROY ${SDCARD_DEVICE}, Press CTRL-c to abort"
30 |
31 | parted --script "${SDCARD_DEVICE}" "mklabel msdos"
32 | parted --script "${SDCARD_DEVICE}" "mkpart primary fat16 1MiB 64MB"
33 | parted --script "${SDCARD_DEVICE}" "mkpart primary ext4 64MB -1s"
34 | parted --script "${SDCARD_DEVICE}" print
35 | mkfs.vfat "${SDCARD_DEVICE}1"
36 | mkfs.ext4 -F -j "${SDCARD_DEVICE}2"
37 | mkdir -p "${MOUNTPOINT}"
38 | mount "${SDCARD_DEVICE}2" "${MOUNTPOINT}"
39 | mkdir -p "${MOUNTPOINT}/boot"
40 | mount "${SDCARD_DEVICE}1" "${MOUNTPOINT}/boot"
41 | df -h "${MOUNTPOINT}"
42 | df -h "${MOUNTPOINT}/boot"
43 | read -p "Press ENTER To begin image restore"
44 | tar $@ -xvzf "${PI_BACKUP_SLASH}" -C "${MOUNTPOINT}"
45 |
46 | # Begin NOOBS fixup / Recommended by @KevinSidwar / 20140829-1744-MEH
47 | ORIG_SLASHDEV_FOUND=`cat "${MOUNTPOINT}/etc/fstab"| grep " / " |grep -v "^#" |awk '{ print $1; }'`
48 | ORIG_BOOTDEV_FOUND=`cat "${MOUNTPOINT}/etc/fstab"| grep " /boot " |grep -v "^#" |awk '{ print $1; }'`
49 |
50 | # Hardcoded
51 | NEW_SLASHDEV="/dev/mmcblk0p2"
52 | NEW_BOOTDEV="/dev/mmcblk0p1"
53 |
54 | # Defaults just in case the above search of fstab is a miss
55 | ORIG_SLASHDEV="${ORIG_SLASHDEV_FOUND:-$NEW_SLASHDEV}"
56 | ORIG_BOOTDEV="${ORIG_BOOTDEV_FOUND:-$NEW_BOOTDEV}"
57 |
58 |
59 | echo "ORIG_SLASHDEV[${ORIG_SLASHDEV}] NEW_SLASHDEV[${NEW_SLASHDEV}] ORIG_BOOTDEV[${ORIG_BOOTDEV}] NEW_BOOTDEV[${NEW_BOOTDEV}]"
60 |
61 | FILE_FSTAB="${MOUNTPOINT}/etc/fstab"
62 | FILE_CMDLINE="${MOUNTPOINT}/boot/cmdline.txt"
63 | FILE_OS_CONFIG_JSON="${MOUNTPOINT}/boot/os_config.json"
64 |
65 | if [ "${ORIG_SLASHDEV}" != "${NEW_SLASHDEV}" -o "${ORIG_BOOTDEV}" != "${NEW_BOOTDEV}" ]
66 | then
67 | echo "CONFIGURATION CONVERSION NECESSARY - Devices do not match, modifying files. "
68 |
69 | THISFILE="${FILE_FSTAB}"
70 | if [ -e "${THISFILE}" ]
71 | then
72 | echo "Fixing ${THISFILE}"
73 | cp -f "${THISFILE}" "${THISFILE}.old"
74 | cat "${THISFILE}.old" |sed -e "s#${ORIG_SLASHDEV}#%NEW_SLASHDEV%# ; s#${ORIG_BOOTDEV}#%NEW_BOOTDEV%#" > "${THISFILE}.i"
75 | cat "${THISFILE}.i" |sed -e "s#%NEW_SLASHDEV%#${NEW_SLASHDEV}# ; s#%NEW_BOOTDEV%#${NEW_BOOTDEV}#" >"${THISFILE}"
76 | rm -f "${THISFILE}.i"
77 | fi
78 |
79 | THISFILE="${FILE_CMDLINE}"
80 | if [ -e "${THISFILE}" ]
81 | then
82 | echo "Fixing ${THISFILE}"
83 | cp -f "${THISFILE}" "${THISFILE}.old"
84 | cat "${THISFILE}.old" |sed -e "s#${ORIG_SLASHDEV}#%NEW_SLASHDEV%# ; s#${ORIG_BOOTDEV}#%NEW_BOOTDEV%#" > "${THISFILE}.i"
85 | cat "${THISFILE}.i" |sed -e "s#%NEW_SLASHDEV%#${NEW_SLASHDEV}# ; s#%NEW_BOOTDEV%#${NEW_BOOTDEV}#" >"${THISFILE}"
86 | rm -f "${THISFILE}.i"
87 | fi
88 |
89 | THISFILE="${FILE_OS_CONFIG_JSON}"
90 | if [ -e "${THISFILE}" ]
91 | then
92 | echo "Fixing ${THISFILE}"
93 | cp -f "${THISFILE}" "${THISFILE}.old"
94 | cat "${THISFILE}.old" |sed -e "s#${ORIG_SLASHDEV}#%NEW_SLASHDEV%# ; s#${ORIG_BOOTDEV}#%NEW_BOOTDEV%#" > "${THISFILE}.i"
95 | cat "${THISFILE}.i" |sed -e "s#%NEW_SLASHDEV%#${NEW_SLASHDEV}# ; s#%NEW_BOOTDEV%#${NEW_BOOTDEV}#" >"${THISFILE}"
96 | rm -f "${THISFILE}.i"
97 | fi
98 |
99 | fi
100 | # End Noobs fixup
101 | if [ -n "${PI_OVERWRITE_ETC_HOSTNAME}" ]
102 | then
103 | # Write a new /etc/hostname
104 | echo "Writing new /etc/hostname with [${PI_OVERWRITE_ETC_HOSTNAME}] to ${MOUNTPOINT}/etc/hostname"
105 | echo "${PI_OVERWRITE_ETC_HOSTNAME}" > "${MOUNTPOINT}/etc/hostname"
106 | fi
107 |
108 | if [ -e "${PI_OPENVPN_CONFIG_FILE}" ]
109 | then
110 | echo "Writing OpenVPN config [${PI_OPENVPN_CONFIG_FILE}] to ${MOUNTPOINT}/etc/openvpn/"
111 | rm -f ${MOUNTPOINT}/etc/openvpn/*.conf
112 | cp -f "${PI_OPENVPN_CONFIG_FILE}" "${MOUNTPOINT}/etc/openvpn/"
113 | fi
114 |
115 | echo ""
116 | echo ""
117 | echo =DONE=
118 | echo "The SD is mounted at: ${MOUNTPOINT}"
119 | echo "Now would be a good time to make modifications in another shell session..."
120 | read -p "Press ENTER To unmount or CTRL-c to exit leaving mounted."
121 | echo ""
122 | echo "Working. This may take a moment..."
123 | echo ""
124 | set -x
125 | umount "${MOUNTPOINT}/boot"
126 | umount "${MOUNTPOINT}"
127 |
128 |
129 |
--------------------------------------------------------------------------------