Skip to content

Commit 9ae32f5

Browse files
author
Luis Sanchez
committed
[FAB-8010] document kafka version provided in v1.0
Change-Id: I2957022579e24abb0b28695a1811726ae29bf7dc Signed-off-by: Luis Sanchez <sanchezl@us.ibm.com>
1 parent 8e98cdc commit 9ae32f5

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

docs/source/upgrade_to_one_point_one.rst

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This means that every network -- and every channel within that network -- must d
3434
set of conditions necessary for transactions to be processed properly. For example, Fabric
3535
v1.1 introduces new MSP role types of "Peer", "Orderer", and "Client". However, if a v1.0
3636
peer does not understand these new role types, it will not be able to appropriately
37-
evaluate an endorsement policy that references them.
37+
evaluate an endorsement policy that references them.
3838

3939
Without this consistency across channels, a component -- the orderer, for example --
4040
might label a transaction invalid when a *different* orderer that has been upgraded
@@ -58,7 +58,7 @@ three groups, each of which defines a capability of a different type.
5858
the root ``Channel`` group.
5959

6060
* **Application:** apply to peers only and are located in the ``Application`` group.
61-
61+
6262
* **Orderer:** apply to orderers only and are located in the ``Orderer`` group.
6363

6464
The capabilities are broken into these groups in order to align with the existing
@@ -110,9 +110,14 @@ orderer process:
110110
* For docker deployments, change the deployment scripts to use image version
111111
v1.1.x.
112112

113-
.. note:: For Docker deployments, you must set the environment variable
114-
``ORDERER_KAFKA_VERSION`` to match your Kafka cluster version, even if it
115-
was not set before.
113+
.. note:: You must configure the Kafka protocol version used by the orderer to match
114+
your Kafka cluster version, even if it was not set before. For example, if
115+
you are using the sample Kafka images provided with Hyperledger Fabric 1.0.x,
116+
either set the ``ORDERER_KAFKA_VERSION`` environment variable, or the
117+
``Kafka.Version`` key in the ``orderer.yaml`` to ``0.9.0.1``. If you are unsure
118+
about your Kafka cluster version, you can configure the orderer's Kafka protocol
119+
version to ``0.9.0.1`` for maximum compatibility and update the setting afterwards
120+
when you have determined your Kafka cluster version.
116121

117122
4. Start the orderer.
118123
5. Verify that the new orderer starts up and synchronizes with the rest of the network.
@@ -405,18 +410,22 @@ Upgrading the Kafka Cluster
405410
406411
It is not required, but it is recommended that the Kafka cluster be upgraded and kept
407412
up to date along with the rest of Fabric. Newer versions of Kafka support older protocol
408-
versions, so you may upgrade Kafka before or after the result of Fabric.
413+
versions, so you may upgrade Kafka before or after the rest of Fabric.
409414
410415
If your Kafka cluster is older than Kafka v0.11.0, this upgrade is especially recommended
411-
as it hardens replication in order to better handle crash faults which can exhibit
416+
as it hardens replication in order to better handle crash faults which can exhibit
412417
problems such as seen in FAB-7330.
413418
414-
No configuration changes to the orderer are required when the Kafka brokers are upgraded
415-
to a newer version. Refer to the official Apache Kafka documentation on upgrading Kafka
416-
from previous versions on how to upgrade the Kafka brokers.
419+
Refer to the official Apache Kafka documentation on `upgrading Kafka from previous versions
420+
<https://kafka.apache.org/documentation/#upgrade>`_ to upgrade the Kafka cluster brokers.
417421
418-
Please note that the Kafka cluster might experience a negative performance impact if
419-
the value of Kafka.Version in the orderer.yaml is older than the Kafka broker version.
422+
Please note that the Kafka cluster might experience a negative performance impact if the
423+
orderer is configured to use a Kafka protocol version that is older than the Kafka broker
424+
version. The Kafka protocol version is set using either the ``Kafka.Version`` key in the
425+
``orderer.yaml`` file or via the ``ORDERER_KAFKA_VERSION`` environment variable in a
426+
Docker deployment. Hyperledger Fabric v1.0 provided sample Kafka docker images containing
427+
Kafka version ``0.9.0.1``. Hyperledger Fabric v1.1 provides sample Kafka docker images containing
428+
Kafka version ``0.10.2.1``.
420429
421430
Upgrading CouchDB
422431
-----------------

0 commit comments

Comments
 (0)