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 choosen 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           (required, string, default "default")
41
42       interface
43           Name of the network interface
44
45           (optional, string, default "eth0")
46
47       route_name
48           Route name
49
50           (unique, optional, string, default "ra-gcp-vpc-move-route")
51
52       stackdriver_logging
53           If enabled (set to true), IP failover logs will be posted to
54           stackdriver logging. Using stackdriver logging requires additional
55           libraries (google-cloud-logging).
56
57           (optional, boolean, default false)
58

SUPPORTED ACTIONS

60       This resource agent supports the following actions (operations):
61
62       start
63           Starts the resource. Suggested minimum timeout: 180s.
64
65       stop
66           Stops the resource. Suggested minimum timeout: 180s.
67
68       monitor
69           Performs a detailed status check. Suggested minimum timeout: 30s.
70           Suggested interval: 60s.
71
72       validate-all
73           Performs a validation of the resource configuration. Suggested
74           minimum timeout: 5s.
75
76       meta-data
77           Retrieves resource agent metadata (internal use only). Suggested
78           minimum timeout: 5s.
79

EXAMPLE CRM SHELL

81       The following is an example configuration for a gcp-vpc-move-route
82       resource using the crm(8) shell:
83
84           primitive p_gcp-vpc-move-route ocf:heartbeat:gcp-vpc-move-route \
85             params \
86               ip=string \
87               vpc_network="default" \
88             op monitor depth="0" timeout="30s" interval="60s"
89

EXAMPLE PCS

91       The following is an example configuration for a gcp-vpc-move-route
92       resource using pcs(8)
93
94           pcs resource create p_gcp-vpc-move-route ocf:heartbeat:gcp-vpc-move-route \
95             ip=string \
96             vpc_network="default" \
97             op monitor depth="0" timeout="30s" interval="60s"
98

AUTHOR

103       ClusterLabs contributors (see the resource agent source for information
104       about individual authors)
105
106
107
108resource-agents UNKNOWN           03/14/2019            OCF_HEARTBEAT_GCP-V(7)