Actions

Add custom application to Toolpack OAM: Difference between revisions

 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Toolpack OAM is able to automatically launch/monitor/relaunch applications (this includes Toolpack's own applications, and also custom applications).
{{DISPLAYTITLE:Add Custom Application to Toolpack OAM}}


In order to be managed by Toolpack OAM, an application needs to:
= Add an OAM-friendly application to Toolpack OAM =
Toolpack OAM can automatically launch/monitor/relaunch applications (this includes Toolpack's own applications, and custom applications).
 
To be managed by Toolpack OAM, an application needs to:
* Create instances of classes [[CTBCAFServiceAlmMgmt]] (and optionally [[CTBCAFServiceCmMgmtClient]])
* Create instances of classes [[CTBCAFServiceAlmMgmt]] (and optionally [[CTBCAFServiceCmMgmtClient]])
* Be added to the list of managed applications in the Web Portal
* Be added to the list of managed applications in the Web Portal


The list of applications that are launched and managed by Toolpack OAM is found in the Toolpack Web Portal, under the following section:
* Applications
== Steps to add new applications ==
#Create a new Application Configuration
*Go to Applications menu
*Click "Create New Application"
*Fill in the appropriate information
** Name of this application
** Application type (should be "User-specific")
** "Supports Toolpack ALM" should be checked only if the application implements [[CTBCAFServiceAlmMgmt]]
** Path of the binary file to launch (some variables can be used here for convenience)
** Working directory
** Command-line arguments
* Click "Create"
2. Select on which hosts the application will run
*Go to Applications menu
*Click on the application to edit
*On the bottom of the page, use the controls (<<) to move to the left box any host that the application must be run on
*Go to "System" menu, and "Apply" the configuration


The list of applications that are launched and managed by Toolpack OAM is found in the Toolpack Web Portal, under sections:
= Add a non-OAM-friendly application =
* Applications -> Configurations
Toolpack can also manage the launch of any 3rd-party applications that do not support ALM (does not implement class [[CTBCAFServiceAlmMgmt]]).
* Applications -> Instances


Steps to add an new applications are:
To do this, it is necessary that the option "'''Supports Toolpack ALM'''" is '''unchecked''' in the application configuration page in the web portal.
* Create a new Application Configuration
** Go to Applications -> Configurations
** Click "Create New Application Config"
** Fill appropriate information
*** Name of this application's configuration
*** Path of the binary file to launch (some variables can be used here for convenience)
*** Working directory
*** Command-line arguments
* Create a new Application Instance
** Go to Applications -> Instances
** Click "Create New Application Instance"
** Fill appropriate information
*** Name for this application instance
*** Host the application should be running on
*** Configuration just created above
*** Target state (run, don't run)
* Apply the modified configuration

Latest revision as of 10:07, 13 June 2022


Add an OAM-friendly application to Toolpack OAM

Toolpack OAM can automatically launch/monitor/relaunch applications (this includes Toolpack's own applications, and custom applications).

To be managed by Toolpack OAM, an application needs to:

The list of applications that are launched and managed by Toolpack OAM is found in the Toolpack Web Portal, under the following section:

  • Applications

Steps to add new applications

  1. Create a new Application Configuration
  • Go to Applications menu
  • Click "Create New Application"
  • Fill in the appropriate information
    • Name of this application
    • Application type (should be "User-specific")
    • "Supports Toolpack ALM" should be checked only if the application implements CTBCAFServiceAlmMgmt
    • Path of the binary file to launch (some variables can be used here for convenience)
    • Working directory
    • Command-line arguments
  • Click "Create"

2. Select on which hosts the application will run

  • Go to Applications menu
  • Click on the application to edit
  • On the bottom of the page, use the controls (<<) to move to the left box any host that the application must be run on
  • Go to "System" menu, and "Apply" the configuration

Add a non-OAM-friendly application

Toolpack can also manage the launch of any 3rd-party applications that do not support ALM (does not implement class CTBCAFServiceAlmMgmt).

To do this, it is necessary that the option "Supports Toolpack ALM" is unchecked in the application configuration page in the web portal.