Commit Graph

581 Commits

Author SHA1 Message Date
Pau Espin 63058b1722 OsmoGsmTester: Put several permission categories under cat User Permission
Change-Id: Ie9f846af0311d768c5dd6f9da572c8f6482f4d39
2017-11-29 11:54:40 +00:00
Pau Espin 5e67f555ac OsmoGSMTester: Add state_dir section
Change-Id: Ie12e3933747a4e698de59ff9ac57281e9f261d3d
2017-11-29 11:54:40 +00:00
Pau Espin 808db8625a OsmoGSMTester: Add suites_dir section
Change-Id: Ie25fd742f484981f5e5b25397c2637eda38f0424
2017-11-29 11:54:40 +00:00
Pau Espin e357194c2e OsmoGSMTester: Add scenarios_dir section
It explains how scenario combination works

Change-Id: I3f89bd3d71400da14cda7ea8bb9c190fe80a539f
2017-11-29 11:54:40 +00:00
Max 91c4274c7d rate_ctr: clarify ctrl interface
Clarify introspection over ctrl interface and request for individual
rate counter.

Change-Id: I3d258aaafc381644be2f16b51e4dc655c1fb9b26
2017-11-28 19:04:22 +01:00
Holger Hans Peter Freyther 01fa9856ca osmocomBB: Begin with a manual for the "mobile" application
Begin with manual for the layer23 ("mobile") application but focus
on the scripting code first.

Change-Id: I736f2d61650feac70b6d960811b478639aa71737
2017-11-28 07:01:39 +00:00
Max bb466ee020 Update rate_ctr description
* use example new counter names with ':' separator
* mention that 'counter' is obsolete
* mention group name and index
* use bold and monospace fonts to improve visibility

Change-Id: Ia962367bb93cb826002db6c950d23ae2102ac713
Related: OS#2550
2017-11-27 16:44:06 +00:00
Philipp Maier df58937574 common: add osmo-mgw to mgcp
Add osmo-mgw to the list of programs which use the MGCP port IETF

Change-Id: Idfd0340297ddb15494b4b20d776e89e6288107e1
2017-11-24 10:24:23 +01:00
Philipp Maier f9fbe955af common: add VTY port number of osmo-mgw
osmo-mgw currently uses the VTY port constant of
osmo-bsc_mgcp. We decided to re use the same port
number for osmo-mgw, this is not mentioned in the
manuals yet.

Add the port number of osmo-mgw to the manuals
(common)

Change-Id: I41f7f2a7f850613707eddea610557b688de7a904
2017-11-24 10:24:23 +01:00
Philipp Maier 4e24daf908 Revert "common: add VTY port number for osmo-mgw"
We agreed to re-use the port of osmo-bsc-mgcp, so there is
no need for this patch anymore.

This reverts commit ad4a01e2a4.

Change-Id: I8629db5e975cc218c80c747a39c0fdca5f5d6e10
2017-11-24 10:24:23 +01:00
Neels Hofmeyr c7da0d6a60 install doc: add asciidoc-dblatex dep
On debian 9, apparently asciidoc-dblatex needs to be installed manually in
order to be able to generate PDFs. Add asciidoc-dblatex dep to INSTALL.txt.

Change-Id: I24b606016e7f1c03bd73a3b0cf4fa3e5b89eb192
2017-11-20 21:39:34 +00:00
Neels Hofmeyr 57c4d5a13a OsmoGGSN: typo: priveleges
Change-Id: Id7e59f5dfcbb632fde6c35ef014e9b85099fe06d
2017-11-20 20:49:13 +00:00
Neels Hofmeyr ea343bae7e OsmoGGSN: add Routing section for IP forward and masquerading
Change-Id: Ie49ca7a45113f49e89ce09017500008cbec757f5
2017-11-20 15:14:40 +01:00
Neels Hofmeyr 5ee9d2edfd OsmoGGSN: multiple instances: mention GTP port
Change-Id: I781feeb955ace17d93206bc98d12bc423584ce32
2017-11-20 10:26:48 +00:00
Neels Hofmeyr 58977d8796 OsmoGGSN: more info on non-root operation / tun creation
Add examples for 'ip addr add' and mention correspondence to config file,
add examples for enabling masquerading and IP forwarding,
place the non-root config in its own section and highlight the diffs.

Add tiny hint at systemd-networkd.

