Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Script and Guidelines for mirroring Ceph
This commit introduces a script which admins can use to mirror the Ceph packages to their local systems. With this script they can easily sync from a mirror local to them. The README explains user on how and when to sync the sources and how they can become a official mirror for Ceph. Signed-off-by: Wido den Hollander <wido@42on.com>
- Loading branch information
Showing
4 changed files
with
192 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
download.ceph.com: Red Hat <ceph-users@lists.ceph.com> | ||
eu.ceph.com: Wido den Hollander <wido@42on.com> | ||
au.ceph.com: Matthew Taylor <matthew.taylor@digitalpacific.com.au> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Mirroring Ceph | ||
Ceph is primarily distributed from download.ceph.com which is based in the US. | ||
|
||
However, globally there are multiple mirrors which offer the same content. Often | ||
faster than downloading from the primary source. | ||
|
||
Using the script found in this directory you can easily mirror Ceph to your local | ||
datacenter and serve packages from there to your servers. | ||
|
||
## Guidelines | ||
If you want to mirror Ceph please follow these guidelines: | ||
* Please use a mirror close to you | ||
* Do not sync in a shorter interval than 3 hours | ||
* Avoid syncing at minute 0 of the hour, use something between 0 and 59. | ||
|
||
## Mirror script | ||
The 'mirror-ceph.sh' script is written in Bash and will use rsync to mirror | ||
all the contents to a local directory. | ||
|
||
Usage is simple: | ||
|
||
<pre> | ||
./mirror-ceph.sh -q -s eu -t /srv/mirrors/ceph | ||
</pre> | ||
|
||
This example will mirror all contents from the source 'eu' which is *eu.ceph.com*. | ||
|
||
### Running with CRON | ||
The script can easily be run with CRON: | ||
|
||
<pre> | ||
13 1,5,9,13,17,21 * * * /home/ceph/mirror-ceph.sh -q -s eu -t /srv/mirrors/ceph | ||
</pre> | ||
|
||
This will sync from *eu.ceph.com* on 01:13, 05:13, 09:13, 13:13, 17:13 and 21:13. | ||
|
||
## Becoming a mirror source | ||
If you have spare hardware and resources available you can opt for becoming a mirror | ||
source for others. | ||
|
||
A few things which are required: | ||
* 1Gbit connection or more | ||
* Native IPv4 **and** IPv6 | ||
* HTTP access | ||
* rsync access | ||
* 2TB of storage or more | ||
* Monitoring of the mirror/source | ||
|
||
You can then run the *mirror-ceph.sh* script and mirror all the contents. | ||
|
||
### Logs | ||
The project wants to analyze the downloads of Ceph a few times a year. From mirrors | ||
we expect that they store HTTP access logs for at least 6 months so they can be | ||
used for analysis. | ||
|
||
### DNS | ||
Using a DNS CNAME record a XX.ceph.com entry can be forwarded to the server and | ||
added to the mirror script. | ||
|
||
You can request such a DNS entry on the ceph mailinglists. | ||
|
||
### Apache configuration | ||
A Apache 2.4 VirtualHost example configuration can be found the Git repository | ||
with the name *apache2.vhost.conf* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# | ||
# This is a example Apache 2 VirtualHost being used | ||
# on eu.ceph.com which runs on Ubuntu 14.04 | ||
# | ||
|
||
<VirtualHost *:80> | ||
ServerName eu.ceph.com | ||
ServerAdmin webmaster@localhost | ||
DocumentRoot /srv/mirror/ceph/download | ||
<Directory /srv/mirror/ceph/download> | ||
Options FollowSymLinks Indexes | ||
AllowOverride none | ||
Require all granted | ||
</Directory> | ||
|
||
ErrorLog ${APACHE_LOG_DIR}/error.log | ||
CustomLog ${APACHE_LOG_DIR}/access.log combined | ||
</VirtualHost> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
#!/bin/bash | ||
# | ||
# Script to mirror Ceph locally | ||
# | ||
# Please, choose a local source and do not sync in a shorter interval than | ||
# 3 hours. | ||
# | ||
SILENT=0 | ||
|
||
# All available source mirrors | ||
declare -A SOURCES | ||
SOURCES[eu]="eu.ceph.com" | ||
SOURCES[au]="au.ceph.com" | ||
SOURCES[us]="download.ceph.com" | ||
SOURCES[global]="download.ceph.com" | ||
|
||
function print_usage() { | ||
echo "$0 [-q ] -s <source mirror> -t <target directory>" | ||
} | ||
|
||
while getopts ":qhs:t:" opt; do | ||
case $opt in | ||
q) | ||
SILENT=1 | ||
;; | ||
s) | ||
SOURCE=$OPTARG | ||
;; | ||
t) | ||
TARGET=$OPTARG | ||
;; | ||
h) | ||
HELP=1 | ||
;; | ||
\?) | ||
print_usage | ||
exit 1 | ||
;; | ||
esac | ||
done | ||
|
||
if [ ! -z "$HELP" ] || [ -z "$TARGET" ] || [ -z "$SOURCE" ]; then | ||
print_usage | ||
exit 1 | ||
fi | ||
|
||
if [ ! -d "$TARGET" ]; then | ||
echo "$TARGET is not a valid target directory" | ||
exit 1 | ||
fi | ||
|
||
for i in "${!SOURCES[@]}"; do | ||
if [ "$i" == "$SOURCE" ]; then | ||
SOURCE_HOST=${SOURCES[$i]} | ||
fi | ||
done | ||
|
||
if [ -z "$SOURCE_HOST" ]; then | ||
echo -n "Please select one of the following sources:" | ||
for i in "${!SOURCES[@]}"; do | ||
echo -n " $i" | ||
done | ||
echo "" | ||
exit 1 | ||
fi | ||
|
||
RSYNC_OPTS="--stats --progress" | ||
if [ $SILENT -eq 1 ]; then | ||
RSYNC_OPTS="--quiet" | ||
fi | ||
|
||
# We start a two-stage sync here for DEB and RPM | ||
# Based on: https://www.debian.org/mirror/ftpmirror | ||
# | ||
# The idea is to prevent temporary situations where metadata points to files | ||
# which do not exist | ||
# | ||
|
||
# Exclude all metadata files | ||
RET=0 | ||
|
||
rsync ${RSYNC_OPTS} ${SOURCE_HOST}::ceph --recursive --times --links \ | ||
--hard-links \ | ||
--exclude Packages* \ | ||
--exclude Sources* \ | ||
--exclude Release* \ | ||
--exclude InRelease \ | ||
--exclude i18n/* \ | ||
--exclude ls-lR* \ | ||
--exclude repodata/* \ | ||
${TARGET} | ||
|
||
if [ "$?" -ne 0 ]; then | ||
RET=$? | ||
fi | ||
|
||
# Now also transfer the metadata and delete afterwards | ||
rsync ${RSYNC_OPTS} ${SOURCE_HOST}::ceph --recursive --times --links \ | ||
--hard-links --delete-after \ | ||
${TARGET} | ||
|
||
if [ "$?" -ne 0 ]; then | ||
RET=$? | ||
fi | ||
|
||
exit $RET |