Class: Architect::Plugin

Inherits:
Object
  • Object
show all
Defined in:
lib/architect/plugin.rb

Overview

When the main Architect executable runs, it calls out to various Plugin objects to do additional work at various stages.

Direct Known Subclasses

HelloWorldPlugin, LDAPNetgroupPlugin

Defined Under Namespace

Classes: MachineInstance

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#config ⇒ Object (readonly)

The configuration settings for the plugin



10
11
12
 
# File 'lib/architect/plugin.rb', line 10

def config
  @config
end

#name ⇒ Object (readonly)

The name of the plugin



8
9
10
 
# File 'lib/architect/plugin.rb', line 8

def name
  @name
end

Instance Method Details

#check ⇒ Object

Check to see if any actions need to be taken, and return a list of Architect::ChangeRequest objects for each proposed action



25
26
27
 
# File 'lib/architect/plugin.rb', line 25

def check
  []
end

#configure(yaml) ⇒ Object

Parse a [yaml] configuration file



18
19
20
 
# File 'lib/architect/plugin.rb', line 18

def configure(yaml)
  nil
end

#design ⇒ Object

Ask questions during the design of a new plan; i.e. when architect –design is called.



31
32
33
 
# File 'lib/architect/plugin.rb', line 31

def design
  nil
end

#execute ⇒ Object

Execute the proposed actions based on the current plan.



41
42
43
 
# File 'lib/architect/plugin.rb', line 41

def execute
  nil
end

#plan(yaml) ⇒ Object

Parse a YAML plan file and perform validation.



36
37
38
 
# File 'lib/architect/plugin.rb', line 36

def plan(yaml)
  nil
end

#register ⇒ Object

Called when the plugin is registered



13
14
15
 
# File 'lib/architect/plugin.rb', line 13

def register
  nil
end