1OCF_HEARTBEAT_SAPINS(7) OCF resource agents OCF_HEARTBEAT_SAPINS(7)
2
6 ocf_heartbeat_SAPInstance - Manages a SAP instance as an HA resource.
7
9 SAPInstance [start | stop | status | monitor | promote | demote |
10 meta-data | validate-all]
11
13 Usually a SAP system consists of one database and at least one or more
14 SAP instances (sometimes called application servers). One SAP Instance
15 is defined by having exactly one instance profile. The instance
16 profiles can usually be found in the directory /sapmnt/SID/profile.
17 Each instance must be configured as it's own resource in the cluster
18 configuration. The resource agent supports the following SAP versions:
19 - SAP WebAS ABAP Release 6.20 - 7.30 - SAP WebAS Java Release 6.40 -
20 7.30 - SAP WebAS ABAP + Java Add-In Release 6.20 - 7.30 (Java is not
21 monitored by the cluster in that case) When using a SAP Kernel 6.40
22 please check and implement the actions from the section "Manual
23 postprocessing" from SAP note 995116 (http://sdn.sap.com).
24 All operations of the SAPInstance resource agent are done by using the
26 startup framework called SAP Management Console or sapstartsrv that was
27 introduced with SAP kernel release 6.40. Find more information about
28 the SAP Management Console in SAP note 1014480. Using this framework
29 defines a clear interface for the Heartbeat cluster, how it sees the
30 SAP system. The options for monitoring the SAP system are also much
31 better than other methods like just watching the ps command for running
32 processes or doing some pings to the application. sapstartsrv uses SOAP
33 messages to request the status of running SAP processes. Therefore it
34 can actually ask a process itself what it's status is, independent from
35 other problems that might exist at the same time.
36 sapstartsrv knows 4 status colours: - GREEN = everything is fine -
38 YELLOW = something is wrong, but the service is still working - RED =
39 the service does not work - GRAY = the service has not been started
40 The SAPInstance resource agent will interpret GREEN and YELLOW as OK.
42 That means that minor problems will not be reported to the Heartbeat
43 cluster. This prevents the cluster from doing an unwanted failover. The
44 statuses RED and GRAY are reported as NOT_RUNNING to the cluster.
45 Depending on the status the cluster expects from the resource, it will
46 do a restart, failover or just nothing.
47
49 InstanceName
50 The full qualified SAP instance name. e.g. P01_DVEBMGS00_sapp01ci.
51 Usually this is the name of the SAP instance profile. (unique,
52 required, string, no default)
53 DIR_EXECUTABLE
55 The full qualified path where to find sapstartsrv and sapcontrol.
56 Specify this parameter, if you have changed the SAP kernel
57 directory location after the default SAP installation. (unique,
58 optional, string, no default)
59 DIR_PROFILE
61 The full qualified path where to find the SAP START profile.
62 Specify this parameter, if you have changed the SAP profile
63 directory location after the default SAP installation. (unique,
64 optional, string, no default)
65 START_PROFILE
67 The name of the SAP START profile. Specify this parameter, if you
68 have changed the name of the SAP START profile after the default
69 SAP installation. As SAP release 7.10 does not have a START profile
70 anymore, you need to specify the Instance Profile than. (unique,
71 optional, string, no default)
72 START_WAITTIME
74 After that time in seconds a monitor operation is executed by the
75 resource agent. Does the monitor return SUCCESS, the start
76 ishandled as SUCCESS. This is useful to resolve timing problems
77 with e.g. the J2EE-Addin instance.Usually the resource agent waits
78 until all services are started and the SAP Management Console
79 reports a GREEN status. A double stack installation (ABAP + Java
80 AddIn) consists of an ABAP dispatcher and aJAVA instance. Normally
81 the start of the JAVA instance takes much longer than the start of
82 the ABAP instance. For a JAVA Instance you may need to configure a
83 much higher timeout for the start operation of the resource in
84 Heartbeat. The disadvantage here is, that the discovery of a failed
85 start by the cluster takes longer. Somebody might say: For me it is
86 important, that the ABAP instance is up and running. A failure of
87 the JAVA instance shall not cause a failover of the SAP instance.
88 Actually the SAP MC reports a YELLOW status, if the JAVA instance
89 of a double stack system fails. From the resource agent point of
90 view YELLOW means:everything is OK. Setting START_WAITTIME to a
91 lower value determines the resource agent to check the status of
92 the instance during a start operation after that time. As it would
93 wait normally for a GREEN status, now it reports SUCCESS to the
94 cluster in case of a YELLOW status already after the specified
95 time. .sp That is only useful for double stack systems. (unique,
96 optional, string, default 3600)
97 AUTOMATIC_RECOVER
99 The SAPInstance resource agent tries to recover a failed start
100 attempt automaticaly one time. This is done by killing runing
101 instance processes, removing the kill.sap file and executing
102 cleanipc. Sometimes a crashed SAP instance leaves some processes
103 and/or shared memory segments behind. Setting this option to true
104 will try to remove those leftovers during a start operation. That
105 is to reduce manual work for the administrator. (unique, optional,
106 boolean, default false)
107 MONITOR_SERVICES
109 Within a SAP instance there can be several services. Usually you
110 will find the defined services in the START profile of the related
111 instance (Attention: with SAP Release 7.10 the START profile
112 content was moved to the instance profile). Not all of those
113 services are worth to monitor by the cluster. For example you
114 properly do not like to failover your SAP instance, if the central
115 syslog collector daemon fails. Those services are monitored within
116 the SAPInstance resource agent: .sp - disp+work - msg_server -
117 enserver - enrepserver - jcontrol - jstart .sp That names match the
118 strings used in the output of the command 'sapcontrol -nr
119 [Instance-Nr] -function GetProcessList'. The default should fit
120 most cases where you want to manage a SAP Instance from the
121 cluster. You may change this with this parameter, if you like to
122 monitor more/less or other services that sapstartsrv supports. You
123 may specify multiple services seperated by a | (pipe) sign in this
124 parameter: disp+work|msg_server|enserver (unique, optional, string,
125 default disp+work|msg_server|enserver|enrepserver|jcontrol|jstart)
126 SHUTDOWN_METHOD
128 Usual a SAP Instance is stopped by the command 'sapcontrol -nr
129 InstanceNr -function Stop'. SHUTDOWN_METHOD=KILL means to kill the
130 SAP Instance using OS commands. SAP processes of the instance are
131 terminated with 'kill -9', shared memory is deleted with 'cleanipc'
132 and the 'kill.sap' file will be deleted. That method is much faster
133 than the gracefull stop, but the instance does not have the chance
134 to say goodbye to other SAPinstances in the same system. USE AT
135 YOUR OWN RISK !! (unique, optional, string, default normal)
136 ERS_InstanceName
138 Only used in a Master/Slave resource configuration: The full
139 qualified SAP enqueue replication instance name. e.g.
140 P01_ERS02_sapp01ers. Usually this is the name of the SAP instance
141 profile. The enqueue replication instance must be installed, before
142 you want to configure a master-slave cluster recource. .sp The
143 master-slave configuration in the cluster must use this properties:
144 clone_max = 2 clone_node_max = 1 master_node_max = 1 master_max = 1
145 (unique, optional, string, no default)
146 ERS_START_PROFILE
148 Only used in a Master/Slave resource configuration: The parameter
149 ERS_InstanceName must also be set in this configuration. The name
150 of the SAP START profile. Specify this parameter, if you have
151 changed the name of the SAP START profile after the default SAP
152 installation. As SAP release 7.10 does not have a START profile
153 anymore, you need to specify the Instance Profile than. (unique,
154 optional, string, no default)
155 PRE_START_USEREXIT
157 The full qualified path where to find a script or program which
158 should be executed before this resource gets started. (unique,
159 optional, string, no default)
160 POST_START_USEREXIT
162 The full qualified path where to find a script or program which
163 should be executed after this resource got started. (unique,
164 optional, string, no default)
165 PRE_STOP_USEREXIT
167 The full qualified path where to find a script or program which
168 should be executed before this resource gets stopped. (unique,
169 optional, string, no default)
170 POST_STOP_USEREXIT
172 The full qualified path where to find a script or program which
173 should be executed after this resource got stopped. (unique,
174 optional, string, no default)
175
177 This resource agent supports the following actions (operations):
178 start
180 Starts the resource. Suggested minimum timeout: 180.
181 stop
183 Stops the resource. Suggested minimum timeout: 240.
184 status
186 Performs a status check. Suggested minimum timeout: 60.
187 monitor
189 Performs a detailed status check. Suggested minimum timeout: 60.
190 Suggested interval: 120.
191 promote
193 Promotes the resource to the Master role. Suggested minimum
194 timeout: 320.
195 demote
197 Demotes the resource to the Slave role. Suggested minimum timeout:
198 320.
199 validate-all
201 Performs a validation of the resource configuration. Suggested
202 minimum timeout: 5.
203 meta-data
205 Retrieves resource agent metadata (internal use only). Suggested
206 minimum timeout: 5.
207 methods
209 Suggested minimum timeout: 5.
210
212 The following is an example configuration for a SAPInstance resource
213 using the crm(8) shell:
214 primitive p_SAPInstance ocf:heartbeat:SAPInstance \
216 params \
217 InstanceName=string \
218 op monitor depth="0" timeout="60" interval="120"
219 ms ms_SAPInstance p_SAPInstance \
221 meta notify="true" interleave="true"
222
224 http://www.linux-ha.org/wiki/SAPInstance_(resource_agent)
225
227 Linux-HA contributors (see the resource agent source for information
228 about individual authors)
229resource-agents 3.9.2 07/08/2011 OCF_HEARTBEAT_SAPINS(7)