Change-Id: I02bd9cfa35c7f2fb338d5d92c2e968fe80574a78
2017-11-20 10:26:48 +00:00
Max 5625fcf76f Fix build with default paths
If LIBOSMO_DIR is not set explicitly than ~/source/gsm/libosmocore is
used which is base for MERGE_DOC which is used by
vty_reference_combine.sh as it is. If the shell used by
vty_reference_combine.sh does not expand ~ than the build will
fail. Let's be nice and use realpath on MERGE_DOC before giving it to
vty_reference_combine.sh to make sure complete path is used.

Change-Id: I2edf64348502cbe498d9fd27a686c712b044c926
2017-11-20 09:21:47 +00:00
Pau Espin 5c6f783d60 OsmoGSMTester: Improve Trial section content
Change-Id: I8d74b02166ea33ad9ab7f987894f4f02064fbebc
2017-11-12 14:21:04 +00:00
Pau Espin 3fec854984 OsmoGSMTester: Update defaults.conf example
Change-Id: If12df88b4088ecec6d6cb20c83a693c019b8af4a
2017-11-12 14:21:04 +00:00
Pau Espin 89b555beeb OsmoGSMTester: Remove resolved TODO
Change-Id: Ie0f18293e566a690d2434d08cbaaf2fdf71d88e4
2017-11-12 14:21:04 +00:00
Pau Espin 5e641c78de OsmoGSMTester: Update resources cfg documentation
Change-Id: I6ec9fc5468ce6ead52d9c8b35d8991cac4bfa97e
2017-11-12 14:21:04 +00:00
Pau Espin 274fe3733b OsmoGSMTester: Document how to setup main unit to set CAP_NET_RAW as
non-root

Change-Id: I011beaa929efcabe9a9dc4f9c7222ba36fa2aae4
2017-11-12 14:21:04 +00:00
Pau Espin 16f5d075d1 OsmoGSMTester: Move TODO comment to a redmine task
Following task has been created: OS#2612

Change-Id: I79837e49f3e6af4254e9f0c7f53037eae66cda6d
2017-11-12 14:21:04 +00:00
Pau Espin f880d707aa 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
2017-11-12 14:21:04 +00:00
Pau Espin 7650547ec5 OsmoGSMTester: Add deps required for osmo-bts-octphy support
Change-Id: I384ec8cd55cfaa68ee1f461de99ceac78c5d8414
2017-11-12 14:21:04 +00:00
Pau Espin 1ca6d8543e OSmoGsmTester: Specify group in Main unit intro
Change-Id: I132bf7681a1a435c161c4048e41c28dc75c1fa28
2017-11-12 14:21:04 +00:00
Pau Espin e924c2fce4 OsmoGSMTester: Explain patchelf is used sometimes to modify RPATH
Change-Id: I7bb811bc984c8d576984b038b391cf8130cc465e
2017-11-12 14:21:04 +00:00
Pau Espin 88ad5ed0df 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
2017-11-12 14:21:03 +00:00
Pau Espin d8802e7b99 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
2017-11-12 14:21:03 +00:00
Pau Espin 48092ec2a8 OsmoGSMTester: Improve Resource Resolution section content
Change-Id: Ice37093dc9f8e03a2a9f5e3f7df79d1b589b6991
2017-11-12 14:21:03 +00:00
Pau Espin 80f4380d91 OsmoGSMTester: Update sample test script with an AoIP example
Change-Id: I7978c7e96c8f1d43837271c94dd64893649974e0
2017-11-12 14:21:03 +00:00
Pau Espin c3d12c6b55 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
2017-11-12 14:21:03 +00:00
Pau Espin 74b87c1e0d 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
2017-11-12 14:21:03 +00:00
Neels Hofmeyr 284e67c467 GGSN: don't say 'NITB'
Change-Id: I960ce8ee749621176ceaa556a1fe93b54e08b6fc
2017-11-11 23:24:47 +00:00
Harald Welte e521ddea46 STP: Update vty reference XML file
This ensures useful content in the STP vty reference manual

