'\" t
.\"     Title: ocf_heartbeat_aws-vpc-route53
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/13/2023
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.12.0-2
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_AWS\-V" "7" "04/13/2023" "resource-agents 4.12.0-2" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_aws-vpc-route53 \- Update Route53 VPC record for AWS EC2
.SH "SYNOPSIS"
.HP \w'\fBaws\-vpc\-route53\fR\ 'u
\fBaws\-vpc\-route53\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Update Route53 record of Amazon Webservices EC2 by updating an entry in a hosted zone ID table\&.
.PP
AWS instances will require policies which allow them to update Route53 ARecords: { "Version": "2012\-10\-17", "Statement": [ { "Sid": "Stmt1471878724000", "Effect": "Allow", "Action": [ "route53:ChangeResourceRecordSets", "route53:GetChange", "route53:ListResourceRecordSets", ], "Resource": [ "*" ] } ] }
.PP
Example Cluster Configuration:
.PP
Use a configuration in "crm configure edit" which looks as follows\&. Replace hostedzoneid, fullname and profile with the appropriate values:
.PP
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
.SH "SUPPORTED PARAMETERS"
.PP
\fBawscli\fR
.RS 4
Path to command line tools for AWS
.sp
(optional, string, default "/usr/bin/aws")
.RE
.PP
\fBprofile\fR
.RS 4
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:
.sp
[profile cluster] region = us\-east\-1 output = text
.sp
"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"\&.
.sp
(optional, string, default "default")
.RE
.PP
\fBhostedzoneid\fR
.RS 4
Hosted zone ID of Route 53\&. This is the table of the Route 53 record\&.
.sp
(required, string, no default)
.RE
.PP
\fBfullname\fR
.RS 4
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!
.sp
(required, string, no default)
.RE
.PP
\fBip\fR
.RS 4
IP (local (default), public or secondary private IP address (e\&.g\&. 10\&.0\&.0\&.1)\&.
.sp
A secondary private IP can be setup with the awsvip agent\&.
.sp
(optional, string, default "local")
.RE
.PP
\fBttl\fR
.RS 4
Time to live for Route53 ARECORD
.sp
(optional, string, default "10")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 180s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 180s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 180s\&. Suggested interval: 300s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a aws\-vpc\-route53 resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_aws\-vpc\-route53 ocf:heartbeat:aws\-vpc\-route53 \e
  params \e
    hostedzoneid=\fIstring\fR \e
    fullname=\fIstring\fR \e
  op monitor depth="0" timeout="180s" interval="300s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a aws\-vpc\-route53 resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_aws\-vpc\-route53 ocf:heartbeat:aws\-vpc\-route53 \e
  hostedzoneid=\fIstring\fR \e
  fullname=\fIstring\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="180s" interval="300s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR