OCF_HEARTBEAT_GCP-I(7)

NAME
ocf_heartbeat_gcp-ilb - Replies to health checks from Google Cloud

SYNOPSIS

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

DESCRIPTION

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.

SUPPORTED PARAMETERS

port
    Listening port for health-check probes. Default: 60000

    (optional, string, default "60000")

cat
    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.

    (optional, string, default "nc")

log_enable
    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).

    (optional, string, default "false")

log_cmd
    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"

    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.

    (optional, string, default "gcloud")

log_params
    Additional input for the logging application. See explanation for log_cmd

    (optional, string, default "logging write GCPILB")

log_end_params
    Additional input for the logging application. Placed after the message being logged.

    (optional, string, no default)

SUPPORTED ACTIONS

This resource agent supports the following actions (operations):

start
    Starts the resource. Suggested minimum timeout: 10s.

stop
    Stops the resource. Suggested minimum timeout: 30s.

monitor
    Performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval: 30s.

validate-all
    Performs a validation of the resource configuration. Suggested minimum timeout: 5s.

meta-data
    Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

EXAMPLE CRM SHELL

The following is an example configuration for a gcp-ilb resource using the crm(8) shell:

    primitive p_gcp-ilb ocf:heartbeat:gcp-ilb \
      op monitor depth="0" timeout="30s" interval="30s"

EXAMPLE PCS

The following is an example configuration for a gcp-ilb resource using pcs(8)

    pcs resource create p_gcp-ilb ocf:heartbeat:gcp-ilb \
      op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="30s"

SEE ALSO

http://clusterlabs.org/

AUTHOR

ClusterLabs contributors (see the resource agent source for information about individual authors)