From dd7be1788a1f4effa5a4d8b062fc44977c92461d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivar=20Conradi=20=C3=98sthus?= Date: Fri, 17 Nov 2017 13:04:20 +0100 Subject: [PATCH 1/2] Update migration-guide.md Add details on how to upgrade unleash to version 3. closes #276 --- docs/migration-guide.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/migration-guide.md b/docs/migration-guide.md index c89761cf5c..63c0870389 100644 --- a/docs/migration-guide.md +++ b/docs/migration-guide.md @@ -1,6 +1,14 @@ # Migrations guide +Generally the intention is that `unleash-server` should always provide support for clients one lower major version. This should make it easier to upgrade `unleash` gradually. -## Upgrading from v1.0 to 2.0 + +## Upgrading from v2.x to v3.x +Upgrade `unleash-server` to v3, which still supports v2 clients. Then upgrade all your clients to v3. When you have upgraded all your clients you should consider to turn off legacy routes, used by v2 clients. Read more about this option in in the [gettings started guide](https://github.com/Unleash/unleash/blob/master/docs/getting-started.md#2-or-programmatically) + + + + +## Upgrading from v1.0 to v2.0 ### Caveat 1: Not used db-migrate to migrate the unleash database? In FINN we used, for internal reasons, liquebase to migrate our database. From 8002e118ad3f96658b63d382d7953907ce2088c8 Mon Sep 17 00:00:00 2001 From: ivaosthu Date: Fri, 17 Nov 2017 13:56:04 +0100 Subject: [PATCH 2/2] Added docs for v3 options --- docs/getting-started.md | 5 ++++- docs/migration-guide.md | 5 ++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 2d237c00ed..f31ae85ef2 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -37,7 +37,10 @@ Available unleash options includes: - **databaseUrl** - the postgress database url to connect to. Should include username/password. - **port** - Which port should the unleash-server bind to? -- **enableLegacyRoutes** (boolean) - allows you to turn on/off support for legacy routes to support older clients. +- **enableLegacyRoutes** (boolean) - allows you to turn on/off support for legacy routes to support older clients. Enabled by default. +- **serverMetrics** (boolean) - Use this option to turn of prometheus metrics. +- **preHook** (function) - This is a hook if you need to provide any middlewares to express before `unleash` adds any. Express app instance is injected as first arguement. +- **preRouterHook** (function) - Use this to register custom express middlewares before the `unleash` specific routers are added. This is typically how you would register custom middlewares to handle authentication. ## How do I configure the log output? diff --git a/docs/migration-guide.md b/docs/migration-guide.md index 63c0870389..5f3c8b4dc7 100644 --- a/docs/migration-guide.md +++ b/docs/migration-guide.md @@ -3,10 +3,9 @@ Generally the intention is that `unleash-server` should always provide support f ## Upgrading from v2.x to v3.x -Upgrade `unleash-server` to v3, which still supports v2 clients. Then upgrade all your clients to v3. When you have upgraded all your clients you should consider to turn off legacy routes, used by v2 clients. Read more about this option in in the [gettings started guide](https://github.com/Unleash/unleash/blob/master/docs/getting-started.md#2-or-programmatically) - - +First your should upgrade the `unleash-server` to v3 (which still supports v2 clients). After this is done you should upgrade all your clients to v3. +After upgrading all your clients you should consider turning off legacy routes, used by v2 clients. Read more about this option in in the [gettings started guide](https://github.com/Unleash/unleash/blob/master/docs/getting-started.md#2-or-programmatically) ## Upgrading from v1.0 to v2.0