Change-Id: Ica4b1c0172255ec2328562fdd8fac190e3ad448d
2017-11-12 08:19:03 +09:00
Harald Welte 9518d10734 STP: State actual vty commands for dynamic RKM registration
Change-Id: I639dc271dd7f5bea1f6cb8b070990c7c15a39dba
2017-11-12 08:01:39 +09:00
Harald Welte 93643560dc STP: cosmetic fixes/improvements
Change-Id: I1c1c7bb122e9cf9b707feb8e6617a03d15043089
2017-11-12 08:01:22 +09:00
Harald Welte a410c43ab8 First step towards an OsmoSTP manual
Change-Id: I450bfac7444ac9cb7f50c086d87cf7157c2e2a31
2017-11-12 04:34:00 +09:00
Philipp Maier ad4a01e2a4 common: add VTY port number for osmo-mgw
Change-Id: Ifa7eec30ccc5a0beb26c9ec50492d4637cd1d0a5
2017-11-10 10:58:19 +01:00
Max c6259d0ac5 OsmoBSC: update CTRL docs
* use proper naming scheme for BTS-specific CTRL commands
* add/update oml-* commands

Change-Id: I5b2cd940b4d84c140fce871f236aeab091b27360
Related: OS#2486
2017-11-02 15:18:47 +01:00
Neels Hofmeyr 759effc01c jenkins: use osmo-clean-workspace.sh before and after build
See osmo-ci change I2409b2928b4d7ebbd6c005097d4ad7337307dd93 for rationale.

Depends: I2409b2928b4d7ebbd6c005097d4ad7337307dd93
Change-Id: Iaf8338d0d061c70f7ab3737dc425784dc7c170a4
2017-10-27 22:54:14 +02:00
Neels Hofmeyr a919206f92 OsmoHLR: update ctrl description and examples
The patch to refactor ctrl commands to osmo-hlr, change
I98ee6a06b3aa6a67adb868e0b63b0e04eb42eb50, was tweaked. Adjust accordingly.

Change-Id: Ie4da6115bb2eb005a9f95bf4de1bfe36468fd607
2017-10-27 01:54:50 +02:00
Neels Hofmeyr 8ec16bec29 OsmoHLR: add make target to update the example ctrl and vty files
Change-Id: I88027396ec15101697a79aa5e964387d47abdae2
2017-10-27 01:54:50 +02:00
Neels Hofmeyr c481a988e3 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
2017-10-25 16:51:55 +00:00
Neels Hofmeyr 1b1b176e68 OsmoNITB: update vty reference
Change node IDs to use the names derived from the node prompt,
in the process fix the node references to not place the vty_additions in the
wrong places.

Related: I8fa555570268b231c5e01727c661da92fad265de (libosmocore)
Change-Id: I48edb65be94be56c4b57293d8edc1b30271acc12
2017-10-24 15:32:00 +00:00
Neels Hofmeyr 644bcae369 add OsmoHLR manual, OsmoHLR VTY reference
Change-Id: Ieb6a362a26a7e65199f68f5cd32d9b6b0e5d0fbf
2017-10-19 06:43:37 +02:00
Neels Hofmeyr f2252db133 common/vty: minor wording tweaks and typo fixes
Change-Id: I5eb1ea0d3de883ff5e9742f77e7ef4be0482852d
2017-10-18 00:31:41 +02:00
Neels Hofmeyr 75b442450a common/vty: explain difference between telnet and config file
- Mention that the CONFIG node is used to parse config files.
- Mention that it is not well defined whether CONFIG node items have immediate
  effect.
- Add a 'telnet' here and there to clarify.

Change-Id: I882346c69f12c67d0e41d563c99d4de4efd8b8f6
2017-10-18 00:19:07 +02:00
Neels Hofmeyr 8d607a7900 common/vty: "programs should not use the telnet VTY"
Change-Id: Ic7e8c3663a2bfaf8dcb5752bf55ccb822b111c31
2017-10-18 00:19:07 +02:00
Neels Hofmeyr 4538d2d67f common/vty: fix: CONFIG entered from ENABLE, not VIEW node
Change-Id: I892081f9452f8923441913f978a3be542a3c53d0
2017-10-18 00:19:07 +02:00
Harald Welte eaf95fe26e GGSN: Document how 'ip tuntap' is used for non-root; call netdev 'apn0'
* Some people want to manually create/configure their tun devices,
  show them how to do this using ip with the correct parameters
* Let's not call the network device 'ggsn' but rather 'apn0', as
  the device has a 1:1 correspondence to the APN, not to the GGSN.

Change-Id: I2fef818bfcb8cb521397136539f492922d5f6def
2017-10-14 07:34:12 +02:00