ocf_heartbeat_gcp-vpc-move-ip(7)

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

NAME

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

SYNOPSIS

9       gcp-vpc-move-ip [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       gcloud
32           Path to command line tools for GCP
33
34           (optional, string, default "/usr/bin/gcloud")
35
36       configuration
37           Named configuration for gcloud
38
39           (optional, string, default "default")
40
41       ip
42           Floating IP address. Note that this IP must be chosen outside of
43           all existing subnet ranges
44
45           (unique, required, string, no default)
46
47       vpc_network
48           Name of the VPC network
49
50           (required, string, default "default")
51
52       interface
53           Name of the network interface
54
55           (optional, string, default "eth0")
56
57       route_name
58           Route name
59
60           (unique, optional, string, default "ra-gcp-vpc-move-ip")
61

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

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

EXAMPLE PCS

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

AUTHOR

106       ClusterLabs contributors (see the resource agent source for information
107       about individual authors)
108
109
110
111resource-agents UNKNOWN           01/25/2023            OCF_HEARTBEAT_GCP-V(7)