Commit Graph

190 Commits

Author SHA1 Message Date
Neels Hofmeyr 8a08220bbb 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-24 15:51:07 +02:00
Neels Hofmeyr 38b7cff16c OsmoHLR: add make target to update the example ctrl and vty files
Change-Id: I88027396ec15101697a79aa5e964387d47abdae2
2017-10-24 15:51:07 +02:00
Neels Hofmeyr 68a9801c88 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-19 06:43:37 +02: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
Neels Hofmeyr 565a9dc3de OsmoGSMTester: document logrotate maxsize
Change-Id: Ib3e7143eb5d90eea4860a0a334da25efe926a231
2017-10-11 00:04:02 +00:00
Max 6c3abbe655 logging: document alarms target
Add subsection describing "log alarms" target.

Change-Id: I95ce5f3db38616608590e02ee79eb3a7e6e4ea14
Fixes: OS#1913
2017-10-09 12:29:18 +02:00
Max ed8284ac6b logging: restructure sections
The basic logging concepts like filters and levels which are
target-independent. It's counter-intuitive that they are described
inside vty target section.

* fix that by putting them in separate sections which are referenced
  from target sections as necessary
* move all targets into subsections under "Log targets" section

Change-Id: I5acde815c66eb3d57e06ecd8dc65fe338216fe63
Related: OS#1913
2017-10-06 19:52:52 +02:00
Max 5f8413c282 logging: replace OpenBSC -> OsmoBSC in examples
Change-Id: Id55dcd41b0d2b3408969d1858e925da55fb5427c
2017-10-06 19:09:18 +02:00
Neels Hofmeyr 03739af1c5 mncc: not 'TCHF', rather 'TCH'
Change-Id: I0edf1763122f182c66ad4c7155ddd4bea0c1d608
2017-10-02 16:31:13 +02:00
Neels Hofmeyr b459f4dbad add OsmoMSC manual
Add OsmoMSC and OsmoHLR to bibliography (even though the OsmoHLR manual does
not yet exist, a reference to it has been added in OsmoMSC's manual).

Change-Id: I9ecff2837fbf5fdc19675a726f6d70c21eb178ee
2017-10-02 16:31:13 +02:00
Neels Hofmeyr 1310fa82e9 move smpp.adoc to common chapters, generalize
OsmoMSC will need the same SMPP chapter as OsmoNITB.

In smpp.adoc, replace program name with parameter, add parameter to
OsmoNITB's main adoc and move smpp.adoc to common/chapters.

Change-Id: I15febdea6569316dad3eed5f9dc7158adb5b078c
2017-10-02 14:27:04 +00:00
Neels Hofmeyr 6e55bc1361 mncc.adoc: clarify MNCC_BRIDGE, with future outlook
Change-Id: Ic71a83d71f2da87e1066fcc060b2b942643eddbc
2017-09-28 18:09:07 +02:00
Neels Hofmeyr 40abc7a217 tweak common/mncc.adoc: use variable for program name
Change-Id: I993a3c3bf617b9823f49898364b5f728a4549330
2017-09-28 18:09:07 +02:00
Neels Hofmeyr f56996aa41 move mncc.adoc to common chapters
Upcoming OsmoMSC will reference the same, hence MNCC becomes a common chapter.

Move the file and adjust various wording to include OsmoMSC.

Change-Id: I404758ff7f1372e841ffe33c75455f513fff3caf
2017-09-25 16:42:01 +02:00
Max 271f5b4081 Expand OsmoGGSN manual
* add cross-references
* add example of running without root priviledges

Change-Id: I1743f370ee2b351d2847f2e29e0f59f35cd401f4
2017-09-25 08:29:28 +00:00
Neels Hofmeyr 52136c3ae3 fix various grammar and typos in: preface, cell-broadcast
Change-Id: I0c61ad0e824b0d62bb9332f2208b247d3852dbb5
2017-09-24 22:35:00 +02:00
Neels Hofmeyr 0e3e4c217a fix make deps: join hint_to_remove_draft_mode to build step
Change-Id: Iecf8e18ce2f1dac61bf55019e1fec601b33abb95
2017-09-19 02:43:28 +02:00
Neels Hofmeyr 60ccbe55c5 INSTALL.txt: add missing dep and vty ref howto
Change-Id: I1068d665b91faf1faa1b295503fcdc33f4ac500a
2017-09-19 02:43:26 +02:00
Harald Welte 56f77a3b64 OsmoGGSN: Add VTY reference manual
Change-Id: Iddf6fe26689172d7db001198943c816eaaed7931
2017-09-07 16:18:02 +02:00
Harald Welte 6fc8db48eb initial version of OsmoGGSN user manual
Closes: OS#1721
Change-Id: I7cdf150e8dd4f9dfc5e6d28e780d05dc1e1e5458
2017-09-06 13:31:49 +02:00
Pau Espin 37f8b7856d 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
2017-09-04 16:11:29 +00:00
Pau Espin b1503f04bf Allow easily disabling GFDL references
All parts referencing GFDL can be easily disabled by removing the
'gfdl-enabled' attribute from the document.

Change-Id: I2489726ad2e90301bceadfada926e31ae0f85986
2017-09-01 09:43:23 +02:00
Harald Welte 79e1aa0a23 MGW: Include MGCP endpoint naming scheme of old IPA/SCCPlite approach
Change-Id: Ib1fe96f0041534fa027b70ee67978cb7c6bc5207
2017-08-18 18:08:34 +00:00
Harald Welte b88cfa860f mgw: Fix endpoint names for new MGW
According to RFC3435, an RTP bridge forrwarding packets, transcoding
or otherwise, is a single endpoint with two connections.  Let's treat
it as such.  We introduce the "rtpbridge/" prefix to identify such
special RTP endpoints.

Change-Id: Id1f079307225faf05d298dcb12aa1c421bfa680a
2017-08-18 18:08:34 +00:00
Max e4a9602d4d 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
2017-08-18 18:08:00 +00:00
Harald Welte 8be8ec61a2 Add VTY port number for GGSN
Change-Id: I199f0d10b819215442885629ffc9955c949133ca
2017-08-16 23:43:26 +02:00
Pau Espin 6d2dd43a1a osmux: Fix description for Dummy frames FT field
Change-Id: Ia421655bd1be45101da3db2a0af44fbb3cc111c1
2017-08-11 15:04:40 +02:00
Harald Welte da7adb3bba rf.adoc: Fix table rendering for path loss models
Change-Id: Ia36c5ecf943b978d846884a1c4b638dccd89da3b
2017-08-08 20:07:46 +02:00
Harald Welte 45a83d5cfa update osmo-bts-virtual documentation, now that code is merged
Change-Id: Icd8706d29ca0e96cb89b7736dbb62f9ce159382d
2017-07-20 16:59:19 +00:00
Pau Espin afd3e9495d Makefile: Add check-deps target and run it by default
This target will do several quick tests to ensure all the required
dependencies needed to build all documents are installed on the system.
If a dependency is missing, we abort the build early. Otherwise we can
end up building documents which some content missing.

Change-Id: I9b86aedd3bfccd7ac00343c16b9d25adc605808d
2017-07-20 15:13:06 +02:00
Pau Espin 005901b1de osmux-reference-docinfo: Add latest changes to revhistory
Change-Id: I01e513a71a3f830d393c57c43678d7e4c8d2d151
2017-07-19 16:29:23 +02:00
Pau Espin 36cc3e748c osmux-reference: Add traffic saving plot
Change-Id: I8fa60c1f95436c39fd1ff9424a907876d367484e
2017-07-19 16:24:29 +02:00
Pau Espin 2d133928e8 osmux-reference: Add sequence charts
Change-Id: Ic2c63e4d9e67b877dc06a206ec7f07d0704329a5
2017-07-19 16:24:29 +02:00
Pau Espin 85d6c12f51 osmux-reference: Use packetdiag to draw packet header structures
Change-Id: Id75152278f41d56b7bd2e652b9947e33d6523c64
2017-07-19 13:21:45 +02:00
Pau Espin d04deae002 all manuals: Move date and release from center head to right foot
Otherwise long doc titles (top left) run on top of release and date
making it impossible to read any of them correctly.

Change-Id: I685a981a5cfd82214d1d654aa1553a844c2af157
2017-07-19 10:53:02 +00:00
Pau Espin 725b3521a3 rtp-amr: Fix typo and trailing whitespace
Change-Id: I8efda2387e0e5e95700b070dab8f8dd427fa562d
2017-07-18 14:27:54 +00:00
Pau Espin b052cb0499 rtp-amr: Describe requirement to recieve all PH-DATA.ind events
Change-Id: I4a78b3398c36a8107fa1809ba9b89235980f0e4f
2017-07-18 14:20:49 +00:00
Neels Hofmeyr bed4162c70 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
2017-07-17 14:43:10 +02:00
Harald Welte 3bcb9f4c15 Add Message Sequence Chart for MO call with ext. MNCC in OsmoMSC
We simply talk to the MGW instead of the BTS, everything else should
remain identical.

Change-Id: I5c249cc2144276a25dba4d7bcb086a34b52d6334
2017-07-11 17:42:04 +02:00
Harald Welte e62d414c0c Add Message Sequence Chart for a MO calls with ext. MNCC handler
Change-Id: Ida10fc7ccb345b8cd084c4ecc5f4f7d4ce6c98a0
2017-07-11 17:39:27 +02:00
Harald Welte bbfb0c33ef SMPP: Document Osmocom extensions
Change-Id: I4cedd07a33633bdd2350d2bda0a22cc0c631c0a9
2017-07-10 18:12:46 +02:00
Max ad61fb82e6 Remove currently broken everything logging option
Change-Id: I52e370d59274e29502cd23690f0d5c73aa3a4cc7
Related: OS#71
2017-07-08 10:44:11 +00:00
Holger Hans Peter Freyther 67934008ca sgsn: Add charging characteristics to GSUP
Reserve a new IE for the charging characteristics. We need to handle
them as a GGSN might otherwise reject the PDP context creation. For
the SGSN it is enough to send the two octets as it.

Pick the 0x1X range for the IEs as it is used with the PDP contexts.

Change-Id: I1d7423582e154728a240cf15c32772a06822f4ad
2017-07-07 01:16:04 +02:00
Holger Hans Peter Freyther fdc69ac2d3 sgsn: Fix numbering of QoS and add basic description for APN
QoS was supposed to be 13 as 12 has been used for the APN. Fix that
and document the APN.

Change-Id: Ib6113aa7c59841aada424e2cafd94ed88c7badc7
2017-07-07 01:16:02 +02:00
Pau Espin e10b5d6718 smpp.adoc: describe VTY cmd 'local-tcp-ip' instead of 'local-tcp-port'
Change-Id: I594b89094413758146bb25f5262902e263f8f3d1
2017-07-05 11:12:36 +00:00