ocf_heartbeat_awsvip - Man Page
Amazon AWS Secondary Private IP Address Resource Agent
Synopsis
awsvip [start | stop | monitor | migrate_to | migrate_from | meta-data | validate-all]
Description
Resource Agent for Amazon AWS Secondary Private IP Addresses.
It manages AWS Secondary Private IP Addresses with awscli.
Credentials needs to be setup by running "aws configure", or by using AWS Policies.
See https://aws.amazon.com/cli/ for more information about awscli.
This resource agent may be configured for native migration if available in the cluster manager. For Pacemaker, the allow-migrate="true" meta attribute enables native migration.
Supported Parameters
- awscli
command line tools for aws services
(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
Valid AWS CLI profile name (see ~/.aws/config and 'aws configure')
(optional, string, default "default")
- secondary_private_ip
reserved secondary private ip for ec2 instance
(unique, required, string, no default)
- region
Region for AWS resource (required for role-based authentication)
(optional, string, no default)
- api_delay
a short delay between API calls, to avoid sending API too quick
(optional, integer, default 3)
- 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: 30s.
- stop
Stops the resource. Suggested minimum timeout: 30s.
- monitor
Performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval: 20s.
- migrate_to
Executes steps necessary for migrating the resource to the node. Suggested minimum timeout: 30s.
- migrate_from
Executes steps necessary for migrating the resource away from the node. Suggested minimum timeout: 30s.
- meta-data
Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.
- validate
Suggested minimum timeout: 10s.
- validate-all
Performs a validation of the resource configuration. Suggested minimum timeout: 10s.
Example CRM Shell
The following is an example configuration for a awsvip resource using the crm(8) shell:
primitive p_awsvip ocf:heartbeat:awsvip \ params \ secondary_private_ip=string \ meta allow-migrate="true" \ op monitor timeout="30s" interval="20s" depth="0"
Example PCS
The following is an example configuration for a awsvip resource using pcs(8)
pcs resource create p_awsvip ocf:heartbeat:awsvip \ secondary_private_ip=string \ op monitor timeout="30s" interval="20s" OCF_CHECK_LEVEL="0"
See Also
Author
ClusterLabs contributors (see the resource agent source for information about individual authors)