Node

Introduction

The Node module is responsible for deploying (starting) and un-deploying (stopping) a group of modules to form an application.

Module based applications use the Node module to bootstrap and the application configuration file (in JSON format) is passed as is (after include and expansion) to the Node module which processes the modules part of the file.

This module is never deployed by configuration.

Configuration

Properties

Name	Description	Default	Mandatory
modules	List of modules to deploy. If empty or non-existing no modules will be deployed.	[]
heartbeat	HTTP heartbeat configuration.	{ "enabled": false }

Example

{
  "modules": [
    {
      "name": "<module-name-01>",
      "enabled": true
      "config": {
      }
    },
    {
      "name": "<module-name-02>",
      "enabled": false
      "config": {
      }
    }    
  ],
  "heartbeat": {
    "enabled": false
  } 
}

Module

A module object represent a module to deploy. All modules defines their own configuration, documented separately.

Properties

Name	Description	Default	Mandatory
name	Module class name or alias
enabled	Flag controlling if module should be deployed or not	true
config	JSON object containing the module configuration.	{}

Example

{
  "name": "<module-name-or-alias>",
  "enabled": true
  "config": {
  }
}

Heartbeat

The Node module supports HTTP heartbeat.

The heartbeat responder supports all HTTP module configuration properties and is started when all configured moduled has been successfully started (i.e. when the application is started and ready to receive requests).

By default the heartbeat responder uses the following URL:

http://<host-or-ip>:8080/heartbeat

Properties

Name	Description	Default	Mandatory
enabled	Flag to enable heartbeat	false
context_path	HTTP context path. Together with http property http_context (default: "/heartbeat") this property forms the full context.	/*

Example

{
  "enabled": true,
  "context_path": "/hb",
  "http_context": "/node01",
  "http_port": 8888
}