ocf_heartbeat_gcp-ilb(7)

1OCF_HEARTBEAT_GCP-I(7)        OCF resource agents       OCF_HEARTBEAT_GCP-I(7)
2
3
4

NAME

6       ocf_heartbeat_gcp-ilb - Replies to health checks from Google Cloud
7

SYNOPSIS

9       gcp-ilb [start | stop | monitor | meta-data | validate-all]
10

DESCRIPTION

12       Resource Agent that wraps /usr/bin/nc or /usr/bin/socat to reply to
13       health checks in Google Cloud. See
14       https://cloud.google.com/load-balancing/docs/health-checks for more
15       information.
16

SUPPORTED PARAMETERS

18       port
19           Listening port for health-check probes. Default: 60000
20
21           (optional, string, default "60000")
22
23       cat
24           Location of netcat (default: /usr/bin/nc ) or socat (default:
25           /usr/bin/socat ). If present, is used /usr/bin/socat. The
26           recommended binary is socat, present in the following minimum
27           versions if the package resource-agents: - SLES 12 SP4/SP5:
28           resource-agents-4.3.018.a7fb5035-3.30.1. - SLES 15/15 SP1:
29           resource-agents-4.3.0184.6ee15eb2-4.13.1.
30
31           (optional, string, default "nc")
32
33       log_enable
34           Logging with an external application is enabled (accepts "true" or
35           "false"). The defaults are configured to call "gcloud logging"
36           (see: https://cloud.google.com/sdk/gcloud/reference/logging).
37
38           (optional, string, default "false")
39
40       log_cmd
41           External logging command. The defaults are configured to call
42           "gcloud logging" (see:
43           https://cloud.google.com/sdk/gcloud/reference/logging). This
44           parameter should only have the binary that can be validated (e.g.,
45           gcloud). The rest of the command is formed with the additional
46           parameters and the message being logged as follows: - log_cmd +
47           log_params + "The message being logged" + log_end_params Using the
48           gcloud command for Stackdriver logging, the parameters would be: -
49           log_cmd = gcloud - log_params = logging write GCPILB - "This is a
50           message being sent by the app" - log_end_params = (nothing in this
51           case, this is reserved for use with other tools) Which would result
52           in this valid command (where GCPILB is the name of the log): gcloud
53           logging write GCPILB "This is a message being sent by the app"
54
55           NOTE: Only the binary is validated for existence and no further
56           checks are performed. The assumption is that only administrators
57           with root access can configure this tool.
58
59           (optional, string, default "gcloud")
60
61       log_params
62           Additional input for the logging application. See explanation for
63           log_cmd
64
65           (optional, string, default "logging write GCPILB")
66
67       log_end_params
68           Additional input for the logging application. Placed after the
69           message being logged.
70
71           (optional, string, no default)
72

SUPPORTED ACTIONS

74       This resource agent supports the following actions (operations):
75
76       start
77           Starts the resource. Suggested minimum timeout: 10s.
78
79       stop
80           Stops the resource. Suggested minimum timeout: 30s.
81
82       monitor
83           Performs a detailed status check. Suggested minimum timeout: 30s.
84           Suggested interval: 30s.
85
86       validate-all
87           Performs a validation of the resource configuration. Suggested
88           minimum timeout: 5s.
89
90       meta-data
91           Retrieves resource agent metadata (internal use only). Suggested
92           minimum timeout: 5s.
93

EXAMPLE CRM SHELL

95       The following is an example configuration for a gcp-ilb resource using
96       the crm(8) shell:
97
98           primitive p_gcp-ilb ocf:heartbeat:gcp-ilb \
99             op monitor depth="0" timeout="30s" interval="30s"
100

EXAMPLE PCS

102       The following is an example configuration for a gcp-ilb resource using
103       pcs(8)
104
105           pcs resource create p_gcp-ilb ocf:heartbeat:gcp-ilb \
106             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="30s"
107

AUTHOR

112       ClusterLabs contributors (see the resource agent source for information
113       about individual authors)
114
115
116
117resource-agents UNKNOWN           10/11/2023            OCF_HEARTBEAT_GCP-I(7)