From d1941d6a9ba89c5e581e207f4be770c8e11545f0 Mon Sep 17 00:00:00 2001 From: OpenSIPS Date: Sun, 17 Jul 2022 00:16:11 +0300 Subject: [PATCH] Rebuild documentation --- modules/b2b_entities/README | 8 +- modules/b2b_entities/doc/contributors.xml | 20 +-- modules/clusterer/README | 145 ++++++++++++---------- modules/clusterer/doc/contributors.xml | 8 +- modules/tls_wolfssl/README | 2 +- modules/tls_wolfssl/doc/contributors.xml | 8 +- 6 files changed, 103 insertions(+), 88 deletions(-) diff --git a/modules/b2b_entities/README b/modules/b2b_entities/README index 7ad0b248c8b..521e55063d8 100644 --- a/modules/b2b_entities/README +++ b/modules/b2b_entities/README @@ -449,7 +449,7 @@ Chapter 3. Contributors 2. Vlad Patrascu (@rvlad-patrascu) 79 47 2304 744 3. Bogdan-Andrei Iancu (@bogdan-iancu) 52 45 423 151 4. Ovidiu Sas (@ovidiusas) 51 39 853 291 - 5. Razvan Crainea (@razvancrainea) 43 38 220 130 + 5. Razvan Crainea (@razvancrainea) 44 39 225 132 6. Liviu Chircu (@liviuchircu) 17 13 87 126 7. Vlad Paiu (@vladpaiu) 6 4 74 47 8. Nick Altmann (@nikbyte) 5 2 158 27 @@ -481,9 +481,9 @@ Chapter 3. Contributors Table 3.2. Most recently active contributors^(1) to this module Name Commit Activity - 1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Jun 2022 - 2. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Apr 2022 - 3. Razvan Crainea (@razvancrainea) Dec 2010 - Mar 2022 + 1. Razvan Crainea (@razvancrainea) Dec 2010 - Jul 2022 + 2. Vlad Patrascu (@rvlad-patrascu) May 2017 - Jun 2022 + 3. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Apr 2022 4. Nick Altmann (@nikbyte) Jan 2013 - May 2021 5. Maksym Sobolyev (@sobomax) Jan 2021 - Mar 2021 6. Liviu Chircu (@liviuchircu) Mar 2014 - Nov 2020 diff --git a/modules/b2b_entities/doc/contributors.xml b/modules/b2b_entities/doc/contributors.xml index f325d97c764..13da4c0c856 100644 --- a/modules/b2b_entities/doc/contributors.xml +++ b/modules/b2b_entities/doc/contributors.xml @@ -53,10 +53,10 @@ 5. Razvan Crainea (@razvancrainea) - 43 - 38 - 220 - 130 + 44 + 39 + 225 + 132 6. @@ -128,18 +128,18 @@ 1. - Vlad Patrascu (@rvlad-patrascu) - May 2017 - Jun 2022 + Razvan Crainea (@razvancrainea) + Dec 2010 - Jul 2022 2. - Bogdan-Andrei Iancu (@bogdan-iancu) - Aug 2009 - Apr 2022 + Vlad Patrascu (@rvlad-patrascu) + May 2017 - Jun 2022 3. - Razvan Crainea (@razvancrainea) - Dec 2010 - Mar 2022 + Bogdan-Andrei Iancu (@bogdan-iancu) + Aug 2009 - Apr 2022 4. diff --git a/modules/clusterer/README b/modules/clusterer/README index 3da34246ebe..224478dd006 100644 --- a/modules/clusterer/README +++ b/modules/clusterer/README @@ -25,17 +25,18 @@ CLUSTERER Module 1.4.9. ping_timeout 1.4.10. node_timeout 1.4.11. seed_fallback_interval - 1.4.12. sync_packet_max_size - 1.4.13. id_col - 1.4.14. cluster_id_col - 1.4.15. node_id_col - 1.4.16. url_col - 1.4.17. state_col - 1.4.18. no_ping_retries_col - 1.4.19. priority_col - 1.4.20. sip_addr_col - 1.4.21. flags_col - 1.4.22. description_col + 1.4.12. sync_timeout + 1.4.13. sync_packet_max_size + 1.4.14. id_col + 1.4.15. cluster_id_col + 1.4.16. node_id_col + 1.4.17. url_col + 1.4.18. state_col + 1.4.19. no_ping_retries_col + 1.4.20. priority_col + 1.4.21. sip_addr_col + 1.4.22. flags_col + 1.4.23. description_col 1.5. Exported Functions @@ -120,27 +121,28 @@ CLUSTERER Module 1.9. Set ping_timeout parameter 1.10. Set node_timeout parameter 1.11. Set seed_fallback_interval parameter - 1.12. Set sync_packet_max_size parameter - 1.13. Set id_col parameter - 1.14. Set cluster_id_col parameter - 1.15. Set node_id_col parameter - 1.16. Set url_col parameter - 1.17. Set state_col parameter - 1.18. Set no_ping_retries_col parameter - 1.19. Set priority_col parameter - 1.20. Set sip_addr_col parameter - 1.21. Set flags_col parameter - 1.22. Set description_col parameter - 1.23. cluster_send_req() usage - 1.24. cluster_send_rpl() usage - 1.25. cluster_broadcast_req() usage - 1.26. cluster_check_addr() usage - 1.27. clusterer_list usage - 1.28. clusterer_list_topology usage - 1.29. clusterer_list_cap usage - 1.30. Example database content - clusterer table - 1.31. Node A configuration - 1.32. Node B configuration + 1.12. Set sync_timeout parameter + 1.13. Set sync_packet_max_size parameter + 1.14. Set id_col parameter + 1.15. Set cluster_id_col parameter + 1.16. Set node_id_col parameter + 1.17. Set url_col parameter + 1.18. Set state_col parameter + 1.19. Set no_ping_retries_col parameter + 1.20. Set priority_col parameter + 1.21. Set sip_addr_col parameter + 1.22. Set flags_col parameter + 1.23. Set description_col parameter + 1.24. cluster_send_req() usage + 1.25. cluster_send_rpl() usage + 1.26. cluster_broadcast_req() usage + 1.27. cluster_check_addr() usage + 1.28. clusterer_list usage + 1.29. clusterer_list_topology usage + 1.30. clusterer_list_cap usage + 1.31. Example database content - clusterer table + 1.32. Node A configuration + 1.33. Node B configuration Chapter 1. Admin Guide @@ -405,7 +407,20 @@ modparam("clusterer", "node_timeout", 10) modparam("clusterer", "seed_fallback_interval", 10) ... -1.4.12. sync_packet_max_size +1.4.12. sync_timeout + + The inteval, in seconds, since the last sync data packet + received after which to consider the sync process as failed and + revert the node to the not synced state. + + Default value is “15”. + + Example 1.12. Set sync_timeout parameter +... +modparam("clusterer", "sync_timeout", 5) +... + +1.4.13. sync_packet_max_size The maximum size of the BIN packets sent while doing data synchronization. This is only a suggested value as the actual @@ -413,70 +428,70 @@ modparam("clusterer", "seed_fallback_interval", 10) Default value is “65535”. - Example 1.12. Set sync_packet_max_size parameter + Example 1.13. Set sync_packet_max_size parameter ... modparam("clusterer", "sync_packet_max_size", 32765) ... -1.4.13. id_col +1.4.14. id_col The name of the column storing an id for the table rows. Default value is “id”. - Example 1.13. Set id_col parameter + Example 1.14. Set id_col parameter ... modparam("clusterer", "id_col", "id") ... -1.4.14. cluster_id_col +1.4.15. cluster_id_col The name of the column to store the id of a cluster. Default value is “cluster_id”. - Example 1.14. Set cluster_id_col parameter + Example 1.15. Set cluster_id_col parameter ... modparam("clusterer", "cluster_id_col", "cluster_id") ... -1.4.15. node_id_col +1.4.16. node_id_col The name of the column to store the id of an instance. The values must be greater than 0. Default value is “node_id”. - Example 1.15. Set node_id_col parameter + Example 1.16. Set node_id_col parameter ... modparam("clusterer", "node_id_col", "node_id") ... -1.4.16. url_col +1.4.17. url_col The name of the column containing the instance url. The values must be greater than 0. Default value is “url”. - Example 1.16. Set url_col parameter + Example 1.17. Set url_col parameter ... modparam("clusterer", "url_col", "url") ... -1.4.17. state_col +1.4.18. state_col The name of the column storing the state of the node(enabled/disabled). Default value is “state”. - Example 1.17. Set state_col parameter + Example 1.18. Set state_col parameter ... modparam("clusterer", "state_col", "state") ... -1.4.18. no_ping_retries_col +1.4.19. no_ping_retries_col The name of the column containing the maximum number of ping retries before the link with the neighbour node is considered @@ -484,12 +499,12 @@ modparam("clusterer", "state_col", "state") Default value is “no_ping_retries”. - Example 1.18. Set no_ping_retries_col parameter + Example 1.19. Set no_ping_retries_col parameter ... modparam("clusterer", "no_ping_retries_col", "no_ping_retries") ... -1.4.19. priority_col +1.4.20. priority_col The name of the column storing the node priority to be chosen as next hop in case of same length(number of hops) paths when @@ -497,40 +512,40 @@ modparam("clusterer", "no_ping_retries_col", "no_ping_retries") Default value is “priority”. - Example 1.19. Set priority_col parameter + Example 1.20. Set priority_col parameter ... modparam("clusterer", "priority_col", "priority") ... -1.4.20. sip_addr_col +1.4.21. sip_addr_col The name of the column containing a SIP address for the node. Default value is “sip_addr”. - Example 1.20. Set sip_addr_col parameter + Example 1.21. Set sip_addr_col parameter ... modparam("clusterer", "sip_addr_col", "sip_addr") ... -1.4.21. flags_col +1.4.22. flags_col The name of the column containing the node flags. Default value is “flags”. - Example 1.21. Set flags_col parameter + Example 1.22. Set flags_col parameter ... modparam("clusterer", "flags_col", "flags") ... -1.4.22. description_col +1.4.23. description_col The name of the column containing a node description. Default value is “description”. - Example 1.22. Set description_col parameter + Example 1.23. Set description_col parameter ... modparam("clusterer", "description_col", "description") ... @@ -567,7 +582,7 @@ modparam("clusterer", "description_col", "description") This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE. - Example 1.23. cluster_send_req() usage + Example 1.24. cluster_send_req() usage ... # send a request cluster_send_req(1, 1, "Check USER: $fU", $var(req_tag)); @@ -611,7 +626,7 @@ route[rpl_resume] { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE. - Example 1.24. cluster_send_rpl() usage + Example 1.25. cluster_send_rpl() usage ... event_route[E_CLUSTERER_REQ_RECEIVED] { cluster_send_rpl($param(cluster_id), $param(src_id), $var(my_reply), $ @@ -639,7 +654,7 @@ param(tag)); This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE. - Example 1.25. cluster_broadcast_req() usage + Example 1.26. cluster_broadcast_req() usage ... cluster_broadcast_req($var(cl_id), $var(share_data)); ... @@ -661,7 +676,7 @@ cluster_broadcast_req($var(cl_id), $var(share_data)); This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE. - Example 1.26. cluster_check_addr() usage + Example 1.27. cluster_check_addr() usage ... if (cluster_check_addr(1, $si)) { ... @@ -692,7 +707,7 @@ if (cluster_check_addr(1, $si)) { Parameters:none - Example 1.27. clusterer_list usage + Example 1.28. clusterer_list usage $ opensips-cli -x mi clusterer_list { "Clusters": [ @@ -726,7 +741,7 @@ $ opensips-cli -x mi clusterer_list Parameters:none - Example 1.28. clusterer_list_topology usage + Example 1.29. clusterer_list_topology usage $ opensips-cli -x mi clusterer_list_topology { "Clusters": [ @@ -843,7 +858,7 @@ opensips-cli -x mi cluster_broadcast_mi 1 dr_reload partition_5 Parameters:none - Example 1.29. clusterer_list_cap usage + Example 1.30. clusterer_list_cap usage $ opensips-cli -x mi clusterer_list_cap { "Clusters": [ @@ -999,7 +1014,7 @@ f-repl 1 We insert in the the clusterer table the following: - Example 1.30. Example database content - clusterer table + Example 1.31. Example database content - clusterer table +----+------------+---------+----------------------+-------+------------ -----+----------+----------+-------+-------------+ | id | cluster_id | node_id | url | state | no_ping_ret @@ -1042,7 +1057,7 @@ ries | priority | sip_addr | flags | description | configure the two instances of OpenSIPS. First, we configure Node A: - Example 1.31. Node A configuration + Example 1.32. Node A configuration ... socket= bin:192.168.0.5:5566 # bin listener for Node A @@ -1058,7 +1073,7 @@ modparam("ratelimit", "pipe_replication_cluster", 1) Similarly, the configuration for Node B is as follows: - Example 1.32. Node B configuration + Example 1.33. Node B configuration ... socket= bin:192.168.0.6:5566 # bin listener for Node B @@ -1239,7 +1254,7 @@ Chapter 3. Contributors Table 3.1. Top contributors by DevScore^(1), authored commits^(2) and lines added/removed^(3) Name DevScore Commits Lines ++ Lines -- - 1. Vlad Patrascu (@rvlad-patrascu) 330 113 12756 6907 + 1. Vlad Patrascu (@rvlad-patrascu) 336 117 12872 6981 2. Liviu Chircu (@liviuchircu) 53 39 630 443 3. Eseanu Marius Cristian (@eseanucristian) 45 10 3142 534 4. Razvan Crainea (@razvancrainea) 24 18 321 145 diff --git a/modules/clusterer/doc/contributors.xml b/modules/clusterer/doc/contributors.xml index 260faaecc71..dfbbb2b1034 100644 --- a/modules/clusterer/doc/contributors.xml +++ b/modules/clusterer/doc/contributors.xml @@ -21,10 +21,10 @@ 1. Vlad Patrascu (@rvlad-patrascu) - 330 - 113 - 12756 - 6907 + 336 + 117 + 12872 + 6981 2. diff --git a/modules/tls_wolfssl/README b/modules/tls_wolfssl/README index 48ae0ac363a..4efd7ff3072 100644 --- a/modules/tls_wolfssl/README +++ b/modules/tls_wolfssl/README @@ -92,7 +92,7 @@ Chapter 3. Contributors Table 3.1. Top contributors by DevScore^(1), authored commits^(2) and lines added/removed^(3) Name DevScore Commits Lines ++ Lines -- - 1. Vlad Patrascu (@rvlad-patrascu) 23 16 496 93 + 1. Vlad Patrascu (@rvlad-patrascu) 24 17 497 94 (1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted diff --git a/modules/tls_wolfssl/doc/contributors.xml b/modules/tls_wolfssl/doc/contributors.xml index 093a1fbfc3b..06c7747160c 100644 --- a/modules/tls_wolfssl/doc/contributors.xml +++ b/modules/tls_wolfssl/doc/contributors.xml @@ -21,10 +21,10 @@ 1. Vlad Patrascu (@rvlad-patrascu) - 23 - 16 - 496 - 93 + 24 + 17 + 497 + 94