ocf_heartbeat_gcp-vpc-move-ip - Man Page
Move IP within a GCP VPC
Synopsis
gcp-vpc-move-ip [start | stop | monitor | meta-data | validate-all]
Description
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 :
- IP forwarding must be enabled on all instances in order to be able to terminate the route
- The floating IP address must be chosen so that it is outside all existing subnets in the VPC network
- 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)
Supported Parameters
- gcloud
Path to command line tools for GCP
(optional, string, default "/usr/bin/gcloud")
- configuration
Named configuration for gcloud
(optional, string, default "default")
- ip
Floating IP address. Note that this IP must be chosen outside of all existing subnet ranges
(unique, required, string, no default)
- vpc_network
Name of the VPC network
(required, string, default "default")
- interface
Name of the network interface
(optional, string, default "eth0")
- route_name
Route name
(unique, optional, string, default "ra-gcp-vpc-move-ip")
Supported Actions
This resource agent supports the following actions (operations):
- start
Starts the resource. Suggested minimum timeout: 180s.
- stop
Stops the resource. Suggested minimum timeout: 180s.
- monitor
Performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval: 60s.
- 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-vpc-move-ip resource using the crm(8) shell:
primitive p_gcp-vpc-move-ip ocf:heartbeat:gcp-vpc-move-ip \ params \ ip=string \ vpc_network="default" \ op monitor depth="0" timeout="30s" interval="60s"
Example PCS
The following is an example configuration for a gcp-vpc-move-ip resource using pcs(8)
pcs resource create p_gcp-vpc-move-ip ocf:heartbeat:gcp-vpc-move-ip \ ip=string \ vpc_network="default" \ op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="60s"
See Also
Author
ClusterLabs contributors (see the resource agent source for information about individual authors)