release howto for pike blue

Makefile

@@ -3,13 +3,16 @@ SRC := config/$(basename $(MAIN)).tex
 DEP := \
 	config/headfoot.tex	\
 	config/sourcelst.tex	\
-	config/titlepage.tex	\
 	content.tex		\
-	title.tex		\
 	Makefile
 
 all: $(MAIN)
 
+one_page: $(DEP)
+	@latex config/framework_one_page.tex
+	latex config/framework_one_page.tex
+	dvipdf framework_one_page.dvi framework_one_page.pdf
+
 clean:
 	rm -f \
 	$(basename $(MAIN)).aux \
@@ -17,7 +20,8 @@ clean:
 	$(basename $(MAIN)).log \
 	$(basename $(MAIN)).out \
 	$(basename $(MAIN)).toc \
-	$(MAIN)
+	$(MAIN)			\
+	framework_one_page.*
 
 $(MAIN): $(DEP)
 	@latex $(SRC)

config/framework.tex

@@ -40,5 +40,6 @@ citecolor = black]{hyperref}%
 \input{config/headfoot.tex}
 \newpage
 \input{content.tex}
+\lstsetdefault
 \end{document}
 

config/framework_one_page.tex

@@ -0,0 +1,40 @@
+\documentclass[a4paper,12pt,oneside]{article}%
+\usepackage[utf8]{inputenc}%
+\usepackage[T1]{fontenc}%
+\usepackage{caption}%
+\usepackage{placeins}%
+\usepackage{graphicx}%
+\usepackage[colorlinks,
+pdfpagelabels,
+pdfstartview = FitH,
+bookmarksopen = true,
+bookmarksnumbered = true,
+linkcolor = black,
+plainpages = false,
+hypertexnames = false,
+citecolor = black]{hyperref}%
+
+\usepackage{amsmath}%
+\usepackage{amssymb}%
+\usepackage{amstext}%
+\usepackage{amsfonts}%
+\usepackage{mathrsfs}%
+\usepackage{hyperref}%
+\usepackage{xcolor}%
+\usepackage{scrpage2}%
+
+\newcommand*\euler{\mathrm{e}}
+%\input{title.tex}
+\input{config/font.tex}
+\input{config/sourcelst.tex}
+
+\begin{document}
+\clearscrheadfoot
+\clearscrplain
+\clearscrheadings
+\pagestyle{scrheadings}		% switch on head and foot line
+\input{config/headfoot.tex}
+\lstsetdefault
+\input{content.tex}
+\end{document}
+

config/headfoot.tex

@@ -2,6 +2,6 @@
 %\ihead{\includegraphics[scale=0.16]{config/novero_logo_web_500px.eps}}
 \ohead{\today}
 \setheadsepline{1pt}
-\ofoot{\pagemark}
+%\ofoot{\pagemark}
-\setfootsepline{1pt}
+%\setfootsepline{1pt}
 

config/sourcelst.tex

@@ -1,6 +1,18 @@
 \usepackage{listings}%
 \usepackage{courier}%
 
+\newcommand{\lstsetdefault}
+{\lstset
+{
+language=bash,
+tabsize=4,
+frame=single,
+basicstyle=\ttfamily\small,
+commentstyle=\color{black},
+keywordstyle=\color{black}
+}
+}
+
 \newcommand{\lstsetc}
 {\lstset
 {

content.tex

@@ -1,241 +1,46 @@
-\section{Installation}
+\section*{Pike Blue Release HowTo}
-\subsection{SD card preparation}
+\subsection*{Internal release}
-\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 the pike blue project svn
+repository (\texttt{http://dabsvn01.internal.novero.com/svn/\ \\
+0\_31X\_P0610\_pike\_blue/trunk/development/software/\ \\
+releases/release\_candidate/}).\\
+The branch can be created eiter by gitlab ui or locally.
+\subsubsection*{Local}
+Checkout the new release branch:
 \lstsetbash
 \begin{lstlisting}
-fdisk /dev/mmcblk0
+git checkout -b release/<release_name>
 \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 pike blue'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}
-mkfs.vfat /dev/mmcblk0p1
+variables:
-mkfs.ext4 /dev/mmcblk0p2
+  PRODUCT_NAME: "PI"
+  PRODUCT_VARIANT: "CX"
+  PROJECT_VERSION: "20"
+  SW_MAJOR: "1"
+  SW_MINOR: "0"
 \end{lstlisting}
-Create mount points and mount the new partitions:
+Push the new branch to the gitlab-server:
 \begin{lstlisting}
-mkdir boot
+git push -u origin release/<release_name>
-mkdir root
-mount /dev/mmcblk0p1 boot
-mount /dev/mmcblk0p2 root
 \end{lstlisting}
-
+\subsection*{External release}
-\subsubsection{Download and extract root file system}
+A \textit{release/\_PI\_CX\_20...} named tag in the pike blue repository at the
-\begin{lstlisting}
+gitlab server will create a release and deploys it to the pike blue project
-wget http://archlinuxarm.org/os/\
+svn repository (\texttt{http://dabsvn01.internal.novero.com/svn/\ \\
-ArchLinuxARM-rpi-2-latest.tar.gz
+0\_31X\_P0610\_pike\_blue/trunk/development/software/\ \\
-bsdtar -xpf ArchLinuxARM-rpi-2-latest.tar.gz -C root
+releases/release/}).\\
-sync
+The tag can be created eiter by gitlab ui or locally. 
-mv root/boot/* boot
+\subsubsection{Gitlab UI}
-\end{lstlisting}
+To create the tag:
-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}
-\item Create \texttt{.ssh/} folder in users home directory
+\item go to the pike blue gitlab tags section \\
-\item Copy public key file (i.e. \texttt{id\_rsa.pub}) into \texttt{.ssh}
+(\texttt{https://novgit05.novero.com/Pike/Blue/tags})
-folder
+\item Hit the \textit{+ New tag} button
-\item Authorize public key:
+\item Choose a valid tag name \textit{(release/PI\_CX\_20...)}
-\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}
 
-\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}