[PUP-7362] Fail fast if there are no facts for a node - Puppet Jira Server

XML

Word

Printable

Details

Type: Improvement
Status: Resolved
Priority: Normal
Resolution: Fixed
Affects Version/s: PUP 4.9.4
Fix Version/s: PUP 7.13.0, PUP 6.26.0
Component/s: None
Labels:
- docs_reviewed
Environment:

CentOS 7

Acceptance Criteria:

Hide

If the --node option is specified and the node has never submitted facts, then trying to lookup a key for that node should fail fast with a message that facts can be supplied/overridden using the --facts option.

This is not an issue when the --node option is omitted, because in that case we use facter to collect facts.

Show
If the --node option is specified and the node has never submitted facts, then trying to lookup a key for that node should fail fast with a message that facts can be supplied/overridden using the --facts option. This is not an issue when the --node option is omitted, because in that case we use facter to collect facts.
Epic Link:
Trusted fact based lookups
Team:
Night's Watch
Story Points:
2
Sprint:
NW - 2021-10-20, NW - 2021-11-03, NW - 2021-11-17

Release Notes:
Bug Fix
Release Notes Summary:

Hide
Fixed an issue where `puppet lookup` would result in misleading results when using the `--node` flag. This happened because there can be cases where the target node doesn't have any facts cached. To avoid this, the fix implemented checks for the node facts/facts given in a fact file, and if it doesn't find any it raises an error.

Show
Fixed an issue where `puppet lookup` would result in misleading results when using the `--node` flag. This happened because there can be cases where the target node doesn't have any facts cached. To avoid this, the fix implemented checks for the node facts/facts given in a fact file, and if it doesn't find any it raises an error.

QA Risk Assessment:
Needs Assessment

Description

Hi,

This issue was orginaly posted on Pupepet user lsit https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/puppet-users/0Pgxjk5Ru4I/goQU3tz3BQAJ . Being suggested by Eric Thompson and Henrik Lindberg, I file a ticket for PUP here.

After upgrading opensource Puppet to version 4.9.4, I followed the Hiera guide https://docs.puppet.com/puppet/4.9/hiera_hierarchy.html#most-hierarchies-interpolate-variables to feed some data to it. I found that for some node, 'puppet lookup' failed to interpolate variables in yaml setting, which lead to incorrect lookup results.

Steps to reproduce this issue

1. Install Puppet server on puppet.pi.sjtu.edu.cn .
2. Install Puppet agents on puppet.pi.sjtu.edu.cn, slurm1.pi.sjtu.edu.cn and mu05.pi.sjtu.edu.cn. Sign certificates for them.
3. Delete global hiera setting `/etc/puppetlabs/code/hiera.yaml`.

rm -f /etc/puppetlabs/code/hiera.yaml

4. Create an environment named `production`.

mkdir -p /etc/puppetlabs/code/environments/production/ {hieradata,maifests,modules}

5. Create the Hiera conf file for the production environment in `/etc/puppetlabs/code/environments/production/hiera.yaml`

---

version: 5

defaults:

  datadir: hieradata

  data_hash: yaml_data

hierarchy:

  - name: "Per-node data"

    path: "nodes/%{trusted.certname}.yaml"

  - name: "common"

    path: "common.yaml"

6. Add common data in `/etc/puppetlabs/code/environments/production/hieradata/common.yaml`:

---

group: Compute Nodes

7a. Add per-node hiera data for slurm1.pi.sjtu.edu.cn in `/etc/puppetlabs/code/environments/production/hieradata/nodes/slurm1.pi.sjtu.edu.cn.yaml`:

---

group: SLURM

7b. Add per-node hiera data for puppet.pi.sjtu.edu.cn in `/etc/puppetlabs/code/environments/production/hieradata/nodes/puppet.pi.sjtu.edu.cn.yaml`:

---

group: Puppet Server

8a. Lookup group for puppet.pi.sjtu.edu.cn and successfully get "Puppet Server" stored in `puppet.pi.sjtu.edu.cn.yaml`.

# puppet lookup group --node puppet.pi.sjtu.edu.cn --explain

Searching for "lookup_options"

  Global Data Provider (hiera configuration version 5)

    No such key: "lookup_options"

  Environment Data Provider (hiera configuration version 5)

    Using configuration "/etc/puppetlabs/code/environments/production/hiera.yaml"

    Merge strategy hash

      Hierarchy entry "Per-node data"

        Path "/etc/puppetlabs/code/environments/production/hieradata/nodes/puppet.pi.sjtu.edu.cn.yaml"

          Original path: "nodes/%{trusted.certname}.yaml"

          No such key: "lookup_options"

      Hierarchy entry "common"

        Path "/etc/puppetlabs/code/environments/production/hieradata/common.yaml"

          Original path: "common.yaml"

          No such key: "lookup_options"

