HPA installation and deployment HPA portal Portal configuration Configuration file - environment.yml

Calypso environments

General structure

This file describes your monitored Calypso environments

An example of environment.yml is stored in {{hpa_base_dir}}/environment.yml.template

Multiple environments can be described in this file, each environment have a key and a name.

hpa.environments:
   example-key-envTesting2:
      name: description
      ....
      ....
   other_example-key_env-1:
      name: other description
      ....
      ....

The environment key can not have a space but description can (see example below)

The key must be unique and be present in environement.yml

Agent naming

This file is a giant selector for the HPA Agent. Agents are named with :

  • server host, identified as agentHost, by default let it at '%' for “all servers”
  • agent name, identified as agentName
  • globalAgentProcess set the agent process for all components, choose one different per environment

The agentHost is the hostname of the Calypso environment. You can let it unset, i.e '%' otherwise take care to select all hosts included in the Calypso environment. Check into the Webview Investigator and expand the SuperDomain tree.

Be careful ! HPA selector is %

The agent name depends of the components, the idea is to select with an expression all the agents for a given scope of client. Environments have a name and a list of selector :

  • dataservers
  • engines
  • navigators
  • scheduleTasks

By default the wizard propose a name that match the agent selection, it’s easier to follow the suggested pattern.

Keep HpaRisk prefix for risk components, see the reason above in Zoom on risk components

File example

hpa.environments:
   staging-v17:
      name: Staging
      navigatorAgentDescriptor:
         agentName: Navigator
         agentProfile: IntroscopeAgent_navigator.profile
         agentVersion: latest
         webstartUrl: http://<private Calypso url/ip>:8100/webstart/
      dataservers:
         agentName: DataServer
      dataservers-ro:
         agentName: DataServerRO
      eventserver:
         agentName: HpaGeneric-EventServer
      engines:
         agentName: '%Engine%'
      navigators:
         agentName: 'Navigator%'
      scheduledTasks:
         agentName: 'Schedule%'
      schedulerServer:
         agentName: 'SchedulerServer%'
      database:
         agentName: HpaInfrastructure
      riskComponents:
         agentName: 'HpaRisk%'
      calculators:
         agentName: 'HpaRisk-Calculator%'
      riskServers:
         agentName: 'HpaRiskServer%'
      generic:
         agentName: '%HpaGeneric%'

Zoom on risk components

Portal use the selectors to group and search information on risk components at the same time, so to make it work properly, it muse follow the pattern :

  • calculators are identified by the pattern of calculators section
  • riskServers are identified by the pattern of riskServers section

The last pattern includes all the risk components : dispatchers, calculators, risk servers. To make it work easily the pattern for this includes the calculators and riskserver patterns :

HpaRisk% is for all components and includes :

  • calculators because HpaRisk-Calculator% is more precise
  • and HpaRiskServer% for the same rease they both start with HpaRisk.
      riskComponents:
         agentName: 'HpaRisk%'
      calculators:
         agentName: 'HpaRisk-Calculator%'
      riskServers:
         agentName: 'HpaRiskServer%'