OCF_HEARTBEAT_OPENST(7)

πŸ¦‹ ocf_heartbeat_openstack-cinder-volume β€” it's giving "attach a cinder volume" ✨

okay bestie, sit down, hydrate, and let me tell you about ocf_heartbeat_openstack-cinder-volume, which lives in section OCF_HEARTBEAT_OPENST(7) of the manual. this one is a resource agent (not a command you just type at your shell, bestie, it's for your cluster manager) and it is lowkey iconic at one job: attaching a cinder volume to an instance. periodt. πŸ’…


🌸 NAME 🌸

ocf_heartbeat_openstack-cinder-volume β€” attach a cinder volume. that's it. that's the whole personality. πŸŽ€


✨ SYNOPSIS ✨

openstack-cinder-volume [start | stop | monitor | meta-data |
                        validate-all]

five moves. no notes. 🫢


πŸ’– DESCRIPTION πŸ’–

so this resource agent attaches a cinder volume to an instance. it's a team player tho β€” it doesn't do the identity work itself, it relies on attributes given by the openstack-info resource agent, specifically the openstack_id attribute. so make sure your openstack-info bestie showed up first, or this whole thing is just standing there like 🧍


πŸ‘‘ SUPPORTED PARAMETERS πŸ‘‘

every single one, no gatekeeping. these are the options you can pass:

  • cloud β€” which Openstack cloud you're on, read from ~/.config/openstack/clouds.yaml or /etc/openstack/clouds.yaml. (optional, string, no default) ☁️
  • openrc β€” your Openstack credentials as an openrc file from api_access/openrc. (optional, string, no default)
  • auth_url β€” the Keystone Auth URL. (optional, string, no default)
  • username β€” username. who are you bestie. (optional, string, no default)
  • password β€” password. keep it secret, keep it safe πŸ” (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. πŸ‘€ (optional, boolean, default false)
  • volume_local_check β€” this one lets the cluster monitor whether the cinder volume is present without calling the API. so chill, so efficient, we love a low-effort queen. (optional, boolean, default true)
  • volume_id β€” the Cinder volume identifier used to attach the block storage. this one is REQUIRED, no default, no vibes-based guessing. (required, string, no default) 🚨

πŸ”₯ SUPPORTED ACTIONS πŸ”₯

this resource agent supports these actions (aka operations), and each one comes with a suggested minimum timeout, so respect the clock bestie ⏰:

  • 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, don't touch it, it's not for you πŸ™ˆ). suggested minimum timeout: 5s.

πŸŽ€ EXAMPLE CRM SHELL πŸŽ€

here's what it looks like as a config for an openstack-cinder-volume resource using the crm(8) shell. copy it exactly, no typos, the shell will notice:

primitive p_openstack-cinder-volume ocf:heartbeat:openstack-cinder-volume \
  params \
    volume_id=string \
  op monitor depth="0" timeout="180s" interval="60s"

🌈 EXAMPLE PCS 🌈

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

pcs resource create p_openstack-cinder-volume ocf:heartbeat:openstack-cinder-volume \
  volume_id=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="180s" interval="60s"

πŸ’œ SEE ALSO πŸ’œ

go touch grass on the internet bestie: http://clusterlabs.org/


🌟 AUTHOR 🌟

ClusterLabs contributors (see the resource agent source for information about individual authors). they ate. πŸ’…


no cap, that's the whole page β€” every param, every action, every example, untouched, just with better vibes. iykyk. πŸ¦‹

okay so that's a wrap, my love πŸ’– this was OCF_HEARTBEAT_OPENST(7) from resource-agents, version UNKNOWN, dated 04/08/2026. slay, go attach that volume, and remember: volume_id is required, so no skipping. periodt. βœ¨πŸ‘‘

πŸ“¦ where this page comes from