Commit Graph

69 Commits

Author SHA1 Message Date
Pau Espin fceb8e14de doc/manuals: Swap order of schemas and config files
First explain the different config files and directories, later describe
the schemas used in each of them.

Change-Id: Iaf31808a655a5c77a1dfaa155e86d42585130820
2020-05-12 14:07:36 +02:00
Pau Espin 6c6c0e8599 Cmdline arg -c sets main configuration file (old paths.conf) instead of dir containing it
It has been notified that current configuration system is difficult to
understand and to use, so it has been envisioned to refactor it a bit.
The idea is that the user passes a -c path/to/main.conf file, which in
turn contains whatever osmo-gsm-tester main settings supports (basically
what old paths.conf used to be, plus some files harcoded to the same -c
directory are now configurable through the main configuration file).

Change-Id: Ieca65b71b543c44cfcec8e83efd0fe053c432e55
2020-05-12 14:07:29 +02:00
Pau Espin 06c82aee5c Deprecate envvar OSMO_GSM_TESTER_CONF and remove other ones
Environment variable OSMO_GSM_TESTER_CONF is marked as deprecated and an
error is logged each time it's used. Same feature is available through
"-c" command line parameters, so having the envvar only makes things
more complex for no good reason. It cannot yet be completely dropped
since some environemnt still make use of it. Give some time to users to
adapt their setups.
Other environment variables setting some config apths can be dropped
since they are not being really used in any setup.

Change-Id: I7eb69f870d0dcb5906d45ae067d6bed1aabf5862
2020-05-07 19:09:23 +02:00
Pau Espin 306373027a Allow suites to dynamically register schemas so tests can receive parameters
Change-Id: Idbe99a35993d193cd97059feb980e61ff14c67ad
2020-05-07 15:06:01 +00:00
Pau Espin 17dd270cf4 Rework README file
Drop old one in doc/ which contains lots of outadated stuff already
placed in the User Manual.
Write a new markdown README in the root directory with pointers to
places in the repo and the issue tracket, ansible setup, etc.

Change-Id: I9febe56223eaeadc9d31291dd0110a11470e3ab1
2020-05-05 19:25:33 +02:00
Pau Espin 0baa5c7269 doc: install.adoc: Correctly split optional dependencies
Change-Id: Id8b5dcd15fd86c670915b928112699d831e6e7b0
2020-05-05 19:08:13 +02:00
Pau Espin 06376b779a doc: Drop redundant app-name in install section
Change-Id: I6ec3c42efd3eb958f832ff9a797ddaa3dae4a99a
2020-05-05 18:39:44 +02:00
Pau Espin 40c7bc7765 tests: Replace 'suite' with 'tenv'
Change-Id: I777ec59ffd83b861ddc09e85e52d7a8896264b8c
2020-05-05 13:56:01 +02:00
Pau Espin f9d92f78e6 Introduce doc/examples/ directory
It contains simple usual setups to get started with osmo-gsm-tester,
such as creating a 4G network using srsLTE or a 2G network using the
osmocom stack (+ ofono modems).

Change-Id: I55d5b1152da201799af21a77ef6c562f97bd94fc
2020-04-10 19:00:14 +02:00
Pau Espin 6b8f5ae3d2 srs/amarisoft{ue,enb}: Fix b200 specific rf_dev_args
Commit 12ae6d79a5 switched the rf_dev_type
to be in lowercase but forgot to change these conditions.

Change-Id: I91d3877381b4e6343dc4aa0465e699341ed6648d
2020-04-07 18:51:59 +02:00
Pau Espin 69488f6d8a Move suites/ dir inside example/
example/paths.conf and documentation are updated accordingly.

Test suites should have been moved a long time ago, since the they are
user or setup-specific based on what needs to be tested.

Change-Id: I154b19979b545deba8b232b60172903f63fd9e28
2020-04-07 16:12:47 +00:00
Pau Espin b99b0f308c doc/manuals: Introduce chapter explaining config data mangling
Explains how configurations bits are arranged and mangled to provide a
last config set.

