Updates to architecture doc

This commit is contained in:
DanB
2020-01-14 15:15:19 +01:00
parent a38adbac55
commit 029591290a
3 changed files with 19 additions and 33 deletions

View File

@@ -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.
::

View File

@@ -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

View File

@@ -1,3 +1,5 @@
.. _configuration:
4. Configuration
=============