Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update migration guide #4258

Merged
merged 2 commits into from
Apr 10, 2024
Merged

Update migration guide #4258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d810b87
Describe migration from 6.2.0
chrzaszcz Apr 10, 2024
994d873
Fix typo in doc
chrzaszcz Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/configuration/internal-databases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Backend for CETS discovery.

### `internal_databases.cets.cluster_name`

Namespace for the cluster. Only nodes with the same cluster name would be discoverd. This option is for RDBMS backend.
Namespace for the cluster. Only nodes with the same cluster name would be discovered. This option is for RDBMS backend.

* **Syntax:** string.
* **Default:** `"mongooseim"`
Expand Down
30 changes: 24 additions & 6 deletions doc/migrations/6.2.0_x.x.x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,35 @@
## Database migration

There is a new column in the `mam_message` table in the database, which is used to support including or excluding groupchat results in a user archive. See the migrations for Postgres, MySQL and MSSQL in the [`priv/migrations`](https://github.com/esl/MongooseIM/tree/master/priv/migrations) directory. Please be aware that the filtering process will only be effective for new messages and will not apply to those messages that have already been stored in the database.
The migration scripts for PostgreSQL, MySQL and MS SQL are in the [`priv/migrations`](https://github.com/esl/MongooseIM/tree/master/priv/migrations) directory. They are required due to the following changes:

## Presences
### MAM message improvements

`mod_presences` was internally refactored to modernise and improve the performance of the code, but as a side-effect, code for [XEP-0018](https://xmpp.org/extensions/xep-0018.html) was removed. Note that this XEP was not advertised and as a matter of fact was deprecated already in 2003, so if your client was depending on it, it is high time to update.
There is a new column in the `mam_message` table, which is used to support including or excluding groupchat results in a user archive ([`mod_mam`](../modules/mod_mam.md)). Please be aware, that the filtering process will only be effective for new messages and will not apply to those messages that have already been stored in the database.

## Roster
### Roster

`mod_roster` was internally refactored to modernise and improve the performance of the code, but as a side-effect, some database migrations need to be carried. See the migrations for Postgres, MySQL and MSSQL in the [`priv/migrations`](https://github.com/esl/MongooseIM/tree/master/priv/migrations) directory.
[`mod_roster`](../modules/mod_roster.md) was internally refactored to modernise and improve the performance of the code, but as a side-effect, some database migrations need to be carried.

## Outgoing pools
### CETS node discovery

The `discovery_nodes` table used by the CETS [internal database](http://localhost:8000/MongooseDocs/latest/configuration/internal-databases/) has been updated - now each node name can appear only once, while in the past a node could be a part of multiple clusters. Manual intervention might be needed if there are nodes that belong to more than one cluster.

### Entity capabilities

[`mod_caps`](../modules/mod_caps.md) has a new RDBMS backend, making it possible to use it with CETS. As a result, a new table `caps` is added to the DB schema.

## Configuration changes: outgoing pools

The outgoing connections option `host` is now named `host_type`, see [outgoing pools](../configuration/outgoing-connections.md) for more information.

The option `single_host` for the scope has been deprecated, in favour of configuring the specified pools within the [`host_config`](../configuration/host_config.md) section.

## Functional changes: presences

[`mod_presence`](../modules/mod_presence.md) was internally refactored to modernise and improve the performance of the code, but as a side-effect, code for [XEP-0018](https://xmpp.org/extensions/xep-0018.html) was removed. Note that this XEP was not advertised and as a matter of fact was deprecated already in 2003, so if your client was depending on it, it is high time to update.

## Upgrade procedure

The standard migration procedure is to stop the cluster, apply the DB migrations, and start the new version of the cluster.

Should you require no downtime, you could apply the DB migration first, and then perform the rolling upgrade procedure - either manually or using `helm` or `kubectl`. If you are using CETS, the restarted nodes will stay disconnected from the ones still running the previous version, causing transient connectivity issues between the end users connected to different parts of the cluster. This is due to changes in the internal CETS API.