CF-RUNAGENT(8)

📦
version 3.24.1 · 2 versions
, in debian trixie

💅 CF-RUNAGENT(8) — the cf-runagent glow-up ✨

okay bestie, welcome to cf-runagent(8), from the System Manager's Manual section 8 🎀. This is the little remote-control vibe for your CFEngine fleet and she is lowkey iconic.

✨ NAME ✨

cf-runagent — poke cf-agent awake on a remote host, from a distance, like the main character you are 👑

🌸 SYNOPSIS 🌸

cf-runagent [OPTION]...  [FILE]

🦋 DESCRIPTION 🦋

So here's the tea: cf-runagent connects to a list of running instances of cf-serverd. It lets you skip the whole usual cf-execd schedule and just activate cf-agent whenever you feel like it. no cap, you're the schedule now 💅

And that's not all — a user may also send classes to be defined on the remote host. Two kinds of classes may be sent:

  1. classes to decide on which hosts cf-agent will be started
  2. classes that the user requests cf-agent should define on execution

The second type is regulated by cf-serverd's role based access control. yes queen, RBAC said permission check 🔐

💖 OPTIONS 💖

  • --help, -h — prints the help message. bestie behaviour, always valid 🫶
  • --background, -b value — parallelize connections (50 by default). it's giving multitasking 🌈
  • --debug, -d — enable debugging output. the receipts ✨
  • --verbose, -v — output verbose information about the behaviour of cf-runagent. she tells you everything 💬
  • --log-level, -g value — specify how detailed logs should be. Possible values: 'error', 'warning', 'notice', 'info', 'verbose', 'debug' 🎚️
  • --dry-run, -n — all talk and no action mode — make no changes, only inform of promises not kept. all talk, no action, zero commitment, we respect it 🙈
  • --version, -V — output the version of the software 📌
  • --file, -f value — specify an alternative input file than the default. This option is overridden by FILE if supplied as argument. so like, the argument wins, periodt 👑
  • --define-class, -D value — define a list of comma separated classes to be sent to a remote agent 🏷️
  • --select-class, -s value — define a list of comma separated classes to be used to select remote agents by constraint. choose your fighters 🌟
  • --inform, -I — print basic information about changes made to the system, i.e. promises repaired 🔔
  • --remote-options, -o value — (deprecated) 💀 old news, do not use
  • --diagnostic, -x — (deprecated) 💀 also old news
  • --hail, -H value — hail the following comma-separated lists of hosts, overriding default list. HAIL THE HOSTS 📣
  • --interactive, -i — enable interactive mode for key trust 🔑
  • --timeout, -t value — connection timeout, seconds ⏳
  • --color, -C value — enable colorized output. Possible values: 'always', 'auto', 'never'. If option is used, the default value is 'auto' 🌈
  • --timestamp, -l — log timestamps on each line of log output 🕐
  • --ignore-preferred-augments, - — ignore def_preferred.json file in favor of def.json 🙅♀️
  • --log-modules, - value — enable even more detailed debug logging for specific areas of the implementation. Use together with '-d'. Use --log-modules=help for a list of available modules 🔬
  • --remote-bundles, - value — bundles to execute on the remote agent 📦

🌟 CFENGINE 🌟

CFEngine provides automated configuration management of large-scale computer systems. A system administrator describes the desired state of a system using CFEngine policy code. The program cf-agent reads policy code and attempts to bring the current system state to the desired state described. Policy code is downloaded by cf-agent from a cf-serverd daemon. The daemon cf-execd is responsible for running cf-agent periodically. 🔁

Documentation for CFEngine is available at https://docs.cfengine.com/. go read it, it's giving lore 📚

🧚 PROMISE THEORY 🧚

CFEngine is built on principles from promise theory, proposed by Mark Burgess in 2004. Promise theory is a model of voluntary cooperation between individual, autonomous actors or agents who publish their intentions to one another in the form of promises. A promise is a declaration of intent whose purpose is to increase the recipient's certainty about a claim of past, present or future behaviour. For a promise to increase certainty, the recipient needs to trust the promiser, but trust can also be built on the verification that previous promises have been kept, thus trust plays a symbiotic relationship with promises. 🤝

For an introduction to promise theory, please see http://arxiv.org/abs/0810.3294/

💜 AVAILABILITY 💜

cf-runagent is part of CFEngine.

Binary packages may be downloaded from https://cfengine.com/download/.

The source code is available at https://github.com/cfengine/

💀 BUGS 💀

Please see the public bug-tracker at https://northerntech.atlassian.net/projects/CFE/.

GitHub pull-requests may be submitted to https://github.com/cfengine/core/.

not me telling you to file a bug... but like, do it, they're nice 🫶

⭐ SEE ALSO ⭐

cf-promises(8), cf-agent(8), cf-serverd(8), cf-execd(8), cf-monitord(8), cf-runagent(8), cf-key(8)

the whole friend group, fr fr 💖

🎀 AUTHOR 🎀

Mark Burgess and Northern.tech AS

and that's the whole page, bestie 🦋 — brought to you by CFEngine, living in the System Administration section, and yeah the manual name is literally CF-RUNAGENT(8) so you can cite it at the function, iykyk 💅✨

📦 where this page comes from