diff --git a/docs/agents.rst b/docs/agents.rst new file mode 100644 index 000000000..05f44f48b --- /dev/null +++ b/docs/agents.rst @@ -0,0 +1,22 @@ + +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: 1 + + diamagent + radagent + httpagent + dnsagent + astagent + fsagent + kamagent + ers \ No newline at end of file diff --git a/docs/apiers.rst b/docs/apiers.rst new file mode 100644 index 000000000..16896d347 --- /dev/null +++ b/docs/apiers.rst @@ -0,0 +1,5 @@ +APIerS +====== + + +TBD \ No newline at end of file diff --git a/docs/attributes.rst b/docs/attributes.rst new file mode 100644 index 000000000..d4fc0f017 --- /dev/null +++ b/docs/attributes.rst @@ -0,0 +1,5 @@ +AttributeS +========== + + +TBD \ No newline at end of file diff --git a/docs/caches.rst b/docs/caches.rst new file mode 100644 index 000000000..218202694 --- /dev/null +++ b/docs/caches.rst @@ -0,0 +1,5 @@ +CacheS +====== + + +TBD \ No newline at end of file diff --git a/docs/cdre.rst b/docs/cdre.rst new file mode 100644 index 000000000..70e1bf9f7 --- /dev/null +++ b/docs/cdre.rst @@ -0,0 +1,5 @@ +CDRe +==== + + +TBD \ No newline at end of file diff --git a/docs/cdrs.rst b/docs/cdrs.rst new file mode 100644 index 000000000..be310f0b1 --- /dev/null +++ b/docs/cdrs.rst @@ -0,0 +1,5 @@ +CDRs +==== + + +TBD \ No newline at end of file diff --git a/docs/cgr-engine.rst b/docs/cgr-engine.rst index 9ef987f59..55487fa3d 100644 --- a/docs/cgr-engine.rst +++ b/docs/cgr-engine.rst @@ -52,25 +52,29 @@ Able to read the configuration from either a local directory of *.json* files w 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: +The components from the diagram can be found documented in the links bellow: .. toctree:: :maxdepth: 1 - diamagent - radagent - httpagent - dnsagent - astagent - fsagent - kamagent - ers + agents + sessions + rals + cdrs + attributes + chargers + resources + suppliers + stats + thresholds + filters + dispatchers + schedulers + cdre + apiers + loaders + datadb + stordb + caches + diff --git a/docs/chargers.rst b/docs/chargers.rst new file mode 100644 index 000000000..dbdea1e78 --- /dev/null +++ b/docs/chargers.rst @@ -0,0 +1,5 @@ +ChargerS +======== + + +TBD \ No newline at end of file diff --git a/docs/datadb.rst b/docs/datadb.rst new file mode 100644 index 000000000..f7f8c6001 --- /dev/null +++ b/docs/datadb.rst @@ -0,0 +1,5 @@ +DataDB +====== + + +TBD \ No newline at end of file diff --git a/docs/dispatchers.rst b/docs/dispatchers.rst new file mode 100644 index 000000000..08afcf15a --- /dev/null +++ b/docs/dispatchers.rst @@ -0,0 +1,5 @@ +DispatcherS +=========== + + +TBD \ No newline at end of file diff --git a/docs/loaders.rst b/docs/loaders.rst new file mode 100644 index 000000000..c64f8d3b0 --- /dev/null +++ b/docs/loaders.rst @@ -0,0 +1,5 @@ +LoaderS +======= + + +TBD \ No newline at end of file diff --git a/docs/rals.rst b/docs/rals.rst new file mode 100644 index 000000000..8fa08134a --- /dev/null +++ b/docs/rals.rst @@ -0,0 +1,5 @@ +RALs +==== + + +TBD \ No newline at end of file diff --git a/docs/resources.rst b/docs/resources.rst new file mode 100644 index 000000000..50c9b5efe --- /dev/null +++ b/docs/resources.rst @@ -0,0 +1,5 @@ +ResourceS +========= + + +TBD \ No newline at end of file diff --git a/docs/schedulers.rst b/docs/schedulers.rst new file mode 100644 index 000000000..a77e381d9 --- /dev/null +++ b/docs/schedulers.rst @@ -0,0 +1,5 @@ +SchedulerS +========== + + +TBD \ No newline at end of file diff --git a/docs/sessions.rst b/docs/sessions.rst new file mode 100644 index 000000000..4fdab0a32 --- /dev/null +++ b/docs/sessions.rst @@ -0,0 +1,5 @@ +SessionS +======== + + +TBD \ No newline at end of file diff --git a/docs/stats.rst b/docs/stats.rst new file mode 100644 index 000000000..ae7d311f9 --- /dev/null +++ b/docs/stats.rst @@ -0,0 +1,5 @@ +StatS +===== + + +TBD \ No newline at end of file diff --git a/docs/stordb.rst b/docs/stordb.rst new file mode 100644 index 000000000..cf5423b15 --- /dev/null +++ b/docs/stordb.rst @@ -0,0 +1,5 @@ +StorDB +====== + + +TBD \ No newline at end of file diff --git a/docs/suppliers.rst b/docs/suppliers.rst new file mode 100644 index 000000000..3bb36ccf4 --- /dev/null +++ b/docs/suppliers.rst @@ -0,0 +1,5 @@ +SupplierS +========= + + +TBD \ No newline at end of file diff --git a/docs/thresholds.rst b/docs/thresholds.rst new file mode 100644 index 000000000..32f1c71ee --- /dev/null +++ b/docs/thresholds.rst @@ -0,0 +1,5 @@ +ThresholdS +========== + + +TBD \ No newline at end of file