Skip to content

Commit 7518953

Browse files
author
Jason Yellick
committed
[FAB-8460] Document config file updgrade
For users which deploy fabric natively, they must update their orderer.yaml and core.yaml files when they update their binaries. Otherwise, env variable overrides will fail to work. This CR adds to the upgrade doc noting this step for native deployments. Change-Id: I9f706f7be2bc371162d91b952c9cda8a70fc6d70 Signed-off-by: Jason Yellick <jyellick@us.ibm.com>
1 parent a825a83 commit 7518953

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

docs/source/upgrade_to_one_point_one.rst

+25-11
Original file line numberDiff line numberDiff line change
@@ -105,19 +105,29 @@ orderer process:
105105
2. Backup the orderer's ledger and MSP.
106106
3. Replace the orderer binary with the one from v1.1.x.
107107

108-
* For native deployments, replace the file ‘orderer’ with the one from the
109-
release artifacts.
108+
* For native deployments, replace the file ``orderer`` with the one from the
109+
release artifacts. Backup the ``orderer.yaml`` and replace it with the
110+
``orderer.yaml`` file from the release artifacts. Port any modified
111+
variables from the backed up ``orderer.yaml`` to the new one. Utilizing
112+
a utility like ``diff`` may be helpful.
113+
114+
.. note:: To decrease confusion, the variable ``General.TLS.ClientAuthEnabled``
115+
has been renamed to ``General.TLS.ClientAuthRequired`` (just as it is
116+
specified in the peer configuration.). If the old name for this variable
117+
is still present in the ``orderer.yaml`` file, the new ``orderer`` binary
118+
will fail to start.
119+
110120
* For docker deployments, change the deployment scripts to use image version
111121
v1.1.x.
112122

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.
123+
.. note:: You must configure the Kafka protocol version used by the orderer to match
124+
your Kafka cluster version, even if it was not set before. For example, if
125+
you are using the sample Kafka images provided with Hyperledger Fabric 1.0.x,
126+
either set the ``ORDERER_KAFKA_VERSION`` environment variable, or the
127+
``Kafka.Version`` key in the ``orderer.yaml`` to ``0.9.0.1``. If you are unsure
128+
about your Kafka cluster version, you can configure the orderer's Kafka protocol
129+
version to ``0.9.0.1`` for maximum compatibility and update the setting afterwards
130+
when you have determined your Kafka cluster version.
121131

122132
4. Start the orderer.
123133
5. Verify that the new orderer starts up and synchronizes with the rest of the network.
@@ -180,7 +190,11 @@ in 1.1, there will be an internal CouchDB database for each channel_chaincode co
180190

181191
4. Replace the old peer binary with the one from v1.1.x.
182192

183-
* For **native** deployments, replace the file ``peer`` with the one from the release artifacts.
193+
* For **native** deployments, replace the file ``peer`` with the one from the
194+
release artifacts. Backup your ``core.yaml`` and replace it with the one
195+
from the release artifacts. Port any modified variables from the backed up
196+
``core.yaml`` to the new one. Utilizing a utility like ``diff`` may be
197+
helpful.
184198
* For **Docker** deployments, change the deployment scripts to use image version v1.1.x.
185199

186200
5. Start the peer, making sure to verify that the peer blockchain syncs with the rest of the

0 commit comments

Comments
 (0)