ocf_heartbeat_awseip(7)

1OCF_HEARTBEAT_AWSEIP(7)       OCF resource agents      OCF_HEARTBEAT_AWSEIP(7)
2
3
4

NAME

6       ocf_heartbeat_awseip - Amazon AWS Elastic IP Address Resource Agent
7

SYNOPSIS

9       awseip [start | stop | monitor | migrate_to | migrate_from | meta-data
10              | validate-all]
11

DESCRIPTION

13       Resource Agent for Amazon AWS Elastic IP Addresses.
14
15       It manages AWS Elastic IP Addresses with awscli.
16
17       Credentials needs to be setup by running "aws configure".
18
19       See https://aws.amazon.com/cli/ for more information about awscli.
20
21       This resource agent may be configured for native migration if available
22       in the cluster manager. For Pacemaker, the allow-migrate="true" meta
23       attribute enables native migration.
24

SUPPORTED PARAMETERS

26       awscli
27           command line tools for aws services
28
29           (optional, string, default "/usr/bin/aws")
30
31       profile
32           Valid AWS CLI profile name (see ~/.aws/config and 'aws configure')
33
34           (optional, string, default "default")
35
36       elastic_ip
37           reserved elastic ip for ec2 instance
38
39           (unique, required, string, no default)
40
41       allocation_id
42           reserved allocation id for ec2 instance
43
44           (unique, required, string, no default)
45
46       private_ip_address
47           predefined private ip address for ec2 instance
48
49           (unique, optional, string, no default)
50
51       api_delay
52           a short delay between API calls, to avoid sending API too quick
53
54           (optional, integer, default 3)
55

SUPPORTED ACTIONS

57       This resource agent supports the following actions (operations):
58
59       start
60           Starts the resource. Suggested minimum timeout: 30s.
61
62       stop
63           Stops the resource. Suggested minimum timeout: 30s.
64
65       monitor
66           Performs a detailed status check. Suggested minimum timeout: 30s.
67           Suggested interval: 20s.
68
69       migrate_to
70           Executes steps necessary for migrating the resource to the node.
71           Suggested minimum timeout: 30s.
72
73       migrate_from
74           Executes steps necessary for migrating the resource away from the
75           node. Suggested minimum timeout: 30s.
76
77       meta-data
78           Retrieves resource agent metadata (internal use only). Suggested
79           minimum timeout: 5s.
80
81       validate
82           Suggested minimum timeout: 10s.
83
84       validate-all
85           Performs a validation of the resource configuration. Suggested
86           minimum timeout: 10s.
87

EXAMPLE CRM SHELL

89       The following is an example configuration for a awseip resource using
90       the crm(8) shell:
91
92           primitive p_awseip ocf:heartbeat:awseip \
93             params \
94               elastic_ip=string \
95               allocation_id=string \
96             meta allow-migrate="true" \
97             op monitor timeout="30s" interval="20s" depth="0"
98

EXAMPLE PCS

100       The following is an example configuration for a awseip resource using
101       pcs(8)
102
103           pcs resource create p_awseip ocf:heartbeat:awseip \
104             elastic_ip=string \
105             allocation_id=string \
106             op monitor timeout="30s" interval="20s" OCF_CHECK_LEVEL="0"
107

AUTHOR

112       ClusterLabs contributors (see the resource agent source for information
113       about individual authors)
114
115
116
117resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_AWSEIP(7)