ocf_heartbeat_openstack-virtual-ip(7)

ocf_heartbeat_openstack-virtual-ip7

Move a virtual ip

Usage

openstack-virtual-ip [start | stop | monitor | meta-data | validate-all]

Overview

Resource Agent to move a virtual IP address from an instance to another one by adding an allowed-address pair associated with an instance port. It relies on attributes given by openstack-info resource agent (openstack_ports, openstack_id attributes). The attribute called "openstack_virtual_ip" is updated.

Supported parameters

cloud

Openstack cloud (from ~/.config/openstack/clouds.yaml or /etc/openstack/clouds.yaml).

(optional, string, no default)

openrc

Openstack credentials as openrc file from api_access/openrc.

(optional, string, no default)

auth_url

Keystone Auth URL

(optional, string, no default)

username

Username.

(optional, string, no default)

password

Password.

(optional, string, no default)

project_name

Keystone Project.

(optional, string, no default)

user_domain_name

Keystone User Domain Name.

(optional, string, default "Default")

project_domain_name

Keystone Project Domain Name.

(optional, string, default "Default")

openstackcli

Path to command line tools for openstack.

(optional, string, default "/usr/bin/openstack")

insecure

Allow insecure connections

(optional, boolean, default false)

ip

Virtual IP Address.

(required, string, no default)

subnet_id

Subnet Identifier to use to attach the address.

(required, string, no default)

Supported actions

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 180s.

stop

Stops the resource. Suggested minimum timeout: 180s.

monitor

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

validate-all

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

meta-data

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

Example CRM shell

The following is an example configuration for a openstack-virtual-ip resource using the crm(8) shell:

primitive p_openstack-virtual-ip ocf:heartbeat:openstack-virtual-ip \
  params \
    ip=string \
    subnet_id=string \
  op monitor depth="0" timeout="180s" interval="60s" 

Example PCS

The following is an example configuration for a openstack-virtual-ip resource using pcs(8)

pcs resource create p_openstack-virtual-ip ocf:heartbeat:openstack-virtual-ip \
  ip=string \
  subnet_id=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="180s" interval="60s" 

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

  1. 12
  2. 13

Author

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

From resource-agents 1:4.16.0-3+deb13u2 in Debian 13 (Trixie). Parsed by carta from the page's man source.