Skip to content

Commit

Permalink
Update raft_bft_migration.md
Browse files Browse the repository at this point in the history
Updated Migration instructions to add pre migration checklist and security considerations. 

Signed-off-by: Koushik Gavini <kgavini@gala.games>
  • Loading branch information
KoushikGavini authored and denyeart committed Sep 10, 2024
1 parent 7611991 commit 5e20ae5
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/source/raft_bft_migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ To migrate, upgrade from version 2.x to version 3.0.0.

This tutorial will describe the migration process at a high level, calling out specific details where necessary.

## Pre-migration Checklist
Before beginning the migration process, ensure the following:
1. All ordering service nodes are running Fabric v3.0.0 or greater
2. All peers are running at least Fabric v3.0.0
3. All channels are configured with the V3_0 or later channel capability
4. The number of nodes is configured as 3f + 1, where f is the number of tolerated failures
5. BFT metadata and ConsenterMapping are prepared for each channel

## Security Considerations
1. Ensure all communication channels are encrypted
2. Verify node identities and certificates before and after migration
3. Update access controls if necessary after migration

## Assumptions and considerations
Before attempting migration, take the following into account:
Expand Down Expand Up @@ -152,4 +164,4 @@ There are a few states which might indicate migration has failed:

1. Some nodes crash or shutdown.
2. There is no record of a successful leader election per channel in the logs.
3. The attempt to switch to `STATE_NORMAL` mode fails.
3. The attempt to switch to `STATE_NORMAL` mode fails.

0 comments on commit 5e20ae5

Please sign in to comment.