I wrote devz a while ago to help me out with workflows that look like;
work & test on a system -> push the changes to the production systems.
Devz was written in an evening and it has been helping me and a few friends for ~three years. Recently, I wanted to use devz on another project so I beautified it a bit and wrote this how-to.
devz has 4 basic verbs-functionalities that do 4 simple things.
- toprod: sends a file to a list of systems using scp
- ctoprod: sends a set of commands to a list of systems over ssh
- stor: stores a file in ./stor/file.n
- fromprod: fetches a file from the first production system
- devz-setagent: initiates an ssh-agent session
- devz-showconfig: see the files used in the configuration and list the production systems
updated devz howto
To list the devz commands type devz.
$devz ****** devz DEVeloper'S Stupid Servant g0 2010 - http://ipduh.com/contact ****** devz verbs: * 'toprod' or 'devz toprod' toprod file scp a file to the production server(s) * 'ctoprod' or 'devz ctoprod' ctoprod 'command;command;' send commands to all production server(s) * 'fromprod' or 'devz fromprod' fromprod file scp a file from the first production server here. * 'stor' or 'devz stor' stor file creates the directory stor in the current directory if it does not exist. makes a copy of the file in stor the file gets a version number like file.n where n [0,n] * 'devz-setagent' or 'devz setagent' setagent start an ssh-agent login session * 'devz-showconfig' or 'devz showconfig' showconfig See and Current devz configuration * 'devz-setconfig' or 'devz setconfig' setconfig set production-servers list file ******
Use devz
At the beginning of each session you better start an ssh-agent session.
turor:~$devz setagent Enter passphrase for /tutor/.ssh/id_dsa: Identity added: /tutor/.ssh/id_dsa (/tutor/.ssh/id_dsa)
Let's list the devz configuration.
tutor:~$devz showconfig ****** PRODUCTION SERVERS LIST from /tutor/.devzconfig/production-servers 1) - 10.19.143.6 -- 22 -- root - 2) - 10.255.9.14 -- 22 -- root - *** IDENTITY: /tutor/.ssh/id_dsa ******
Send a command to the production servers
tutor:~$ctoprod 'cat /proc/cpuinfo |grep name' devz: root@10.19.143.6:22 "cat /proc/cpuinfo |grep name" model name : Intel(R) Xeon(R) CPU X5560 @ 2.80GHz model name : Intel(R) Xeon(R) CPU X5560 @ 2.80GHz model name : Intel(R) Xeon(R) CPU X5560 @ 2.80GHz model name : Intel(R) Xeon(R) CPU X5560 @ 2.80GHz devz: root@10.255.9.14:22 "cat /proc/cpuinfo |grep name" model name : Intel(R) Xeon(R) CPU E5310 @ 1.60GHz model name : Intel(R) Xeon(R) CPU E5310 @ 1.60GHz model name : Intel(R) Xeon(R) CPU E5310 @ 1.60GHz model name : Intel(R) Xeon(R) CPU E5310 @ 1.60GHz
Send a file to the production systems
tutor:~$cd /tmp tutor:~$echo test > test tutor:~$toprod test devz:/tmp/test to root@10.19.143.6:22:/tmp/test test 100% 5 0.0KB/s 00:00 devz:/tmp/test to root@10.255.9.14:22:/tmp/test test 100% 5 0.0KB/s 00:00 tutor:~$
Stor a file
tutor:/tmp$stor test devz:The directory ./stor does not exist! I will create it. devz:test is at ./stor/test.0
a bit more on stor
tutor:/tmp$stor test devz:test is the same as ./stor/test.0 devz:I did not stor test
a bit more on stor
tutor:/tmp$echo next > test tutor:/tmp$stor test devz:test is at ./stor/test.1
Fetch a file from a production system
tutor:/tmp$fromprod test devz:test exists! Please stor it and delete it or rename it or delete it. tutor:/tmp$rm test tutor:/tmp$fromprod test devz:root@10.19.143.6:22:/tmp/test to /tmp/test test 100% 5 0.0KB/s 00:00
Install devz
devz is a simple extension of your bash environment and depends on many unix utilities.
devz assumes that you have created at least one ssh identity - ssh key-pair and that copies of your public key are in the authorized keys of the production systems.
#wget http://kod.ipduh.com/lib/devz #mv devz /bin #chmod 755 /bin/devzTo install elsewhere eg /usr/local/bin change DEVZAT.
Setup devz for user tutor
$ whoami tutor $ mkdir ~/.devzconfig $ echo "source /bin/devz" >> ~/.bashrc $ source ~/.bashrcA production-servers list should be in ~/.devzconfig and look like the following.
$cat ~/.devzconfig/production-servers # production servers # IP address , SSH TCP port, user 10.19.143.6,22,root 10.255.9.14,22,rootLines beginning with a # are ignored.
Create an SSH key pair
$ ssh-keygen -t dsa Generating public/private dsa key pair. Enter file in which to save the key (/home/tutor/.ssh/id_dsa): Created directory '/home/tutor/.ssh'. Enter passphrase (empty for no passphrase): Enter same passphrase again: Your identification has been saved in /home/tutor/.ssh/id_dsa. Your public key has been saved in /home/tutor/.ssh/id_dsa.pub. The key fingerprint is: 88:5a:f3:75:ed:c3:92:ed:04:a0:bf:bc:d7:e9:7c:68 tutor@some-ipduh-system The key's randomart image is: +--[ DSA 1024]----+ | | | | | . | | . o . . | | + o S o . | | o + o . = | | . . . oo*. | | . +E*+. | | ++ o+ | +-----------------+ $ ls -a ~/.ssh . .. id_dsa id_dsa.pubNow, you need to copy your public key in each
Production-System-X:/USER-HOME-DIR-PATH/.ssh/authorized_keys2
eg for root@10.19.143.16: 10.19.143.6:/root/.ssh/authorized_keys2
more on ssh-keys
devz source
devz is just a few hundred lines of easy to follow bash code and depends on many standard unix programs.
##devz DEVeloper'S Stupid Servant
##devz g0 2010 - http://ipduh.com/contact
## GNU GPLvX
## Dependencies: bash,source,grep,awk,ssh,ssh-agent,scp,diff,pwd,expr,ps,cat
## One of these days I 'll write it in C --not , g0
## http://alog.ipduh.com/2013/04/devz-how-to.html
VERBOSE="1"
PRO_SRV="${HOME}/.devzconfig/production-servers"
EGO="devz"
DEVZAT=/bin/${EGO}
IDENTITY="${HOME}/.ssh/id_dsa"
function devz {
MEAT=${DEVZAT}
PT2="##"
if [ "${1}" = "toprod" ]
then
toprod ${2}
elif [ "${1}" = "fromprod" ]
then
fromprod ${2}
elif [ "${1}" = "stor" ]
then
stor ${2}
elif [ "${1}" = "setagent" ]
then
devz-setagent
elif [ "${1}" = "showconfig" ]
then
devz-showconfig
elif [ "${1}" = "setconfig" ]
then
devz-setconfig
else
echo "******"
echo "devz"
grep "${PT2}devz " ${MEAT} |awk -F "${PT2}devz " '{print $2}'
echo "******"
echo "devz verbs:"
echo "*"
echo "'toprod' or 'devz toprod'"
grep "${PT2}toprod" ${MEAT} |awk -F "${PT2}toprod" '{print $2}'
echo "*"
echo "'ctoprod' or 'devz ctoprod'"
grep "${PT2}ctoprod" ${MEAT} |awk -F "${PT2}ctoprod" '{print $2}'
echo "*"
echo "'fromprod' or 'devz fromprod'"
grep "${PT2}fromprod" ${MEAT} |awk -F "${PT2}fromprod" '{print $2}'
echo "*"
echo "'stor' or 'devz stor'"
grep "${PT2}stor" ${MEAT} |awk -F "${PT2}stor" '{print $2}'
echo "*"
echo "'devz-setagent' or 'devz setagent'"
grep "${PT2}devz-setagent" ${MEAT} |awk -F "${PT2}devz-setagent" '{print $2}'
echo "*"
echo "'devz-showconfig' or 'devz showconfig'"
grep "${PT2}devz-showconfig" ${MEAT} |awk -F "${PT2}devz-showconfig" '{print $2}'
echo "*"
echo "'devz-setconfig' or 'devz setconfig'"
grep "${PT2}devz-setconfig" ${MEAT} |awk -F "${PT2}devz-setconfig" '{print $2}'
echo "******"
fi
}
##
##devz-setconfig setconfig
##devz-setconfig set production-servers list file
##
function devz-setconfig {
PROSRV=""
ls -l ${PRO_SRV}*
read -p "Set production-servers list: " PROSRV;
cat ${PROSRV} > ${PRO_SRV}
devz-showconfig
}
##
##devz-showconfig showconfig
##devz-showconfig See the Current devz configuration
##
function devz-showconfig {
echo "******"
echo "PRODUCTION SERVERS LIST from ${PRO_SRV}"
COUNTER=1
for SERVER in `grep -v -E '^#|^$' ${PRO_SRV}`
do
PRODUCTION_SRV=`echo ${SERVER} | awk -F "," '{print $1}'`
PRODUCTION_SRV_PORT=`echo ${SERVER} | awk -F "," '{print $2}'`
PRODUCTION_SRV_USER=`echo ${SERVER} | awk -F "," '{print $3}'`
echo "${COUNTER}) - $PRODUCTION_SRV -- $PRODUCTION_SRV_PORT -- $PRODUCTION_SRV_USER -"
(( COUNTER += 1 ))
done
echo "***"
echo "IDENTITY: ${IDENTITY}"
echo "******"
}
##
##devz-setagent setagent
##devz-setagent start an ssh-agent login session
##
function devz-setagent {
ssh-add -ls 2>/dev/null
if [ $? -eq 0 ]
then
echo "${EGO}:It seems that active identities are held by the ssh-agent"
else
ssh-agent sh -c "ssh-add ${IDENTITY} && bash"
fi
}
##
##toprod toprod file
##toprod scp a file to the production server(s)
##
function toprod {
PWD=`pwd`
if [ -z "${1}" ]
then
echo "${EGO}:toprod WHAT?"
echo "${EGO}:Type devz for help with all commands."
elif [ ! -e ${PRO_SRV} ]
then
echo "${EGO}:Make sure that a readable ${PRO_SRV} exists and contains at least one not null DEVZ_PROD_SRV"
else
for SERVER in `grep -v -E '^#|^$' ${PRO_SRV}`
do
PRODUCTION_SRV=`echo ${SERVER} | awk -F "," '{print $1}'`
PRODUCTION_SRV_PORT=`echo ${SERVER} | awk -F "," '{print $2}'`
PRODUCTION_SRV_USER=`echo ${SERVER} | awk -F "," '{print $3}'`
if [ ${VERBOSE} -eq 1 ]
then
echo "${EGO}:${PWD}/${1} to $PRODUCTION_SRV_USER@$PRODUCTION_SRV:$PRODUCTION_SRV_PORT:${PWD}/${1}"
fi
scp -r -P ${PRODUCTION_SRV_PORT} -i ${IDENTITY} $1 ${PRODUCTION_SRV_USER}@${PRODUCTION_SRV}:${PWD}/$1
done
fi
}
##
##ctoprod ctoprod 'command;command;'
##ctoprod send commands to all production server(s)
##
function ctoprod {
PWD=`pwd`
if [ -z "${1}" ]
then
echo "${EGO}:ctoprod WHAT?"
echo "${EGO}:Type devz for help with all commands."
elif [ ! -e ${PRO_SRV} ]
then
echo "${EGO}:Make sure that a readable ${PRO_SRV} exists and contains at least one not null DEVZ_PROD_SRV"
else
for SERVER in `grep -v -E '^#|^$' ${PRO_SRV}`
do
PRODUCTION_SRV=`echo ${SERVER} | awk -F "," '{print $1}'`
PRODUCTION_SRV_PORT=`echo ${SERVER} | awk -F "," '{print $2}'`
PRODUCTION_SRV_USER=`echo ${SERVER} | awk -F "," '{print $3}'`
if [ ${VERBOSE} -eq 1 ]
then
echo "${EGO}: ${PRODUCTION_SRV_USER}@${PRODUCTION_SRV}:${PRODUCTION_SRV_PORT} \"$1\""
fi
ssh -p ${PRODUCTION_SRV_PORT} -i ${IDENTITY} ${PRODUCTION_SRV_USER}@${PRODUCTION_SRV} ${1}
done
fi
}
##
##fromprod fromprod file
##fromprod scp a file from the first production server here.
##
function fromprod {
if [ -z "${1}" ]
then
echo "${EGO}:fromprod WHAT?"
echo "${EGO}:Type devz for help with all commands."
else
if [ -e $1 ]
then
echo "${EGO}:$1 exists! Please stor it and delete it or rename it or delete it."
else
SERVER=`grep -v -E '^#|^$' -m 1 ${PRO_SRV}`
PRODUCTION_SRV=`echo ${SERVER} | awk -F "," '{print $1}'`
PRODUCTION_SRV_PORT=`echo ${SERVER} | awk -F "," '{print $2}'`
PRODUCTION_SRV_USER=`echo ${SERVER} | awk -F "," '{print $3}'`
if [ ${VERBOSE} -eq 1 ]
then
echo "${EGO}:$PRODUCTION_SRV_USER@$PRODUCTION_SRV:$PRODUCTION_SRV_PORT:${PWD}/${1} to ${PWD}/${1}"
fi
scp -r -P ${PRODUCTION_SRV_PORT} -i ${IDENTITY} ${PRODUCTION_SRV_USER}@${PRODUCTION_SRV}:${PWD}/$1 .
fi
fi
}
##
##stor stor file
##stor creates the directory stor in the current directory if it does not exist.
##stor makes a copy of the file in stor
##stor the file gets a version number like file.n where n [0,n]
##
function stor {
if [ -z "${1}" ]
then
echo "${EGO}:stor WHAT?"
echo "${EGO}:Type devz for help with all commands."
else
if [ ! -d ./stor ]
then
echo "${EGO}:The directory ./stor does not exist! I will create it."
mkdir ./stor
fi
if [ -e ./stor/$1.0 -a -d ./stor ]
then
declare -a FILES=( `ls ./stor |grep ${1} |awk -F "${1}." '{print $2}'` )
FILEV="" #file versions string
for i in $(seq 0 $((${#FILES[@]} -1)))
do
if [[ "${FILES[$i]}" =~ ^[0-9]+$ ]]
then
FILEV="$FILEV ${FILES[$i]}"
fi
done
declare -a FILEVL=( ${FILEV} )
LAST=0
for j in $(seq 0 $((${#FILEVL[@]} -1)))
do
if [ ${LAST} -lt ${FILEVL[$j]} ]
then
LAST=${FILEVL[$j]}
fi
done
diff ${1} ./stor/${1}.${LAST} > /dev/null
if [ $? -eq 0 ]
then
echo "${EGO}:${1} is the same as ./stor/${1}.${LAST}"
echo "${EGO}:I did not stor ${1}"
else
LAST=`expr ${LAST} + 1`
cp $1 ./stor/$1.${LAST}
echo "${EGO}:${1} is at ./stor/${1}.${LAST}"
fi
fi
if [ ! -e ./stor/$1.0 -a -d ./stor ]
then
cp $1 ./stor/$1.0
echo "${EGO}:$1 is at ./stor/$1.0"
fi
fi
}
devz How To
