amf.conf(5)

1
2AMF.CONF(5)                   File Formats Manual                  AMF.CONF(5)
3
4
5

NAME

7       amf.conf - corosync AMF configuration file
8
9

DESCRIPTION

11       amf.conf is the configuration file that determines the behaviour of the
12       AIS Availability Management Framework  service,  AMF  in  the  corosync
13       implementation.
14
15       Entries  in  this file will for example determine what applications AMF
16       will start and how to supervise them.
17
18       By default AMF opens /etc/ais/amf.conf. The environment  variable  OPE‐
19       NAIS_AMF_CONFIG_FILE can be set to the pathname of an AMF configuration
20       file to override the default behaviour.
21
22       Any line whose first non-white-space character is a '#' is considered a
23       comment line. Empty lines are ignored.
24
25       The file contains object entries of the form:
26
27              <Object Class> = <Object Name> {
28                     <attribute> = <value>
29                     ...
30              }
31
32       Object  entries  are nested, one entry contains another entry. This way
33       relations between objects are built up. For example a component  object
34       defined  inside  a  Software  Unit (SU) object means that the component
35       belongs to the SU. In other words, the SU is composed of the component.
36       See the example configuration file.
37
38       The relation between objects has to comply with the AMF model specified
39       in [5].
40
41       Object names shall use only printable ASCII  characters.  Object  names
42       shall be unique within its context, i.e. two components within the same
43       service unit has to have different names, but can have the same name as
44       another component within another service unit.
45
46       Attribute  names  are  consistent  with the naming of the configuration
47       attributes in [5].
48
49       AMF object attributes are either configuration or  runtime  attributes.
50       The AMF configuration file is used to specify configuration attributes.
51       Some configuration attributes have default values and does not need  to
52       be  specified. Others are not valid in certain redundancy models and so
53       on.
54
55       The type of an attribute value is either a string, a number, a time  or
56       an  enumeration. Enumeration values are specified according to the type
57       definition in the AIS specification. Time values are specified in  mil‐
58       liseconds.
59
60       Multivalue  attributes  are  specified  using multiple entries with the
61       same attribute name but different values. See the example configuration
62       file.
63
64       The  (RDN)  value of 'safAmfNode' is a logical name for an AMF node. It
65       is mapped to a real  physical  node  using  the  attribute  'saAmfNode‐
66       ClmNode'.
67
68       The  value  of  the attribute 'saAmfNodeClmNode' should be the hostname
69       (without domain name) as given to the host at boot time. This  name  is
70       returned by the shell command 'hostname'.
71
72       Currently,  AMF  is  enabled/disabled  by an entry in the corosync.conf
73       file, see [1].  It is default disabled.
74
75
76       The following list of attributes is currently supported:
77
78       safAmfCluster
79
80       saAmfClusterStartupTimeout
81
82       safAmfNode
83
84       saAmfNodeClmNode                Host name, required
85
86       saAmfNodeSuFailOverProb         Required but not used.
87
88       saAmfNodeSuFailoverMax          Required but not used.
89
90       safApp
91
92       clccli_path                     A path added to all CLC-CLI scripts
93
94       saAmfSIProtectedbySG            Required when several SGs are specified
95
96       safSg
97
98       safSi
99
100       saAmfSINumCSIs                  Required but not used.
101
102       safCSType
103
104       saAmfSGRedundancyModel          Currently only 'nplusm'  is  supported,
105                                       required.
106
107       saAmfSGNumPrefActiveSUs
108
109       saAmfSGNumPrefStandbySUs
110
111       saAmfSGMaxActiveSIsperSUs
112
113       saAmfSGMaxStandbySIsperSUs
114
115       saAmfSGCompRestartProb          Required but not used.
116
117       saAmfSGCompRestartMax
118
119       saAmfSGSuRestartProb            Required but not used.
120
121       saAmfSGAutoAdjustProb           Required but not used.
122
123       saAmfSGSuRestartMax
124
125       safSu
126
127       saAmfSUNumComponents            Required but not used.
128
129       saAmfSUIsExternal               Required but not used.
130
131       saAmfSUFailover                 Required but not used.
132
133       saAmfSUHostedByNode             Required.  Set  to AMF node name. Note:
134                                       this is a deviation from the specifica‐
135                                       tion.
136
137       safComp
138
139       saAmfCompCsTypes                Multivalue
140
141       saAmfCompCategory
142
143       saAmfCompCapability             Required but not used.
144
145       saAmfCompNumMaxActiveCsi        Required but not used.
146
147       saAmfCompNumMaxStandbyCsi       Required but not used.
148
149       saAmfCompCmdEnv                 Multivalue
150
151       saAmfCompDefaultClcCliTimeout   Required but not used.
152
153       saAmfCompDefaultCallbackTimeOut Required but not used.
154
155       saAmfCompInstantiateCmdArgv
156
157       saAmfCompInstantiateCmd
158
159       saAmfCompTerminateCmdArgv       Required but not used.
160
161       saAmfCompTerminateCmd           Required but not used.
162
163       saAmfCompCleanupCmdArgv
164
165       saAmfCompCleanupCmd
166
167       saAmfCompRecoveryOnError        Required but not used.
168
169       safHealthcheckKey
170
171       saAmfHealthcheckPeriod
172
173       saAmfHealthcheckMaxDuration
174
175       safCsi
176
177       saAmfSIPrefActiveAssignments
178
179       saAmfSIPrefStandbyAssignments
180
181       saAmfCSTypeName
182
183       safCSIAttr                      Multivalue
184
185
186

AUTHOR

188       Hans.Feldt at ericsson.com
189
190

EXAMPLE

192       For  an AMF configuration file example, see the amf.conf file under the
193       corosync conf directory.
194
195

FILES

197       /etc/ais/amf.conf
198
199       /etc/ais/corosync.conf
200
201

NAME

DESCRIPTION

AUTHOR

EXAMPLE

FILES

SEE ALSO