Skip to content

Commit b1e3e77

Browse files
committed
[FAB-8700] Clarify channel update tutorial leader elec
The gossip leader election section of the channel update tutorial is vague about whether any settings need to be changed or what setting the peers are using for EYFN. This CR clarifies that the settings are already set for EYFN in the docker-compose file and that the section is included for reference for adding peers to a network beyond the peer added by EYFN. Change-Id: I360849c0d344e8ddbf9cf784cbda37b511591d4a Signed-off-by: Will Lahti <wtlahti@us.ibm.com>
1 parent 063b899 commit b1e3e77

File tree

1 file changed

+30
-17
lines changed

1 file changed

+30
-17
lines changed

docs/source/channel_update_tutorial.rst

+30-17
Original file line numberDiff line numberDiff line change
@@ -490,36 +490,49 @@ its contents.
490490
Configuring Leader Election
491491
~~~~~~~~~~~~~~~~~~~~~~~~~~~
492492

493-
Newly joining peers are bootstrapped with the genesis block, which does not contain information about the organization
494-
that is being added in the channel configuration update. Therefore new peers are not able to utilize gossip as
495-
they cannot verify blocks forwarded by other peers from their own organization until they get the configuration
496-
transaction which added the organization to the channel. Newly added peers must therefore have one of the following
493+
.. note:: This section is included as a general reference for understanding
494+
the leader election settings when adding organizations to a network
495+
after the initial channel configuration has completed. This sample
496+
defaults to dynamic leader election, which is set for all peers in the
497+
network in `peer-base.yaml`.
498+
499+
Newly joining peers are bootstrapped with the genesis block, which does not
500+
contain information about the organization that is being added in the channel
501+
configuration update. Therefore new peers are not able to utilize gossip as
502+
they cannot verify blocks forwarded by other peers from their own organization
503+
until they get the configuration transaction which added the organization to the
504+
channel. Newly added peers must therefore have one of the following
497505
configurations so that they receive blocks from the ordering service:
498506

499-
1. Utilize static leader mode and configure the peer to be an organization leader:
507+
1. To utilize static leader mode, configure the peer to be an organization
508+
leader:
500509

501510
::
502511

503-
export CORE_PEER_GOSSIP_USELEADERELECTION=false
504-
export CORE_PEER_GOSSIP_ORGLEADER=true
512+
CORE_PEER_GOSSIP_USELEADERELECTION=false
513+
CORE_PEER_GOSSIP_ORGLEADER=true
505514

506515

507-
.. note:: This configuration must be the same for all new peers added to the channel.
516+
.. note:: This configuration must be the same for all new peers added to the
517+
channel.
508518

509-
2. Utilize dynamic leader election:
519+
2. To utilize dynamic leader election, configure the peer to use leader
520+
election:
510521

511522
::
512523

513-
export CORE_PEER_GOSSIP_USELEADERELECTION=true
514-
export CORE_PEER_GOSSIP_ORGLEADER=false
524+
CORE_PEER_GOSSIP_USELEADERELECTION=true
525+
CORE_PEER_GOSSIP_ORGLEADER=false
515526

516527

517-
.. note:: Because peers of newly added organization won't be able to form membership view, this option will
518-
be similar to the static configuration, as each peer will start proclaiming himself to be a leader.
519-
However eventually once they get updated with the configuration transaction that adds the
520-
organization to the channel, there will be only one active leader for the organization. Therefore it
521-
is recommended to leverage this option if you eventually want the organization's peers to utilize
522-
leader election.
528+
.. note:: Because peers of the newly added organization won't be able to form
529+
membership view, this option will be similar to the static
530+
configuration, as each peer will start proclaiming itself to be a
531+
leader. However, once they get updated with the configuration
532+
transaction that adds the organization to the channel, there will be
533+
only one active leader for the organization. Therefore, it is
534+
recommended to leverage this option if you eventually want the
535+
organization's peers to utilize leader election.
523536

524537

525538
Join Org3 to the Channel

0 commit comments

Comments
 (0)