Modifying Clearwater Settings¶
This page discusses how to change settings on a Clearwater system. Most settings can be changed on an existing deployment (e.g. security keys and details of external servers), but some are so integral to the system (e.g. the SIP home domain) that the best way to change it is to recreate the Clearwater deployment entirely.
Modifying Sprout JSON Configuration¶
This configuration can be freely modified without impacting service.
Some of the more complex sprout-specific configuration is stored in JSON files
/etc/clearwater/s-cscf.json
- contains information to allow the Sprout I-CSCF to select an appropriate S-CSCF to handle some requests./etc/clearwater/bgcf.json
- contains routing rules for the Sprout BGCF./etc/clearwater/enum.json
- contains ENUM rules when using file-based ENUM instead of an external ENUM server.
To change one of these files, if you are using Clearwater’s automatic configuration sharing functionality:
- Edit the file on one of your sprout nodes.
- Run one of
sudo /usr/share/clearwater/clearwater-config-manager/scripts/upload_{scscf|bgcf|enum}_json
depending on which file you modified. - The change will be automatically propagated around the deployment and will start being used.
If you are not using automatic clustering do the following on each node:
- Make the necessary changes to the file.
- Run
sudo service sprout reload
to make sprout pick up the changes.
Starting from scratch¶
This will have a service impact of up to half an hour.
If other settings (such as the Clearwater home domain) are being changed, we recommend that users delete their old deployment and create a new one from scratch, either with Chef or manually. This ensures that the new settings are consistently applied.