ocf_heartbeat_aws-vpc-route53(7)

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

NAME

6       ocf_heartbeat_aws-vpc-route53 - Update Route53 VPC record for AWS EC2
7

SYNOPSIS

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

DESCRIPTION

12       Update Route53 record of Amazon Webservices EC2 by updating an entry in
13       a hosted zone ID table.
14
15       AWS instances will require policies which allow them to update Route53
16       ARecords: { "Version": "2012-10-17", "Statement": [ { "Sid":
17       "Stmt1471878724000", "Effect": "Allow", "Action": [
18       "route53:ChangeResourceRecordSets", "route53:GetChange",
19       "route53:ListResourceRecordSets", ], "Resource": [ "*" ] } ] }
20
21       Example Cluster Configuration:
22
23       Use a configuration in "crm configure edit" which looks as follows.
24       Replace hostedzoneid, fullname and profile with the appropriate values:
25
26       primitive res_route53 ocf:heartbeat:aws-vpc-route53 params
27       hostedzoneid=EX4MPL3EX4MPL3 fullname=service.cloud.example.corp.
28       profile=cluster op start interval=0 timeout=180 op stop interval=0
29       timeout=180 op monitor interval=300 timeout=180 meta
30       target-role=Started
31

SUPPORTED PARAMETERS

33       awscli
34           Path to command line tools for AWS
35
36           (optional, string, default "/usr/bin/aws")
37
38       profile
39           The name of the AWS CLI profile of the root account. This profile
40           will have to use the "text" format for CLI output. The file
41           /root/.aws/config should have an entry which looks like:
42
43           [profile cluster] region = us-east-1 output = text
44
45           "cluster" is the name which has to be used in the cluster
46           configuration. The region has to be the current one. The output has
47           to be "text".
48
49           (optional, string, default "default")
50
51       hostedzoneid
52           Hosted zone ID of Route 53. This is the table of the Route 53
53           record.
54
55           (required, string, no default)
56
57       fullname
58           The full name of the service which will host the IP address.
59           Example: service.cloud.example.corp. Note: The trailing dot is
60           important to Route53!
61
62           (required, string, no default)
63
64       ip
65           IP (local (default), public or secondary private IP address (e.g.
66           10.0.0.1).
67
68           A secondary private IP can be setup with the awsvip agent.
69
70           (optional, string, default "local")
71
72       ttl
73           Time to live for Route53 ARECORD
74
75           (optional, string, default "10")
76

SUPPORTED ACTIONS

78       This resource agent supports the following actions (operations):
79
80       start
81           Starts the resource. Suggested minimum timeout: 180s.
82
83       stop
84           Stops the resource. Suggested minimum timeout: 180s.
85
86       monitor
87           Performs a detailed status check. Suggested minimum timeout: 180s.
88           Suggested interval: 300s.
89
90       validate-all
91           Performs a validation of the resource configuration. Suggested
92           minimum timeout: 5s.
93
94       meta-data
95           Retrieves resource agent metadata (internal use only). Suggested
96           minimum timeout: 5s.
97

EXAMPLE CRM SHELL

99       The following is an example configuration for a aws-vpc-route53
100       resource using the crm(8) shell:
101
102           primitive p_aws-vpc-route53 ocf:heartbeat:aws-vpc-route53 \
103             params \
104               hostedzoneid=string \
105               fullname=string \
106             op monitor depth="0" timeout="180s" interval="300s"
107

EXAMPLE PCS

109       The following is an example configuration for a aws-vpc-route53
110       resource using pcs(8)
111
112           pcs resource create p_aws-vpc-route53 ocf:heartbeat:aws-vpc-route53 \
113             hostedzoneid=string \
114             fullname=string \
115             op monitor OCF_CHECK_LEVEL="0" timeout="180s" interval="300s"
116

AUTHOR

121       ClusterLabs contributors (see the resource agent source for information
122       about individual authors)
123
124
125
126resource-agents UNKNOWN           04/06/2022            OCF_HEARTBEAT_AWS-V(7)