Change-Id: I5c8f136e743b6beb02956b3436aa3d1010205141
2020-03-17 20:20:34 +01:00
Pau Espin c1220e1418 doc/manuals: Several format and styles fixes for config.adoc
Change-Id: I6371e09d6d88f137e7611bd60ac97b86414d8c47
2020-03-16 19:50:40 +01:00
Pau Espin 8ccd99a3a9 doc/manuals: Add proper content for Debugging section
Change-Id: Iaed2544d59f7c5dd69eef3ddfade544b35c837cd
2020-03-16 19:48:02 +01:00
Pau Espin cc0ad7dc78 doc/manuals: Introduce Troubleshooting section about SIGKILL fix
Add a section describing how to clean up and recover osmo-gsm-tester
state after a sigkill is used.

Change-Id: I4841ab6d44a122140e6352df1fb6543418adc033
2020-03-16 19:03:46 +01:00
Pau Espin 71a54fbf81 doc/manuals: Fix title out of sequence
asciidoc: WARNING: install.adoc: line 450: section title out of sequence: expected level 3, got level 4

Change-Id: I0c881405e66cc6815533bb884016db20cfdff3dc
2020-03-14 19:20:05 +01:00
Pau Espin 7dc2216071 doc/manuals: Write section explaining parametrized scenarios
Change-Id: I04b7fa46c2a282095bbb8f6d69ade87ff86f910c
2020-03-12 17:50:06 +00:00
Pau Espin 94622f12d9 doc/manuals: Write proper content for Ansible Setup section
Change-Id: Iffd3beefa50dd5f18908b4c3f7e4deb169feca62
2020-03-12 17:50:06 +00:00
Pau Espin bff90dce73 doc/manuals: Write proper content for Docker Setup section
Change-Id: Ie883adbf03a3b5c9a852182c01d15a212749ce04
2020-03-12 17:50:06 +00:00
Pau Espin 7e0b2ddfb8 doc/manual: Refactor, rewrite, improve and update most of the User Manual
* Some TODOs are added as comments which actually require code changes.
  These are details which showed up as incongruences or missing bits
  while writing the documentation for them.

* Some sections are introduced but still waiting to be writen soon:
** Debugging section
** Docker Setup section
** Ansible Setup section
** Troubleshooting (add jenkins red cross button sending kill -9)
** resources.conf attribute list needs to be converted to a table

* Device related setup needs to be updated and extended
* Parametrized scenarios need to be documented
* 4G resources documentation needs to be added.

Change-Id: Ifc2a3c74d45336cc988b76c0ff68a85311e4dd40
2020-03-12 17:50:06 +00:00
Holger Hans Peter Freyther 3c2dd3e13b doc: Update list of dependencies and add pysispm one
Change-Id: I05cc63bfd627bfec83b50fe89fe8004d130384e6
2019-02-19 09:34:09 +00:00
Oliver Smith 5ed6f6ce11 doc/manuals: integrate into this repository
Update .gitignore and make the manuals build without a toplevel
configure.ac file from autotools:

$ cd doc/manuals
$ make

Related: OS#3385
Change-Id: I5916bc7e656b508fc74917e79841ce7e1ee4981b
2018-11-29 10:42:34 +01:00
Oliver Smith 41af859af6 build manuals moved here from osmo-gsm-manuals.git
Moved to doc/manuals/, with full commit history, in preceding merge commit.
Now incorporate in the build system.

Build with:

$ autoreconf -fi
$ ./configure --enable-manuals
$ make

Shared files from osmo-gsm-manuals.git are found automatically if
- the repository is checked out in ../osmo-gsm-manuals; or
- if it osmo-gsm-manuals was installed with "make install"; or
- OSMO_GSM_MANUALS_DIR is set.

Related: OS#3385
Change-Id: I8a34871948425ea40f40dbb11a59806905e4bed1
2018-11-28 17:15:55 +01:00
Neels Hofmeyr 09b0b24093 Merge history from osmo-gsm-manuals.git 2018-11-28 17:15:42 +01:00
Pau Espin 4c47659fb5 OsmoGSMTester: Update import test->testenv
Latest changes in osmo-gsm-tester require this import change.

Depends on: osmo-gsm-tester I520bd046cb09042b5567d967f951f050e4e02e85

