Skip to content
This repository has been archived by the owner on Feb 27, 2020. It is now read-only.

Commit

Permalink
Merge pull request #265 from Metaswitch/fallback_rename
Browse files Browse the repository at this point in the history
[Reviewer: Krista] Rename default to fallback
  • Loading branch information
eleanor-merry committed Jun 12, 2017
2 parents c6cd943 + bf168a1 commit 3208bfc
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/Backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ To backup the shared configuration:
/etc/clearwater/enum.json
/etc/clearwater/s-cscf.json
/etc/clearwater/shared_ifcs.xml
/etc/clearwater/default_ifcs.xml
/etc/clearwater/fallback_ifcs.xml
```

### Restoring Configuration
Expand All @@ -264,6 +264,6 @@ To restore a previous backup, copy the six files listed above to `/etc/clearwate
cw-upload_enum_json
cw-upload_scscf_json
cw-upload_shared_ifcs_xml
cw-upload_default_ifcs_xml
cw-upload_fallback_ifcs_xml

See [Modifying Clearwater settings](Modifying_Clearwater_settings.md) for more details on this.
2 changes: 1 addition & 1 deletion docs/Clearwater_Configuration_Options_Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ This section describes optional configuration options, particularly for ensuring
* `disable_tcp_switch` - when set to 'Y', Clearwater disables UDP-to-TCP uplift on SIP messages. This is useful when creating a deployment where all SIP is sent over UDP. This option only affects Sprout nodes.
* `sprout_impi_store` - this is the location of Sprout's IMPI store. It has the same format as `sprout_registration_store`. If not provided, Sprout uses the same value configured in `sprout_registration_store`.
* `request_shared_ifcs` - when set to 'Y' Clearwater requests Shared iFC sets from the HSS. This option is enabled by default. Shared iFC sets can be configured on Clearwater in the `/etc/clearwater/shared_ifcs.xml` file.
* `apply_default_ifcs` - when set to 'Y' Clearwater will apply any default iFCs specified by the operator in the `/etc/clearwater/default_ifcs.xml` file to initial requests who have no applicable iFCs associated with them. This option is not enabled by default.
* `apply_fallback_ifcs` - when set to 'Y' Clearwater will apply any fallback iFCs specified by the operator in the `/etc/clearwater/fallback_ifcs.xml` file to initial requests who have no applicable iFCs associated with them. This option is not enabled by default.
* `reject_if_no_matching_ifcs` - when set to 'Y' Clearwater will reject any initial requests that don't have any matching iFCs that can be applied to them. This option is not enabled by default.
* `dummy_app_server` - this field allows the name of a dummy application server to be specified. If an iFC contains this dummy application server, then no application server will be invoked when this iFC is triggered.

Expand Down
2 changes: 1 addition & 1 deletion docs/Clearwater_SNMP_Statistics.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Sprout nodes provide the following statistics:
* The count, average, variance, and high and low watermarks for originating video session setup time at the S-CSCF, indexed by time period. For the purposes of these stats a call is considered to be a video call if video is specified in the SDP on the initial INVITE. The session setup time is measured as the time between receiving the originating INVITE and sending the first successful response (e.g. 180 RINGING or 200 OK).
* The number of Shared iFC set IDs retrieved from the HSS where the S-CSCF has no matching set of iFCs, indexed by time period.
* The number of initial requests that had no matching iFCs to apply, indexed by time period.
* The number of initial requests that attempted to use Default iFCs but had no matching ones, indexed by time period.
* The number of initial requests that attempted to use fallback iFCs but had no matching ones, indexed by time period.
* The number of requests rejected because an identity was barred.

### Vellum statistics
Expand Down
4 changes: 2 additions & 2 deletions docs/Handling_Multiple_Failed_Nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ Check the JSON configuration files on all Sprout nodes in the affected site:
Check the XML configuration files on all Sprout nodes in the affected site:

* Verify that the `/etc/clearwater/shared_ifcs.xml` file is correct, fixing it up if it's not.
* verify that the `/etc/clearwater/default_ifcs.xml` file is correct, fixing it up if it's not.
* Verify that the `/etc/clearwater/fallback_ifcs.xml` file is correct, fixing it up if it's not.

