Change in osmo-gsm-tester[master]: doc/manuals: Write proper content for Ansible Setup section

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

pespin gerrit-no-reply at lists.osmocom.org
Thu Mar 12 17:50:07 UTC 2020


pespin has submitted this change. ( https://gerrit.osmocom.org/c/osmo-gsm-tester/+/17465 )

Change subject: doc/manuals: Write proper content for Ansible Setup section
......................................................................

doc/manuals: Write proper content for Ansible Setup section

Change-Id: Iffd3beefa50dd5f18908b4c3f7e4deb169feca62
---
M doc/manuals/chapters/ansible.adoc
1 file changed, 52 insertions(+), 2 deletions(-)

Approvals:
  pespin: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/doc/manuals/chapters/ansible.adoc b/doc/manuals/chapters/ansible.adoc
index b672528..4c80723 100644
--- a/doc/manuals/chapters/ansible.adoc
+++ b/doc/manuals/chapters/ansible.adoc
@@ -1,6 +1,56 @@
 [[ansible]]
 == Ansible Setup
 
-Available in osmocom's osmo-ci.git subdirectory 'ansible/', see there 'gsm-tester/README.md'.
+Since the set of steps to set up a full {app-name} environment can be quite long
+and tedious, nowadays the Osmocom RnD and Production {app-name} setups are
+installed and maintained using Ansible scripts. The set of ansible scripts is
+available  in Osmocom's git repository
+link:https://git.osmocom.org/osmo-ci/[osmo-ci.git] under 'ansible' subdirectory,
+with the rest of ansible scripts to set jenkins slaves, etc.
 
-//TODO: Explain more where to find, how to build, how to use.
+Since these set of scripts is mainly aimed at Osmocom's own setup, and debian is
+used there, so far only debian hosts are supported officially, though patches to
+support other distributions are welcome.
+
+In there, the 'setup-gsm-tester.yml' file is responsible of doing all required
+steps to set up a host to become either a <<install_main_unit,Main Unit>> or a a
+<<install_slave_unit,Slave Unit>>. The ansible file can be run as follows:
+----
+$ ansible-playbook -i hosts setup-gsm-tester.yml
+----
+
+You will need root-alike access in the remote host in order to let ansible
+install everything {app-name}, however, no root-specific user is required as
+long as your remote user has sudo access on that host. If that's your case, add
+the following parameters to 'ansible-playbook':
+----
+$ ansible-playbook -i hosts -b -K -u your_remote_user setup-gsm-tester.yml
+----
+
+The 'setup-gsm-tester.yml' file is mostly an aggregator of tasks. Most
+{app-name} related tasks can be found under subdirectory 'roles/gsm-tester-*'.
+
+Since different (for instance Production vs RnD) can have different
+characteristics, some per-host variables can be found under directory
+host_vars/, specifying for instance the number of expected modems attached to
+the Main Unit, the DHCP server static leasing for devices, etc.
+
+The different tasks usually have tags to differentiate which kind of {app-name}
+host they are required by. They are also set to differentiate sets of tasks
+required if a specific feature is being used in the host (for instance, willing
+to manage modems with ofono). This allows playing with the '-t' and
+'--skip-tags' when running 'ansible-playbooks' in order to run specific set of
+tasks on each host.
+
+For instance, to run tasks required to set up a Slave Unit, one can run:
+----
+$ ansible-playbook -i hosts setup-gsm-tester.yml -t osmo-gsm-tester-proc
+----
+
+To run all modem-related tasks:
+----
+$ ansible-playbook -i hosts setup-gsm-tester.yml -t modem
+----
+
+Don't forget to read all README.md files available in different subdirectories
+to find out more detailed information on how to run the scripts.

-- 
To view, visit https://gerrit.osmocom.org/c/osmo-gsm-tester/+/17465
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-tester
Gerrit-Branch: master
Gerrit-Change-Id: Iffd3beefa50dd5f18908b4c3f7e4deb169feca62
Gerrit-Change-Number: 17465
Gerrit-PatchSet: 2
Gerrit-Owner: pespin <pespin at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: pespin <pespin at sysmocom.de>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20200312/ab9bc117/attachment.htm>


More information about the gerrit-log mailing list