Merge pull request #3 from Metaswitch/sync_with_wiki

Sync with wiki

docs/IBCF.md

@@ -41,7 +41,7 @@ Refer to the [ENUM guide](ENUM) for more about how to configure ENUM.
 
 ## BGCF Configuration
 
-BGCF (Border Gateway Control Function) configuration is stored in the bgcf.json file in `/etc/clearwater` on each sprout node.  The file stores mappings from SIP trunk IP addresses and/or host names to IBCF host names, and these mappings control which IBCF nodes are used to route to a particular destination. Multiple nodes can be specified.  In this case, Route headers are added to the message such that it is sent to the first node and the first node sends it to the second node and so on; the message is not tried at the second node if it fails at the first node.
+BGCF (Border Gateway Control Function) configuration is stored in the `bgcf.json` file in `/etc/clearwater` on each sprout node (both I- and S-CSCF).  The file stores mappings from SIP trunk IP addresses and/or host names to IBCF host names, and these mappings control which IBCF nodes are used to route to a particular destination. Multiple nodes can be specified.  In this case, Route headers are added to the message such that it is sent to the first node and the first node sends it to the second node and so on; the message is not tried at the second node if it fails at the first node.
 
 The file is in JSON format, for example.
 

docs/Upgrading_a_Clearwater_deployment.md

@@ -0,0 +1,66 @@
+# Upgrading a Clearwater Deployment
+
+This article explains how to upgrade a Project Clearwater deployment.
+
+## Quick Upgrade
+
+The quickest way to upgrade is to simply upgrade all your nodes in any order.
+There is no need to wait for one node to finish upgrading before moving onto the
+next.
+
+This is recommended if you:
+
+* Do not have a fault-tolerant deployment (e.g. the All-in-One image, or a
+  deployment with one node of each type) OR
+* Do not need to provide uninterrupted service to users of your system.
+
+
+Note that during a quick upgrade your users may be unable to register, or make
+and receive calls.  If you do have a fault-tolerant deployment and need
+uninterrupted service, see "Seamless Upgrade" below.
+
+### Manual Install
+
+If you installed your system using the [Manual Install Instructions](Manual_Install), simply run `sudo clearwater-upgrade` on each node.
+
+### Chef Install
+
+If you installed your deployment with [chef](Creating_a_deployment_with_Chef):
+
+* Follow the instructions to [update the Chef server](https://github.com/Metaswitch/chef#updating-the-chef-server)
+* Run `sudo chef-client` on each node.
+
+## Seamless Upgrade
+
+If your deployment contains at least two nodes of each type (excluding Ellis) it
+is possible to perform a *seamless upgrade* that does not result in any loss of
+service.
+
+To achieve this the nodes must be upgraded one at a time and in a specific
+order: first all Ralf nodes (if present), then Homestead, Homer, Sprout, Memento
+(if present), Gemini (if present), Bono, and finally Ellis.
+
+For example if your deployment has two Homesteads, two Homers, two Sprouts, two
+Bonos, and one Ellis, you should upgrade them in the following order:
+
+* Homestead-1
+* Homestead-2
+* Homer-1
+* Homer-2
+* Sprout-1
+* Sprout-2
+* Bono-1
+* Bono-2
+* Ellis
+
+### Manual Install
+
+If you installed your system using the [Manual Install Instructions](Manual_Install)
+run `sudo clearwater-upgrade` on each node in the order described above.
+
+### Chef Install
+
+If you installed your deployment with [chef](Creating_a_deployment_with_Chef):
+
+* Follow the instructions to [update the Chef server](https://github.com/Metaswitch/chef#updating-the-chef-server)
+* Run `sudo chef-client` on each node in the order described above.

docs/index.md

@@ -4,7 +4,7 @@ Project Clearwater is an open-source IMS core, developed by [Metaswitch Networks
 
 ## Latest Release
 
-The latest stable release of Clearwater is "[Virtua Fighter](http://en.wikipedia.org/wiki/Virtua_Fighter_(series))".
+The latest stable release of Clearwater is "[X-Wing vs. TIE Fighter](http://en.wikipedia.org/wiki/Star_Wars:_X-Wing_vs._TIE_Fighter)".
 
 ## Architecture
 

mkdocs.yml

@@ -20,11 +20,14 @@ pages:
 - ['Installing_a_Chef_server.md', 'Installation', 'Installing a Chef server']
 - ['Creating_a_deployment_environment.md', 'Installation', 'Creating a deployment environment']
 - ['Creating_a_deployment_with_Chef.md', 'Installation', 'Creating a deployment with Chef']
-- ['Modifying_Clearwater_settings.md', 'Installation', 'Modifying Clearwater settings']
-- ['Clearwater_Configuration_Options_Reference.md', 'Installation', 'Clearwater Configuration Options Reference']
 - ['Configuring_the_native_Android_SIP_client.md', 'Installation', 'Configuring the native Android SIP client']
 - ['Configuring_Zoiper_Android_iOS_Client.md', 'Installation', 'Configuring Zoiper Android/iOS Client']
 
+# Upgrading and Modifying
+- ['Upgrading_a_Clearwater_deployment.md', 'Upgrading and Modifying', 'Upgrading a Clearwater deployment']
+- ['Modifying_Clearwater_settings.md', 'Upgrading and Modifying', 'Modifying Clearwater settings']
+- ['Clearwater_Configuration_Options_Reference.md', 'Upgrading and Modifying', 'Clearwater Configuration Options Reference']
+
 # Integration:
 - ['Configuring_an_Application_Server.md', 'Integration', 'Configuring an Application Server']
 - ['External_HSS_Integration.md', 'Integration', 'External HSS Integration']