From 029591290a8757bde17a82a76ed60e5c5cb91a9d Mon Sep 17 00:00:00 2001 From: DanB Date: Tue, 14 Jan 2020 15:15:19 +0100 Subject: [PATCH] Updates to architecture doc --- docs/architecture.rst | 43 ++++++++++++------------------------------ docs/cgrates_json.rst | 7 +++++-- docs/configuration.rst | 2 ++ 3 files changed, 19 insertions(+), 33 deletions(-) diff --git a/docs/architecture.rst b/docs/architecture.rst index 0ec7cab89..449e9fa39 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -1,37 +1,22 @@ 2. Architecture =============== -The CGRateS suite consists of **five** software applications described below. + +The CGRateS framework consists of functionality packed within **five** software applications, described below. .. hlist:: :columns: 5 - - cgr-engine - - cgr-loader - - cgr-console - - cgr-tester - - cgr-migrator + - `cgr-engine`_ + - `cgr-console`_ + - `cgr-loader`_ + - `cgr-migrator`_ + - `cgr-tester`_ -CGRateS has an internal cache. - -:: - - "internal_cache" - cache - -Operates with different external databases mentioned below. - -:: - - "data_db" - MongoDB, Redis - "stor_db" - MongoDB, MySQL, PostgreSQL - - -.. hlist:: - :columns: 1 - - - **data_db** - used to store runtime data ( eg: accounts ) - - **stor_db** - used to store offline tariff plan(s) and CDRs +.. _cgr-engine: +2.1. cgr-engine +--------------- .. figure:: images/CGRateSInternalArchitecture.png :alt: CGRateS Internal Architecture @@ -39,13 +24,9 @@ Operates with different external databases mentioned below. :scale: 75 % - Internal Architecture of **cgr-engine** + Internal Architecture of **cgr-engine**_. -2.1. cgr-engine ---------------- -Is the most important and complex component. -Customisable through the use of *json* configuration file(s), -it will start on demand **one or more** service(s), outlined below. +Main component, implements most of the CGRateS functionality in form of services customisable through the use of *json* engine_configuration_ or command line arguments. :: diff --git a/docs/cgrates_json.rst b/docs/cgrates_json.rst index 7ba333d79..cc864c84d 100644 --- a/docs/cgrates_json.rst +++ b/docs/cgrates_json.rst @@ -1,9 +1,12 @@ + +.. _engine_configuration: + 4.1. cgr-engine configuration file -============================= +================================== Organized into configuration sections. All configuration options come with defaults and we have tried our best to choose the best ones for a minimum of efforts necessary when running. -Below is the default configuration file which comes hardcoded into **cgr-engine**. +Below is the default configuration file which comes hardcoded into `**cgr-engine**`_. .. literalinclude:: ../data/conf/cgrates/cgrates.json :language: javascript diff --git a/docs/configuration.rst b/docs/configuration.rst index c99d17f7d..7f73d267c 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -1,3 +1,5 @@ +.. _configuration: + 4. Configuration =============