Searching for "group"

  Global Data Provider (hiera configuration version 5)

    No such key: "group"

  Environment Data Provider (hiera configuration version 5)

    Using configuration "/etc/puppetlabs/code/environments/production/hiera.yaml"

    Hierarchy entry "Per-node data"

      Path "/etc/puppetlabs/code/environments/production/hieradata/nodes/puppet.pi.sjtu.edu.cn.yaml"

        Original path: "nodes/%{trusted.certname}.yaml"

        Found key: "group" value: "Puppet Server"

8b. Lookup group for puppet.pi.sjtu.edu.cn and successfully get "Compute Nodes" stored in `common.yaml`.

# puppet lookup group --node mu05.pi.sjtu.edu.cn --explain

Searching for "lookup_options"

  Global Data Provider (hiera configuration version 5)

    No such key: "lookup_options"

  Environment Data Provider (hiera configuration version 5)

    Using configuration "/etc/puppetlabs/code/environments/production/hiera.yaml"

    Merge strategy hash

      Hierarchy entry "Per-node data"

        Path "/etc/puppetlabs/code/environments/production/hieradata/nodes/mu05.pi.sjtu.edu.cn.yaml"

          Original path: "nodes/%{trusted.certname}.yaml"

          Path not found

      Hierarchy entry "common"

        Path "/etc/puppetlabs/code/environments/production/hieradata/common.yaml"

          Original path: "common.yaml"

          No such key: "lookup_options"

Searching for "group"

  Global Data Provider (hiera configuration version 5)

    No such key: "group"

  Environment Data Provider (hiera configuration version 5)

    Using configuration "/etc/puppetlabs/code/environments/production/hiera.yaml"

    Hierarchy entry "Per-node data"

      Path "/etc/puppetlabs/code/environments/production/hieradata/nodes/mu05.pi.sjtu.edu.cn.yaml"

        Original path: "nodes/%{trusted.certname}.yaml"

        Path not found

    Hierarchy entry "common"

      Path "/etc/puppetlabs/code/environments/production/hieradata/common.yaml"

        Original path: "common.yaml"

        Found key: "group" value: "Compute Nodes"

8c. Lookup group for slurm1.pi.sjtu.edu.cn and fail to interpolate %{trusted.certname}
which results in incorrect lookup fallback to `common.yaml`. It is expected to use `slurm1.pi.sjtu.edu.cn.yaml` and the correct result should be "SLURM", not "Compute Nodes".

# puppet lookup group --node slurm1.pi.sjtu.edu.cn --explain

Searching for "lookup_options"

  Global Data Provider (hiera configuration version 5)

    No such key: "lookup_options"

  Environment Data Provider (hiera configuration version 5)

    Using configuration "/etc/puppetlabs/code/environments/production/hiera.yaml"

    Merge strategy hash

      Hierarchy entry "Per-node data"

        Path "/etc/puppetlabs/code/environments/production/hieradata/nodes/.yaml"

          Original path: "nodes/%{trusted.certname}.yaml"

          Path not found

      Hierarchy entry "common"

        Path "/etc/puppetlabs/code/environments/production/hieradata/common.yaml"

          Original path: "common.yaml"

          No such key: "lookup_options"

Searching for "group"

  Global Data Provider (hiera configuration version 5)

    No such key: "group"

  Environment Data Provider (hiera configuration version 5)

    Using configuration "/etc/puppetlabs/code/environments/production/hiera.yaml"

    Hierarchy entry "Per-node data"

      Path "/etc/puppetlabs/code/environments/production/hieradata/nodes/.yaml"

        Original path: "nodes/%{trusted.certname}.yaml"

        Path not found

    Hierarchy entry "common"

      Path "/etc/puppetlabs/code/environments/production/hieradata/common.yaml"

        Original path: "common.yaml"

        Found key: "group" value: "Compute Nodes"

Attachments

Activity

People

Assignee:: Victor Bobosila

Reporter:: Jianwen Wei

Votes:: 0 Vote for this issue

Watchers:: 9 Start watching this issue

Dates

Created:: 2017/03/16 7:35 AM

Updated:: 2022/01/11 8:14 PM

Resolved:: 2021/11/10 12:30 AM