Change-Id: I0f7f7d0353014b7ef8a0c5a7707c91b2613be79a
2018-11-28 17:15:34 +01:00
Pau Espin e617d2a844 OsmoGsmTester: Put several permission categories under cat User Permission
Change-Id: Ie9f846af0311d768c5dd6f9da572c8f6482f4d39
2018-11-28 17:15:34 +01:00
Pau Espin 21f2b8f129 OsmoGSMTester: Add state_dir section
Change-Id: Ie12e3933747a4e698de59ff9ac57281e9f261d3d
2018-11-28 17:15:34 +01:00
Pau Espin dfdb7033c3 OsmoGSMTester: Add suites_dir section
Change-Id: Ie25fd742f484981f5e5b25397c2637eda38f0424
2018-11-28 17:15:34 +01:00
Pau Espin 6131f35c80 OsmoGSMTester: Add scenarios_dir section
It explains how scenario combination works

Change-Id: I3f89bd3d71400da14cda7ea8bb9c190fe80a539f
2018-11-28 17:15:34 +01:00
Pau Espin 0b512ba1b9 OsmoGSMTester: Improve Trial section content
Change-Id: I8d74b02166ea33ad9ab7f987894f4f02064fbebc
2018-11-28 17:15:34 +01:00
Pau Espin 6fa6199237 OsmoGSMTester: Update defaults.conf example
Change-Id: If12df88b4088ecec6d6cb20c83a693c019b8af4a
2018-11-28 17:15:34 +01:00
Pau Espin 122306cf57 OsmoGSMTester: Remove resolved TODO
Change-Id: Ie0f18293e566a690d2434d08cbaaf2fdf71d88e4
2018-11-28 17:15:34 +01:00
Pau Espin 264829e136 OsmoGSMTester: Update resources cfg documentation
Change-Id: I6ec9fc5468ce6ead52d9c8b35d8991cac4bfa97e
2018-11-28 17:15:34 +01:00
Pau Espin 8ad5e6abbc OsmoGSMTester: Document how to setup main unit to set CAP_NET_RAW as
non-root

Change-Id: I011beaa929efcabe9a9dc4f9c7222ba36fa2aae4
2018-11-28 17:15:34 +01:00
Pau Espin 68ac2401d4 OsmoGSMTester: Move TODO comment to a redmine task
Following task has been created: OS#2612

Change-Id: I79837e49f3e6af4254e9f0c7f53037eae66cda6d
2018-11-28 17:15:34 +01:00
Pau Espin f5c83dae62 OsmoGSMTester: Installation: change some confusing terminology
It's difficult to understand when it referrs to jenkins job in general
and when it talks about specific jenkins jobs that builds binaries required for
osmo-gsm-tester and the ones which run osmo-gsm-tester.

As a result, it's difficult to understand which sections apply to each
host in case more than one host is used.

Change-Id: I5c882e77b469629028b8d773053783e18f3d1737
2018-11-28 17:15:34 +01:00
Pau Espin 1ba1f5aa7b OsmoGSMTester: Add deps required for osmo-bts-octphy support
Change-Id: I384ec8cd55cfaa68ee1f461de99ceac78c5d8414
2018-11-28 17:15:34 +01:00
Pau Espin accd74fb0a OSmoGsmTester: Specify group in Main unit intro
Change-Id: I132bf7681a1a435c161c4048e41c28dc75c1fa28
2018-11-28 17:15:34 +01:00
Pau Espin 627aea5142 OsmoGSMTester: Explain patchelf is used sometimes to modify RPATH
Change-Id: I7bb811bc984c8d576984b038b391cf8130cc465e
2018-11-28 17:15:34 +01:00
Pau Espin 3ed0391ab3 OsmoGSMTester: Update suite.conf example
This is the one we are usig nowadays in suite.conf, which explicitly
asks to be run with modems supporting sms features.

Change-Id: If5dbc3b4689b282db6fae4668e2838be59e88da8
2018-11-28 17:15:34 +01:00
Pau Espin c9cbbc6f38 OsmoGSMTester: Use a more up-to-date resources.conf example
It showcases new features such as osmo-trx support, cipher support,
modem features support, etc.

