ocf_heartbeat_ocivip(7)

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

NAME

6       ocf_heartbeat_ocivip - OCI Secondary Private IP Address for Compute
7       instances Resource Agent
8

SYNOPSIS

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

DESCRIPTION

14       Resource Agent for OCI Compute instance Secondary Private IP Addresses.
15
16       It manages OCI Secondary Private IP Addresses for Compute instances
17       with oci cli.
18
19       See
20       https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts.htm
21       for more information about oci cli.
22
23       Prerequisites:
24
25       - OCI CLI installed
26       (https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/climanualinst.htm)
27
28       - jq installed
29
30       - dynamic group with a policy attacched
31
32       - the policy must have this statement: allow dynamic-group GROUP_NAME
33       to use virtual-network-family in compartment id COMPARTMENT_ID
34
35       - a reserved secondary private IP address for Compute Instances high
36       availability
37
38       This resource agent may be configured for native migration if available
39       in the cluster manager. For Pacemaker, the allow-migrate="true" meta
40       attribute enables native migration.
41

SUPPORTED PARAMETERS

43       ocicli
44           OCI Command line interface (CLI) tools
45
46           (optional, string, default "/usr/local/bin/oci")
47
48       secondary_private_ip
49           reserved secondary private ip for compute instance
50
51           (unique, required, string, no default)
52
53       cidr_netmask
54           netmask for the secondary_private_ip
55
56           (optional, integer, default 24)
57
58       interface_alias
59           numeric alias for the interface
60
61           (optional, integer, default 0)
62
63       api_delay
64           a short delay between API calls, to avoid sending API too quick
65
66           (optional, integer, default 3)
67

SUPPORTED ACTIONS

69       This resource agent supports the following actions (operations):
70
71       start
72           Starts the resource. Suggested minimum timeout: 30s.
73
74       stop
75           Stops the resource. Suggested minimum timeout: 30s.
76
77       monitor
78           Performs a detailed status check. Suggested minimum timeout: 30s.
79           Suggested interval: 20s.
80
81       migrate_to
82           Executes steps necessary for migrating the resource to the node.
83           Suggested minimum timeout: 30s.
84
85       migrate_from
86           Executes steps necessary for migrating the resource away from the
87           node. Suggested minimum timeout: 30s.
88
89       meta-data
90           Retrieves resource agent metadata (internal use only). Suggested
91           minimum timeout: 5s.
92
93       validate
94           Suggested minimum timeout: 10s.
95
96       validate-all
97           Performs a validation of the resource configuration. Suggested
98           minimum timeout: 10s.
99

EXAMPLE CRM SHELL

101       The following is an example configuration for a ocivip resource using
102       the crm(8) shell:
103
104           primitive p_ocivip ocf:heartbeat:ocivip \
105             params \
106               secondary_private_ip=string \
107             meta allow-migrate="true" \
108             op monitor timeout="30s" interval="20s" depth="0"
109

EXAMPLE PCS

111       The following is an example configuration for a ocivip resource using
112       pcs(8)
113
114           pcs resource create p_ocivip ocf:heartbeat:ocivip \
115             secondary_private_ip=string \
116             op monitor timeout="30s" interval="20s" OCF_CHECK_LEVEL="0"
117

AUTHOR

122       ClusterLabs contributors (see the resource agent source for information
123       about individual authors)
124
125
126
127resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_OCIVIP(7)