Skip to content

Commit

Permalink
move migration steps to a release_notes file
Browse files Browse the repository at this point in the history
Signed-off-by: Aleksandar Stanchev <aleksandar.stanchev@bosch.com>
  • Loading branch information
alstanchev committed Sep 11, 2023
1 parent 73277b5 commit a270162
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 31 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,6 @@ This page shows the basics for operating Ditto.
Ditto has many config parameters which can be set in the config files or via environment variables.
This section will cover some of Ditto's config parameters.

### Migrating to Ditto 3.4.x

From v3.4.0 Ditto removes all dependencies for [Akka](https://akka.io) since the switch to [BSL License](https://www.lightbend.com/akka/license-faq) after Akka v2.6.x
and switches over to [Apache Pekko](https://pekko.apache.org/docs/pekko/current/index.html) which is a fork of Akka from the latest Apache 2.0 version.

To migrate a running system with live data there are few configurations that should be overridden with Java system properties in the following services.

Policies:
```markdown
* -Dpekko-contrib-mongodb-persistence-policies-journal.overrides.metadata-index=akka_persistence_metadata_pid
* -Dpekko-contrib-mongodb-persistence-policies-journal-read.overrides.metadata-index=akka_persistence_metadata_pid
```

Things:
```markdown
* -Dpekko-contrib-mongodb-persistence-things-journal.overrides.metadata-index=akka_persistence_metadata_pid
* -Dpekko-contrib-mongodb-persistence-things-journal-read.overrides.metadata-index=akka_persistence_metadata_pid
```

Connectivity:
```markdown
* -Dpekko-contrib-mongodb-persistence-connection-journal.overrides.metadata-index=akka_persistence_metadata_pid
* -Dpekko-contrib-mongodb-persistence-connection-journal-read.overrides.metadata-index=akka_persistence_metadata_pid
* -Dpekko-contrib-mongodb-persistence-connection-remember-journal.overrides.metadata-index=akka_persistence_metadata_pid
```

And also a full cluster recreate is required, rolling update is not supported as there are changes in the management
urls and ports.

Other than that the transition should be smooth.

### MongoDB configuration
If you choose not to use the MongoDB container and instead use a dedicated MongoDB you can use
the following environment variables in order to configure the connection to the MongoDB.
Expand Down
51 changes: 51 additions & 0 deletions documentation/src/main/resources/pages/ditto/release_notes_340.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: Release notes 3.4.0
tags: [release_notes]
published: true
keywords: release notes, announcements, changelog
summary: "Version 3.4.0 of Eclipse Ditto, released on 13.09.2023"
permalink: release_notes_340.html
---

The fourth minor release of Ditto 3.x, Eclipse Ditto version 3.4.0 is here.

This release is completely [IP (intellectual property) checked by the Eclipse Foundation](https://www.eclipse.org/projects/handbook/#ip)
meaning that project code as well as all used dependencies were "[...] reviewed to ensure that the copyrights
expressed are correct, licensing is valid and compatible, and that other issues have been uncovered and properly
investigated."


## Changelog

Compared to the latest release [3.3.6](release_notes_336.html), no features were added.
This release focuses only on swapping the Akka framework (because of its switch of license to [BSL License](https://www.lightbend.com/akka/license-faq) after Akka v2.6.x)
with its fork [Apache Pekko](https://pekko.apache.org/docs/pekko/current/index.html) which is Apache 2.0 licensed.

### Migrating to Ditto 3.4.x

To migrate a running system with live data there are few configurations that should be overridden with Java system properties in the following services.

Policies:
```markdown
* -Dpekko-contrib-mongodb-persistence-policies-journal.overrides.metadata-index=akka_persistence_metadata_pid
* -Dpekko-contrib-mongodb-persistence-policies-journal-read.overrides.metadata-index=akka_persistence_metadata_pid
```

Things:
```markdown
* -Dpekko-contrib-mongodb-persistence-things-journal.overrides.metadata-index=akka_persistence_metadata_pid
* -Dpekko-contrib-mongodb-persistence-things-journal-read.overrides.metadata-index=akka_persistence_metadata_pid
```

Connectivity:
```markdown
* -Dpekko-contrib-mongodb-persistence-connection-journal.overrides.metadata-index=akka_persistence_metadata_pid
* -Dpekko-contrib-mongodb-persistence-connection-journal-read.overrides.metadata-index=akka_persistence_metadata_pid
* -Dpekko-contrib-mongodb-persistence-connection-remember-journal.overrides.metadata-index=akka_persistence_metadata_pid
```

And also a full cluster recreate is required, rolling update is not supported as there are changes in the management
urls and ports.

Other than that the transition should be smooth.

0 comments on commit a270162

Please sign in to comment.