Change-Id: I66bbcd028f03290797c2c467271d0f0982698b47
2018-11-28 17:15:34 +01:00
Pau Espin dc53c9c466 OsmoGSMTester: Improve Resource Resolution section content
Change-Id: Ice37093dc9f8e03a2a9f5e3f7df79d1b589b6991
2018-11-28 17:15:34 +01:00
Pau Espin c8cd1fa7c5 OsmoGSMTester: Update sample test script with an AoIP example
Change-Id: I7978c7e96c8f1d43837271c94dd64893649974e0
2018-11-28 17:15:34 +01:00
Pau Espin cb474072ca OsmoGSMTester: Update trial graph with current data
The osmo-bts-trx tgz doesn't exist anymore and it does not contain
osmo-trx, which comes in its own tgz.

Change-Id: Id803eca3791137b04bc24d195119d5c511fcfc49
2018-11-28 17:15:34 +01:00
Pau Espin 48d2564f2c OsmoGSMTester: Improve setup graph
* Add sysmocell5000
* Remove 1 modem, showing 2 of them is enough
* Split osmo-bts-trx from osmo-trx node as sysmocell500 doesn't use the
later.
* Update OsmoNITB node to show we also support split openbsc.git
components.

Change-Id: I893beb114d47edd3f67183dd9ea5acc19462496c
2018-11-28 17:15:33 +01:00
Neels Hofmeyr 607229a775 refactor Makefile build rules, don't use the FORCE
The initial goal was to make sure we don't have overall FORCE rules causing
unnecessary rebuilds -- annoying while writing documentation. As I looked
through possible dependencies, I finally understood what's going on here.

Remove code dup and nicely sort which belongs where in build/Makefile.*.inc. In
each, describe in a top comment how to use it, and also unify how they are
used:

- Rename Makefile.inc to Makefile.docbook.inc and refactor
- Add Makefile.vty-reference.inc
- Add Makefile.common.inc

Make sure that we accurately pick up all dependencies.

Drop use of the macro called 'command', that silenced the actual command lines
invoked and replaced them with short strings: it obscures what is actually
going on and makes the Makefiles hard to read and understand.

Each manual's makefile is greatly reduced to few definitions and a Makefile
include, e.g. one for asciidoc, one for VTY reference.

Move common/bsc_vty_additions.xml to OsmoBSC/vty/libbsc_vty_additions.xml, link
from OsmoNITB. It applies only to OsmoBSC and OsmoNITB.

Add a script that combines a VTY reference file with *all* additions files
found in a manual's vty/ dir. Call this from Makefile.vty-reference.inc.

Change-Id: I9758e04162a480e28c7dc83475b514cf7fd25ec0
2018-11-28 17:15:33 +01:00
Neels Hofmeyr 7468953045 OsmoGSMTester: document logrotate maxsize
Change-Id: Ib3e7143eb5d90eea4860a0a334da25efe926a231
2018-11-28 17:15:33 +01:00
Pau Espin 018e1048b4 OsmoGsmTester: Move coredump section and add reference to kernel.core_pattern sysctl
This section is moved further below in order to have it after section
which explains how to create user jenkins and osmo-gsm-tester group, as
we need this group already created anyway for the config to work
correctly.

Change-Id: I5bdde0a9960f9806f081e9a876b8b66db9e7f37c
2018-11-28 17:15:33 +01:00
Max be69b6b183 OsmoGSMTester: use proper systemd service names
* use osmo-bts-sysmo for sysmoBTS systemd service name which is available
  since 114293a414bd5b7c86622ec8c293c4034c80d243
* use osmo-pcu for OsmoPCU systemd service name which is available since
  241f5bcb00f9c6fee4200a3aea9aa497bf0d3eee

Change-Id: Ie017946b9099460ac6758ff84ec7a10df13390a1
2018-11-28 17:15:33 +01:00
Neels Hofmeyr 3f596ed018 osmo-gsm-tester: jenkins fixes: install JDK, SSH instructions
Add instructions to install Java JDK for jenkins build slave.
Minor fixes to SSH key instructions.

Change-Id: Ib2c1adc2ddee3be016e4d253451593b19dbe133a
2018-11-28 17:15:33 +01:00