ocf_heartbeat_ovsmonitor(7)

1OCF_HEARTBEAT_OVSMON(7)       OCF resource agents      OCF_HEARTBEAT_OVSMON(7)
2
3
4

NAME

6       ocf_heartbeat_ovsmonitor - Monitors ovs bonding bonds
7

SYNOPSIS

9       ovsmonitor [start | stop | status | monitor | meta-data | validate-all]
10

DESCRIPTION

12       Monitor the vitality of a local ovs bond.
13
14       You may set up this RA as a clone resource to monitor the network bonds
15       on different nodes, with the same bond name. This is not related to the
16       IP address or the network on which a bond is configured. You may use
17       this RA to move resources away from a node, which has a faulty bond or
18       prevent moving resources to such a node. This gives you independent
19       control of the resources, without involving cluster intercommunication.
20       But it requires your nodes to have more than one network bond.
21
22       The resource configuration requires a monitor operation, because the
23       monitor does the main part of the work. In addition to the resource
24       configuration, you need to configure some location constraints, based
25       on a CIB attribute value. The name of the attribute value is configured
26       in the 'name' option of this RA.
27
28       Example constraint configuration using crmsh location
29       loc_connected_node my_resource_grp rule ="rule_loc_connected_node"
30       -INF: ovsmonitor-bond-public eq 0
31
32       Example constraint configuration using pcs. Only allow 'my_resource' to
33       run on nodes where eth0 ethernet device is available. pcs constraint
34       location my_resource rule score=-INFINITY ovsmonitor-bond-public ne 1
35
36       The ethmonitor works in 3 different modes to test the bond vitality. 1.
37       call ovs-appctl to see if at least one of the bonding's link status is
38       up (if link is down -> error) 2. call ovs-ofctl and watch the RX
39       counter (if packages come around in a certain time -> success) 3.
40       return error
41

SUPPORTED PARAMETERS

43       bond
44           The name of the network bond which should be monitored (e.g.
45           bond-public).
46
47           (unique, required, string, no default)
48
49       bridge
50           The name of the ovs bridge that contains the bridge.
51
52           (unique, required, string, no default)
53
54       name
55           The name of the CIB attribute to set. This is the name to be used
56           in the constraints. Defaults to "ovsmonitor-'bond_name'".
57
58           (unique, optional, string, no default)
59
60       multiplier
61           Multiplier for the value of the CIB attriobute specified in
62           parameter name.
63
64           (optional, integer, default 1)
65
66       repeat_count
67           Specify how often the bond will be monitored, before the status is
68           set to failed. You need to set the timeout of the monitoring
69           operation to at least repeat_count * repeat_interval
70
71           (optional, integer, default 5)
72
73       repeat_interval
74           Specify how long to wait in seconds between the repeat_counts.
75
76           (optional, integer, default 10)
77
78       pktcnt_timeout
79           Timeout for the RX packet counter. Stop listening for packet
80           counter changes after the given number of seconds.
81
82           (optional, integer, default 5)
83
84       link_status_only
85           Only report success based on link status. Do not perform RX counter
86           related connectivity tests.
87
88           (optional, boolean, default false)
89

SUPPORTED ACTIONS

91       This resource agent supports the following actions (operations):
92
93       start
94           Starts the resource. Suggested minimum timeout: 60s.
95
96       stop
97           Stops the resource. Suggested minimum timeout: 20s.
98
99       status
100           Performs a status check. Suggested minimum timeout: 60s. Suggested
101           interval: 10s.
102
103       monitor
104           Performs a detailed status check. Suggested minimum timeout: 60s.
105           Suggested interval: 10s.
106
107       meta-data
108           Retrieves resource agent metadata (internal use only). Suggested
109           minimum timeout: 5s.
110
111       validate-all
112           Performs a validation of the resource configuration. Suggested
113           minimum timeout: 20s.
114

EXAMPLE CRM SHELL

116       The following is an example configuration for a ovsmonitor resource
117       using the crm(8) shell:
118
119           primitive p_ovsmonitor ocf:heartbeat:ovsmonitor \
120             params \
121               bond=string \
122               bridge=string \
123             op monitor depth="0" timeout="60s" interval="10s"
124

EXAMPLE PCS

126       The following is an example configuration for a ovsmonitor resource
127       using pcs(8)
128
129           pcs resource create p_ovsmonitor ocf:heartbeat:ovsmonitor \
130             bond=string \
131             bridge=string \
132             op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="10s"
133

AUTHOR

138       ClusterLabs contributors (see the resource agent source for information
139       about individual authors)
140
141
142
143resource-agents UNKNOWN           01/25/2023           OCF_HEARTBEAT_OVSMON(7)