'\" t
.\"     Title: ocf_heartbeat_gcp-vpc-move-route
.\"    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\-V" "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-vpc-move-route \- Move IP within a GCP VPC
.SH "SYNOPSIS"
.HP \w'\fBgcp\-vpc\-move\-route\fR\ 'u
\fBgcp\-vpc\-move\-route\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource Agent that can move a floating IP addresse within a GCP VPC by changing an entry in the routing table\&. This agent also configures the floating IP locally on the instance OS\&. Requirements :
.PP
\- IP forwarding must be enabled on all instances in order to be able to terminate the route
.PP
\- The floating IP address must be chosen so that it is outside all existing subnets in the VPC network
.PP
\- IAM permissions (see https://cloud\&.google\&.com/compute/docs/access/iam\-permissions) : 1) compute\&.routes\&.delete, compute\&.routes\&.get and compute\&.routes\&.update on the route 2) compute\&.networks\&.updatePolicy on the network (to add a new route) 3) compute\&.networks\&.get on the network (to check the VPC network existence) 4) compute\&.routes\&.list on the project (to check conflicting routes)
.SH "SUPPORTED PARAMETERS"
.PP
\fBip\fR
.RS 4
Floating IP address\&. Note that this IP must be chosen outside of all existing subnet ranges
.sp
(unique, required, string, no default)
.RE
.PP
\fBvpc_network\fR
.RS 4
Name of the VPC network
.sp
(optional, string, default "default")
.RE
.PP
\fBproject\fR
.RS 4
Project ID of the instance\&. It can be useful to set this attribute if the instance is in a shared service project\&. Otherwise, the agent should be able to determine the project ID automatically\&.
.sp
(optional, string, default "default")
.RE
.PP
\fBinterface\fR
.RS 4
Name of the network interface
.sp
(optional, string, default "eth0")
.RE
.PP
\fBroute_name\fR
.RS 4
Route name
.sp
(unique, optional, string, default "ra\-gcp\-vpc\-move\-route")
.RE
.PP
\fBserviceaccount\fR
.RS 4
Path to Service account JSON file
.sp
(optional, string, no default)
.RE
.PP
\fBstackdriver_logging\fR
.RS 4
If enabled (set to true), IP failover logs will be posted to stackdriver logging
.sp
(optional, boolean, default
false)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 180s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 180s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 60s\&.
.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\-vpc\-move\-route resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_gcp\-vpc\-move\-route ocf:heartbeat:gcp\-vpc\-move\-route \e
  params \e
    ip=\fIstring\fR \e
  op monitor depth="0" timeout="30s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a gcp\-vpc\-move\-route resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_gcp\-vpc\-move\-route ocf:heartbeat:gcp\-vpc\-move\-route \e
  ip=\fIstring\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="60s" 
.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