Forum: CFEngine Help
Subject: Re: Documenting policy
Author: zzamboni
Link to topic: https://cfengine.com/forum/read.php?3,26480,26484#msg-26484
I'm not completely sure what you want to do - to document your policy files, or
to produce documentation using policy files? You mention both in your post.
Documenting what the policies do, or documenting the system that the policies
are creating/configuring?
As for policy files, in principle the CFEngine way is to consider policy files
as their own documentation ("infrastructure as documentation") - as you
encapsulate things to higher levels, the "why" and "what" should be more
visible than "how". You can use "handle" and "comment" attributes to express
human-readable names and intent of promises. You should be able to use cf-know
to extract and display this information. In CFEngine Enterprise, you can search
and view this information in a graphical form using the knowledge map. I
haven't played much with cf-know in the Community version recently, so I'm not
sure how much you can do with it.
_______________________________________________
Help-cfengine mailing list
Help-cfengine@cfengine.org
https://cfengine.org/mailman/listinfo/help-cfengine
