Documentation

Documentation.Migration-3-0-0-to-3-1-0 History

Hide minor edits - Show changes to markup

June 17, 2021, at 09:41 AM by liviu -
Changed line 85 from:
  • the "W" flag of do_routing() has been removed in favour of specifying it via the database (specifically, the dr_rules.sort_alg column). If you were using weight-based routing before, you need to update all of your dr_rules to use the "W" algorithm instead of "N" (default).
to:
  • the "W" flag of do_routing() has been removed in favour of specifying it via the database (specifically, the dr_rules.sort_alg column). If you were using weight-based routing before, you need to update all of your dr_rules to use the "W" sorting algorithm instead of "N" ("None", the current default).
June 17, 2021, at 09:37 AM by razvancrainea -
Added lines 121-124:

RLS module

  • the server_address module parameter has been dropped - its functionality was replaced by the new contact_user parameter.
June 17, 2021, at 09:35 AM by razvancrainea -
Added line 100:
  • the server_address module parameter has been dropped - its functionality was replaced by the new contact_user parameter.
June 16, 2021, at 07:16 PM by liviu -
Added line 85:
  • the "W" flag of do_routing() has been removed in favour of specifying it via the database (specifically, the dr_rules.sort_alg column). If you were using weight-based routing before, you need to update all of your dr_rules to use the "W" algorithm instead of "N" (default).
December 10, 2020, at 08:37 PM by liviu -
Changed line 80 from:
  • the carrier flags have shifted as seen below. This will break the code of any provisioning UIs which were using these flags (e.g. OpenSIPS Control Panel).
to:
  • the carrier flags have shifted as seen below. This breaks the code of any provisioning UIs written for OpenSIPS 3.0 which are using the old flags (e.g. OpenSIPS Control Panel 8.3.0).
December 10, 2020, at 08:36 PM by liviu -
Changed line 80 from:
  • the carrier flags have shifted as follows:
to:
  • the carrier flags have shifted as seen below. This will break the code of any provisioning UIs which were using these flags (e.g. OpenSIPS Control Panel).
December 10, 2020, at 08:34 PM by liviu -
Changed lines 80-84 from:
  • the carrier flags have shifted as follows: WEIGHT_ROUTING (removed, replaced by the new sort_alg column), USE_FIRST_GW (2 -> 1), DISABLED (4 -> 2), DIRTY (8 -> 4).
to:
  • the carrier flags have shifted as follows:
    • WEIGHT_ROUTING (removed, replaced by the new sort_alg column)
    • USE_FIRST_GW (2 -> 1)
    • DISABLED (4 -> 2)
    • DIRTY (8 -> 4)
December 10, 2020, at 08:34 PM by liviu -
Added lines 77-81:

DROUTING module

  • the carrier flags have shifted as follows: WEIGHT_ROUTING (removed, replaced by the new sort_alg column), USE_FIRST_GW (2 -> 1), DISABLED (4 -> 2), DIRTY (8 -> 4).
July 28, 2020, at 08:40 PM by rvlad_patrascu -
Changed lines 59-61 from:
  • isbflagset()'s, resetbflagset()'s and setbflagset()'s flag parameter is now a quoted string.
  • the order of isbflagset()'s, resetbflagset()'s and setbflagset()'s flag and branch_idx parameters has been inverted.
to:
  • isbflagset()'s, resetbflagset()'s and setbflagset()'s flag parameter is now a quoted string
  • the order of isbflagset()'s, resetbflagset()'s and setbflagset()'s flag and branch_idx parameters has been inverted
  • raise_event()'s third parameter should now be always provided if you want the raised event to include attributes (eg. raise_event("E_MY_EVENT", $avp(attr-val)) calls should be replaced with raise_event("E_MY_EVENT", , $avp(attr-val)) calls)
  • the migration requirements caused by the the changes in the core functions parameter interface have been described above; nevertheless you can also check the 2-4 to 3-0 module functions migration guidelines described here as the changes are similar.
June 02, 2020, at 06:28 PM by rvlad_patrascu -
Added line 60:
  • the order of isbflagset()'s, resetbflagset()'s and setbflagset()'s flag and branch_idx parameters has been inverted.
