Getting Started

This guide covers your initial installation and setup of Espresso Scheduler.

You should have already downloaded Espresso Scheduler and received your licence key. If you have not done so, see Downloads.

Quick Start

If you wish to evaluate or quickly check out Espresso, here are the steps you need to follow.

1. Create database for use by Espresso (MySQL 5 or PosgreSQL 9). If a database already exists that you wish to share, you may skip this step, though you may wish to consult Espresso Tables before proceeding.
2. Edit com.carfey.properties to specify the database url, user and password.
3. Deploy the admin/scheduler war to your chosen servlet container (Tomcat or Jetty).
4. Log in to the admin web application with the user and password provided to you when you received your licence key.

Choose Your Installation Type

If you skipped the Quick Start section or wish more control over your installation, the following sections will detail your choices and steps to configure and deploy Espresso.

Espresso consists of two main processes:

• Scheduler
• Admin Web Application

These can be run together or in separate processes in the following configurations:

1. Standalone Scheduler
2. Embedded Scheduler (within your application)
3. Standalone Admin Web Application
4. Combined Scheduler and Admin Web Application

Choosing which option works for you depends on your specific needs. The setups which are suitable for most cases would be:

• using and embedded scheduler (option 2) along with a standalone admin webapp (option 3)
• using a combined scheduler and admin web app (option 4)

You may wish to use multiple configurations together. For example, you may combine standalone schedulers along with a combined scheduler and web application.

Note: A key server proxy package also exists and you may choose to deploy it within a servlet container like Jetty or Tomcat. See Key Server Proxy for details on key server proxies.

Initial Setup

This section covers the setup required after you've selected your deployment setup.

Database

Espresso relies on a database which should be configured before attempting to deploy your scheduler processes.

Currently Espresso supports MySQL 5 and PostgreSQL 9.

To configure which database to use, you should edit your com.carfey.properties file to include the correct user, password and url. You can follow the examples in the properties file included with your installation files.

Note that the database must exist before deployment, but Espresso will automatically perform initial setup including table creation. When you first deploy your scheduler, it will perform all necessarily initialization.

Note: Espresso needs to create the tables in the target database. If the schema is shared with your application’s tables, please ensure there are no name conflicts. If there are conflicts, separate schemas/databases can be used. See the Espresso Tables that are created upon first deployment.

Authentication

The Espresso admin web application supports both native users and LDAP-enabled authentication.

By default, it is configured to use native login, and a default “admin” user is created when the scheduler is first deployed. Users can then be created and managed from within the admin management console.

To use LDAP-based authentication, edit your com.carfey.properties file as follows. :

# Comment out the native authenticator setup
#com.carfey.suite.security.Authenticator=com.carfey.suite.security.DBAuthenticator

#Set your LDAP info here
com.carfey.suite.security.Authenticator=com.carfey.suite.security.LdapAuthenticator
com.carfey.suite.security.LdapAuthenticator.dn.base=ou=people,o=MyOrgHere
com.carfey.suite.security.LdapAuthenticator.url=ldap://localhost:10389

# Configure who may access the web app, based on LDAP group membership
com.carfey.suite.security.LdapAuthenticator.accessDN=cn=SchedulerAccess,ou=groups,o=MyOrgHere

# Configure the Write role used in the admin web app, based on LDAP group membership (by default, users may only read)
com.carfey.suite.security.LdapAuthenticator.role.write.dn=cn=SchedulerWrite,ou=groups,o=MyOrgHere
# No need to alter this
com.carfey.suite.security.LdapAuthenticator.role.write.roleName=Write

# Configure the Admin role used in the admin web app, based on LDAP group membership (users may configure system parameters, etc).
com.carfey.suite.security.LdapAuthenticator.role.admin.dn=cn=SchedulerAdmin,ou=groups,o=MyOrgHere
# No need to alter this
com.carfey.suite.security.LdapAuthenticator.role.admin.roleName=Admin

Deployment

You are now ready to deploy your scheduler and admin web application.

Important: To run a scheduler with your custom code and jobs, you simply need to ensure the scheduler process classpath includes your jars. This applies to all the deployment options listed below.

Standalone Scheduler

To deploy and run the standalone scheduler, invoke the main starter method:

java com.carfey.ops.job.SchedulerStarter start <listenerPort>

Listener port is a port number used by Espresso to subsequently issue a shut down:

java com.carfey.ops.job.SchedulerStarter stop <listenerPort>

Startup and Shutdown example:

java com.carfey.ops.job.SchedulerStarter start 10451
java com.carfey.ops.job.SchedulerStarter stop 10451

Embedded Scheduler

To deploy and run the embedded scheduler, use the class scheduler starter to initialize and shut down the scheduler processes:

// will start scheduler on first 
com.carfey.ops.job.SchedulerStarter starter = com.carfey.ops.job.SchedulerStarter.get(com.carfey.ops.job.SchedulerStarter.SchedulerMode.JVM);
// gracefully shut down scheduler 
starter.shutDown();

To deploy and run the combined scheduler and admin web application, simply deploy the war to your servlet container (Jetty or Tomcat). You may also need to package your custom jars in with the war so the scheduler can run your custom jobs. Likewise, to deploy the standalone admin web application, simply deploy the standalone admin war to your servlet container.

You’re Good to Go! You are now fully set up and ready to go! If you are an admin user, you can log into the admin web application and customize your installation settings using the “Systems” tab. This has advanced options that allow you to customize scheduler and administration settings.