Uploaded image for project: 'Puppet'
  1. Puppet
  2. PUP-6345

Configuration reference reports wacky default for hiera_config setting

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PUP 4.5.3
    • Component/s: None
    • Labels:
      None
    • Template:

      Description

      Docs team relies on puppet doc -r configuration to build the configuration reference. If you run that command with Puppet 4.5, it reports the default location of hiera_config as something like /Users/nick/.puppetlabs/etc/code/hiera.yaml.

      a. It should be reporting the default in terms of variables like $confdir, not printing a user-specific path.
      b. Even $confdir/hiera.yaml isn't the whole story, because of the try-codedir-first behavior to preserve backward compatibility. That kind of dynamic behavior is really hard to introspect, and we rely on being able to introspect.

      I think I know how to fix this, but I'm filing it as a real ticket to raise awareness:

      • When we add dynamic behaviors for auto-documented objects, we also need to make sure we don't break the docs.
      • Plain old introspection is brittle, and it would be really nice to have a way, in the settings themselves, to provide a descriptive default value. We probably won't get this for oldskool puppet settings, but it'd be nice to take into account for whatever's next. We've been burned by this sort of thing before, in several places.

        Attachments

          Issue Links

            Activity

              jsd-sla-details-panel

                People

                • Assignee:
                  Unassigned
                  Reporter:
                  nick.fagerlund Nicholas Fagerlund
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  1 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved: