shost description of agricola release porcess

This commit is contained in:
Thomas Klaehn 2016-05-17 10:36:13 +02:00
parent 1c73229183
commit 3e392ea624

View File

@ -1,241 +1,41 @@
\section{Installation} \section*{Agricola Release HowTo}
\subsection{SD card preparation} \subsection*{Create release branch}
\subsubsection{Partitions} A push event to a \textit{release/...} named branch will create release
Format the SD card with two new partitions: candidates. These release candidates are deployed to agricola's project svn.
\lstsetbash (\texttt{http://dabsvn01.internal.novero.com/svn/\ \\
0\_31X\_P0070\_agricola/trunk/development/software/\ \\
releases/release\_candidate/})\\
Checkout the new release branch:
\begin{lstlisting} \begin{lstlisting}
fdisk /dev/mmcblk0 git checkout -b release/<release_name>
\end{lstlisting} \end{lstlisting}
\begin{enumerate} Prepare build variables in the \textit{variables} section of the build job
\item Type \textbf{o} to erase all former partitions file\\(\texttt{.gitlab-ci.yml} in agricola's root directory).
\item Type \textbf{p} to list all existing partitions
\item Type \textbf{n}, then \textbf{p} to create the boot partition. Press
\textbf{RETURN} to accept the first sector, then \textbf{+100M} for the
last sector
\item Type \textbf{t}, then \textbf{c} to set the partition type to FAT32
\item Type \textbf{n}, then \textbf{p} to create the root partition. Press
\textbf{RETURN} to accept the first sector, then \textbf{RETURN} for the
last sector
\item Type \textbf{w} to write the new partition table
\end{enumerate}
\subsubsection{File systems}
Create the file systems for the new partitions:
\begin{lstlisting} \begin{lstlisting}
mkfs.vfat /dev/mmcblk0p1 variables:
mkfs.ext4 /dev/mmcblk0p2 PRODUCT_NAME: "AG"
PRODUCT_VARIANT: "NA"
# PRODUCT_VARIANT: "EU"
# PRODUCT_VARIANT: "CN"
PROJECT_VERSION: "10"
SW_MAJOR: "1"
SW_MINOR: "2"
\end{lstlisting} \end{lstlisting}
Create mount points and mount the new partitions: Push the new branch to the gitlab-server:
\begin{lstlisting} \begin{lstlisting}
mkdir boot git push --set-upstream release/<release_name> origin \
mkdir root release/<release_name>
mount /dev/mmcblk0p1 boot
mount /dev/mmcblk0p2 root
\end{lstlisting} \end{lstlisting}
\subsection*{Create release tag}
\subsubsection{Download and extract root file system} A \textit{release/174\_AG...} named tag in the agricola repository at the
\begin{lstlisting} gitlab server will create a release and deploys it to the agricola project
wget http://archlinuxarm.org/os/\ svn repository. To create the tag:
ArchLinuxARM-rpi-2-latest.tar.gz
bsdtar -xpf ArchLinuxARM-rpi-2-latest.tar.gz -C root
sync
mv root/boot/* boot
\end{lstlisting}
Enable ssh root login:
\begin{lstlisting}
vim root/etc/ssh/sshd\_config
\end{lstlisting}
Find \texttt{\#PermitRootLogin yes} and uncommend it
\begin{lstlisting}
PermitRootLogin yes
\end{lstlisting}
Unmount both partitions
\begin{lstlisting}
umount boot root
\end{lstlisting}
\section{Configuration}
\subsection{User management}
\subsubsection{Create new user}
\begin{lstlisting}
useradd -m -g users -G wheel -s /bin/bash tkl
\end{lstlisting}
\begin{tabular}{ l l }
\texttt{-m} & create user name home directory\\
\texttt{-g} & initial login group\\
\texttt{-G} & list of supplementary groups - comma separated\\
\texttt{-s} & path and file name of default login shell\\
\end{tabular}\\
Set password for the new user:
\begin{lstlisting}
passwd tkl
\end{lstlisting}
Enable wheel group members as sudoers:
\begin{lstlisting}
EDITOR=vim visudo
\end{lstlisting}
Uncomment:
\begin{lstlisting}
%wheel ALL=(ALL) ALL
\end{lstlisting}
\subsection{Aliasing}
\begin{lstlisting}
cd ~
vi .bashrc
\end{lstlisting}
Add:\\
\texttt{alias vi='vim'}
\subsection{Customize vim}
Edit \texttt{.vimrc}:
\begin{lstlisting}
syntax on "Syntax highlightning
set number "Line numbering
\end{lstlisting}
\subsection{Wifi}
Configure wifi network:
\begin{lstlisting}
wifi-menu
\end{lstlisting}
Enable wifi network permanent:
\begin{lstlisting}
netctl enable wlan0-<network_name>
\end{lstlisting}
\subsubsection{Deactivate wifi device sleep mode}
\begin{lstlisting}
pacman -S iw
echo ACTION=="add", SUBSYSTEM=="net", KERNEL=="wlan*", \
RUN+="/usr/bin/iw dev \%k set power\_save off\" \
> etc/udev/rules.d/70-wifi-powersave.rules
\end{lstlisting}
\subsection{Ssh key login}
\begin{itemize} \begin{itemize}
\item Create \texttt{.ssh/} folder in users home directory \item go to agricola's gitlab tags section \\
\item Copy public key file (i.e. \texttt{id\_rsa.pub}) into \texttt{.ssh} (\texttt{https://novgit05.novero.com/agricola/agricola/tags})
folder \item Hit the \textit{+ New tag} button
\item Authorize public key: \item Choose a valid tag name \textit{(release/174\_AG...)}
\begin{lstlisting} \item Choose the above created release branch as source for the new tag.
cat id_rsa.pub >> authorized_keys \item Hit the \textit{Create tag} button
\end{lstlisting}
\end{itemize} \end{itemize}
\subsection{Interfaces}
\subsubsection{I2C}
To enable i2c interface edit \texttt{/boot/config.txt}. \\
Uncomment \texttt{\#device\_tree\_param=i2c\_arm=on}\\
Load i2c modules while boot:
\begin{lstlisting}
/etc/modules-load.d/raspberry.conf
i2c-dev
i2c-bcm2708
\end{lstlisting}
Install package \texttt{i2c-tools}
Test i2c bus after reboot:
\begin{lstlisting}
i2cdetect -y 1
\end{lstlisting}
Set permissions for i2c device access:
\begin{lstlisting}
/etc/udev/rules.d/99-i2c.rules
KERNEL=="i2c-1", MODE="0777"
\end{lstlisting}
\subsubsection{SPI}
To enable spi interface edit \texttt{/boot/config.txt}. \\
Uncomment \texttt{\#device\_tree\_param=spi=on}
\subsubsection{GPIO}
Create an udev rule to enable others than root accessing the gpio files:
\begin{lstlisting}
/etc/udev/rules.d/98-gpio.rules
SUBSYSTEM=="gpio*", PROGRAM="/bin/sh -c 'chown -R root:gpio\
/sys/class/gpio; chmod -R 0777 /sys/class/gpio; chown -R \
root:gpio /sys/devices/virtual/gpio; chmod -R 0777 \
/sys/devices/virtual/gpio'"
\end{lstlisting}
\subsection{tools}
\begin{itemize}
\item \texttt{fakeroot}
\item \texttt{gcc}
\item \texttt{git}
\item \texttt{make}
\item \texttt{patch}
\item \texttt{python2, python2-pip}
\item \texttt{wget}
\end{itemize}
\subsection{Hostname}
\begin{lstlisting}
echo "hostname" > /etc/hostname
\end{lstlisting}
\section{Applications}
\subsection{I2C-OLED}
\subsubsection{Oled Test application}
Clone test application:
\begin{lstlisting}
git clone git@dabgit01.internal.novero.com:raspberry/\
oledpi.git
\end{lstlisting}
\subsubsection{Install driver}
Clone oled driver:
\begin{lstlisting}
git clone https://github.com/rm-hull/ssd1306.git
\end{lstlisting}
Install it:
\begin{lstlisting}
python2 setup.py install
\end{lstlisting}
\subsubsection{Dependencies}
\begin{itemize}
\item \texttt{python-smbus/python2-smbus} (AUR)
\item \texttt{i2c-tool-git} (AUR)
\item \texttt{libjpeg-turbo}
\item \texttt{pillow} install using pip \texttt{(pip/pip2 install pillow)}
\end{itemize}
\subsection{Weatherpi}
\subsubsection{Usb weatherstation test application}
Clone test application:
\begin{lstlisting}
git clone git@dabgit01.internal.novero.com:raspberry/\
weatherpi.git
\end{lstlisting}
\subsubsection{Dependencies}
\begin{itemize}
\item \texttt{python2-pyusb} (AUR) (edit \texttt{PKGBUILD} and add
\texttt{'armv7h'} to \texttt{arch})
\item \texttt{libusb-compat}
\end{itemize}
\subsection{MQTT Broker}
Install mosquitto (AUR)\\
Install paho-mqtt client library:\\
\begin{lstlisting}
pip2 install paho-mqtt
\end{lstlisting}
Create config file:
\begin{lstlisting}
cp /etc/mosquitto.conf.example /etc/mosquitto.conf
\end{lstlisting}
Start mosquitto broker service:
\begin{lstlisting}
systemctl enable mosquitto.service
systemctl start mosquitto.service
\end{lstlisting}
\subsubsection{Test}
Subscribe to a topic:
\begin{lstlisting}
mosquitto_sub -t "topic/path"
\end{lstlisting}
Populate a message:
\begin{lstlisting}
mosquitto_pub -t "topic/path" -m "message payload"
\end{lstlisting}