~ubuntu-branches/ubuntu/utopic/pacemaker/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/Pacemaker_Explained/en-US/Ch-Options.txt

  • Committer: Package Import Robot
  • Author(s): Andres Rodriguez
  • Date: 2013-07-16 16:40:24 UTC
  • mfrom: (1.1.11) (2.2.3 experimental)
  • Revision ID: package-import@ubuntu.com-20130716164024-lvwrf4xivk1wdr3c
Tags: 1.1.9+git20130321-1ubuntu1
* Resync from debian expiremental.
* debian/control:
  - Use lower version for Build-Depends on libcorosync-dev
    and libqb-dev.
  - Build-Depends on libcfg-dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
 
3
3
== Special Options ==
4
4
 
5
 
indexterm:[Special Cluster Options]
6
 
indexterm:[Cluster Options,Special Options]
7
 
 
8
5
The reason for these fields to be placed at the top level instead of
9
6
with the rest of cluster options is simply a matter of parsing.  These
10
7
options are used by the configuration database which is, by design,
13
10
      
14
11
== Configuration Version ==
15
12
 
16
 
indexterm:[Configuration Version, Cluster Option]
17
 
indexterm:[Cluster Options,Configuration Version]
 
13
indexterm:[Configuration Version,Cluster]
 
14
indexterm:[Cluster,Option,Configuration Version]
18
15
 
19
16
When a node joins the cluster, the cluster will perform a check to see
20
17
who has the best configuration based on the fields below.  It then
23
20
setting them, and setting them correctly, very important.
24
21
 
25
22
.Configuration Version Properties
26
 
[width="95%",cols="1m,5<",options="header",align="center"]
 
23
[width="95%",cols="2m,5<",options="header",align="center"]
27
24
|=========================================================
28
25
|Field |Description
29
26
 
30
27
| admin_epoch |
31
 
indexterm:[admin_epoch Cluster Option]
32
 
indexterm:[Cluster Options,admin_epoch]
 
28
indexterm:[admin_epoch,Cluster Option]
 
29
indexterm:[Cluster,Option,admin_epoch]
33
30
Never modified by the cluster. Use this to make the configurations on
34
31
any inactive nodes obsolete.
35
32
 
38
35
when nothing is found on disk.
39
36
 
40
37
| epoch | 
41
 
indexterm:[epoch Cluster Option]
42
 
indexterm:[Cluster Options,epoch]
 
38
indexterm:[epoch,Cluster Option]
 
39
indexterm:[Cluster,Option,epoch]
43
40
Incremented every time the configuration is updated (usually by the admin)
44
41
 
45
42
| num_updates |
46
 
indexterm:[num_updates Cluster Option]
47
 
indexterm:[Cluster Options,num_updates]
 
43
indexterm:[num_updates,Cluster Option]
 
44
indexterm:[Cluster,Option,num_updates]
48
45
Incremented every time the configuration or status is updated (usually by the cluster)
49
46
  
50
47
|=========================================================
51
48
 
52
49
== Other Fields ==
53
50
.Properties Controlling Validation
54
 
[width="95%",cols="1m,5<",options="header",align="center"]
 
51
[width="95%",cols="2m,5<",options="header",align="center"]
55
52
|=========================================================
56
53
|Field |Description
57
54
      
58
55
| validate-with |
59
 
indexterm:[validate-with Cluster Option]
60
 
indexterm:[Cluster Options,validate-with]
 
56
indexterm:[validate-with,Cluster Option]
 