June 02, 2020, at 06:07 PM by rvlad_patrascu -
Added lines 58-59:
  • isflagset()'s, resetflag()'s and setflag()'s parameter is now a quoted string
  • isbflagset()'s, resetbflagset()'s and setbflagset()'s flag parameter is now a quoted string.
June 02, 2020, at 03:39 PM by liviu -
Changed lines 108-111 from:
  • the default tls_method has been changed from SSLv23 to TLSv1_2. Therefore if you were not setting the tls_method parameter in your script, you will now have to explicitly set it: modparam("tls_mgm", "tls_method", "[default]SSLv23")
to:
  • the default tls_method has been changed from SSLv23 to TLSv1_2. Therefore if you were not setting the tls_method parameter in your script, you will now have to explicitly set it: modparam("tls_mgm", "tls_method", "[default]SSLv23")

TM module

  • fr_timer and fr_inv_timer are now completely removed (not just deprecated). Use fr_timeout and fr_inv_timeout instead!
May 28, 2020, at 01:50 AM by rvlad_patrascu -
Deleted lines 46-49:

Core keywords

  • example
Deleted lines 57-64:

Core MI commands

  • example

Statistics migration

  • example
May 28, 2020, at 01:38 AM by rvlad_patrascu -
Added lines 72-74:

AUTH module

  • the "qop" parameter of the www_challenge() and proxy_challenge() functions is now optional and accepts the values: auth, auth-int or both (separated by ',').
May 27, 2020, at 02:47 AM by rvlad_patrascu -
May 27, 2020, at 02:16 AM by rvlad_patrascu -
May 27, 2020, at 02:03 AM by rvlad_patrascu -
Added lines 73-75:

B2B_ENTITIES module

  • dropped the replication_mode module parameter.
Added lines 91-93:

PRESENCE module

  • switch to string values instead of integers for the cluster_federation_mode module parameter (disabled instead of 0 and on-demand-sharing instead of 1)
May 27, 2020, at 12:35 AM by rvlad_patrascu -
Added lines 78-87:

EVENT_DATAGRAM module

  • The event payload is now formated as a JSON-RPC notification instead of the custom OpenSIPS line oriented formatting, so you have to change the parsing of the event in your external applications.

