NAME

ocf_heartbeat_powervs-subnet - Manages moving a Power Virtual Server subnet

SYNOPSIS

powervs-subnet [start | stop | monitor | meta-data | validate-all]

DESCRIPTION

Resource Agent to move a Power Virtual Server subnet and its IP address from one virtual server instance to another. The prerequisites for the use of this resource agent are as follows:

1. Red Hat Enterprise Linux 9.2 or higher: Install with @server group to ensure that NetworkManager settings are correct. Verify that the NetworkManager-config-server package is installed.

2. A two-node cluster that is distributed across two different Power Virtual Server workspaces in two data centers in a region.

3. IBM Cloud API Key: Create a service API key that is privileged for both Power Virtual Server workspaces. Save the service API key in a file and copy the file to both cluster nodes. Use same filename and directory location on both cluster nodes. Reference the path to the key file in the resource definition.

For comprehensive documentation on implementing high availability for SAP applications on IBM Power Virtual Server, visit https://cloud.ibm.com/docs/sap?topic=sap-ha-overview.

SUPPORTED PARAMETERS

IP address within the subnet. The IP address moves together with the subnet.

(required, string, no default)

cidr

Classless Inter-Domain Routing (CIDR) of the subnet.

(required, string, no default)

subnet_name

Name of the subnet. If not specified, CIDR is used as name.

(optional, string, no default)

api_type

Connect to Power Virtual Server regional endpoints over a public or private network (public|private).

(optional, string, default "private")

region

Region that represents the geographic area where the instance is located. The region is used to identify the Cloud API endpoint.

(required, string, no default)

api_key

API Key or @API_KEY_FILE_PATH for IBM Cloud access. The API key content or the path of an API key file that is indicated by the @ symbol.

(required, string, no default)

crn_host_map

Map the hostname of the Power Virtual Server instance to the CRN of the Power Virtual Server workspaces hosting the instance. Separate hostname and CRN with a colon ':', separate different hostname and CRN pairs with a semicolon ';'. Example: hostname01:CRN-of-Instance01;hostname02:CRN-of-Instance02

(required, string, no default)

vsi_host_map

Map the hostname of the Power Virtual Server instance to its instance id. Separate hostname and instance id with a colon ':', separate different hostname and instance id pairs with a semicolon ';'. Example: hostname01:instance-id-01;hostname02:instance-id-02

(required, string, no default)

proxy

Proxy server to access IBM Cloud API endpoints.

(optional, string, no default)

jumbo

Create a Power Virtual Server subnet with an MTU size of 9000 (true|false).

(optional, string, default "false")

route_table

ID of the route table for the interface. Default is 500.

(optional, string, default "500")

SUPPORTED ACTIONS

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 900s.

stop

Stops the resource. Suggested minimum timeout: 450s.

monitor

Performs a detailed status check. Suggested minimum timeout: 60s. Suggested interval: 60s.

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 300s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 10s.

EXAMPLE CRM SHELL

The following is an example configuration for a powervs-subnet resource using the crm(8) shell:

primitive p_powervs-subnet ocf:heartbeat:powervs-subnet \
  params \
    ip=string \
    cidr=string \
    region=string \
    api_key=string \
    crn_host_map=string \
    vsi_host_map=string \
  op monitor timeout="60s" interval="60s" depth="0"

EXAMPLE PCS

The following is an example configuration for a powervs-subnet resource using pcs(8)

pcs resource create p_powervs-subnet ocf:heartbeat:powervs-subnet \
  ip=string \
  cidr=string \
  region=string \
  api_key=string \
  crn_host_map=string \
  vsi_host_map=string \
  op monitor timeout="60s" interval="60s" OCF_CHECK_LEVEL="0"

AUTHOR

ClusterLabs contributors (see the resource agent source for information about individual authors)