docs(changelog/update) 0.5.0 script instructions

Former-commit-id: 546c1e8286bbe4d5f37dd84ccccd57b8a13adf62
chrisamoore · Aug 21, 2015 · 377204c · 377204c
1 parent 8b7cef1
commit 377204c
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,12 +1,15 @@
 ## [Unreleased][unreleased]
 
-#### Added
+This release contains breaking changes.
 
-- The Basic Authentication plugin now supports credentials in the `Proxy-Authorization` header. [#460](https://github.com/Mashape/kong/issues/460)
+### Breaking changes
 
-#### Changed
+- The database schema has been updated to be future proof and handle the separation of plugins outside of the core repository. Please follow the instructions in [UPDATE.md](/UPDATE.md#update-to-kong-050).
 
-#### Fixed
+#### Added
+
+- Plugins migrations. Each plugin can now have its own migration scripts if it needs to store data in your cluster. This is a step forward to improve Kong's pluggable architecture. [#443](https://github.com/Mashape/kong/pull/443)
+- The Basic Authentication plugin now supports credentials in the `Proxy-Authorization` header. [#460](https://github.com/Mashape/kong/issues/460)
 
 ## [0.4.2] - 2015/08/10
 

diff --git a/UPDATE.md b/UPDATE.md
@@ -1,5 +1,30 @@
 This document describes eventual additional steps that might be required to update between two versions of Kong. If nothing is described here for a particular version and platform, then assume the update will go smoothly.
 
+## Update to Kong `0.5.0`
+
+It is important that you be running Kong `0.4.2` when executing those steps.
+
+The database schema slightly changed to introduce "plugins migrations". Now, each plugin can have its own migration if it needs to store data in your cluster. This is not a regular migration since the schema of the table handling the migrations itself changed. This Python script will take care of migrating your database schema should you execute the following instructions:
+
+```shell
+# First, make sure you are already running Kong 0.4.2
+
+# Download the new version of Kong.
+
+# The script will use your first contact point (the first of the 'hosts' property)
+# so make sure it is valid and has the format 'host:port'.
+
+# Execute the migration script:
+$ python migration.py -c /path/to/kong/config
+
+# If everything went well the script should print a success message.
+
+# Then, reload Kong to avoid downtime:
+$ kong reload
+```
+
+Your cluster should successfully be migrated to Kong `0.5.0`.
+
 ## Update to Kong `0.4.2`
 
 The configuration format for specifying the port of your Cassandra instance changed. Replace: