Uploaded image for project: 'CFEngine Community'
  1. CFEngine Community
  2. CFE-1493 need hard classes to tell us which component we're running
  3. CFE-3996

Each components page should reference the class that it defines for itself

    XMLWordPrintable

    Details

    • Type: Sub-task
    • Status: Done
    • Priority: (None)
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.15.7, 3.18.3, 3.21.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      The classes that each component sets for itself is currently documented under Reference -> Language Concepts -> Classes and Decisions -> Hard Classes.

      agent cf-agent, server cf-serverd, monitor cf-monitord, executor cf-execd, runagent cf-runagent, keygenerator cf-keygen, hub cf-hub, common cf-promises and others: classes that identify the current component. cf-promises is a special case because it's not an agent in the CFEngine sense, so note that using cf-promises --show-classes will not show these classes because it can't.

      I think that these would be much easier to find/know about if they were listed on the component specific page.

      E.g. Reference -> Components -> cf-agent should indicate that it defines the `agent` class when executing.

      This matters mostly in the context of common bundles, specifically in some place where you are using a common bundle to define variables that extend inputs via body file control. For example, these classes can be used to avoid having cf-serverd parse a bunch of policy files that are full of agent bundles

        Attachments

          Activity

            People

            Assignee:
            a10042 Nick Anderson
            Reporter:
            a10042 Nick Anderson
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: