OCF_HEARTBEAT_AWS-V(7)

πŸ’… OCF_HEARTBEAT_AWS-V(7) β€” ocf_heartbeat_aws-vpc-route53, bestie edition πŸŽ€

okay so this is the manual page for ocf_heartbeat_aws-vpc-route53, and yes that name is a mouthful, but it's literally the icon we're covering today πŸ’–

✨ NAME ✨

ocf_heartbeat_aws-vpc-route53 β€” Update Route53 VPC record for AWS EC2 πŸ¦‹

✨ SYNOPSIS ✨

aws-vpc-route53 [start | stop | monitor | meta-data | validate-all]

✨ DESCRIPTION ✨

So what it does πŸ‘‘: it updates the Route53 record of Amazon Webservices EC2 by updating an entry in a hosted zone ID table. That's the whole vibe, and it ate.

Now, AWS instances will require policies which allow them to update Route53 ARecords 🫢 β€” here's the exact one, no cap:

{ "Version": "2012-10-17", "Statement": [ { "Sid": "Stmt1471878724000", "Effect": "Allow", "Action": [ "route53:ChangeResourceRecordSets", "route53:GetChange", "route53:ListResourceRecordSets", ], "Resource": [ "*" ] } ] }

🌸 Example Cluster Configuration 🌸

Use a configuration in crm configure edit which looks as follows, bestie. Replace hostedzoneid, fullname and profile with the appropriate values (yes, all three, don't skip any 😭):

primitive res_route53 ocf:heartbeat:aws-vpc-route53 params
hostedzoneid=EX4MPL3EX4MPL3 fullname=service.cloud.example.corp.
profile=cluster op start interval=0 timeout=180 op stop interval=0
timeout=180 op monitor interval=300 timeout=180 meta target-role=Started

✨ SUPPORTED PARAMETERS ✨

lowkey the most important section, so pay attention πŸ™ˆ

  • awscli β€” Path to command line tools for AWS. (optional, string, default "/usr/bin/aws")
  • auth_type β€” Authentication type: "key" for AccessKey and SecretAccessKey set via "aws configure", or "role" to use AWS Policies. (optional, string, default "key")
  • profile β€” The name of the AWS CLI profile of the root account. This profile will have to use the "text" format for CLI output. The file /root/.aws/config should have an entry which looks like:
[profile cluster] region = us-east-1 output = text

"cluster" is the name which has to be used in the cluster configuration. The region has to be the current one. The output has to be "text" β€” like, all three of those things, fr fr. (optional, string, default "default")

  • hostedzoneid β€” Hosted zone ID of Route 53. This is the table of the Route 53 record. (required, string, no default β€” you GOTTA give this one πŸ’€)
  • fullname β€” The full name of the service which will host the IP address. Example: service.cloud.example.corp. Note: the trailing dot is important to Route53! ⭐ (required, string, no default)
  • ip β€” IP: local (default), public or secondary private IP address (e.g. 10.0.0.1).

A secondary private IP can be setup with the awsvip agent. (optional, string, default "local")

  • ttl β€” Time to live for Route53 ARECORD. (optional, string, default "10")
  • curl_retries β€” curl retries before failing. (optional, integer, default 4)
  • curl_sleep β€” curl sleep between tries. (optional, integer, default 3)

✨ SUPPORTED ACTIONS ✨

This resource agent supports the following actions (operations) β€” collect them all, they're iconic 🧚:

  • 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: 180s. Suggested interval: 300s.
  • 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 aws-vpc-route53 resource using the crm(8) shell:

primitive p_aws-vpc-route53 ocf:heartbeat:aws-vpc-route53 \
  params \
    hostedzoneid=string \
    fullname=string \
  op monitor depth="0" timeout="180s" interval="300s"

✨ EXAMPLE PCS ✨

The following is an example configuration for a aws-vpc-route53 resource using pcs(8):

pcs resource create p_aws-vpc-route53 ocf:heartbeat:aws-vpc-route53 \
  hostedzoneid=string \
  fullname=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="180s" interval="300s"

✨ SEE ALSO ✨

http://clusterlabs.org/ β€” go peek, iykyk πŸ’œ

✨ AUTHOR ✨

ClusterLabs contributors (see the resource agent source for information about individual authors) 🌈


πŸ’– that's the whole page, bestie β€” go forth and update those records ✨

okay and literally the last thing, the cute sign-off: this whole thing comes courtesy of resource-agents version UNKNOWN, dated 10/01/2026. slay πŸŽ€πŸ¦‹πŸ’…

πŸ“¦ where this page comes from