puppetlabs / puppetlabs/puppetlabs-puppetdb

Stop overwriting the routes.yaml file

Open
#24 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bugfix
Dominant language
Puppet
Stars
56
Forks
231
Avg merge
12d 2h
Merged PRs (30d)
2

Description

The current implementation of this module overwrite routes.yaml with the exact settings needed by PuppetDB. If a user already has a routes.yaml file that is managing other things besides the the facts terminus, their settings will be blown away.

We should handle this more gracefully. It ought to be pretty simple to put together a yaml module that had a resource type for dealing with an individual yaml setting. If we did that, then the PuppetDB module could use that to set only the relevant settings without overriding any existing settings.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the PuppetDB module code that writes routes.yaml and inspect how its current settings are assembled. Define the YAML resource behavior around individual settings, then verify that PuppetDB's required facts terminus settings are managed without overwriting unrelated user settings in routes.yaml.

Written by the indexing model from the issue text.

Assessment

Domain
infrastructure
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.