doc/src/rtd/config-deploy.xfm

   1 .** vim: ts=4 noet sw=4:
   2 .if false
   3 ==================================================================================
   4         Copyright (c) 2019 Nokia
   5         Copyright (c) 2018-2019 AT&T Intellectual Property.
   6
   7    Licensed under the Apache License, Version 2.0 (the "License");
   8    you may not use this file except in compliance with the License.
   9    You may obtain a copy of the License at
  10
  11        http://www.apache.org/licenses/LICENSE-2.0
  12
  13    Unless required by applicable law or agreed to in writing, software
  14    distributed under the License is distributed on an "AS IS" BASIS,
  15    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16    See the License for the specific language governing permissions and
  17    limitations under the License.
  18 ==================================================================================
  19 .fi
  20
  21
  22 .if false
  23         Mnemonic:       config-deploy.xfm
  24         Abstract:       Source to generate a configuration delployment guide.
  25         Date:           6 November 2019
  26         Author:         E. Scott Daniels
  27 .fi
  28
  29 .im setup.im
  30
  31 &h1(RMR Configuration and Delpoyment)
  32
  33 The RIC Message Router (RMR) is a library which applications use to send and receive
  34 messages where the message routing, endpoint selection, is based on the message type
  35 rather than on traditional DNS names or IP addresses.
  36 This document contains information regarding the configuration of RMR when it is
  37 embedded by a &ital(user application).
  38 RMR itself is not a deployable entity.
  39
  40 &h2(Configuration)
  41 Several aspects of RMR behaviour is controlled via environment variables which are
  42 set at the time that a user application invokes the RMR initialisation function.
  43 This allows these variables to be set before the application is started as a
  44 function of the true environment, or set by the application as a means for the
  45 application to influence RMR's behaviour.
  46 The following is a list of RMR variables which RMR recognises (see the main
  47 RMR manual page in the development package for more details).
  48
  49
  50 .** use the same list which is used in the manual pages
  51 .im &{lib}/man/env_var_list.im