EVENT_JSONRPC module

  • the event_jsonrpc module has been renamed to event_stream. you have to replace your modparam("event_jsonrpc"... lines with modparam("event_stream"... lines
  • the transport protocol token from the event socket has been changed from jsonrpc to tcp (for example, you have to use tcp:127.0.0.1:8080/block_ip instead of jsonrpc:127.0.0.1:8080/block_ip).

EVENT_RABBITMQ module

  • The event payload is now formated as a JSON-RPC notification instead of the custom OpenSIPS line oriented formatting, so you have to change the parsing of the event in your external applications.
May 26, 2020, at 07:40 PM by liviu -
Added lines 23-25:

See the opensips-cli documentation for more details.

Deleted lines 28-29:

See the opensips-cli documentation for more details.

May 26, 2020, at 07:39 PM by liviu -
Changed line 15 from:

You can migrate your 3.0.x MySQL DB to the 3.1.x format by using the opensipsdbctl tool :

to:

You can migrate your 3.0.x MySQL DB to the 3.1.x format using the opensips-cli tool :

Changed line 17 from:
   # opensipsdbctl migrate opensips_3_0 opensips_3_1
to:
   # opensips-cli -x database migrate 3.0_to_3.1 opensips_3_0 opensips_3_1
Deleted line 22:
Changed lines 27-30 from:

NOTE that the migration tool is available only for MYSQL databases!

NOTE that the default MySQL DB engine is now InnoDB!

to:

See the opensips-cli documentation for more details.

May 26, 2020, at 02:00 PM by razvancrainea -
Changed line 79 from:
  • the dlg_list MI command no longer outputs the DB id as the ID of the dialog, but a hex(entry).hex(id) representation of its id. The DB id field has been moved in the 'db_id node.
to:
  • the dlg_list MI command no longer outputs the DB id as the ID of the dialog, but a hex(entry).hex(id) representation of its id. The DB id field has been moved in the db_id node.
May 26, 2020, at 01:59 PM by razvancrainea -
Added lines 75-80:

DIALOG module

  • the $DLG_did format has been changed from printing the entry:id of the dialog to hex(entry).hex(id), just as the Record-Route parameter is added
  • the dlg_list MI command no longer outputs the DB id as the ID of the dialog, but a hex(entry).hex(id) representation of its id. The DB id field has been moved in the 'db_id node.
  • the dlg_end_dlg MI command no longer receives the DB id as an identifier for finding the dialog to terminate, but the same hex(entry).hex(id) printed by the $DLG_did variable and by the dlg_list command.
April 23, 2020, at 02:14 PM by 109.98.32.84 -
Added line 43:
April 23, 2020, at 01:24 PM by 109.98.32.84 -
Added lines 40-43:
April 23, 2020, at 12:22 PM by 109.98.32.84 -
Added line 39:
  • the tcp_listen_backlog parameter was renamed as tcp_socket_backlog parameter, with the same definition and behavior.
April 23, 2020, at 11:59 AM by 109.98.32.84 -
Changed lines 37-38 from:

The following is the full list of backwards-incompatible syntax or functional changes in the OpenSIPS configuration script (some of them are fixes):

to:

The following is the full list of backwards-incompatible syntax or functional changes in the OpenSIPS configuration script:

  • the listen parameter was renamed as socket parameter, with the same definition and behavior.
January 16, 2020, at 05:54 PM by razvancrainea -
Changed lines 89-91 from:

PROTO_WSS module

  • the default tls_method has been changed from SSLv23 to TLSv1_2. Therefore if you were not setting the tls_method parameter in your script, you will now have to explicitly set it to the SSLv23 value in your script.
to:

TLS_MGM module

  • the default tls_method has been changed from SSLv23 to TLSv1_2. Therefore if you were not setting the tls_method parameter in your script, you will now have to explicitly set it: modparam("tls_mgm", "tls_method", "[default]SSLv23")
January 16, 2020, at 05:52 PM by razvancrainea -
Changed line 81 from:
  • the tls_handshake_timeout and tls_send_timeout from the tls_mgm module have been removed, thus they can no longer be used to tune the proto_wss module. Instead of those parameters, we've added the ] and ], that are now part of the proto_wss module. To migrate your script, you should replace any of your lines as it follows:
to:
  • the tls_handshake_timeout and tls_send_timeout from the tls_mgm module have been removed, thus they can no longer be used to tune the proto_wss module. Instead of those parameters, we've added the and , that are now part of the proto_wss module. To migrate your script, you should replace any of your lines as it follows:
Changed lines 87-91 from:

@]

to:

@]

PROTO_WSS module

  • the default tls_method has been changed from SSLv23 to TLSv1_2. Therefore if you were not setting the tls_method parameter in your script, you will now have to explicitly set it to the SSLv23 value in your script.
January 10, 2020, at 11:38 AM by razvancrainea -
Changed lines 73-74 from:
    modparam("proto_tls", "tls_handshake_timeout", 200) # OLD was modparam("tls_mgm", "tls_handshake_timeout", 200)
    modparam("proto_tls", "tls_send_timeout", 200) # OLD was modparam("tls_mgm", "tls_send_timeout", 200)
to:
    # Before 3.1 was modparam("tls_mgm", "tls_handshake_timeout", 200)
    modparam("proto_tls", "tls_handshake_timeout", 200)
    # Before 3.1 was modparam("tls_mgm", "tls_send_timeout", 200)
    modparam("proto_tls", "tls_send_timeout", 200)
Changed lines 83-84 from:
    modparam("proto_wss", "wss_tls_handshake_timeout", 200) # OLD was modparam("tls_mgm", "tls_handshake_timeout", 200)
    modparam("proto_wss", "wss_send_timeout", 200) # OLD was modparam("tls_mgm", "tls_send_timeout", 200)
to:
    # Before 3.1 was modparam("tls_mgm", "tls_handshake_timeout", 200)
    modparam("proto_wss", "wss_tls_handshake_timeout", 200)
    # Before 3.1 was modparam("tls_mgm", "tls_send_timeout", 200)
    modparam("proto_wss", "wss_send_timeout", 200)
January 10, 2020, at 11:37 AM by razvancrainea -
Changed lines 69-83 from:
  • example
to:

