Puppet Function: choria::run_playbook

Defined in:
lib/puppet/functions/choria/run_playbook.rb
Function type:
Ruby 4.x API

Overview

choria::run_playbook(String $playbook, Optional[Hash] $named_args) ⇒ Any

Runs a Choria playbook

This helper invokes a Choria Playbook and returns any result that the called Playbook returns

Errors will by default be raised causing execution to fail, passing ‘__catch_errors => true` as a property will return the failing task result

Examples:

runs a playbook, fails on any failure


choria::run_playbook("example::restart_puppet",
  "cluster" => "alpha"
)

runs a playbook with custom error handling


choria::run_playbook("example::restart_puppet", _catch_errors => true,
  "cluster" => "alpha"
)
  .on_error |$err| {
     choria::run_playbook("example::notify_slack",
       "msg" => sprintf("Playbook %s failed: %s", $facts["choria"]["playbook"], $err.message)
     )
     choria::run_playbook("example::enable_puppet", "cluster" => "alpha" )
     fail($err.message)
   }

Parameters:

  • playbook (String)
  • named_args (Optional[Hash])

Returns:

  • (Any) 


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
 
# File 'lib/puppet/functions/choria/run_playbook.rb', line 26

Puppet::Functions.create_function(:"choria::run_playbook", Puppet::Functions::InternalFunction) do
  dispatch :run_playbook do
    scope_param
    param "String", :playbook
    optional_param "Hash", :named_args
  end

  def run_playbook(scope, playbook, named_args = {})
    unless Puppet[:tasks]
      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
        Puppet::Pops::Issues::TASK_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, operation: "run_playbook"
      )
    end

    args = named_args.reject {|a| a.start_with?("_") }
    result = []

    begin
      loaders = closure_scope.compiler.loaders
      loader = loaders.private_environment_loader

      if loader && (func = loader.load(:plan, playbook))
        results = func.class.dispatcher.dispatchers[0].call_by_name_with_scope(scope, args, true)
        return results
      end
    rescue Puppet::Error
      raise unless named_args["_catch_errors"]

      return MCollective::Util::BoltSupport::TaskResults.new([], $!)
    end

    raise(ArgumentError, "Function choria::run_playbook(): Unknown playbook: '%s'" % playbook)
  end
end