README.md
1This directory contains the CFEngine Standard Library, previously
2referred to as the Common Open Promise Body Library.
3
4Layout of this `lib` directory:
5
6* `3.6/*.cf`: Modularized version of the CFEngine Standard Library for
7 3.6.x.
8
9* `lib/*.cf`: Re-unified library compatible with 3.7+
10 - *autorun.cf*: This file contains bundles that support automatic activation
11 of bundles based on tags as well as automatically adding policy files found
12 in services/autorun to inputs.
13 - *bundles.cf*: This file contains bundles that are generically useful. For
14 example manage cron entries, recursively deleting directories, checking if
15 a url is repsonding, and merging multiple data containers together.
16 - *cfe_internal.cf*: This file defines bodies and bundles that are related to
17 general CFEngine management. For example purging old log files.
18 - *cfe_internal_hub.cf*: This file defines bodies and bundles that are
19 releated to CFEngine Enterprise Hub management.
20 - *cfengine_enterprise_hub_ha.cf*: This file defines bodies and bundles that
21 are related to managing High Availability on CFEngine Enterprise Hubs.
22 - *commands.cf*: This file contains bodies and bundles that are useful when
23 running commands. For example suppressing command output, or controlling
24 which user or group should be executing the command.
25 - *common.cf*: This file contains bodies and bundles that are useful across
26 the board. For example bodies that help to define classes based on promise
27 outcomes, bodies to control logging for specific promsies, and bodies to help
28 control how frequently promises get activated.
29 - *databases.cf*: This file contains bodies and bundles useful when managing
30 databases like Postgres and the Windows Registry.
31 - *edit_xml.cf*: This file contains bodies and bundles useful when managing
32 xml files.
33 - *examples.cf*: This file contains examples of other useful bundles like
34 activating a bundle based on probability.
35 - *feature.cf*: This file defines a bundle to help manage classes to identify
36 contexts that should be set or not set. It can be useful for turning
37 certain aspects of policy on or off for a given amount of time.
38 - *files.cf*: This file defines bodies and bundles that are useful for
39 managing files.
40 - *guest_environments.cf*: This file defines bodies and bundles useful for
41 manageing guest environments (Virtual Machines).
42 - *monitor.cf*: This file defines bodies and bundles useful when measuring
43 values with cf-monitord (Enterprise only)
44 - *packages.cf*: This file defines bodies and bundles releated to
45 package management.
46 - *paths.cf*: This file defines paths to well known binaries for
47 various platforms.
48 - *processes.cf*: This file defines bodies and bundles useful for
49 managing processes.
50 - *services.cf*: This file defines service methods for use with
51 services type promises.
52 - *stdlib.cf*: This file includes the commonly used library files
53 - *storage.cf*: This file defines storage related bodies and bundles
54 for working with mounts and volumes.
55 - *users.cf*: This file defines bodies and bundles related to local
56 user management
57 - *vcs.cf*: This file defines bodies and bundles useful for
58 interacting with version control systems.
59