Doc skels for all agents

This commit is contained in:
DanB
2020-01-16 19:39:46 +01:00
parent 9650cafcba
commit e949d4c8dc
11 changed files with 44 additions and 15 deletions

View File

@@ -1,7 +1,7 @@
2. Architecture
===============
************
Architecture
************
The CGRateS framework consists of functionality packed within **five** software applications, described below.

0
docs/astagent.rst Normal file
View File

View File

@@ -1,19 +1,12 @@
.. _cgr-engine:
cgr-engine
----------
.. figure:: images/CGRateSInternalArchitecture.png
:alt: CGRateS Internal Architecture
:align: Center
:scale: 75 %
Internal Architecture of **cgr-engine**
==========
Groups various services and components.
Customisable through the use of *json* :ref:`configuration <engine_configuration>` or command line arguments (higher prio).
Able to read the configuration from either a local directory of *.json* files with an unlimited number of subfolders (ordered alphabetically) or a list of http paths (separated by ";").
::
@@ -49,4 +42,34 @@ Customisable through the use of *json* :ref:`configuration <engine_configuration
.. hint:: $ cgr-engine -config_path=/etc/cgrates
.. hint:: $ cgr-engine -config_path=https://raw.githubusercontent.com/cgrates/cgrates/master/data/conf/cgrates/cgrates.json
.. figure:: images/CGRateSInternalArchitecture.png
:alt: CGRateS Internal Architecture
:align: Center
:scale: 75 %
Internal Architecture of **cgr-engine**
Agents
------
**Agents** are interfaces towards external systems, implementing protocols enforced by the communication channels opened.
These can be standard or privately defined.
All of the **Agents** implemented within CGRateS are flexible to be configured with generic parameters configurable for both *request* and *replies*.
Following *Agents* are implemented within CGRateS:
.. toctree::
:maxdepth: 2
diamagent
radagent
httpagent
dnsagent
astagent
fsagent
kamagent
ers

View File

@@ -1,7 +1,8 @@
.. _configuration:
4. Configuration
=============
*************
Configuration
*************
The behaviour of **CGRateS** can be externally influenced by following means:

5
docs/diamagent.rst Normal file
View File

@@ -0,0 +1,5 @@
DiameterAgent
=============
Implements Diameter_ protocol interface in a standard agnostic manner, having the ability to implement them by defining simple *processor templates* within the :ref:`configuration <engine_configuration>` files.
Used mostly in modern mobile networks (xG).

0
docs/dnsagent.rst Normal file
View File

0
docs/ers.rst Normal file
View File

0
docs/fsagent.rst Normal file
View File

0
docs/httpagent.rst Normal file
View File

0
docs/kamagent.rst Normal file
View File

0
docs/radagent.rst Normal file
View File