Puppet Function: puppet_ssldir

Defined in:
modules/wmflib/lib/puppet/functions/puppet_ssldir.rb
Function type:
Ruby 4.x API

Summary

Returns puppet's configured ssldir, using some heuristics.

Overview

puppet_ssldir(Optional[String[1]] $override) ⇒ String[1]

SPDX-License-Identifier: Apache-2.0 This function is needed because we have a separate configurations for the self-hosted puppetmasters ssl directory compared to the standard setup. If we're ever able to simplify or remove such differences, this function might become way simpler, or even disappear.

It's possible to override the heuristics and provide an override parameter, which if set to 'master' will assume you are on a self-hosted puppetmaster.

Examples:

Usage


# returns the default result based on the catalog
$ssldir = puppet_ssldir()
# Forces ssldir to be the one of a self-hosted puppetmaster
$ssldir = puppet_ssldir('master')

Parameters:

  • override (Optional[String[1]])

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'modules/wmflib/lib/puppet/functions/puppet_ssldir.rb', line 22

Puppet::Functions.create_function(:puppet_ssldir) do
  # @optional_param override
  #   One of 'master' or 'client' to override for self-hosted masters
  #
  dispatch :puppet_ssldir do
    optional_param "String[1]", :override
    return_type "String[1]"
  end
  def puppet_ssldir(override = nil)
    unless ["master", "client", nil].include? override
      fail("puppet_ssldir(): only 'master', 'client' and undef are valid")
    end

    default = "/var/lib/puppet/ssl"
    self_master = "/var/lib/puppet/server/ssl"
    self_client = "/var/lib/puppet/client/ssl"

    # Production uses the standard layout
    return default if closure_scope["::realm"] != "labs"

    # Self-hosted puppetmasters explicit setup
    case override
    when "master"
      return self_master
    when "client"
      return self_client
    end

    # Since all self-hosted puppetmasters are in .eqiad.wmflabs, while
    # the labs masters don't
    if closure_scope["::settings::certname"] =~ /\.wikimedia\.org$/
      return default
    end

    puppetmaster = closure_scope["puppetmaster"]
    if puppetmaster == "" || puppetmaster.nil?
      default
    elsif [
          closure_scope["facts"]["networking"]["hostname"],
          "localhost",
          "",
          nil
        ].include? puppetmaster
      self_master
    else
      self_client
    end
  end
end