OCF_HEARTBEAT_OPENST(7)

πŸ’– ocf_heartbeat_openstack-floating-ip β€” like, the whole vibe πŸ’–

okay bestie, so this page lives in section 7 of the manual (that's the OCF_HEARTBEAT_OPENST(7) bit, if you were wondering what that shouty string up top was) and it's all about the ocf_heartbeat_openstack-floating-ip resource agent. Pull up a chair, grab a strawberry πŸ“, and let's get into it.


✨ NAME ✨

ocf_heartbeat_openstack-floating-ip β€” it moves a floating IP. that's it, that's the whole job. πŸ’…


🌸 SYNOPSIS 🌸

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

πŸ¦‹ DESCRIPTION πŸ¦‹

So this resource agent is a whole little matchmaker: it takes a floating IP address and moves it from one instance to another. iconic behaviour, honestly.

Here's the tea though β€” it doesn't figure out all that stuff by itself. It relies on attributes handed over by the openstack-info resource agent, specifically the openstack_ports and openstack_id attributes. And then the attribute called "openstack_floating_ip" gets updated. so yeah, that's the one getting its moment. ✨


πŸŽ€ SUPPORTED PARAMETERS πŸŽ€

  • cloud β€” the Openstack cloud. it'll look for this in ~/.config/openstack/clouds.yaml or /etc/openstack/clouds.yaml. (optional, string, no default)
  • openrc β€” Openstack credentials, given as an openrc file from api_access/openrc. (optional, string, no default)
  • auth_url β€” the Keystone Auth URL. πŸ‘‘ (optional, string, no default)
  • username β€” username. yes, just username. no notes. (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 the command line tools for openstack. (optional, string, default "/usr/bin/openstack")
  • insecure β€” allow insecure connections. 🚨 lowkey risky, just saying, but it's there if you need it. (optional, boolean, default false)
  • ip_id β€” Floating IP Identifier. this one is required, bestie, no skipping. (required, string, no default)
  • subnet_id β€” Subnet Identifier to use to attach the address. also required. πŸ’€ (required, string, no default)

πŸ‘‘ SUPPORTED ACTIONS πŸ‘‘

this resource agent supports these 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, so like, don't touch). suggested minimum timeout: 5s.

🧚 EXAMPLE CRM SHELL 🧚

here's what a openstack-floating-ip resource looks like configured with the crm(8) shell β€” copy it, don't improvise:

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

🌈 EXAMPLE PCS 🌈

and here's the same energy but with pcs(8):

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

πŸ”₯ SEE ALSO πŸ”₯


πŸ’œ AUTHOR πŸ’œ

ClusterLabs contributors β€” and if you wanna know which specific human wrote which bit, the resource agent source has all that deets.


fr fr, that's the whole page. no cap. 🫢

this was brought to you by resource-agents UNKNOWN, dated 04/08/2026 β€” mwah, bye bestie πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from