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

`puppet config print` confusing for users

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: PUP 3.4.0
    • Fix Version/s: PUP 5.5.0
    • Component/s: None
    • Labels:
      None
    • Template:
    • Acceptance Criteria:
      Hide
      • rspec tests includes ability to ensure that output is being written to stderr
      • test to validate warning to stderr when no section provided
      • config help - manually verify content
      • stdout is not altered
      • add the message for section and environment to config set and config delete
      Show
      rspec tests includes ability to ensure that output is being written to stderr test to validate warning to stderr when no section provided config help - manually verify content stdout is not altered add the message for section and environment to config set and config delete
    • Team:
      Platform Core
    • Sub-team:
    • Sprint:
      Platform Core KANBAN
    • Release Notes:
      Bug Fix
    • Release Notes Summary:
      puppet config print, set, and delete now print the environment and section on stderr to reduce user confusion. puppet config print also warns the user if they do not specify a section.
    • QA Risk Assessment:
      Manual

      Description

      puppet config print doesn't require a --section to be specified and doesn't inform the user what section of the config file it is showing the value for. Users then get unexpected information from the command.

      The command needs to change in some way to make it clear what sections the information is coming from and provide a good way to request information from a specific section. 'main' is the default.

      An example: You may have a server setting that is already in the agent setting. When you ran puppet config set server "value" - that will throw it in the "main" section. There already exists a server setting in the "agent" section that is overriding this. The next time you run puppet config print - you will get the one out of the main section (not the overriding agent setting)

      1. Always print section info to stderr:

      $ puppet config print server
      Resolving settings from section 'main' in environment 'production'
      puppetserver.example.com
      Also print any other settings found that may/will override this setting as in the example above - "Setting is also defined in the following sections: X, Y, Z"

      2. If section is omitted, also emit a warning to stderr:

      $ puppet config print server
      Resolving settings from section 'main' in environment 'production'
      No section specified, using 'user' section - settings will not affect agent execution!
      puppetserver.example.com

      3. Update "config" help to strongly recommend always specifying a section (should probably work with Garrett Guillotte on this):

      • what the list of commonly used sections are
      • guidance on naming sections
      • the output of the help command point to the sections documentation
      • Include a good solid example of sections (what settings go in what section)

        Attachments

          Issue Links

            Activity

              jsd-sla-details-panel

                People

                • Assignee:
                  jorie Jorie Tappa
                  Reporter:
                  andy Andrew Parker
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  13 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved: