1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
unleash.unleash/docs/migration-guide.md

34 lines
2.0 KiB
Markdown
Raw Normal View History

---
id: migration_guide
title: Migration Guide
---
2019-03-05 09:26:34 +01:00
Generally, the intention is that `unleash-server` should always provide support for clients one major version lower than the current one. This should make it possible to upgrade `unleash` gradually.
## Upgrading from v2.x to v3.x
2019-03-05 09:26:34 +01:00
The notable change introduced in Unleash v3.x is a strict separation of API paths for client requests and admin requests. This makes it easier to implement different authentication mechanisms for the admin UI and all unleash-clients. You can read more about [securing unleash](https://github.com/Unleash/unleash/blob/master/docs/securing-unleash.md).
2018-11-22 11:20:28 +01:00
2019-03-05 09:26:34 +01:00
The recommended approach is to first upgrade the `unleash-server` to v3 (which still supports v2 clients). After this is done, you should upgrade all your clients to v3.
2018-01-18 08:47:42 +01:00
2019-03-05 09:26:34 +01:00
After upgrading all your clients, you should consider turning off legacy routes, used by v2 clients. Read more about this option in the [Getting started guide](https://github.com/Unleash/unleash/blob/master/docs/getting-started.md#2-or-programmatically).
## Upgrading from v1.0 to v2.0
2016-12-23 10:35:02 +01:00
2016-12-28 14:00:51 +01:00
### Caveat 1: Not used db-migrate to migrate the unleash database?
2018-11-22 11:20:28 +01:00
2019-03-05 09:26:34 +01:00
In FINN we used liquibase, for internal reasons, to migrate our database.
Because unleash from version 2.0 migrates the database internally, with db-migrate, you need to make sure that all previous migrations for version 1 exist, so that Unleash does not try to create already existing tables.
2016-12-23 10:35:02 +01:00
#### How to check?
2018-11-22 11:20:28 +01:00
If you don't have a "migrations" table with _7 unique migrations_ you are affected by this.
2016-12-23 10:35:02 +01:00
#### How to fix?
2018-11-22 11:20:28 +01:00
2016-12-23 10:35:02 +01:00
Before starting unleash version 2 you have to run the SQL located under `scripts/fix-migrations-version-1.sql`
2016-12-28 13:56:41 +01:00
### Caveat 2: databaseUrl (not database*Uri*)
2018-11-22 11:20:28 +01:00
2019-03-05 09:26:34 +01:00
Using Unleash as a library and injecting your own config? Then you should know that we changed the `databaseUri` config param name to **databaseUrl**. This is to make sure the param is aligned with the environment variable `DATABASE_URL` and avoid multiple names for the same config param.