docs/config-deploy.rst

   1
   2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   3 .. SPDX-License-Identifier: CC-BY-4.0
   4 .. CAUTION: this document is generated from source in doc/src/rtd.
   5 .. To make changes edit the source and recompile the document.
   6 .. Do NOT make changes directly to .rst or .md files.
   7
   8
   9 RMR Configuration and Deployment
  10 ============================================================================================
  11
  12 The RIC Message Router (RMR) is a library for peer-to-peer
  13 communication. Applications use the library to send and
  14 receive messages where the message routing and endpoint
  15 selection is based on the message type rather than DNS host
  16 name-IP port combinations.
  17
  18 This document contains information regarding the
  19 configuration of RMR when it is embedded by a *user
  20 application* . RMR itself is a library, not a deployable
  21 entity.
  22
  23 Configuration
  24 --------------------------------------------------------------------------------------------
  25
  26 Many aspects of RMR behavior are controlled via environment
  27 variables. These values are read when a user application
  28 invokes the RMR initialization function. This allows these
  29 variables to be set before the application is started as a
  30 function of the true environment, or set by the application
  31 as a means for the application to influence RMR's behaviour.
  32 The following is a list of environment variables which RMR
  33 recognizes. Also see the main RMR manual page in the
  34 development package for more details.
  35
  36
  37 RMR_ASYNC_CONN
  38
  39   Allows the async connection mode to be turned off (by
  40   setting the value to 0). When set to 1, or missing from
  41   the environment, RMR will invoke the connection interface
  42   in the transport mechanism using the non-blocking (async)
  43   mode. This will likely result in many "soft failures"
  44   (retry) until the connection is established, but allows
  45   the application to continue unimpeded should the
  46   connection be slow to set up.
  47
  48
  49 RMR_BIND_IF
  50
  51   This provides the interface that RMR will bind listen
  52   ports to, allowing for a single interface to be used
  53   rather than listening across all interfaces. This should
  54   be the IP address assigned to the interface that RMR
  55   should listen on, and if not defined RMR will listen on
  56   all interfaces.
  57
  58
  59 RMR_CTL_PORT
  60
  61   This variable defines the port that RMR should open for
  62   communications with Route Manager, and other RMR control
  63   applications. If not defined, the port 4561 is assumed.
  64
  65   Previously, the RMR_RTG_SVC (route table generator service
  66   port) was used to define this port. However, a future
  67   version of Route Manager will require RMR to connect and
  68   request tables, thus that variable is now used to supply
  69   the Route Manager's well-known address and port.
  70
  71   To maintain backwards compatibility with the older Route
  72   Manager versions, the presence of this variable in the
  73   environment will shift RMR's behaviour with respect to the
  74   default value used when RMR_RTG_SVC is **not** defined.
  75
  76   When RMR_CTL_PORT is **defined:** RMR assumes that Route
  77   Manager requires RMR to connect and request table updates
  78   is made, and the default well-known address for Route
  79   manager is used (routemgr:4561).
  80
  81   When RMR_CTL_PORT is **undefined:** RMR assumes that Route
  82   Manager will connect and push table updates, thus the
  83   default listen port (4561) is used.
  84
  85   To avoid any possible misinterpretation and/or incorrect
  86   assumptions on the part of RMR, it is recommended that
  87   both the RMR_CTL_PORT and RMR_RTG_SVC be defined. In the
  88   case where both variables are defined, RMR will behave
  89   exactly as is communicated with the variable's values.
  90
  91
  92 RMR_RTG_SVC
  93
  94   The value of this variable depends on the Route Manager in
  95   use.
  96
  97   When the Route Manager is expecting to connect to an xAPP
  98   and push route tables, this variable must indicate the
  99   port which RMR should use to listen for these connections.
 100
 101   When the Route Manager is expecting RMR to connect and
 102   request a table update during initialisation, the variable
 103   should be the host of the Route Manager process.
 104
 105   The RMR_CTL_PORT variable (added with the support of
 106   sending table update requests to Route manager), controls
 107   the behaviour if this variable is not set. See the
 108   description of that variable for details.
 109
 110
 111 RMR_HR_LOG
 112
 113   By default RMR writes messages to standard error
 114   (incorrectly referred to as log messages) in human
 115   readable format. If this environment variable is set to 0,
 116   the format of standard error messages might be written in
 117   some format not easily read by humans. If missing, a value
 118   of 1 is assumed.
 119
 120
 121 RMR_LOG_VLEVEL
 122
 123   This is a numeric value which corresponds to the verbosity
 124   level used to limit messages written to standard error.
 125   The lower the number the less chatty RMR functions are
 126   during execution. The following is the current
 127   relationship between the value set on this variable and
 128   the messages written:
 129
 130
 131 0
 132
 133   Off; no messages of any sort are written.
 134
 135
 136 1
 137
 138   Only critical messages are written (default if this
 139   variable does not exist)
 140
 141
 142 2
 143
 144   Errors and all messages written with a lower value.
 145
 146
 147 3
 148
 149   Warnings and all messages written with a lower value.
 150
 151
 152 4
 153
 154   Informational and all messages written with a lower
 155   value.
 156
 157
 158 5
 159
 160   Debugging mode -- all messages written, however this
 161   requires RMR to have been compiled with debugging
 162   support enabled.
 163
 164
 165
 166 RMR_RTG_ISRAW
 167
 168   **Deprecated.** Should be set to 1 if the route table
 169   generator is sending "plain" messages (not using RMR to
 170   send messages), 0 if the RTG is using RMR to send. The
 171   default is 1 as we don't expect the RTG to use RMR.
 172
 173   This variable is only recognised when using the NNG
 174   transport library as it is not possible to support NNG
 175   "raw" communications with other transport libraries. It is
 176   also necessary to match the value of this variable with
 177   the capabilities of the Route Manager; at some point in
 178   the future RMR will assume that all Route Manager messages
 179   will arrive via an RMR connection and will ignore this
 180   variable.
 181
 182 RMR_SEED_RT
 183
 184   This is used to supply a static route table which can be
 185   used for debugging, testing, or if no route table
 186   generator process is being used to supply the route table.
 187   If not defined, no static table is used and RMR will not
 188   report *ready* until a table is received. The static route
 189   table may contain both the route table (between newrt
 190   start and end records), and the MEID map (between meid_map
 191   start and end records).
 192
 193 RMR_SRC_ID
 194
 195   This is either the name or IP address which is placed into
 196   outbound messages as the message source. This will used
 197   when an RMR based application uses the rmr_rts_msg()
 198   function to return a response to the sender. If not
 199   supplied RMR will use the hostname which in some container
 200   environments might not be routable.
 201
 202   The value of this variable is also used for Route Manager
 203   messages which are sent via an RMR connection.
 204
 205 RMR_VCTL_FILE
 206
 207   This supplies the name of a verbosity control file. The
 208   core RMR functions do not produce messages unless there is
 209   a critical failure. However, the route table collection
 210   thread, not a part of the main message processing
 211   component, can write additional messages to standard
 212   error. If this variable is set, RMR will extract the
 213   verbosity level for these messages (0 is silent) from the
 214   first line of the file. Changes to the file are detected
 215   and thus the level can be changed dynamically, however RMR
 216   will only suss out this variable during initialisation, so
 217   it is impossible to enable verbosity after startup.
 218
 219 RMR_WARNINGS
 220
 221   If set to 1, RMR will write some warnings which are
 222   non-performance impacting. If the variable is not defined,
 223   or set to 0, RMR will not write these additional warnings.
 224