CF-PROMISES(8)

📦
version 3.24.1 · 2 versions
, in debian trixie

💖 CF-PROMISES(8) 💖

okay so bestie, this is a page from the System Manager's Manual — yes, the section 8 girlies — and it's all about cf-promises, the policy-code checker. pull up a chair, we're doing this 🎀

✨ NAME ✨

cf-promises — validate and analyze CFEngine policy code. that's the whole job. she checks your policy, she does not touch your system. periodt. 💅

🌸 SYNOPSIS 🌸

cf-promises [OPTION]...  [FILE]

🦋 DESCRIPTION 🦋

cf-promises is the tool for checking CFEngine policy code, and she is thorough in a way that's honestly iconic. here's the whole glow-up sequence she goes through:

  1. first she parses your policy code, hunting for syntax errors.
  2. second, she validates the integrity of a policy that's spread across multiple files.
  3. third, she checks for semantic errors — think specific attribute set rules, that kind of thing.
  4. finally, she tries to expose errors by partially evaluating the policy, resolving as many variable and classes promise statements as she possibly can.

and the best part? at no point does cf-promises make any changes to the system. zero. none. she's all vibes and no collateral damage. 🙈

👑 OPTIONS 👑

  • --workdir, -w value — override the work directory for testing (same as setting CFENGINE_TEST_OVERRIDE_WORKDIR)
  • --eval-functions, - value — evaluate functions during syntax checking (may catch more run-time errors). possible values: 'yes', 'no'. default is 'yes'
  • --show-classes, -... value — show discovered classes, including those defined in common bundles in policy. optionally can take a regular expression.
  • --show-vars, - value — show discovered variables, including those defined without dependency to user-defined classes in policy. optionally can take a regular expression.
  • --help, -h — print the help message
  • --bundlesequence, -b value — use the specified bundlesequence for verification
  • --debug, -d — enable debugging output
  • --verbose, -v — output verbose information about the behaviour of cf-promises
  • --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
  • --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.
  • --define, -D value — define a list of comma separated classes to be defined at the start of execution
  • --negate, -N value — define a list of comma separated classes to be undefined at the start of execution
  • --inform, -I — print basic information about changes made to the system, i.e. promises repaired
  • --diagnostic, -x — activate internal diagnostics (developers only)
  • --policy-output-format, -p value — output the parsed policy. possible values: 'none', 'cf', 'json' (this file only), 'cf-full', 'json-full' (all parsed promises). default is 'none'. (experimental)
  • --syntax-description, -s value — output a document describing the available syntax elements of CFEngine. possible values: 'none', 'json'. default is 'none'.
  • --full-check, -c — ensure full policy integrity checks
  • --warn, -W value — pass comma-separated <warnings>|all to enable non-default warnings, or error=<warnings>|all
  • --color, -C value — enable colorized output 🎨 possible values: 'always', 'auto', 'never'. if option is used, the default value is 'auto'
  • --tag-release, -T value — tag a directory with promises.cf with cf_promises_validated and cf_promises_release_id
  • --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

🌈 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/.

🧚 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-promises 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/.

🔥 SEE ALSO 🔥

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

💜 AUTHOR 💜

Mark Burgess and Northern.tech AS

and that's the whole page bestie, no cap 🫶

so like, credit where credit's due: this one's from the System Administration corner of the CFEngine docs, page CF-PROMISES(8) in the System Manager's Manual. mwah, go validate some policy, you absolute icon 💅✨

📦 where this page comes from