man/amf.conf.5

   1 .\"/*
   2 .\" * Copyright (c) 2006 Ericsson AB.
   3 .\" *
   4 .\" * All rights reserved.
   5 .\" *
   6 .\" * Author: Hans Feldt (Hans.Feldt at ericsson.com)
   7 .\" *
   8 .\" * This software licensed under BSD license, the text of which follows:
   9 .\" *
  10 .\" * Redistribution and use in source and binary forms, with or without
  11 .\" * modification, are permitted provided that the following conditions are met:
  12 .\" *
  13 .\" * - Redistributions of source code must retain the above copyright notice,
  14 .\" *   this list of conditions and the following disclaimer.
  15 .\" * - Redistributions in binary form must reproduce the above copyright notice,
  16 .\" *   this list of conditions and the following disclaimer in the documentation
  17 .\" *   and/or other materials provided with the distribution.
  18 .\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
  19 .\" *   contributors may be used to endorse or promote products derived from this
  20 .\" *   software without specific prior written permission.
  21 .\" *
  22 .\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23 .\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26 .\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27 .\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28 .\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29 .\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30 .\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32 .\" * THE POSSIBILITY OF SUCH DAMAGE.
  33 .\" */
  34
  35 .TH AMF.CONF 5 2006-08-29 "openais Man Page"
  36
  37 .SH NAME
  38 amf.conf - openais AMF configuration file
  39
  40 .SH DESCRIPTION
  41 .B amf.conf
  42 is the configuration file that determines the behaviour of the AIS Availability
  43 Management Framework service, AMF in the openais implementation.
  44
  45 Entries in this file will for example determine what applications AMF will start
  46 and how to supervise them.
  47 .P
  48 By default AMF opens /etc/ais/amf.conf. The environment variable
  49 .B
  50 OPENAIS_AMF_CONFIG_FILE
  51 can be set to the pathname of an AMF configuration file to override
  52 the default behaviour.
  53 .P
  54 Any line whose first non-white-space character is
  55 a '#' is considered a comment line. Empty lines are ignored.
  56 .LP
  57 The file contains object entries of the form:
  58 .RS
  59 .nf
  60 .ft B
  61 .sp
  62 <Object Class> = <Object Name> {
  63 .RS
  64 .nf
  65 .ft B
  66 <attribute> = <value>
  67 .I      "..."
  68 .RE
  69 }
  70 .ft R
  71 .fi
  72 .RE
  73 .LP
  74
  75 Object entries are nested, one entry contains another entry. This way relations
  76 between objects are built up. For example a component object defined inside a
  77 Software Unit (SU) object means that the component belongs to the SU. In other
  78 words, the SU is composed of the component. See the example configuration file.
  79
  80 The relation between objects has to comply with the AMF model specified in [5].
  81
  82 Object names shall use only printable ASCII characters. Object names shall be
  83 unique within its context, i.e. two components within the same service unit has
  84 to have different names, but can have the same name as another component within
  85 another service unit.
  86
  87 Attribute names are consistent with the naming of the configuration attributes
  88 in [5].
  89
  90 AMF object attributes are either configuration or runtime attributes. The AMF
  91 configuration file is used to specify configuration attributes. Some configuration
  92 attributes have default values and does not need to be specified. Others are not
  93 valid in certain redundancy models and so on.
  94
  95 The type of an attribute value is either a string, a number, a time or an
  96 enumeration. Enumeration values are specified according to the type definition
  97 in the AIS specification. Time values are specified in milliseconds.
  98
  99 Multivalue attributes are specified using multiple entries with the same
 100 attribute name but different values. See the example configuration file.
 101
 102 The (RDN) value of 'safAmfNode' is a logical name for an AMF node. It is mapped
 103 to a real physical node using the attribute 'saAmfNodeClmNode'.
 104
 105 The value of the attribute 'saAmfNodeClmNode' should be the hostname (without
 106 domain name) as given to the host at boot time. This name is returned by the
 107 shell command 'hostname'.
 108
 109 Currently, AMF is enabled/disabled by an entry in the openais.conf file, see [1].
 110 It is default disabled.
 111
 112
 113 The following list of attributes is currently supported:
 114 .TP 32
 115 .B safAmfCluster
 116 .TP
 117 .B saAmfClusterStartupTimeout
 118 .TP
 119 .B safAmfNode
 120 .TP
 121 .B saAmfNodeClmNode
 122 Host name, required
 123 .TP
 124 .B saAmfNodeSuFailOverProb
 125 Required but not used.
 126 .TP
 127 .B saAmfNodeSuFailoverMax
 128 Required but not used.
 129 .TP
 130 .B safApp
 131 .TP
 132 .B clccli_path
 133 A path added to all CLC-CLI scripts
 134 .TP
 135 .B saAmfSIProtectedbySG
 136 Required when several SGs are specified
 137 .TP
 138 .B safSg
 139 .TP
 140 .B safSi
 141 .TP
 142 .B saAmfSINumCSIs
 143 Required but not used.
 144 .TP
 145 .B safCSType
 146 .TP
 147 .B saAmfSGRedundancyModel
 148 Currently only 'nplusm' is supported, required.
 149 .TP
 150 .B saAmfSGNumPrefActiveSUs
 151 .TP
 152 .B saAmfSGNumPrefStandbySUs
 153 .TP
 154 .B saAmfSGMaxActiveSIsperSUs
 155 .TP
 156 .B saAmfSGMaxStandbySIsperSUs
 157 .TP
 158 .B saAmfSGCompRestartProb
 159 Required but not used.
 160 .TP
 161 .B saAmfSGCompRestartMax
 162 .TP
 163 .B saAmfSGSuRestartProb
 164 Required but not used.
 165 .TP
 166 .B saAmfSGAutoAdjustProb
 167 Required but not used.
 168 .TP
 169 .B saAmfSGSuRestartMax
 170 .TP
 171 .B safSu
 172 .TP
 173 .B saAmfSUNumComponents
 174 Required but not used.
 175 .TP
 176 .B saAmfSUIsExternal
 177 Required but not used.
 178 .TP
 179 .B saAmfSUFailover
 180 Required but not used.
 181 .TP
 182 .B saAmfSUHostedByNode
 183 Required. Set to AMF node name. Note: this is a deviation from the specification.
 184 .TP
 185 .B safComp
 186 .TP
 187 .B saAmfCompCsTypes
 188 Multivalue
 189 .TP
 190 .B saAmfCompCategory
 191 .TP
 192 .B saAmfCompCapability
 193 Required but not used.
 194 .TP
 195 .B saAmfCompNumMaxActiveCsi
 196 Required but not used.
 197 .TP
 198 .B saAmfCompNumMaxStandbyCsi
 199 Required but not used.
 200 .TP
 201 .B saAmfCompCmdEnv
 202 Multivalue
 203 .TP
 204 .B saAmfCompDefaultClcCliTimeout
 205 Required but not used.
 206 .TP
 207 .B saAmfCompDefaultCallbackTimeOut
 208 Required but not used.
 209 .TP
 210 .B saAmfCompInstantiateCmdArgv
 211 .TP
 212 .B saAmfCompInstantiateCmd
 213 .TP
 214 .B saAmfCompTerminateCmdArgv
 215 Required but not used.
 216 .TP
 217 .B saAmfCompTerminateCmd
 218 Required but not used.
 219 .TP
 220 .B saAmfCompCleanupCmdArgv
 221 .TP
 222 .B saAmfCompCleanupCmd
 223 .TP
 224 .B saAmfCompRecoveryOnError
 225 Required but not used.
 226 .TP
 227 .B safHealthcheckKey
 228 .TP
 229 .B saAmfHealthcheckPeriod
 230 .TP
 231 .B saAmfHealthcheckMaxDuration
 232 .TP
 233 .B safCsi
 234 .TP
 235 .B saAmfSIPrefActiveAssignments
 236 .TP
 237 .B saAmfSIPrefStandbyAssignments
 238 .TP
 239 .B saAmfCSTypeName
 240 .TP
 241 .B safCSIAttr
 242 Multivalue
 243
 244
 245 .SH AUTHOR
 246 Hans.Feldt at ericsson.com
 247
 248 .SH EXAMPLE
 249 For an AMF configuration file example, see the amf.conf file under the openais
 250 .B conf
 251 directory.
 252
 253 .SH "FILES"
 254 .TP
 255 /etc/ais/amf.conf
 256 .TP
 257 /etc/ais/openais.conf
 258
 259 .SH "SEE ALSO"
 260 [1] openais_conf (5)
 261 .TP
 262 [2] openais_overview (8)
 263 .TP
 264 [3] README.amf
 265 .TP
 266 [4] www.saforum.org - SAI-XMI-A.01.01.xml.xip
 267 .TP
 268 [5] www.saforum.org - SAI-Overview.B.02.01.pdf
 269 .TP
 270 [6] www.saforum.org - SAI-AIS-AMF-B.02.01.pdf
 271 .PP