Puppet Function: promtail::strip_yaml_header

Defined in:
lib/puppet/functions/promtail/strip_yaml_header.rb
Function type:
Ruby 4.x API

Overview

promtail::strip_yaml_header(String $yaml_string) ⇒ String

A function to strip the — from the beginning of a string

Examples:

concat::fragment { 'server_config_hash':
  target  => $config_file,
  content => $promtail::server_config_hash.promtail::to_yaml.promtail::strip_yaml_header,
  order   => '10',
}

Parameters:

  • yaml_string (String) —

    A string that may start with the —‘s used to denote a YAML file

Returns:

  • (String) —

    Returns the string with the leading header stripped off



2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/puppet/functions/promtail/strip_yaml_header.rb', line 2

Puppet::Functions.create_function(:'promtail::strip_yaml_header') do
  # @param yaml_string
  #   A string that may start with the ---'s used to denote a YAML file
  # @return [String]
  #   Returns the string with the leading header stripped off
  # @example
  #   concat::fragment { 'server_config_hash':
  #     target  => $config_file,
  #     content => $promtail::server_config_hash.promtail::to_yaml.promtail::strip_yaml_header,
  #     order   => '10',
  #   }
  #
  dispatch :strip_header do
    param 'String', :yaml_string
    return_type 'String'
  end

  def strip_header(yaml_string)
    yaml_string.gsub(%r{^---\s}, '')
  end
end