57
indexterm:[Cluster,Option,validate-with]
61
58
Determines the type of validation being done on the configuration.  If
62
59
set to "none", the cluster will not verify that updates conform to the
63
60
DTD (nor reject ones that don't). This option can be useful when
68
65
== Fields Maintained by the Cluster ==
69
66
 
70
67
.Properties Maintained by the Cluster
71
 
[width="95%",cols="1m,5<",options="header",align="center"]
 
68
[width="95%",cols="2m,5<",options="header",align="center"]
72
69
|=========================================================
73
70
|Field |Description
74
71
 
75
 
|crm-debug-origin |
76
 
indexterm:[crm-debug-origin Cluster Fields]
77
 
indexterm:[Cluster Fields,crm-debug-origin]
78
 
Indicates where the last update came from. Informational purposes only.
79
 
 
80
72
|cib-last-written | 
81
 
indexterm:[cib-last-written Cluster Fields]
82
 
indexterm:[Cluster Fields,cib-last-written]
 
73
indexterm:[cib-last-written,Cluster Property]
 
74
indexterm:[Cluster,Property,cib-last-written]
83
75
Indicates when the configuration was last written to disk. Informational purposes only.
84
76
 
85
77
|dc-uuid |
86
 
indexterm:[dc-uuid Cluster Fields]
87
 
indexterm:[Cluster Fields,dc-uuid]
 
78
indexterm:[dc-uuid,Cluster Property]
 
79
indexterm:[Cluster,Property,dc-uuid]
88
80
Indicates which cluster node is the current leader. Used by the
89
81
cluster when placing resources and determining the order of some
90
82
events.
91
83
 
92
84
|have-quorum |
93
 
indexterm:[have-quorum Cluster Fields]
94
 
indexterm:[Cluster Fields,have-quorum]
 
85
indexterm:[have-quorum,Cluster Property]
 
86
indexterm:[Cluster,Property,have-quorum]
95
87
Indicates if the cluster has quorum. If false, this may mean that the
96
88
cluster cannot start resources or fence other nodes. See
97
89
+no-quorum-policy+ below.
103
95
admin with the "correct" ones.  To change the +admin_epoch+, for
104
96
example, one would use:
105
97
 
106
 
pass:[<command>cibadmin --modify --crm_xml ‘&lt;cib admin_epoch="42"/>'</command>]
 
98
[source,C]
 
99
# cibadmin --modify --crm_xml '<cib admin_epoch="42"/>'
107
100
 
108
101
A complete set of fields will look something like this:
109
102
 
110
103
.An example of the fields set for a cib object
 
104
======
111
105
[source,XML]
112
106
-------
113
107
<cib have-quorum="true" validate-with="pacemaker-1.0"
114
108
  admin_epoch="1" epoch="12" num_updates="65"
115
109
  dc-uuid="ea7d39f4-3b94-4cfa-ba7a-952956daabee">
116
110
-------
 
111
======
117
112
 
118
113
== Cluster Options ==
119
114
 
122
117
 
123
118
They are grouped into sets and, in advanced configurations, there may
124
119
be more than one.
125
 
footnote:[This will be described later in the section on <xref
126
 
linkend="ch-rules"/> where we will show how to have the cluster use
 
120
footnote:[This will be described later in the section on
 
121
<<ch-rules>> where we will show how to have the cluster use
127
122
different sets of options during working hours (when downtime is
128
123
usually to be avoided at all costs) than it does during the weekends
129
124
(when resources can be moved to the their preferred hosts without
132
127
 
133
128
== Available Cluster Options ==
134
129
.Cluster Options
135
 
[width="95%",cols="5m,2m,13",options="header",align="center"]
 
130
[width="95%",cols="5m,2,11<",options="header",align="center"]
136
131
|=========================================================
137
132
|Option |Default |Description
138
133
      
139
134
| batch-limit | 30 |
140
 
indexterm:[batch-limit Cluster Options]
141
 
indexterm:[Cluster Options,batch-limit]
 
135
indexterm:[batch-limit,Cluster Option]
 
136
indexterm:[Cluster,Option,batch-limit]
142
137
The number of jobs that the TE is allowed to execute in parallel. The
143
138
"correct" value will depend on the speed and load of your network and
144
139
cluster nodes.
145
140
 
146
141
| migration-limit | -1 (unlimited) |
147
 
indexterm:[migration-limit Cluster Options]
148
 
indexterm:[Cluster Options,migration-limit]
 
142
indexterm:[migration-limit,Cluster Option]
 
143
indexterm:[Cluster,Option,migration-limit]
149
144
The number of migration jobs that the TE is allowed to execute in
150
145
parallel on a node.
151
146
 
152
147
| no-quorum-policy | stop |
153
 
indexterm:[no-quorum-policy Cluster Options]
154
 
indexterm:[Cluster Options,no-quorum-policy]
 
148
indexterm:[no-quorum-policy,Cluster Option]
 
149
indexterm:[Cluster,Option,no-quorum-policy]
155
150
What to do when the cluster does not have quorum.  Allowed values:
156
151
 
157
152
 * ignore - continue all resource management
 
153
 
158
154
 * freeze - continue resource management, but don't recover resources from nodes not in the affected partition
 
155
 
159
156
 * stop - stop all resources in the affected cluster partition
 
157
 
160
158
 * suicide - fence all nodes in the affected cluster partition
161
159
 
162
160
| symmetric-cluster | TRUE | 
163
 
indexterm:[symmetric-cluster Cluster Options]
164
 
indexterm:[Cluster Options,symmetric-cluster]
 
161
indexterm:[symmetric-cluster,Cluster Option]
 
162
indexterm:[Cluster,Option,symmetric-cluster]
165
163
Can all resources run on any node by default?
166
164
 
167
165
| stonith-enabled | TRUE |
168
 
indexterm:[stonith-enabled Cluster Options]
169
 
indexterm:[Cluster Options,stonith-enabled]
 
166
indexterm:[stonith-enabled,Cluster Option]
 
167
indexterm:[Cluster,Option,stonith-enabled]
170
168
Should failed nodes and nodes with resources that can't be stopped be
171
169
shot? If you value your data, set up a STONITH device and enable this.
172
170
 
174
172
one or more STONITH resources have been configured also.
175
173
        
176
174
| stonith-action | reboot |
177
 
indexterm:[stonith-action Cluster Options]
178
 
indexterm:[Cluster Options,stonith-action]
179
 
Action to send to STONITH device. Allowed values: reboot, poweroff.
 
175
indexterm:[stonith-action,Cluster Option]
 
176
indexterm:[Cluster,Option,stonith-action]
 
177
Action to send to STONITH device. Allowed values: reboot, off.
 
178
The value 'poweroff' is also allowed, but is only used for
 
179
legacy devices.
180
180
 
181
181
| cluster-delay | 60s |
182
 
indexterm:[cluster-delay Cluster Options]
183
 
indexterm:[Cluster Options,cluster-delay]
 
182
indexterm:[cluster-delay,Cluster Option]
 
183
indexterm:[Cluster,Option,cluster-delay]
184
184
Round trip delay over the network (excluding action execution). The
185
185
"correct" value will depend on the speed and load of your network and
186
186
cluster nodes.
187
187
 
188
188
| stop-orphan-resources | TRUE |
189
 
indexterm:[stop-orphan-resources Cluster Options]
190
 
indexterm:[Cluster Options,stop-orphan-resources]
 
189
indexterm:[stop-orphan-resources,Cluster Option]
 
190
indexterm:[Cluster,Option,stop-orphan-resources]
191
191
Should deleted resources be stopped?
192
192
 
193
193
| stop-orphan-actions | TRUE | 
194
 
indexterm:[stop-orphan-actions Cluster Options]
195
 
indexterm:[Cluster Options,stop-orphan-actions]
 
194
indexterm:[stop-orphan-actions,Cluster Option]
 
195
indexterm:[Cluster,Option,stop-orphan-actions]
196
196
Should deleted actions be cancelled?
197
197
 
198
198
| start-failure-is-fatal | TRUE | 
199
 
indexterm:[start-failure-is-fatal Cluster Options]
200
 
indexterm:[Cluster Options,start-failure-is-fatal]
 
199
indexterm:[start-failure-is-fatal,Cluster Option]
 
200
indexterm:[Cluster,Option,start-failure-is-fatal]
201
201
When set to FALSE, the cluster will instead use the resource's
202
202
+failcount+ and value for +resource-failure-stickiness+.
203
203
 
204
204
| pe-error-series-max | -1 (all) | 
205
 
indexterm:[pe-error-series-max Cluster Options]
206
 
indexterm:[Cluster Options,pe-error-series-max]
 
205
indexterm:[pe-error-series-max,Cluster Option]
 
206
indexterm:[Cluster,Option,pe-error-series-max]
207
207
The number of PE inputs resulting in ERRORs to save. Used when reporting problems.
208
208
 
209
209
| pe-warn-series-max | -1 (all) | 
210
 
indexterm:[pe-warn-series-max Cluster Options]
211
 
indexterm:[Cluster Options,pe-warn-series-max]
 
210
indexterm:[pe-warn-series-max,Cluster Option]
 
211
indexterm:[Cluster,Option,pe-warn-series-max]
212
212
The number of PE inputs resulting in WARNINGs to save. Used when reporting problems.
213
213
 
214
214
| pe-input-series-max | -1 (all) |
215
 
indexterm:[pe-input-series-max Cluster Options]
216
 
indexterm:[Cluster Options,pe-input-series-max]
 
215
indexterm:[pe-input-series-max,Cluster Option]
 
216
indexterm:[Cluster,Option,pe-input-series-max]
217
217
The number of "normal" PE inputs to save. Used when reporting problems.
218
218
  
219
219
|=========================================================
220
220
 
221
221
You can always obtain an up-to-date list of cluster options, including
222
 
their default values, by running the pass:[<command>pengine
223
 
metadata</command>] command.
 
222
their default values, by running the `pengine
 
223
metadata` command.
224
224
 
225
225
== Querying and Setting Cluster Options ==
226
226
 
227
 
indexterm:[Querying Cluster Options]
228
 
indexterm:[Setting Cluster Options]
229
 
indexterm:[Cluster Options,Querying]
230
 
indexterm:[Cluster Options,Setting]
 
227
indexterm:[Querying,Cluster Option]
 
228
indexterm:[Setting,Cluster Option]
 
229
indexterm:[Cluster,Querying Options]
 
230
indexterm:[Cluster,Setting Options]
231
231
 
232
232
Cluster options can be queried and modified using the
233
 
pass:[<command>crm_attribute</command>] tool.  To get the current
 
233
`crm_attribute` tool.  To get the current
234
234
value of +cluster-delay+, simply use:
235
235
 
236
 
pass:[<command>crm_attribute --attr-name cluster-delay --get-value</command>]
 
236
[source,C]
 
237
# crm_attribute --attr-name cluster-delay --get-value
237
238
 
238
239
which is more simply written as
239
240
 
240
 
pass:[<command>crm_attribute --get-value -n cluster-delay</command>]
 
241
[source,C]
 
242
# crm_attribute --get-value -n cluster-delay
241
243
 
242
244
If a value is found, you'll see a result like this:
243
 
=======
244
 
pass:[<command> # crm_attribute --get-value -n cluster-delay</command>]
245
245
 
 
246
[source,C]
 
247
# crm_attribute --get-value -n cluster-delay
246
248
 name=cluster-delay value=60s
247
 
========
248
249
 
249
250
However, if no value is found, the tool will display an error:
250
 
=======
251
 
pass:[<command># crm_attribute --get-value -n clusta-deway</command>]
252
251
 
253
 
 name=clusta-deway value=(null)
254
 
 Error performing operation: The object/attribute does not exist
255
 
========
 
252
[source,C]
 
253
# crm_attribute --get-value -n clusta-deway`
 
254
name=clusta-deway value=(null)
 
255
Error performing operation: The object/attribute does not exist
256
256
 
257
257
To use a different value, eg. +30+, simply run:
258
258
 
259
 
pass:[<command>crm_attribute --attr-name cluster-delay --attr-value 30s</command>]
 
259
[source,C]
 
260
# crm_attribute --attr-name cluster-delay --attr-value 30s
260
261
 
261
262
To go back to the cluster's default value you can delete the value, for example with this command:
262
263
 
263
 
pass:[<command>crm_attribute --attr-name cluster-delay --delete-attr</command>]
 
264
[source,C]
 
265
# crm_attribute --attr-name cluster-delay --delete-attr
264
266
 
265
267
== When Options are Listed More Than Once ==
266
268
 
268
270
 
269
271
.Deleting an option that is listed twice
270
272
=======
271
 
pass:[<command># crm_attribute --attr-name batch-limit --delete-attr</command>]
 
273
[source,C]
 
274
------
 
275
# crm_attribute --attr-name batch-limit --delete-attr
272
276
 
273
 
 Multiple attributes match name=batch-limit in crm_config:
274
 
 Value: 50          (set=cib-bootstrap-options, id=cib-bootstrap-options-batch-limit)
275
 
 Value: 100         (set=custom, id=custom-batch-limit)
276
 
 Please choose from one of the matches above and supply the 'id' with --attr-id
 
277
Multiple attributes match name=batch-limit in crm_config:
 
278
Value: 50          (set=cib-bootstrap-options, id=cib-bootstrap-options-batch-limit)
 
279
Value: 100         (set=custom, id=custom-batch-limit)
 
280
Please choose from one of the matches above and supply the 'id' with --attr-id
 
281
-------
277
282
=======
278
283
 
279
284
In such cases follow the on-screen instructions to perform the
280
285
requested action.  To determine which value is currently being used by
281
 
the cluster, please refer to the section on <xref
282
 
linkend="ch-rules"/>.
 
286
the cluster, please refer to <<ch-rules>>.