'\" t
.\"     Title: ocf_heartbeat_gcp-ilb
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_GCP\-I" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_gcp-ilb \- Replies to health checks from Google Cloud
.SH "SYNOPSIS"
.HP \w'\fBgcp\-ilb\fR\ 'u
\fBgcp\-ilb\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource Agent that wraps /usr/bin/nc or /usr/bin/socat to reply to health checks in Google Cloud\&. See https://cloud\&.google\&.com/load\-balancing/docs/health\-checks for more information\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBport\fR
.RS 4
Listening port for health\-check probes\&. Default: 60000
.sp
(optional, string, default "60000")
.RE
.PP
\fBcat\fR
.RS 4
Location of netcat (default: /usr/bin/nc ) or socat (default: /usr/bin/socat )\&. If present, is used /usr/bin/socat\&. The recommended binary is socat, present in the following minimum versions if the package resource\-agents: \- SLES 12 SP4/SP5: resource\-agents\-4\&.3\&.018\&.a7fb5035\-3\&.30\&.1\&. \- SLES 15/15 SP1: resource\-agents\-4\&.3\&.0184\&.6ee15eb2\-4\&.13\&.1\&.
.sp
(optional, string, default "nc")
.RE
.PP
\fBlog_enable\fR
.RS 4
Logging with an external application is enabled (accepts "true" or "false")\&. The defaults are configured to call "gcloud logging" (see: https://cloud\&.google\&.com/sdk/gcloud/reference/logging)\&.
.sp
(optional, string, default "false")
.RE
.PP
\fBlog_cmd\fR
.RS 4
External logging command\&. The defaults are configured to call "gcloud logging" (see: https://cloud\&.google\&.com/sdk/gcloud/reference/logging)\&. This parameter should only have the binary that can be validated (e\&.g\&., gcloud)\&. The rest of the command is formed with the additional parameters and the message being logged as follows: \- log_cmd + log_params + "The message being logged" + log_end_params Using the gcloud command for Stackdriver logging, the parameters would be: \- log_cmd = gcloud \- log_params = logging write GCPILB \- "This is a message being sent by the app" \- log_end_params = (nothing in this case, this is reserved for use with other tools) Which would result in this valid command (where GCPILB is the name of the log): gcloud logging write GCPILB "This is a message being sent by the app"
.sp
NOTE: Only the binary is validated for existence and no further checks are performed\&. The assumption is that only administrators with root access can configure this tool\&.
.sp
(optional, string, default "gcloud")
.RE
.PP
\fBlog_params\fR
.RS 4
Additional input for the logging application\&. See explanation for log_cmd
.sp
(optional, string, default "logging write GCPILB")
.RE
.PP
\fBlog_end_params\fR
.RS 4
Additional input for the logging application\&. Placed after the message being logged\&.
.sp
(optional, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 10s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 30s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a gcp\-ilb resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_gcp\-ilb ocf:heartbeat:gcp\-ilb \e
  op monitor depth="0" timeout="30s" interval="30s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a gcp\-ilb resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_gcp\-ilb ocf:heartbeat:gcp\-ilb \e
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="30s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR