Skip to content

Latest commit

 

History

History
93 lines (72 loc) · 3.82 KB

proxy.md

File metadata and controls

93 lines (72 loc) · 3.82 KB

Proxy

Description

This module aims to give the possibility to Gorgone to become distributed.

It is not needed in a Centreon standalone configuration, but must be enabled if there is Poller or Remote servers.

The module includes mechanisms like ping to make sure nodes are alive, synchronisation to store logs in the Central Gorgone database, etc.

A SSH client library make routing to non-gorgoned nodes possible.

Configuration

Directive Description Default value
pool Number of childs to instantiate to process events 5
synchistory_time Time in seconds between two logs synchronisation 60
synchistory_timeout Time in seconds before logs synchronisation is considered timed out 30
ping Time in seconds between two node pings 60
pong_discard_timeout Time in seconds before a node is considered dead 300

Example

name: proxy
package: "gorgone::modules::core::proxy::hooks"
enable: false
pool: 5
synchistory_time: 60
synchistory_timeout: 30
ping: 60
pong_discard_timeout: 300

Events

Event Description
PROXYREADY Internal event to notify the core
REMOTECOPY Copy files or directories from the server running the daemon to another server
SETLOGS Internal event to insert logs into the database
PONG Internal event to handle node ping response
REGISTERNODES Internal event to register nodes
UNREGISTERNODES Internal event to unregister nodes
PROXYADDNODE Internal event to add nodes for proxying
PROXYDELNODE Internal event to delete nodes from proxying
PROXYADDSUBNODE Internal event to add nodes of nodes for proxying
PONGRESET Internal event to deal with no pong nodes

API

Copy files or directory to remote server

Endpoint Method
/api/core/proxy/remotecopy POST

Headers

Header Value
Accept application/json
Content-Type application/json

Body

Key Value
source Path of the source file or directory
destination Path of the destination file or directory
cache_dir Path to the cache directory for archiving purpose 
{
    "source": "<file or directory path>",
    "destination": "<file or directory path>",
    "cache_dir": "<cache directory path>"
}

Example

curl --request GET "https://hostname:8443/api/core/proxy/remotecopy" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data " {
    \"source\": \"/var/cache/centreon/config/engine/2/\",
    \"destination\": \"/etc/centreon-engine\",
    \"cache_dir\": \"/var/cache/centreon\"
}"