PROTO_TLS module

  • the tls_handshake_timeout and tls_send_timeout parameters have been moved from the tls_mgm module to the proto_tls module. Check out the new documentation ]. To migrate your script, you should replace any of your lines as it follows:
    modparam("proto_tls", "tls_handshake_timeout", 200) # OLD was modparam("tls_mgm", "tls_handshake_timeout", 200)
    modparam("proto_tls", "tls_send_timeout", 200) # OLD was modparam("tls_mgm", "tls_send_timeout", 200)

PROTO_WSS module

  • the tls_handshake_timeout and tls_send_timeout from the tls_mgm module have been removed, thus they can no longer be used to tune the proto_wss module. Instead of those parameters, we've added the ] and ], that are now part of the proto_wss module. To migrate your script, you should replace any of your lines as it follows:
    modparam("proto_wss", "wss_tls_handshake_timeout", 200) # OLD was modparam("tls_mgm", "tls_handshake_timeout", 200)
    modparam("proto_wss", "wss_send_timeout", 200) # OLD was modparam("tls_mgm", "tls_send_timeout", 200)
November 14, 2019, at 03:11 PM by 109.99.227.30 -
Changed line 41 from:
  • example
to:
  • the auto_aliases is now by default off, so if you had no setting of it in the old script you should set it explicitly to "on" to keep the same behavior.
August 20, 2019, at 07:56 PM by rvlad_patrascu -
Added lines 56-57:
  • cache_raw_query()'s last parameter is now an unquoted variable
  • construct_uri()'s user, port and extra are now optional parameters
August 20, 2019, at 07:46 PM by rvlad_patrascu -
Changed line 1 from:
Documentation -> Migration -> Migration from 3.1.x to 3.1.0
to:
Documentation -> Migration -> Migration from 3.0.x to 3.1.0
Changed lines 6-7 from:

This section is meant to provide useful help in migrating your OpenSIPS installations from the 3.1.0 version to 3.1.0.

to:

This section is meant to provide useful help in migrating your OpenSIPS installations from the 3.0.0 version to 3.1.0.

Changed line 15 from:

You can migrate your 3.1.x MySQL DB to the 3.1.x format by using the opensipsdbctl tool :

to:

You can migrate your 3.0.x MySQL DB to the 3.1.x format by using the opensipsdbctl tool :

Changed line 20 from:
  • opensips_3_0 is the existing DB name corresponding to version 3.1.x format
to:
  • opensips_3_0 is the existing DB name corresponding to version 3.0.x format
Added lines 46-55:

Core functions

  • The following alias names were dropped:
    • rewritehost() for sethost()
    • rewritehostport() for sethostport()
    • rewriteuser() for setuser()
    • rewriteuserpass() for setuserpass()
    • rewriteport() for setport()
    • rewriteuri() for seturi()
April 16, 2019, at 09:55 PM by razvancrainea -
Added lines 1-57:
Documentation -> Migration -> Migration from 3.1.x to 3.1.0

This page has been visited 5390 times. (:toc-float Table of Contents:)


This section is meant to provide useful help in migrating your OpenSIPS installations from the 3.1.0 version to 3.1.0.

You can find the all the new additions in the 3.1.0 release compiled under this page. The ChangeLog may help your understanding of the migration / update process.

Make sure you don't have any Makefile.conf files in your sources' root before starting the migration. The configuration file generated by 'menuconfig is not compatible with the one in older version!


DB migration

You can migrate your 3.1.x MySQL DB to the 3.1.x format by using the opensipsdbctl tool :

   # opensipsdbctl migrate opensips_3_0 opensips_3_1

where :

  • opensips_3_0 is the existing DB name corresponding to version 3.1.x format
  • opensips_3_1 is the DB name to be created for 3.1.x format

NOTE:

  • the old database will not be deleted, altered or changed - it will not be touched at all
  • new database will be created and data from old DB will be imported into it

NOTE that the migration tool is available only for MYSQL databases!

NOTE that the default MySQL DB engine is now InnoDB!

(:toc-back Back to Table of Contents:)


Script migration

The following is the full list of backwards-incompatible syntax or functional changes in the OpenSIPS configuration script (some of them are fixes):

Global Parameters

  • example

Core keywords

  • example

Core MI commands

  • example

Statistics migration

  • example

Module migration

  • example

Page last modified on June 17, 2021, at 09:41 AM