Back to home page

Enduro/X

 
 

    


0001 UBB2EX(8)
0002 =========
0003 :doctype: manpage
0004 
0005 NAME
0006 ----
0007 ubb2ex - Oracle Tuxedo UBB Configuration file migration to Enduro/X
0008 
0009 SYNOPSIS
0010 --------
0011 *ubb2ex* ['OPTS'] {'UBBCONFIG_file' | -}
0012 
0013 DESCRIPTION
0014 -----------
0015 Tuxedo UBBCONFIG converter to Enduro/X configuration parses Tuxedo
0016 text version of configuration and produces as close as possible
0017 Enduro/X configuration.
0018 
0019 It is expected that provided UBBCONFIG is valid. *ubb2ex* performs
0020 limited validation of the input configuration file, and if file is invalid,
0021 at some scenarios, error cause may be determined only in debug mode (*-D5* flag)
0022 and by checking the stack trace/line number in the *ubb2ex.pscript* file (provided
0023 in distribution).
0024 
0025 As input 'UBBCONFIG_file' or *stdin* is used. Enduro/X parses the structure of
0026 the UBB configuration file, loads it into platform script data structures, after which
0027 a script (built in *ubb2ex* or provided from command line) starts to compose
0028 the equivalent Enduro/X configuration. Additionally converter script deference 
0029 *ENVFILE* from the UBB configuration and copies values to *app.ini* *[@global]* section.
0030 
0031 *ubb2ex* produces following files *TUXCONFIG* directory:
0032 
0033 . *set<lmid_lower_case>* - provides initial environment.
0034 
0035 . *app.<lmid_lower_case>.ini* - per process based configuration, mainly global
0036 resource settings, cctag subsections (close equivalent) to Tuxedo groups,
0037 debug configuration and if used, persistent queue (/Q) configuration.
0038 
0039 . *ndrxconfig.<lmid_lower_case>.xml* - process registry used by *ndrxd* and *cpmsrv*,
0040 mostly resembles UBB configuration.
0041 
0042 The migration tool produces different sets of configuration files, because
0043 Enduro/X uses peer-to-peer clustering principles, thus for each of the peer servers
0044 different set of files are produced (and separated by lower-case LMID identifier from
0045 UBB configuration).
0046 
0047 Additionally as the result directories are created (if not exist):
0048 
0049 . *APPDIR* from UBBCONFIG. This may contain colon (:) separated directories - 
0050 all of them are produced.
0051 
0052 . *TUXCONFIG* from UBBCONFIG.
0053 
0054 . *ULOGPFX* from UBBCONFIG, directory used as general Enduro/X directory for logs
0055 including ULOG by it self.
0056 
0057 . *$\{NDRX_APPHOME\}/tmlogs/rm<RMID>* for resource manager logs, if distributed transactions are used.
0058 
0059 . *$\{NDRX_APPHOME\}/qdata/<QSPACE>* for persistent queues, if used.
0060 
0061 . *$\{NDRX_APPHOME\}/tmp* for storing PID files.
0062 
0063 . Directories of *-e* arguments for servers are created. When servers are created, their
0064 *-e* file path is made relative to *$\{NDRX_ULOG\}* directory or *$\{NDRX_APPHOME\}*, if
0065 possible.
0066 
0067 Where *$\{NDRX_APPHOME\}* is determined by following principles: It is common part
0068 between Tuxedo's *APPDIR* and *TUXCONFIG*. If common part is not found 
0069 (i.e. it is root directory */*), then *$\{NDRX_APPHOME\}* is set to *APPDIR*.
0070 
0071 Migration script supports following Tuxedo features:
0072 
0073 . Migration of *RESOURCES section
0074 
0075 . Migration of *GROUPS section
0076 
0077 . Migration of *NETWORK section
0078 
0079 . Migration of *SERVERS section
0080 
0081 . Migration of *SERVICES section
0082 
0083 . Migration of *ROUTING section
0084 
0085 Tool performs mappings of the such processes as:
0086 
0087 .UBBCONFIG - Enduro/X process mappings
0088 [width="80%", options="header"]
0089 |=========================================================
0090 |Tuxedo process|Enduro/X process
0091 | *TMS*| *tmsrv(8)*
0092 | *TMSYSEVT* and *TMUSREVT* |  *tpevsrv(8)*
0093 | *TMQUEUE* and *TMQUEUE* |  *tmqueue(8)*
0094 | *WSL* and *JSL* |  *restincl(8)* from *endurox-connect* package.
0095 Basic configuration is provided.
0096 |=========================================================
0097 
0098 For more details on how the configuration is mapped to Enduro/X, please read 
0099 *migration_tuxedo(guides)(Migrating from Oracle Tuxedo to Enduro/X)* user guide.
0100 
0101 OPTIONS
0102 -------
0103 [*-n*]::
0104 Do syntax check only.
0105 
0106 [*-y*]::
0107 Auto confirmation, when asking for existing file overwrite.
0108 
0109 [*-n*]::
0110 Do not process UBF mapping during compilation of the view file. This can be useful
0111 in cases if the environment is not configured during the build time and field
0112 definition files are not accessible at the time.
0113 
0114 [*-c*]::
0115 RFU, same as *-n* currently.
0116 
0117 [*-b* 'BLOCKS']::
0118 RFU, ignored.
0119 
0120 [*-L* 'LMID']::
0121 Migrate only this specified LMID form the UBBCONFIG file. Default is
0122 to migate all machines.
0123 
0124 [*-A*]::
0125 Assign new SRVIDs. Enduro/X by default tries to use server IDs in UBBCONFIG.
0126 Enduro/X requires IDs to be unique at instance level, but UBBCONFIG
0127 only requires them to be unique at group level, the *ubb2ex* migration tool
0128 automatically assigns new IDs only if it finds that there are some duplicate
0129 numbers between the UBBCONFIG groups.
0130 
0131 [*-D* 'DEBUG_LEVEL']::
0132 Debug level *1..5*, where *5* is debug details, *1* is fatal error. Default is
0133 *2* (error). If no environment is configured, log is printed to *stderr*.
0134 
0135 [*-S* 'PATH_TO_SCRIPT_FILE']::
0136 This parameter specifies path to external migration tool script name. The
0137 base version which is also built-in in the *ubb2ex* migration tool are provided
0138 for reference and modification purposes typically at */usr/share/endurox/config/ubb2ex.pscript*.
0139 This may be modified if some fine tuning is needed for particular environment.
0140 Script cannot be executed by *pscript* interpreter, due to fact that *ubbex* provides
0141 additional functions to script engine, required by the migration script by it self.
0142 
0143 [*-P* 'OUTPUT_PREFIX']::
0144 This is output files and directories prefix. As Tuxedo UBBCONFIG uses absolute path,
0145 this parameter allows to generate the migrated configuration relative to the
0146 'OUTPUT_PREFIX'.
0147 
0148 [*-O* 'PORT_OFFSET_MULTIPLIER']::
0149 This is multiplier used to render local binding port number for incoming bridge
0150 connections. This is useful if all generated Enduro/X instances (LMIDs) are
0151 run on local machine. Default value is *100*. Meaning that listening socket
0152 port number for each *tpbridge(8)* is rendered as local 'NDRX_NODEID' *
0153 'PORT_OFFSET_MULTIPLIER' + remote 'NDRX_NODEID'.
0154 
0155 EXIT STATUS
0156 -----------
0157 *0*::
0158 Success
0159 
0160 *1*::
0161 Failure
0162 
0163 EXAMPLE
0164 -------
0165 See *atmitest/test090_tuxmig* for sample usage.
0166 
0167 BUGS
0168 ----
0169 Report bugs to support@mavimax.com
0170 
0171 SEE ALSO
0172 --------
0173 *migration_tuxedo(guides)* *ex_env(5)* *ndrxconfig.xml(5)*
0174 
0175 COPYING
0176 -------
0177 (C) Mavimax, Ltd
0178