GeRes2 Documentation

Here you’ll find all the different topics and details you should be aware of when using GeRes2. The documentation is work-in-progress and will improve over time as we get feedback from developers using GeRes2. Also we are still actively working on some parts of the documentation.

The following index provides a complete view on the topics that are part of this documentation Wiki or will soon become a part of the Wiki. It helps to understand, how-to setup GeRes2 in your own environments, how-to deploy jobs as well as developing against the GeRes2 Web API for various use cases.

Documentation Topics

Topic Group

Topic

Needed for
local debugging?

Needed for
Cloud Deployment?

General Setup

Configuring Service Bus for GeRes2

yes

yes

 

Configuring Storage for GeRes2

optional

yes

 

Configuring Azure Active Directory for GeRes2

yes

yes

Deployment

Setup GeRes2 in your development environment

yes

no

 

Deploy GeRes2 to your Microsoft Azure Subscription

no

yes

 

Deploying Jobs for a GeRes2-instance in Blob-storage

yes

yes

Server-side Development

Developing .NET-based Jobs to be executed in GeRes2

yes

yes

 

Development of AutoScaler Policies for GeRes2

no

yes

Client-side Development

Using the GeRes2 Client SDK

optional

optional

 

Submitting Jobs to GeRes2

yes

yes

 

Subscribe to SignalR-based notifications

optional

optional

 

Creating, Closing and Cancelling Batches

optional

optional

 

Cancelation of Jobs

optional

optional

 

Get Jobs and their status through the Monitoring API

optional

optional

 

Assembly DLL libraries and Sample Job Deployment Directories

After a full re-build of the solution you’ll find a folder named “deploy” in your GeRes2-root folder (where you downloaded or cloned the source code to on your local machine). In this folder you find all the libraries you need to reference in your own implementations, for both, client-side and server-side development.

In addition find deployment directories for the sample jobs shipping with GeRes2. You can deploy those for trying either the comprehensive end-2-end scenario sample or the simple GeresJobRequestorSampleConsole application to test your GeRes2 deployment. For details on how-to deploy those jobs look at the Wiki-Page “Deploying Jobs for a GeRes2-instance in Blob-Storage” as listed in the table above.

image

Samples shipping with GeRes2

For all the topics listed in the table above, we do ship samples as part of the GeRes2 solution, already. If you are eager to understand and see, how things do work, feel free to dig into the samples we ship with the solution. Below you find a table showing which sample projects do show which functions from GeRes2:

Sample Project Functionality covered
.\Samples\GeresJobSamples.csproj * Standard job implementation (FinancialYearEnd.cs)
* Progress job Implementation (UpdateWaitingPostings.cs)
.\Samples\GeresJobRequestorSampleConsole.csproj * Using the GeRes2 .NET Client SDK
* Submitting jobs using the Client SDK
* Creating batches and submitting jobs to batches
* Getting jobs and their status using the monitoring API
* Getting a list of batches using the monitoring API
.\Samples\GeresAutoscalerPolicySamples.csproj * Implementing different types of AutoScaler Policies
* Deploying AutoScaler policies (via post-build scripts)
.\Samples\End2End\*.csproj * End-2-End sample
* WPF-based job submission client with notifications
* Complex job implementation using external executables
* External executable shipping as part of Job Implementation
.\Geres.ClientSdk.Core.csproj * Demonstrates usage of the job-submission Web API
* Shows usage of the monitoring Web API

Note: although this is not a sample but rather an integral part of GeRes2, you can use it to learn, how to use the Web APIs and SignalR Hubs natively.

Last edited May 2, 2014 at 3:20 PM by mszcool, version 2