OCF_Functions(3pm)

📦
version 2.3.0 · 3 versions
, in debian trixie, ubuntu noble, ubuntu questing

💖 OCF_Functions — the manual page, but make it bestie 💖

okay so this is OCF_Functions(3pm), a User Contributed Perl Documentation page, and it's genuinely the sweetest little helper module for OCF agents. grab a snack, we're doing this together 🍓

✨ NAME ✨

OCF_Functions</purpose> — helper subroutines for OCF agent. that's it, that's the whole vibe: lil helper besties that do the boring stuff so your agent doesn't have to 🫶

🌸 SYNOPSIS 🌸

the way you summon them is literally just:

use FindBin;
use lib "$FindBin::RealBin/../../lib/heartbeat/";

use OCF_Functions;

no cap, that's the whole ritual ✨

🦋 DESCRIPTION 🦋

so this module got ported from the ocf-shellfuncs shell script of the resource-agents project. she's a glow-up of the original shell version, periodt.

if you wanna go look at where she came from, it's right here: <https://github.com/ClusterLabs/resource-agents/> 👑

💅 VARIABLE 💅

there is exactly one variable exported by this module, and her name is __OCF_ACTION. that's the whole roster. main character energy, honestly 🌟

👑 SUBROUTINES 👑

the ones ported from ocf-shellfuncs (and exported by this module, iykyk):

  • ha_debug
  • ha_log
  • hadate
  • ocf_is_clone
  • ocf_is_ms
  • ocf_is_probe
  • ocf_is_root
  • ocf_is_true
  • ocf_is_ver
  • ocf_local_nodename
  • ocf_log
  • ocf_exit_reason
  • ocf_maybe_random
  • ocf_ver2num
  • ocf_ver_complete_level
  • ocf_ver_level
  • ocf_version_cmp
  • set_logtag

and the one that's ✨ exclusive ✨ — only in the perl module, not in ocf-shellfuncs at all:

  • ocf_notify_env

not me giving her her own little spotlight section, she earned it 💖

Copyright (C) 2016: Jehan-Guillaume de Rorthais and Mael Rimbault.

Licensed under the PostgreSQL License. 📜

fr fr, if you're gonna copy or ship this, read that license first — it's short, you got this 🫶

and that's the whole page, bestie — you understood it, I'm so proud of you 💜

this was OCF_Functions(3pm) from the perl v5.38.2 era, dated 2024-03-18, brought to you by User Contributed Perl Documentation. slay, go write an agent, you're literally built for this 👑✨🎀

📦 where this page comes from