如何在hiera.yaml中声明必填hieradata文件？解决配置丢失问题

Great question! Hiera doesn't have a built-in config option to enforce the presence of specific hieradata files directly, but there are a few solid workarounds to achieve exactly what you're asking for—making Puppet fail immediately if required files like nodes.yaml are missing.

1. Check File Presence Directly in Puppet Code #

The simplest approach is to add a check in your base Puppet manifest (like site.pp) that verifies the required hieradata files exist before any other code runs. Here's how to do it:

# Define the path to your required hieradata file using Puppet's built-in settings
$required_hierafile = "${settings::environmentpath}/${settings::environment}/hieradata/nodes.yaml"

# Fail immediately if the file is missing
if !file_exists($required_hierafile) {
  fail("Critical error: Required hieradata file ${required_hierafile} is missing! Puppet run aborted.")
}

# Optional: Enforce file presence with a resource (the fail above is more immediate)
file { $required_hierafile:
  ensure => present,
  before => Class['your::top_level::class'],
}

This uses Puppet's file_exists() function to validate the file early in the run. If it's missing, the fail() function terminates the Puppet run right away with a clear, actionable error message.

2. Use a Pre-Run Script (Agent-Side) #

For even earlier validation (before Puppet starts compiling catalogs), you can add a pre-run script that checks for required files. This blocks the Puppet agent from running entirely when critical files are missing.

Example Bash Script #

#!/bin/bash
# Use Puppet's environment variable if available, default to production
HIERADATA_DIR="/etc/puppetlabs/code/environments/${PUPPET_ENVIRONMENT:-production}/hieradata"
# List all your mandatory hieradata files here
REQUIRED_FILES=("nodes.yaml" "common.yaml")

for file in "${REQUIRED_FILES[@]}"; do
  if [ ! -f "${HIERADATA_DIR}/${file}" ]; then
    echo "FATAL: Required hieradata file ${HIERADATA_DIR}/${file} is missing!"
    exit 1
  fi
done

Configure Puppet to Run the Script First #

• For systemd-managed agents: Drop an override file in /etc/systemd/system/puppet-agent.service.d/ adding ExecStartPre=/path/to/your/check_script.sh, then reload systemd.
• For cron-based runs: Prepend the script call before the puppet agent -t command in your cron entry.

3. Custom Hiera Backend (Advanced) #

If you need deeper integration with Hiera itself, you can write a custom backend that inherits from Hiera's default YAML backend and adds file existence checks. This requires basic Ruby knowledge.

The core idea is to override the lookup method in your custom backend to verify the target file exists before loading it. If the file is missing, raise an exception that Puppet will catch and use to terminate the run. This approach ties the check directly to Hiera's lookup process, rather than relying on a separate manifest or script.

内容的提问来源于stack exchange，提问作者EdwinW