Uploaded image for project: 'Modules'
  1. Modules
  2. MODULES-7840

puppet_agent : Document valid collection parameter values

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: puppet_agent
    • Labels:
    • Template:
    • Acceptance Criteria:
      Hide

      The collection parameter documentation lists valid options or explains how users can find valid options, and also explains those options' relationships to relevant Puppet and PE releases.

      Show
      The collection parameter documentation lists valid options or explains how users can find valid options, and also explains those options' relationships to relevant Puppet and PE releases.
    • Team:
      Platform OS
    • Sprint:
      Platform OS Kanban
    • QA Risk Assessment:
      Needs Assessment

      Description

      Module Version: 1.6.2
      Puppet Version: most relevant to Puppet 5/PE 2018.1.3
      OS Name/Version: N/A

      Desired Behavior:

      The module's collection parameter documentation lists all valid values (such as PC1, puppet, puppet5, and puppet6), as well as those values' relationships to Puppet or PE releases. It also lists the correct default behavior.

      Barring this, the collection parameter explains to users how to determine what the parameter's valid values are.

      Actual Behavior:

      The collection parameter documentation lists the default value of PC1, which per Branan Riley is incorrect, but also doesn't explain its relationship to Puppet or PE releases, and doesn't explain or link to documentation explaining what a Puppet Collection is. Using the puppet_agent module to install PE 2018.1 agents fails because relevant agent packages are not in the default PC1 collection, and users have to read the module code or already know Puppet's repository structure to know that puppet5 is a valid collection option.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              sean.mcdonald Sean McDonald
              Reporter:
              garrett.guillotte Garrett Guillotte
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support