Module: Rudder::DSL

Defined in:

lib/rudder/dsl.rb,
lib/rudder/dsl/job.rb,
lib/rudder/dsl/util.rb,
lib/rudder/dsl/group.rb,
lib/rudder/dsl/pipeline.rb,
lib/rudder/dsl/resource.rb,
lib/rudder/dsl/component.rb,
lib/rudder/dsl/resource_type.rb

Overview

DSL for configuring and manipulating Concourse Pipelines

The building blocks of the DSL are:

• Pipeline, the top level definition containg all other definitions. See Concourse Pipeline

• Resource, representing inputs and outputs of jobs. See Concourse Resource

• Job, units of work. See Concourse Job

• ResourceType, defines how a Resource operates. See Concourse Resource Type

• Group, logically groups together Concourse Jobs in the UI. See Concourse Grouping Jobs

Defined Under Namespace

Modules: Util Classes: Component, Group, Job, Pipeline, Resource, ResourceType

Class Method Summary

• .eval_from_file(path, vars: {}) ⇒ Rudder::DSL::Pipeline

  Load and evaluate a pipeline from a definition file at the path.

• .from_file(path, vars: {}) ⇒ Rudder::DSL::Pipeline

  Load a pipeline from a definition file at the path.

• .pipeline(*args, **kwargs) ⇒ Rudder::DSL::Pipeline

  Entry to the DSL.

Class Method Details

.eval_from_file(path, vars: {}) ⇒ Rudder::DSL::Pipeline

Load and evaluate a pipeline from a definition file at the path

Parameters:

• path (String) —

  to the Pipeline definition

• vars —

  optional [Hash<(Symbol, String), Any>] of Concourse variables

Returns:

• (Rudder::DSL::Pipeline) —

  from path, fully evaluated

# File 'lib/rudder/dsl.rb', line 52

def self.eval_from_file(path, vars: {})
  Rudder::DSL::Pipeline.new(path, vars: vars).eval
end

.from_file(path, vars: {}) ⇒ Rudder::DSL::Pipeline

Load a pipeline from a definition file at the path

Parameters:

• path (String) —

  to the Pipeline definition

• vars —

  optional [Hash<(Symbol, String), Any>] of Concourse variables

Returns:

• (Rudder::DSL::Pipeline) —

  from path, unevaluated

# File 'lib/rudder/dsl.rb', line 40

def self.from_file(path, vars: {})
  Rudder::DSL::Pipeline.new path, vars: vars
end

.pipeline(*args, **kwargs) ⇒ Rudder::DSL::Pipeline

Entry to the DSL. Creates a new pipeline instance to evaluate user defined pipelines

Returns:

• (Rudder::DSL::Pipeline) —

  new, and unevaluated

# File 'lib/rudder/dsl.rb', line 28

def self.pipeline(*args, **kwargs)
  Rudder::DSL::Pipeline.new(*args, **kwargs)
end