ocf_heartbeat_gcp-vpc-move-route(7)

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

NAME

6       ocf_heartbeat_gcp-vpc-move-route - Move IP within a GCP VPC
7

SYNOPSIS

9       gcp-vpc-move-route [start | stop | monitor | meta-data | validate-all]
10

DESCRIPTION

12       Resource Agent that can move a floating IP addresse within a GCP VPC by
13       changing an entry in the routing table. This agent also configures the
14       floating IP locally on the instance OS. Requirements :
15
16       - IP forwarding must be enabled on all instances in order to be able to
17       terminate the route
18
19       - The floating IP address must be chosen so that it is outside all
20       existing subnets in the VPC network
21
22       - IAM permissions (see
23       https://cloud.google.com/compute/docs/access/iam-permissions) : 1)
24       compute.routes.delete, compute.routes.get and compute.routes.update on
25       the route 2) compute.networks.updatePolicy on the network (to add a new
26       route) 3) compute.networks.get on the network (to check the VPC network
27       existence) 4) compute.routes.list on the project (to check conflicting
28       routes)
29

SUPPORTED PARAMETERS

31       ip
32           Floating IP address. Note that this IP must be chosen outside of
33           all existing subnet ranges
34
35           (unique, required, string, no default)
36
37       vpc_network
38           Name of the VPC network
39
40           (optional, string, default "default")
41
42       project
43           Project ID of the instance. It can be useful to set this attribute
44           if the instance is in a shared service project. Otherwise, the
45           agent should be able to determine the project ID automatically.
46
47           (optional, string, default "default")
48
49       interface
50           Name of the network interface
51
52           (optional, string, default "eth0")
53
54       route_name
55           Route name
56
57           (unique, optional, string, default "ra-gcp-vpc-move-route")
58
59       serviceaccount
60           Path to Service account JSON file
61
62           (optional, string, no default)
63
64       stackdriver_logging
65           If enabled (set to true), IP failover logs will be posted to
66           stackdriver logging
67
68           (optional, boolean, default false)
69

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

92       The following is an example configuration for a gcp-vpc-move-route
93       resource using the crm(8) shell:
94
95           primitive p_gcp-vpc-move-route ocf:heartbeat:gcp-vpc-move-route \
96             params \
97               ip=string \
98             op monitor depth="0" timeout="30s" interval="60s"
99

EXAMPLE PCS

101       The following is an example configuration for a gcp-vpc-move-route
102       resource using pcs(8)
103
104           pcs resource create p_gcp-vpc-move-route ocf:heartbeat:gcp-vpc-move-route \
105             ip=string \
106             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="60s"
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-V(7)