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

Merge Strategy 'first|unique|hash' documentation is unclear

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PUP 4.10.10, PUP 5.3.4, PUP 5.4.0
    • Component/s: Docs
    • Labels:
      None
    • Template:
    • Acceptance Criteria:
      Hide
      • add documentation on purpose or usage situation for this merge strategy
      • Include details of how the various strategies are selected by hiera
      • Indicate if the `|` vertical pipe indicates that this is a configurable strategy (could I say use `strategy => 'unique|hash` instead?)
      Show
      add documentation on purpose or usage situation for this merge strategy Include details of how the various strategies are selected by hiera Indicate if the `|` vertical pipe indicates that this is a configurable strategy (could I say use `strategy => 'unique|hash` instead?)
    • Team:
      Platform Core
    • Release Notes:
      Not Needed
    • QA Risk Assessment:
      Needs Assessment

      Description

      The documentation for the [`first|unique|hash`](https://puppet.com/docs/puppet/5.3/hiera_merging.html#strategy--firstuniquehash) merge strategy is brief, and does not explain usage or functionality of the merge strategy in a similar way to the documentation for the other merge strategies.

      The entirety of the current documentation for this strategy is one sentance:

      > Same as the string versions of these merge behaviors.

      This doesn't tell me anything, since obviously it's not the same, or it wouldn't be an additonal option. Mainly, I believe it's implying that hiera will try to select the appropriate strategy based on the data-type. However that raises the question of how the `unique` or `hash` strategy would be applied to a key when `first` is also present (which ignores all merge's entirely).

        Attachments

          Issue Links

            Activity

              jsd-sla-details-panel

                People

                • Assignee:
                  claire.cadman Claire Cadman
                  Reporter:
                  LongLiveCHIEF Brian Vanderbusch
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  5 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Zendesk Support