ocf_heartbeat_awsvip(7)

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

NAME

6       ocf_heartbeat_awsvip - Amazon AWS Secondary Private IP Address Resource
7       Agent
8

SYNOPSIS

10       awsvip [start | stop | monitor | migrate_to | migrate_from | meta-data
11              | validate-all]
12

DESCRIPTION

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

SUPPORTED PARAMETERS

27       awscli
28           command line tools for aws services
29
30           (optional, string, default "/usr/bin/aws")
31
32       profile
33           Valid AWS CLI profile name (see ~/.aws/config and 'aws configure')
34
35           (optional, string, default "default")
36
37       secondary_private_ip
38           reserved secondary private ip for ec2 instance
39
40           (unique, required, string, no default)
41
42       api_delay
43           a short delay between API calls, to avoid sending API too quick
44
45           (optional, integer, default 3)
46

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

80       The following is an example configuration for a awsvip resource using
81       the crm(8) shell:
82
83           primitive p_awsvip ocf:heartbeat:awsvip \
84             params \
85               secondary_private_ip=string \
86             meta allow-migrate="true" \
87             op monitor timeout="30s" interval="20s" depth="0"
88

EXAMPLE PCS

90       The following is an example configuration for a awsvip resource using
91       pcs(8)
92
93           pcs resource create p_awsvip ocf:heartbeat:awsvip \
94             secondary_private_ip=string \
95             op monitor timeout="30s" interval="20s" OCF_CHECK_LEVEL="0"
96

AUTHOR

101       ClusterLabs contributors (see the resource agent source for information
102       about individual authors)
103
104
105
106resource-agents UNKNOWN           04/06/2022           OCF_HEARTBEAT_AWSVIP(7)