Commit Graph

38 Commits

Author SHA1 Message Date
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
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 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
Neels Hofmeyr 8d8a136aec OsmoGSMTester: update run-job post-build artifact archiving rule
Change-Id: I73c1a6793369604cbe494c83b595a4130a44adc9
2018-11-28 17:15:33 +01:00
Pau Espin b825f790d7 OsmoGsmTester: install.adoc: Remove trailing whitespace
My editor is removing it automatically.

Change-Id: I25c8d179a21c66ab3424204e12215f8e1ddd8e54
2018-11-28 17:15:33 +01:00
Pau Espin 8d72cd68c1 OsmoGsmTester: Add missing dependency python-smpplib
Change-Id: I9a6ad33d41c8a90317d079ff0d1f9640c48a2353
2018-11-28 17:15:33 +01:00
Pau Espin 422f8bae65 OsmoGsmTester: Update sample test script
Copied from newest mo_mt_sms.py test.

Change-Id: I49644f6f8223d45bccbcbb3aa8325c20c06dcdbe
2018-11-28 17:15:33 +01:00
Neels Hofmeyr ee57f0952a OsmoGSMTester: tweak sysmobts: systemctl, ssh, limits, reboot
Simpler systemctl rule to disable stock services.

Fix the limits config, which was not the right way for sysmoBTS.

SSH access: apparently no need to create an ssh key at all, login is permitted
right away.

Add hint to reboot at the right time.

Change-Id: I8e686383318ee2eece908a4e690e5061ade0cd02
2018-11-28 17:15:33 +01:00
Neels Hofmeyr 9711069e53 OsmoGSMTester: add sqlite3 as dependency
Needed to setup the initial hlr db using the hlr.sql file from osmo-hlr
since osmo-gsm-tester commit 798e592fd6
"MSC+BSC: add test api to run OsmoMSC and OsmoBSC with AoIP"

Change-Id: Ic19f93a69df4062364da8523b5d30a1611a0eb77
2018-11-28 17:15:33 +01:00
Neels Hofmeyr 05eb779ce9 OsmoGSMTester: add rtprio conf, tweak core dump conf
Change-Id: I284c3bfb15e914f1f6ab00f15874fe5ea6190c5c
2018-11-28 17:15:33 +01:00
Neels Hofmeyr 5d0330fa45 apply rename of resource nitb_iface to ip_address
See osmo-gsm-tester change-id I829903d7b2111ab5ee106bce52d6121204a5a401

Change-Id: Icbbb7d921e7340739883650f778d5a7341840875
2018-11-28 17:15:33 +01:00
Neels Hofmeyr 7b8dbd81f2 OsmoGSMTester: say 'modems', not 'modem' (sounds like it supports only one)
Change-Id: Ib59788a50754ea5290e665a9f9376d70e01c9be5
2018-11-28 17:15:33 +01:00
Neels Hofmeyr b52df17e8b OsmoGSMTester: add install docs; fixes and tweaks
Change-Id: I574937dbf31bce49cfb7523f91041c20fecb421e
2018-11-28 17:15:33 +01:00
Neels Hofmeyr 73207e1cee OsmoGSMTester: add / tweak overview graphs
Some mistakes fixed (missing osmo-trx, B200 pointing at NITB instead of
osmo-bts-trx)

Add graph showing resource selection.

Add graph showing a trial dir.

Change-Id: I1cfcd99ee11b851095a75107246cb156ede7f4cf
2018-11-28 17:15:33 +01:00
Neels Hofmeyr c0827c4287 cosmetic: OsmoGSMTester: fix dir name
All other subdirs are without dashes, but I added Osmo-GSM-Tester with dashes.
Comply with the naming scheme and remove dashes.

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