From 75189536636a0b70efe99860860a1158cf3d81a2 Mon Sep 17 00:00:00 2001 From: Jason Yellick Date: Wed, 21 Feb 2018 16:26:37 -0500 Subject: [PATCH] [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 --- docs/source/upgrade_to_one_point_one.rst | 36 ++++++++++++++++-------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/docs/source/upgrade_to_one_point_one.rst b/docs/source/upgrade_to_one_point_one.rst index b9c17c64e15..addd9c36c5c 100644 --- a/docs/source/upgrade_to_one_point_one.rst +++ b/docs/source/upgrade_to_one_point_one.rst @@ -105,19 +105,29 @@ orderer process: 2. Backup the orderer's ledger and MSP. 3. Replace the orderer binary with the one from v1.1.x. - * For native deployments, replace the file ‘orderer’ with the one from the - release artifacts. + * For native deployments, replace the file ``orderer`` with the one from the + release artifacts. Backup the ``orderer.yaml`` and replace it with the + ``orderer.yaml`` file from the release artifacts. Port any modified + variables from the backed up ``orderer.yaml`` to the new one. Utilizing + a utility like ``diff`` may be helpful. + + .. note:: To decrease confusion, the variable ``General.TLS.ClientAuthEnabled`` + has been renamed to ``General.TLS.ClientAuthRequired`` (just as it is + specified in the peer configuration.). If the old name for this variable + is still present in the ``orderer.yaml`` file, the new ``orderer`` binary + will fail to start. + * For docker deployments, change the deployment scripts to use image version v1.1.x. -.. note:: You must configure the Kafka protocol version used by the orderer to match - your Kafka cluster version, even if it was not set before. For example, if - you are using the sample Kafka images provided with Hyperledger Fabric 1.0.x, - either set the ``ORDERER_KAFKA_VERSION`` environment variable, or the - ``Kafka.Version`` key in the ``orderer.yaml`` to ``0.9.0.1``. If you are unsure - about your Kafka cluster version, you can configure the orderer's Kafka protocol - version to ``0.9.0.1`` for maximum compatibility and update the setting afterwards - when you have determined your Kafka cluster version. + .. note:: You must configure the Kafka protocol version used by the orderer to match + your Kafka cluster version, even if it was not set before. For example, if + you are using the sample Kafka images provided with Hyperledger Fabric 1.0.x, + either set the ``ORDERER_KAFKA_VERSION`` environment variable, or the + ``Kafka.Version`` key in the ``orderer.yaml`` to ``0.9.0.1``. If you are unsure + about your Kafka cluster version, you can configure the orderer's Kafka protocol + version to ``0.9.0.1`` for maximum compatibility and update the setting afterwards + when you have determined your Kafka cluster version. 4. Start the orderer. 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 4. Replace the old peer binary with the one from v1.1.x. - * For **native** deployments, replace the file ``peer`` with the one from the release artifacts. + * For **native** deployments, replace the file ``peer`` with the one from the + release artifacts. Backup your ``core.yaml`` and replace it with the one + from the release artifacts. Port any modified variables from the backed up + ``core.yaml`` to the new one. Utilizing a utility like ``diff`` may be + helpful. * For **Docker** deployments, change the deployment scripts to use image version v1.1.x. 5. Start the peer, making sure to verify that the peer blockchain syncs with the rest of the