Merge pull request #288 from Metaswitch/add_emps_docs

Update docs to include rph.json config details

docs/Clearwater_Configuration_Options_Reference.md

@@ -254,7 +254,9 @@ This section describes settings that may vary between systems in the same deploy
 
 ## DNS Config
 
-This section describes the static DNS config which can be used to override DNS results. These options should be set in a local copy by running `cw-config download dns_json`, editing this downloaded copy and then running `cw-config upload dns_json` when finished. Currently, the only supported record type is CNAME and the only component which uses this is Chronos and the I-CSCF. The file has the format:
+This section describes the static DNS config which can be used to override DNS results.
+
+The configuration can be set or changed by downloading the current version of `dns.json` by running `cw-config download dns_json`, editing this downloaded copy, and then running `cw-config upload dns_json` when finished. Currently, the only supported record type is CNAME and the only component which uses this is Chronos and the I-CSCF. The file has the format:
 
     {
       "hostnames": [
@@ -269,6 +271,30 @@ This section describes the static DNS config which can be used to override DNS r
       ]
     }
 
+## RPH Config
+
+This section describes how to configure the priorities that should be given to different Resource Priority Header values.
+
+The configuration can be set or changed by downloading the current version of `rph.json` by running `cw-config download rph_json`, editing this downloaded copy, and then running `cw-config upload rph_json` when finished. Currently, only the Namespaces and Priority-Values mentioned in [RFC 4412](https://tools.ietf.org/html/rfc4412) are supported as Resource Priority Header values. This file has the format:
+
+    {
+      "priority_blocks": [
+        {
+          "priority": 1,
+          "rph_values": []
+        },
+
+        ...
+
+        {
+          "priority": 15,
+          "rph_values": []
+        }
+      ]
+    }
+
+It is worth noting that 15 is high priority, and 1 is low priority.
+
 ## Other configuration options
 
 There is further documentation for Chronos configuration [here](https://github.com/Metaswitch/chronos/blob/dev/doc/configuration.md) and Homer/Homestead-prov configuration [here](https://github.com/Metaswitch/crest/blob/master/docs/development.md#local-settings).

docs/Modifying_Clearwater_settings.md

@@ -24,12 +24,13 @@ 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.
+* `/etc/clearwater/rph.json` - contains which priority to give to different Resource Priority Header values.
 
 To change one of these files:
 
-*   Run `cw-config download {scscf|bgcf|enum}_json` on *one* node in each site. This will download the current version of `{scscf|bgcf|enum}_json` and will specify where it has been downloaded to.
+*   Run `cw-config download {scscf|bgcf|enum|rph}_json` on *one* node in each site. This will download the current version of `{scscf|bgcf|enum|rph}_json` and will specify where it has been downloaded to.
 *   Edit the downloaded file to make changes as desired.
-*   Run `cw-config upload {scscf|bgcf|enum}_json` to upload the new config to etcd. The changes to the shared configuration are logged to `/var/log/syslog` and to the console. Each node in the site picks up the changed shared configuration (using Clearwater's [automatic configuration sharing](Automatic_Clustering_Config_Sharing.md) functionality) and will start being used.
+*   Run `cw-config upload {scscf|bgcf|enum|rph}_json` to upload the new config to etcd. The changes to the shared configuration are logged to `/var/log/syslog` and to the console. Each node in the site picks up the changed shared configuration (using Clearwater's [automatic configuration sharing](Automatic_Clustering_Config_Sharing.md) functionality) and will start being used.
 
 ## Modifying Sprout XML Configuration