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

       Update Route53 record of Amazon Webservices EC2 by updating an entry in a hosted zone ID
       table.

       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": [ "*" ] } ] }

       Example Cluster Configuration:

       Use a configuration in "crm configure edit" which looks as follows. Replace hostedzoneid,
       fullname and profile with the appropriate values:

       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

       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".

           (optional, string, default "default")

       hostedzoneid
           Hosted zone ID of Route 53. This is the table of the Route 53 record.

           (required, string, no default)

       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 3)

       curl_sleep
           curl sleep between tries

           (optional, integer, default 1)

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: 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/

AUTHOR

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