aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2023-12-01Use uniform log format for default config filesAndreas Eversberg5-0/+40
Related: OS#6272 Change-Id: I6b6aa5a5100cf0045dcba1b062acc9376d34b0ae
2023-06-08Write explicit role & sctp-role fields in ASP configurationsPau Espin Pedrol2-0/+3
Change-Id: I44e251ca2df02e4f1fdfc1492306ec25d0653ef6
2022-12-08osmo-gtphub.cfg: fix conflict with osmo-ggsn.cfgOliver Smith1-1/+1
Change bind-to-ggsns from 127.0.0.2 to 127.0.0.20, so osmo-gtphub's default config does not confligt with the osmo-ggsn default config. This change is for the effort of making the configs of all Osmocom programs not conflict with each other. A similar change was made in Id892e1f4ab2daabbe9824b819b5fed985373b97a with bind-to-sgsns. Related: OS#5817 Change-Id: I57ee457b62139d831707b6ebd6baaea8d33c2d9c
2021-07-03doc/manuals: update configuration.adoc to use new command syntaxVadim Yanitskiy1-3/+3
The old command is deprecated since [1] has been merged. Change-Id: Iac985f373de98206fdfb3196295ebec160189780 Related: [1] Ie6700c4e9d2df1eb5fde1b971e287b62668cc2de Related: SYS#5324
2021-05-19Support forwarding RIM messages over GTPCv1 EUTRAN<->GERANPau Espin Pedrol1-1/+54
MMEs connect over Gn interface using GTPCv1 towards the SGSN in order to exchange RIM PDUs by using "RAN Information Relay" GTPCv1 message type. For more info, see 3GPP TS 29.060 sec 7.5.14.1 "RAN Information Relay" In order to support it, this commit does the following: * Uses new libgtp APIs to rx and tx RAN Information Relay messages. The same "gsn" object is reused, ie. the local GTPCv1 socket address used for exchanging messages against GGSN is reused. * Adds a new "sgsn_mme_ctx" struct holding information about MMEs allowed by the SGSN, each one containing information about the GTP address it uses, the in/out routing based on TAI requests, etc. The set of MMEs and their config can be set up using new VTY node introduced in this commit. * The RIM related code in SGSN is refactored to allow forwarding from and to several types of addresses/interfaces. Depends: osmo-ggsn.git Change-Id Iea3eb032ccd4aed5187baca7f7719349d76039d4 Depends: libosmocore.git Change-Id I534db7d8bc5ceb19a2a6866f07d5f5c70e456c5c Related: SYS#5314 Change-Id: I396450b8d8b66595dab8ff7bf41cbf964bb40d93
2021-03-12manuals: Regenerate counters/VTY through dockerDaniel Willmann1-65/+11
Change-Id: I09b01d2e4bc7b1c17588100b16ac9f04cf72cf99
2021-02-23manuals: generate vty reference xml at build timeHarald Welte2-2677/+6
Move 'doc' subdir further down to "make sure" the osmo-bsc binary is built before the docs Rremove sgsn_vty_reference from the source tree. In manuals//Makefile.am use the new BUILT_REFERENCE_XML feature recently added to osmo-gsm-manuals, and add a build target to generate the XML using the new osmo-sgsn --vty-ref-xml cmdline switch. Change-Id: Ied75fdd13283aa592350994fb4febce06c213d3a Depends: I613d692328050a036d05b49a436ab495fc2087ba
2021-02-08gbproxy: remove (moved to own repository)Oliver Smith17-2398/+3
New repository: https://git.osmocom.org/osmo-gbproxy/ Related: OS#4992 Change-Id: I37f7cebaf2a06bd93627a452f5df44edcfc0f87a
2021-01-28sgsn: migrate to the new gprs_ns2_vty configurationAlexander Couzens3-9/+9
Change the whole vty configuration for NS to be more flexible and support more setups. Old configurations are invalid. API change which must be synchronized with libosmocore For further information see: https://osmocom.org/projects/libosmocore/wiki/Network_service_(NS) Depends-on: I8c3f2afecc74b78f7f914f7dce166cbcb63444eb (libosmocore) Change-Id: Ie9306ab4d4738c2c57a69987086e22771b30657e
2021-01-28manuals/gbproxy: Move pooling to separate chapterDaniel Willmann2-24/+25
Change-Id: Ie2ad652c8261ce56cb2ed1a6f16a81486ccdf063 Related: SYS#5115, SYS#5005
2021-01-28manuals/gbproxy: MSC -> SGSN for pooling chapterDaniel Willmann1-104/+85
Mostly just change the chapter so it makes sense for gbproxy. Some todos are still left Change-Id: I905835c2be7be43fe376fbc9d743107948c7e6d4 Related: SYS#5115, SYS#5005
2021-01-28manuals/gbproxy: Add osmo-bsc MSC pooling chapter from Neels as a baseDaniel Willmann1-0/+213
Related: SYS#5115, SYS#5005 Change-Id: I930f5df847ea6f40d0ee0c75dd25b6dd20e00839
2021-01-28manuals/gbproxy: Update configuration chapterDaniel Willmann1-4/+37
Change-Id: I01f8d47f9fa384a2528ddf2e6c936ff28d11409e Related: SYS#5115, SYS#5005
2021-01-28Rename OsmoGbPROXY -> *ProxyDaniel Willmann4-5/+5
Change-Id: I7542ac1d5242f1784146de2df7cecaf70fe93c6c Related: SYS#5115, SYS#5005
2021-01-28manual/gbproxy: Update overview chapterDaniel Willmann1-77/+44
* Remove mention of features that are no longer supported * Update the data model Related: SYS#5115, SYS#5005 Change-Id: Icb9095f4002f2a0a4562fccecae109075cb93c7b
2021-01-04gbproxy: Add config option to name an SGSNDaniel Willmann2-0/+2
This is useful for logging and configuration to identify an SGSN by name Change-Id: I2a3410dd9bebb242957e13a63ed70e447204203c Related: SYS#5115, OS#4472
2021-01-04gbproxy: use ns2 vty2Alexander Couzens3-32/+17
The new gprs_ns2 vty2 support ip-sns and reorganize the network service configuration Depends: I163279cf57e84198dc8c53e1c109f5a9474670e9 (libosmocore) Change-Id: I2a18dcf035f1fc7304a0c7c7c83b5e8e15429d2b
2020-12-29gbproxy: Add SGSN NRI configurationDaniel Willmann2-1/+39
In order to support SGSN pooling we need to configure the various NRI parameters such as the bitlen, NULL NRI, and which NRIs are assigned to which SGSN. Related: OS#4890, OS#4472 Change-Id: Id67592aa7712e5e04e7264b2fb8f26d57eb7e69e
2020-12-12gbproxy: Implement scaling of BVC flow control in SGSN poolHarald Welte1-0/+26
When there are multiple SGSNs inside a pool, we need to decide how much of the per-BVC capacity advertised by the BSS in its BVC-FLOW-CONTROL we should announce to each of the pool members. A conservative approach would be to advertise 1/num_sgsn, but there may also be use case where over-provisioning (announcing more than an equal share of the capacity) is useful. Hence, let's introduce "pool bvc-flow-control-ratio <1-100>" in order to allow the administrator to decide. Related: OS#4891 Change-Id: Ibe5addf657e7237499ca0205bacfe999ecd1e771
2020-11-06Port gbproxy to NS2Alexander Couzens1-1/+3
Since NS2 has a different abstraction we mock up the prim send/recv functions and don't test NS like the old tests did. Related: SYS#4998 Change-Id: Iecfd0408a35a11638d254c1db3c1d477b1a11524
2020-09-25gbproxy-usermanual: Explain BSSGP/BVC handlingDaniel Willmann3-5/+121
Related: SYS#5005 Change-Id: I383fcd3864a94177f13909c6b8c15648900d3201
2020-08-18Support setting rt-prio and cpu-affinity mask through VTYPau Espin Pedrol1-0/+40
Change-Id: I1af1b154d14de6d6d6fba08f15f167f4b2ed9aa2 Depends: libosmocore.git Change-Id If76a4bd2cc7b3c7adf5d84790a944d78be70e10a Depends: osmo-gsm-masnuals.git Change-Id Icd75769ef630c3fa985fc5e2154d5521689cdd3c Related: SYS#4986
2020-08-18doc: Update VTY reference xml filePau Espin Pedrol1-87/+188
Change-Id: I787bbc254ef10766fe8d480ffd93a16d9926a50e
2020-03-23manual: explain IuPS, add SCCP/M3UA section from common chaptersNeels Hofmeyr2-0/+22
Add 'cs7' default configuration, link to the osmo-gsm-manuals/common/cs7-config.adoc chapter to fully explain the 'cs7' client configuration. Related: OS#2767 Depends: Ia2508d4c7b0fef9cdc57e7e122799a480e340bf7 (osmo-gsm-manuals) Change-Id: If0f7c8fc4b94eb40b62570cf90999d5074dc00ee
2019-12-03regen_doc.sh: support gbproxy, run without dockerOliver Smith1-11/+71
Do not only update the VTY reference and counters of osmo-sgsn, but also the VTY reference of gbproxy. This was not possible with the old code path of calling "regen_doc.sh" inside docker-playground.git, as it expects the program to be updated to have the same name as the docker image. Using the docker-playground script also has the disadvantage, that one must push the development branch to git.osmocom.org before updating the VTY reference/counters, because that script would build a new docker container with a freshly cloned repository, check out the same commit that we have already locally, build that and then finally regenerate the docs. So instead of adding another parameter for the docker image to the script in docker-playground.git and calling it twice, simplify the process by rewriting the regen_doc.sh script in osmo-sgsn.git. Make it start the locally installed osmo-sgsn and osmo-gbproxy binaries and call osmo_interact_vty.py on them. Related: OS#4292 Change-Id: I8b5bd5347ea34266ad650383372630f2a84d5cce
2019-12-03doc: add OsmoGbProxy VTY referenceOliver Smith4-2/+1675
Depends: (osmo-gsm-manuals) I4dea3e07b88175b2a88e577129360af7ec5f87e1 Related: OS#4292 Change-Id: I24c3ca2fc2446673edceefb797c7d800c3a1a5d2
2019-12-01manual: Fix copy+paste errorHarald Welte1-1/+1
Change-Id: I5753ded676951998a1fd76e4d2c2bf3311213f53
2019-12-01Initial OsmoGbPROXY user manualHarald Welte7-1/+284
This adds a very basic manual consisting of nothing more than the common chapters and a high-level description of what it is all about. Change-Id: I80d4ea016376c59995ccfcd8685c7c0e86745bd2
2019-09-02Move out gtphub to its own subdirPau Espin Pedrol1-1/+1
Change-Id: I707d5e9b775179e732d281ce3d245de83d648eea
2019-08-21vty: Introduce cs7-instance-iuPau Espin Pedrol2-0/+7
Similar to what we already have in osmo-msc. Change-Id: Iaa9e1d06dd0430848ef4f7498a3c15d13f899904
2019-08-21examples: Add osmo-sgsn_custom-sccp.cfgPau Espin Pedrol1-0/+38
Change-Id: Id3a3ccbf168fbbc28153cbf7f0249294eee34d3d
2019-07-30configuration.adoc: Add a section about encryptionDaniel Willmann1-0/+18
Change-Id: I3a2b84d386f55447e9eed35e59fdc0272e5147d1 Related: OS#1720
2019-07-30configuration.adoc: Small fixesDaniel Willmann1-14/+25
Fix some typos, correct data compression command, add example to turn off compression. Change-Id: I6beff8c66eacf12f1081d51dd6b124bdd4478558 Related: OS#1720
2019-07-29osmo-gbproxy.cfg: fix conflict with osmo-sgsn.cfgOliver Smith1-0/+1
Listen on 127.0.0.100 by default, so there is no conflict on 127.0.0.1:23000. This allows starting both services with their default configuration, like we are doing it in the Osmocom-Debian-install-* jenkins jobs. Related: OS#3369 Change-Id: I6e3053de8885a7954296d820c6a069d06276e4df
2019-07-26osmo-sgsn: Fix outdated information in usermanualDaniel Willmann2-18/+9
Quite a few features that are listed as not-implemented in the overview section are actually implemented now. Change-Id: I8d499a25293b69babc2aebb2d697438f8ba8141f Related: OS#1720
2019-07-24osmo-gtphub.cfg: fix conflict with osmo-sgsn.cfgOliver Smith1-1/+1
Change bind-to-sgsns from 127.0.0.1 to 127.0.0.10, so osmo-gtphub's default config does not conflict with the osmo-sgsn default config. The value of bind-to-ggsns does not clash with osmo-ggsn's config, so it was left unchanged. Related: OS#3369 Change-Id: Id892e1f4ab2daabbe9824b819b5fed985373b97a
2019-07-24manuals: Update vty/counter documentationDaniel Willmann2-65/+26
Change-Id: Id7245eb1011d1f04d5dfa1503a96d100bc98344c Related: OS#1700
2019-06-19manuals: Add script to regenerate vty/counter documentationDaniel Willmann2-0/+18
Change-Id: I8ee63a3da532285def8de7fe5e90873152adb21e Related: OS#1700
2019-06-13sgsn: Have authentication required on by defaultPau Espin Pedrol1-3/+3
Previous commit introduced command "authentication (optional|required)", which is only meaningful if auth-policy is remote. Upon adding the cmd, it changed the default logic for remote policy to not require authentication, which broke TTCN3 tests because sgsn no longer tries to authenticate the users. Since it's actually good to enable authentication by default where possible, let's enable it by default when on auth-policy remote. In order to do so, let's simply not care about the value of variable require_authentication if auth_policy is not REMOTE. As a result, we drop parts of the previous patch and remove unneeded checks (which are only partially useful based on order of commands during VTY read). Fixes: 794f446a284ed1ac6d31eb79a8f4c874d66fc34e Change-Id: Ic707a95af178b44f08809df3d3bc8354bf34273c
2019-06-06osmo-sgsn: add VTY parameter to toggle authenticationVadim Yanitskiy3-0/+9
It may be useful to have 'remote' authorization policy, but do not require authentication in GERAN at the same time, e.g. in combination with 'subscriber-create-on-demand' feature of OsmoHLR. This change introduces a new VTY parameter similar to the one that we already have in OsmoMSC: authentication (optional|required) Please note that 'required' only applies if 'auth-policy' is 'remote'. Change-Id: I9909145e7e0af587c28827e16301a61b13eedaa9
2019-06-05doc/manuals/vty: regenerate sgsn_vty_reference.xmlVadim Yanitskiy1-7/+21
Change-Id: I3dfe3598055457cc9724a371590e676f1920652b
2019-05-29debian: create -doc subpackage with pdf manualsOliver Smith1-0/+1
I have verified, that the resulting debian packages build in my own OBS namespace (see the -doc packages): https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/ https://build.opensuse.org/project/show/home:osmith42 Depends: Ib7251cca9116151e473798879375cd5eb48ff3ad (osmo-ci) Related: OS#3899 Change-Id: I9c09a0cb5c65fa2e2cd9817edb4656b2a1a35bb9
2018-11-27build manuals moved here from osmo-gsm-manuals.gitOliver Smith5-27/+34
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: I0477d7c871413bd90b365d3064bac3cba23a0883
2018-11-27Merge history from osmo-gsm-manuals.gitNeels Hofmeyr12-0/+3291
Change-Id: I284bfe2fc61167986cf784eabdd57151d4981e7a
2018-11-27sgsn: update vty referenceNeels Hofmeyr1-55/+252
Change-Id: I64d775efa6791aca025d116905e951e10ffa5d04
2018-11-27vty-ref: Update URI of docbook 5.0 schemaHarald Welte1-2/+2
... to match the /etc/xml/catalog file on debian (no "www" in hostname) Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d
2018-11-27OsmoSGSN: update VTY referenceNeels Hofmeyr2-2113/+2315
This is the first update since the libosmocore changes to the 'show online-help' generated output. Hence the produced document now benefits from the structural improvements: - not repeating common commands for every node; - using section names that match the VTY prompt. Drop most of the sgsn_vty_additions.xml -- they merely repeat what the online VTY doc already explains. Many of these more verbose explanations have been absorbed into the VTY online doc in osmo-sgsn.git change-id I35984014424412e91437b7ed71576aef3819cb1e. Adjust remaining sgsn_vty_additions.xml to match the new node ID scheme. Change-Id: I71863e5056ad369d2055e9882a52a00fa999ab04
2018-11-27OsmoSGSN: overview: Fix typo and reference OpenGGSN->OsmoGGSNPau Espin Pedrol1-2/+2
Change-Id: I94cc362a4f52e6bd9f93299665e73dc4fd75a2c6
2018-11-27share chapters/gsup.adoc from OsmoSGSN to OsmoMSC + OsmoHLRHarald Welte2-860/+1
Since the NITB split, GSUP is used in all three network elements, so make the protocol a shared chapter Change-Id: Id2d7c27ef16eb0ebe5f60d625a1fcf42f1603f4f
2018-11-27OsmoSGSN: add rate counter documentationAlexander Couzens3-0/+127
Change-Id: I4c5d5744f961a92bc7c8888ca739d1e8a8a0be9c