<p>pespin has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-gsm-tester/+/17464">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">doc/manuals: Write proper content for Docker Setup section<br><br>Change-Id: Ie883adbf03a3b5c9a852182c01d15a212749ce04<br>---<br>M doc/manuals/chapters/docker.adoc<br>1 file changed, 52 insertions(+), 2 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-tester refs/changes/64/17464/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/manuals/chapters/docker.adoc b/doc/manuals/chapters/docker.adoc</span><br><span>index b7560e1..bc8ad00 100644</span><br><span>--- a/doc/manuals/chapters/docker.adoc</span><br><span>+++ b/doc/manuals/chapters/docker.adoc</span><br><span>@@ -1,6 +1,56 @@</span><br><span> [[docker]]</span><br><span> == Docker Setup</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-Available in osmocom's docker-playground.git subdirectory 'osmo-gsm-tester/'.</span><br><span style="color: hsl(120, 100%, 40%);">+A sample {app-name} setup based on docker containers and maintained by the</span><br><span style="color: hsl(120, 100%, 40%);">+Osmocom community is available in Osmocom's git repository</span><br><span style="color: hsl(120, 100%, 40%);">+link:https://git.osmocom.org/docker-playground/[docker-playground.git], under</span><br><span style="color: hsl(120, 100%, 40%);">+'osmo-gsm-tester' subdirectory. In there, one can find:</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-//TODO: Explain more where to find, how to build, how to use.</span><br><span style="color: hsl(120, 100%, 40%);">+- A 'Dockerfile' file can be found which builds a docker image which can</span><br><span style="color: hsl(120, 100%, 40%);">+be used both to run as an osmo-gsm-tester <<install_main_unit,Main Unit>> or as</span><br><span style="color: hsl(120, 100%, 40%);">+a <<install_slave_unit,Slave Unit>>. The main difference to use it as one or the</span><br><span style="color: hsl(120, 100%, 40%);">+other is whether osmo-gsm-tester.py is run on it (Main Unit) or otherwise sshd</span><br><span style="color: hsl(120, 100%, 40%);">+(Slave Unit). A convenience script is provided in the same directory to start</span><br><span style="color: hsl(120, 100%, 40%);">+the processes just explained ('osmo-gsm-tester-{master,slave}.sh').</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+- A 'jenkins.sh' file is provided which handles all the</span><br><span style="color: hsl(120, 100%, 40%);">+magic to start a Main Unit and a Slave Unit on the same docker private network</span><br><span style="color: hsl(120, 100%, 40%);">+so they can interact. It also takes care on running the docker containers with</span><br><span style="color: hsl(120, 100%, 40%);">+all the required permissions, mount all virtual filesystem bindings, etc.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+- A sample <<resources_conf,resources.conf>> file is provided which</span><br><span style="color: hsl(120, 100%, 40%);">+provides some virtual resources configured to be run on the Slave Unit.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The 'jenkins.sh' script expects the <<trials, trial directory>> to be in</span><br><span style="color: hsl(120, 100%, 40%);">+'/tmp/trial', and will bind that directory to the docker Main Unit instance so</span><br><span style="color: hsl(120, 100%, 40%);">+osmo-gsm-tester uses it. Hence, one must place a the trial to be run in there</span><br><span style="color: hsl(120, 100%, 40%);">+before running the setup. There is yet no specific docker container available to</span><br><span style="color: hsl(120, 100%, 40%);">+build trials, but one can re-use an Osmocom jenkins slave container available to</span><br><span style="color: hsl(120, 100%, 40%);">+in 'docker-playground.git' in order to build them using the scripts in</span><br><span style="color: hsl(120, 100%, 40%);">+'osmo-gsm-tester.git/contrib/jenkins-build-*.sh'. Alternatively, the quick way</span><br><span style="color: hsl(120, 100%, 40%);">+is to get them from any of the Osmocom's {app-name}</span><br><span style="color: hsl(120, 100%, 40%);">+link:https://jenkins.osmocom.org/jenkins/view/osmo-gsm-tester/[jenkins jobs],</span><br><span style="color: hsl(120, 100%, 40%);">+which store them as artifacts.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+When running the whole setup through the 'jenkins.sh' script, standard out</span><br><span style="color: hsl(120, 100%, 40%);">+('stdout') and standard error ('stderr') outputs for each docker container are</span><br><span style="color: hsl(120, 100%, 40%);">+made available to the host running the script, under '/tmp/logs' directory.</span><br><span style="color: hsl(120, 100%, 40%);">+Results generated by {app-name}'s last run can be found as usual under the trial</span><br><span style="color: hsl(120, 100%, 40%);">+directory ('/tmp/trial/last_run').</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The {app-name} git revision being checked out to build and run inside the</span><br><span style="color: hsl(120, 100%, 40%);">+docker containers can be selected by setting the 'OSMO_GSM_TESTER_BRANCH'</span><br><span style="color: hsl(120, 100%, 40%);">+environment variable. For instance, to install and run branch 'mybranch' in</span><br><span style="color: hsl(120, 100%, 40%);">+'osmo-gsm-tester.git', one can use:</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+export OSMO_GSM_TESTER_BRANCH=mybranch</span><br><span style="color: hsl(120, 100%, 40%);">+./jenkins.sh</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Specific command line parameters to be passed to {app-name} process inside the</span><br><span style="color: hsl(120, 100%, 40%);">+Main Unit docker container instance can be set with the 'OSMO_GSM_TESTER_OPTS'</span><br><span style="color: hsl(120, 100%, 40%);">+environment variable. For instance, to run suite '4g' with debug logging level:</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+export OSMO_GSM_TESTER_OPTS="-s 4g -l dbg"</span><br><span style="color: hsl(120, 100%, 40%);">+./jenkins.sh</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-gsm-tester/+/17464">change 17464</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmo-gsm-tester/+/17464"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-gsm-tester </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Ie883adbf03a3b5c9a852182c01d15a212749ce04 </div>
<div style="display:none"> Gerrit-Change-Number: 17464 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: pespin <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>