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

Jump to bottom

Akka.Cluster.Sharding docs: clarifying migration details for unaffected users #6481

Merged
merged 1 commit into from
Mar 2, 2023
Merged

Akka.Cluster.Sharding docs: clarifying migration details for unaffected users #6481

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 21 additions & 5 deletions docs/community/whats-new/akkadotnet-v1.5-upgrade-advisories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,12 @@ akka.cluster.sharding{
}
```

#### Migrating to New Sharding Storage From Akka.Persistence
> [!WARNING]
> `state-store-mode=persistence` will be deprecated and `state-store-mode=ddata` will eventually be made the default. Make plans to migrate off of persistence _urgently_.

> [!NOTE]
> This section applies to users who are using `remember-entities=on` and want to migrate to using the low-latency event-sourced based storage. All other users should just migrate to `state-store-mode=ddata`.
#### Migrating to DData From Akka.Persistence with Remember Entities

This section applies to users who are using `remember-entities=on` and want to migrate to using the low-latency event-sourced based storage. All other users should just migrate to `state-store-mode=ddata`.

Switching over to using `remember-entities-store = eventsourced` will cause an initial migration of data from the `ShardCoordinator`'s journal into separate event journals going forward.

Expand All @@ -68,8 +70,6 @@ Upgrading to Akka.NET v1.5 will **cause an irreversible migration of Akka.Cluste
> [!IMPORTANT]
> This migration is intended to be performed via upgrading Akka.NET to v1.5 and applying the recommended configuration changes below - **it will require a full restart of your cluster any time you change the `state-store-mode` setting**.

#### Upgrade to Akka.NET v1.5 Sharding

Update your Akka.Cluster.Sharding HOCON to look like the following (adjust as necessary for your custom settings):

```hocon
Expand All @@ -93,6 +93,22 @@ akka.cluster.sharding {
}
```

#### Migrating to DData From Akka.Persistence without Remember Entities

If you're migrating from `state-store-mode=persistence` to `state-store-mode=ddata` and don't use `remember-entities=on`, then all you have to configure is the following:

```hocon
akka.cluster.sharding {
state-store-mode = ddata
}

```

#### Executing Migration

> [!IMPORTANT]
> This section only applies to users migrating from `state-store-mode=persistence` to `state-store-mode=ddata`. For all other users there is no need to plan a special deployment - the transition to Akka.NET v1.5 sharding will be seamless. It's only the changing of `state-store-mode` settings that requires a restart of the cluster.

To deploy this upgrade:

1. Take your cluster offline and
Expand Down