amf (5) - Linux Manuals

amf: corosync AMF configuration file

NAME

amf.conf - corosync AMF configuration file

DESCRIPTION

amf.conf is the configuration file that determines the behaviour of the AIS Availability Management Framework service, AMF in the corosync implementation.

Entries in this file will for example determine what applications AMF will start and how to supervise them. By default AMF opens /etc/ais/amf.conf. The environment variable OPENAIS_AMF_CONFIG_FILE can be set to the pathname of an AMF configuration file to override the default behaviour. Any line whose first non-white-space character is a '#' is considered a comment line. Empty lines are ignored.

The file contains object entries of the form:

<Object Class> = <Object Name> {
<attribute> = <value>

}

Object entries are nested, one entry contains another entry. This way relations between objects are built up. For example a component object defined inside a Software Unit (SU) object means that the component belongs to the SU. In other words, the SU is composed of the component. See the example configuration file.

The relation between objects has to comply with the AMF model specified in [5].

Object names shall use only printable ASCII characters. Object names shall be unique within its context, i.e. two components within the same service unit has to have different names, but can have the same name as another component within another service unit.

Attribute names are consistent with the naming of the configuration attributes in [5].

AMF object attributes are either configuration or runtime attributes. The AMF configuration file is used to specify configuration attributes. Some configuration attributes have default values and does not need to be specified. Others are not valid in certain redundancy models and so on.

The type of an attribute value is either a string, a number, a time or an enumeration. Enumeration values are specified according to the type definition in the AIS specification. Time values are specified in milliseconds.

Multivalue attributes are specified using multiple entries with the same attribute name but different values. See the example configuration file.

The (RDN) value of 'safAmfNode' is a logical name for an AMF node. It is mapped to a real physical node using the attribute 'saAmfNodeClmNode'.

The value of the attribute 'saAmfNodeClmNode' should be the hostname (without domain name) as given to the host at boot time. This name is returned by the shell command 'hostname'.

Currently, AMF is enabled/disabled by an entry in the corosync.conf file, see [1]. It is default disabled.

The following list of attributes is currently supported:

safAmfCluster

saAmfClusterStartupTimeout

safAmfNode

saAmfNodeClmNode

Host name, required

saAmfNodeSuFailOverProb

Required but not used.

saAmfNodeSuFailoverMax

Required but not used.

safApp

clccli_path

A path added to all CLC-CLI scripts

saAmfSIProtectedbySG

Required when several SGs are specified

safSg

safSi

saAmfSINumCSIs

Required but not used.

safCSType

saAmfSGRedundancyModel

Currently only 'nplusm' is supported, required.

saAmfSGNumPrefActiveSUs

saAmfSGNumPrefStandbySUs

saAmfSGMaxActiveSIsperSUs

saAmfSGMaxStandbySIsperSUs

saAmfSGCompRestartProb

Required but not used.

saAmfSGCompRestartMax

saAmfSGSuRestartProb

Required but not used.

saAmfSGAutoAdjustProb

Required but not used.

saAmfSGSuRestartMax

safSu

saAmfSUNumComponents

Required but not used.

saAmfSUIsExternal

Required but not used.

saAmfSUFailover

Required but not used.

saAmfSUHostedByNode

Required. Set to AMF node name. Note: this is a deviation from the specification.

safComp

saAmfCompCsTypes

Multivalue

saAmfCompCategory

saAmfCompCapability

Required but not used.

saAmfCompNumMaxActiveCsi

Required but not used.

saAmfCompNumMaxStandbyCsi

Required but not used.

saAmfCompCmdEnv

Multivalue

saAmfCompDefaultClcCliTimeout

Required but not used.

saAmfCompDefaultCallbackTimeOut

Required but not used.

saAmfCompInstantiateCmdArgv

saAmfCompInstantiateCmd

saAmfCompTerminateCmdArgv

Required but not used.

saAmfCompTerminateCmd

Required but not used.

saAmfCompCleanupCmdArgv

saAmfCompCleanupCmd

saAmfCompRecoveryOnError

Required but not used.

safHealthcheckKey

saAmfHealthcheckPeriod

saAmfHealthcheckMaxDuration

safCsi

saAmfSIPrefActiveAssignments

saAmfSIPrefStandbyAssignments

saAmfCSTypeName

safCSIAttr

Multivalue

AUTHOR

Hans.Feldt at ericsson.com

EXAMPLE

For an AMF configuration file example, see the amf.conf file under the corosync conf directory.

FILES

/etc/ais/amf.conf

/etc/ais/corosync.conf