ocf_heartbeat_ocivip - Man Page
OCI Secondary Private IP Address for Compute instances Resource Agent
Synopsis
ocivip [start | stop | monitor | migrate_to | migrate_from | meta-data | validate-all]
Description
Resource Agent for OCI Compute instance Secondary Private IP Addresses.
It manages OCI Secondary Private IP Addresses for Compute instances with oci cli.
See https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts.htm for more information about oci cli.
Prerequisites:
- OCI CLI installed (https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/climanualinst.htm)
- jq installed
- dynamic group with a policy attacched
- the policy must have this statement: allow dynamic-group GROUP_NAME to use virtual-network-family in compartment id COMPARTMENT_ID
- a reserved secondary private IP address for Compute Instances high availability
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
- ocicli
OCI Command line interface (CLI) tools
(optional, string, default "/usr/local/bin/oci")
- secondary_private_ip
reserved secondary private ip for compute instance
(unique, required, string, no default)
- cidr_netmask
netmask for the secondary_private_ip
(optional, integer, default 24)
- interface_alias
numeric alias for the interface
(optional, integer, default 0)
- api_delay
a short delay between API calls, to avoid sending API too quick
(optional, integer, default 3)
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 ocivip resource using the crm(8) shell:
primitive p_ocivip ocf:heartbeat:ocivip \ 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 ocivip resource using pcs(8)
pcs resource create p_ocivip ocf:heartbeat:ocivip \ 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)