From e949d4c8dca3379b381171b384738ecf61792ce9 Mon Sep 17 00:00:00 2001 From: DanB Date: Thu, 16 Jan 2020 19:39:46 +0100 Subject: [PATCH] Doc skels for all agents --- docs/architecture.rst | 6 +++--- docs/astagent.rst | 0 docs/cgr-engine.rst | 43 ++++++++++++++++++++++++++++++++---------- docs/configuration.rst | 5 +++-- docs/diamagent.rst | 5 +++++ docs/dnsagent.rst | 0 docs/ers.rst | 0 docs/fsagent.rst | 0 docs/httpagent.rst | 0 docs/kamagent.rst | 0 docs/radagent.rst | 0 11 files changed, 44 insertions(+), 15 deletions(-) create mode 100644 docs/astagent.rst create mode 100644 docs/diamagent.rst create mode 100644 docs/dnsagent.rst create mode 100644 docs/ers.rst create mode 100644 docs/fsagent.rst create mode 100644 docs/httpagent.rst create mode 100644 docs/kamagent.rst create mode 100644 docs/radagent.rst diff --git a/docs/architecture.rst b/docs/architecture.rst index 89a601813..4cfafd3a0 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -1,7 +1,7 @@ - -2. Architecture -=============== +************ +Architecture +************ The CGRateS framework consists of functionality packed within **five** software applications, described below. diff --git a/docs/astagent.rst b/docs/astagent.rst new file mode 100644 index 000000000..e69de29bb diff --git a/docs/cgr-engine.rst b/docs/cgr-engine.rst index 4543ca63c..01436caf5 100644 --- a/docs/cgr-engine.rst +++ b/docs/cgr-engine.rst @@ -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 ` 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 ` files. +Used mostly in modern mobile networks (xG). \ No newline at end of file diff --git a/docs/dnsagent.rst b/docs/dnsagent.rst new file mode 100644 index 000000000..e69de29bb diff --git a/docs/ers.rst b/docs/ers.rst new file mode 100644 index 000000000..e69de29bb diff --git a/docs/fsagent.rst b/docs/fsagent.rst new file mode 100644 index 000000000..e69de29bb diff --git a/docs/httpagent.rst b/docs/httpagent.rst new file mode 100644 index 000000000..e69de29bb diff --git a/docs/kamagent.rst b/docs/kamagent.rst new file mode 100644 index 000000000..e69de29bb diff --git a/docs/radagent.rst b/docs/radagent.rst new file mode 100644 index 000000000..e69de29bb