Skip to content

Commit

Permalink
A MIGRATION note about v10.13.5
Browse files Browse the repository at this point in the history
  • Loading branch information
@jwolski
jwolski committed Feb 2, 2016
1 parent f586877 commit 8feda9b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions MIGRATION.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@ Some changes to Ringpop require an additional note about how developer's
should upgrade. Below is where you'll find instructions on how to upgrade
gracefully from one version of Ringpop to another.

## Upgrading to v10.13.5
In v10.13.5, we hardened Ringpop to be resilient against wedged nodes. Nodes
may become wedged as a result of a potential TChannel bug -- when pings,
ping-reqs or joins are sent. Ringpop will timeout a wedged request and resume
gracefully. We have observed Ringpop to behave correctly while in this state,
but you may observe otherwise. We will let you come to your own conclusions.
Ringpop will emit an `error` event (when listeners have subscribed) providing a
`PotentiallyWedgedRequestError` object as an argument. Registering for this event
will give you the ability to restart your process, if you so choose.

## Upgrading from v10.9.6 to v10.9.7
v10.9.7 includes an `event` arg as part of the `ringChanged` event that it
emits. The event is of type `RingChangedEvent` and carries with it 3 properties:
Expand Down

0 comments on commit 8feda9b

Please sign in to comment.