net.roboconf.plugin.puppet.internal

Class PluginPuppet

java.lang.Object

net.roboconf.plugin.puppet.internal.PluginPuppet

All Implemented Interfaces:

net.roboconf.plugin.api.PluginInterface

public class PluginPuppet
extends Object
implements net.roboconf.plugin.api.PluginInterface

The plug-in executes a Puppet manifests.

WARNING: when this plug-in is used on a local IaaS / host, only the initialization will work. Other actions that require root permissions will fail. They may work on a real IaaS because the agent (which runs this plug-in) must be started with an "init.d" script. Thus, it automatically inherits root permissions.

Modules will be installed automatically during the initialization. Although there can be several manifests into the "manifests" directory, only "init.pp" will be used. Other should be referenced through includes.

The best solution is to use the default template to mutualize actions. Thus, start and stop can be achieved through a same script that will either have the running state to RUNNING or to STOPPED.

The action is one of "deploy", "start", "stop", "undeploy" and "update".
Let's take an example with the "start" action to understand the way this plug-in works.

• The plug-in will load manifests/start.pp
• If it is not found, it will try to load templates/start.pp.template
• If it is not found, it will try to load templates/default.pp.template
• If it is not found, the plug-in will do nothing

The default template is used to factorize actions.

Author:

Noël - LIG, Vincent Zurczak - Linagora, Christophe Hamerling - Linagora

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginPuppet.PuppetState The running states for Puppet.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_NAME

Constructor Summary

Constructors

Constructor and Description
PluginPuppet()

Method Summary

Modifier and Type	Method and Description
void	deploy(net.roboconf.core.model.beans.Instance instance)
String	getPluginName()
void	initialize(net.roboconf.core.model.beans.Instance instance)
void	setNames(String applicationName, String scopedInstancePath)
void	start(net.roboconf.core.model.beans.Instance instance)
void	stop(net.roboconf.core.model.beans.Instance instance)
void	undeploy(net.roboconf.core.model.beans.Instance instance)
void	update(net.roboconf.core.model.beans.Instance instance, net.roboconf.core.model.beans.Import importChanged, net.roboconf.core.model.beans.Instance.InstanceStatus statusChanged)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PLUGIN_NAME

public static final String PLUGIN_NAME

See Also:

Constant Field Values

Constructor Detail

PluginPuppet

public PluginPuppet()

Method Detail

getPluginName

public String getPluginName()

Specified by:

getPluginName in interface net.roboconf.plugin.api.PluginInterface

setNames

public void setNames(String applicationName,
                     String scopedInstancePath)

Specified by:

setNames in interface net.roboconf.plugin.api.PluginInterface

initialize

public void initialize(net.roboconf.core.model.beans.Instance instance)
                throws net.roboconf.plugin.api.PluginException

Specified by:

initialize in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

deploy

public void deploy(net.roboconf.core.model.beans.Instance instance)
            throws net.roboconf.plugin.api.PluginException

Specified by:

deploy in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

start

public void start(net.roboconf.core.model.beans.Instance instance)
           throws net.roboconf.plugin.api.PluginException

Specified by:

start in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

update

public void update(net.roboconf.core.model.beans.Instance instance,
                   net.roboconf.core.model.beans.Import importChanged,
                   net.roboconf.core.model.beans.Instance.InstanceStatus statusChanged)
            throws net.roboconf.plugin.api.PluginException

Specified by:

update in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

stop

public void stop(net.roboconf.core.model.beans.Instance instance)
          throws net.roboconf.plugin.api.PluginException

Specified by:

stop in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

undeploy

public void undeploy(net.roboconf.core.model.beans.Instance instance)
              throws net.roboconf.plugin.api.PluginException

Specified by:

undeploy in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException