Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Control your Interwoven/Autonomy OpenDeploy base server with Perl
Perl
branch: master
Failed to load latest commit information.
inc/Module initial checkin
lib/OpenDeploy initial checkin
t initial checkin
.gitignore initial checkin
Changes initial checkin
MANIFEST.SKIP initial checkin
Makefile.PL initial checkin
README initial checkin
TODO added path to defaultiwod60home file in /etc

README

NAME
    OpenDeploy::Control - a simple class to control OpenDeploy servers

VERSION
    Version 0.01

SYNOPSIS
    This class can be used to control your Interwoven/Autonomy OpenDeploy
    Base servers. It's providing a clean oop-style interface to the
    commandline binary iwodcmd. Using this class it will be easier to use
    OpenDeploy commands inside your TeamSite workflows or any other purposes
    where you need to run OpenDeploy based deployments.

    Create an object, provide the deployment name for the constructor and
    call the deploy method.

        use OpenDeploy::Control;
        my $worker = OpenDeploy::Control->new( deployment => 'foo' );
        $worker->deploy();

    You can use keyword substitution inside your deployment configuration
    and set the key=value pairs with this class.

        use OpenDeploy::Control;
        my $worker = OpenDeploy::Control->new( deployment => 'foo' );
    
        my %substitutions = (
                                srcdirectory  => '/var/cms/content',
                                destdirectory => '/var/www',
                                receiver      => 'webserver.pkgbox.org'
        );
    
        $worker->subst( \%substitutions );
        $worker->deploy();
        
    Using this package will result in the following commandline:

        iwodcmd start foo -k srcdirectory=/var/cms/content \
                          -k destdirectory=/var/www \
                          -k receiver=webserver.pkgbox.org

    There are several options which can be set with the class properties.

CLASS PROPERTIES
    All functions below are accessors to the different class properties.

  iwodcmd()
    The property iwodcmd is a Path::Class::File object to the iwodcmd
    command. There is a little magic by default and this class tries hard to
    find your iwodcmd binary.

  deployment()
    The property deployment is a string with the name of the deployment. If
    your deployment file is called foo.xml the correct name for the
    deployment property will be foo.

    This property is required when you create an object of this class. Make
    sure to pass it to the constructor like:

        use OpenDeploy::Control;
        my $worker = OpenDeploy::Control->new( deployment => 'foo');

  inst()
    OpenDeploy allows to set an instance name per deployment. Please note
    that there must not be more than one deployment of the same instance
    name running or the deployment will terminate with an error.

  sim()
    OpenDeploy can simulate the deployment for testing purposes like
    checking your configuration files. By setting this property you can
    simulate the deployment.

  async()
    The default behavior is to wait for a deployment to finish before
    another deployment can be triggered. By setting the async property you
    can run several deployments at the same time and the iwodcmd command
    returns once the deployment has been triggered. Make sure to use a
    unique instance name.

  logging()
    There are two possible logging values - verbose and normal. The default
    for this class is the normal loglevel.

    Example:

        use OpenDeploy::Control;
        my $worker = OpenDeploy::Control->new( deployment => 'foo');
        $worker->logging('verbose');

  command()
    The iwodcmd command can start or deploycancel a running deployment. By
    setting this property you can terminate a deployment when running in
    async mode. The default for this property is 'start'.

    Example:

        use OpenDeploy::Control;
        my $worker = OpenDeploy::Control->new( deployment => 'foo');
        $worker->command('deploycancel');
        $worker->deploy();

  subst()
    OpenDeploy can substitute keyword with key=value pairs inside your
    configuration files. This allows to reuse one deployment xml file for
    several purposes. To use this property pass a hashref with the
    substitutions to the subst accessor.

    Example:

        use OpenDeploy::Control;
        my $worker = OpenDeploy::Control->new( deployment => 'foo');
        my %substitutions = (
                                srcdirectory  => '/var/cms/content',
                                destdirectory => '/var/www',
                                receiver      => 'webserver.pkgbox.org'
        );

        $worker->subst( \%substitutions );

FUNCTIONS
  deploy
    Method for starting/cancelling a deployment. Check the different class
    properties on how to control the behavior of the deployment.

  _find_iwodcmd
    Inner method to look for the iwodcmd commandline binary for the
    deployment tasks.

BUGS
    Please report any bugs or feature requests to "bug-opendeploy-control at
    rt.cpan.org", or through the web interface at
    <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=OpenDeploy-Control>. I
    will be notified, and then you'll automatically be notified of progress
    on your bug as I make changes.

SUPPORT
    You can find documentation for this module with the perldoc command.

        perldoc OpenDeploy::Control

AUTHOR
    Written by Ulrich Habel, "<rhaen at cpan.org>".

ACKNOWLEDGEMENTS
    Thanks to the Moose developers for the wonderful package.

COPYRIGHT
    Copyright 2009, Ulrich Habel, All Rights Reserved.

    You may use, modify, and distribute this package under the same terms as
    Perl itself.

    See <http://www.perl.com/perl/misc/Artistic.html>

Something went wrong with that request. Please try again.