Running one of the commands `sudo cw-validate_{shared|default}_ifcs_xml` will check if the specified file is syntactically correct.
Running one of the commands `sudo cw-validate_{shared|fallback}_ifcs_xml` will check if the specified file is syntactically correct.

### Recreate the etcd cluster

Expand Down
20 changes: 10 additions & 10 deletions docs/Manual_Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,27 +349,27 @@ To validate the Shared iFC configuration file before uploading it, run the comma

To remove the Shared iFC configuration, run the command `sudo cw-remove_shared_ifcs_xml` on any Sprout node.

### Default iFC configuration
### Fallback iFC configuration

If you wish to apply iFCs by default to any subscribers who have no iFCs triggered on a request, these iFCs must be configured on the S-CSCF, and the configuration option `apply_default_ifcs` set to 'Y'.
If you wish to apply iFCs to any subscribers who have no iFCs triggered on a request (e.g. as a fallback to catch misconfigured subscribers), these iFCs must be configured on the S-CSCF, and the configuration option `apply_fallback_ifcs` set to 'Y'.

You can configure Default iFCs on the S-CSCF by editing the `/etc/clearwater/default_ifcs.xml` file.
You can configure fallback iFCs on the S-CSCF by editing the `/etc/clearwater/fallback_ifcs.xml` file.

This file stores a list of Default iFCs. The format of the file is as follows:
This file stores a list of fallback iFCs. The format of the file is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<DefaultIFCsSet>
<FallbackIFCsSet>
<InitialFilterCriteria>
<iFC>
</InitialFilterCriteria>
</DefaultIFCsSet>
</FallbackIFCsSet>

The `iFC` is an iFC, in XML format.

There must be exactly one `DefaultIFCsSet` element, which can can contain multiple `InitialFilterCriteria` elements (the minimum number of `InitialFilterCriteria` elements is zero).
There must be exactly one `FallbackIFCsSet` element, which can can contain multiple `InitialFilterCriteria` elements (the minimum number of `InitialFilterCriteria` elements is zero).

To change the Default iFC configuration, edit this file on any Sprout node, then upload it to the shared configuration database by running `sudo cw-upload_default_ifcs_xml`.
To change the fallback iFC configuration, edit this file on any Sprout node, then upload it to the shared configuration database by running `sudo cw-upload_fallback_ifcs_xml`.

To validate the Default iFC configuration file before uploading it, run the command `sudo cw-validate_default_ifcs_xml <file_location>` on the Sprout node the file is present on.
To validate the fallback iFC configuration file before uploading it, run the command `sudo cw-validate_fallback_ifcs_xml <file_location>` on the Sprout node the file is present on.

To remove the Default iFC configuration, run the command `sudo cw-remove_default_ifcs_xml` on any Sprout node.
To remove the fallback iFC configuration, run the command `sudo cw-remove_fallback_ifcs_xml` on any Sprout node.
4 changes: 2 additions & 2 deletions docs/Modifying_Clearwater_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ To change one of these files:
Some of the more complex sprout-specific configuration is stored in XML files.

* `/etc/clearwater/shared_ifcs.xml` - contains information about all Shared iFC sets for the Sprout S-CSCF to use.
* `/etc/clearwater/default_ifcs.xml` - contains information about all the Default iFCs for the Sprout S-CSCF to apply.
* `/etc/clearwater/fallback_ifcs.xml` - contains information about all the fallback iFCs for the Sprout S-CSCF to apply.

To change one of these files:

* Edit the file on *one* of your sprout nodes in each site.
* Run one of `sudo cw-upload_{shared|default}_ifcs_xml` depending on which file you modified.
* Run one of `sudo cw-upload_{shared|fallback}_ifcs_xml` depending on which file you modified.
* The change will be automatically propogated around the site (by Clearwater's [automatic configuration sharing](Automatic_Clustering_Config_Sharing.md) functionality) and will start being used.

## Modifying DNS Config
Expand Down

0 comments on commit 3208bfc

Please sign in to comment.