Skip to content

Commit 474efd4

Browse files
committed
[FAB-5257] - Remove rc1 refs
clean up on these three docs; trivial change few small improvements to build first network as well [ci-skip] Change-Id: Iee7528ad87f1750dde81a9b7a3dcd1b3b2e522d6 Signed-off-by: Nick Gaski <[email protected]>
1 parent e50ca0c commit 474efd4

File tree

3 files changed

+42
-24
lines changed

3 files changed

+42
-24
lines changed

docs/source/build_network.rst

+36-18
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Building Your First Network
22
===========================
33

44
.. note:: These instructions have been verified to work against the
5-
version "1.0.0-rc1" tagged Docker images and the pre-compiled
5+
version "1.0.0" tagged Docker images and the pre-compiled
66
setup utilities within the supplied tar file. If you run
77
these commands with images or tools from the current master
88
branch, it is possible that you will see configuration and panic
@@ -31,14 +31,14 @@ sub-directory now.
3131
3232
.. note:: The supplied commands in this documentation
3333
**MUST** be run from your ``first-network`` sub-directory
34-
of the ``fabric-samples``repository clone. If you elect to run the
34+
of the ``fabric-samples`` repository clone. If you elect to run the
3535
commands from a different location, the various provided scripts
3636
will be unable to find the binaries.
3737

3838
Want to run it now?
3939
-------------------
4040

41-
We provide a fully annotated script ``byfn.sh`` that leverages these Docker
41+
We provide a fully annotated script - ``byfn.sh`` - that leverages these Docker
4242
images to quickly bootstrap a Hyperledger Fabric network comprised of 4 peers
4343
representing two different organizations, and an orderer node. It will also
4444
launch a container to run a scripted execution that will join peers to a
@@ -75,13 +75,17 @@ it, then your CLI container will exit upon conclusion of the script.
7575
Generate Network Artifacts
7676
^^^^^^^^^^^^^^^^^^^^^^^^^^
7777

78-
Ready to give it a go? Okay then! Execute the following command. You will see
79-
a brief description as to what will occur, along with a yes/no command line
80-
prompt. Respond with a ``y`` to execute the described action.
78+
Ready to give it a go? Okay then! Execute the following command:
8179

8280
.. code:: bash
8381
8482
./byfn.sh -m generate
83+
84+
You will see a brief description as to what will occur, along with a yes/no command line
85+
prompt. Respond with a ``y`` to execute the described action.
86+
87+
.. code:: bash
88+
8589
Generating certs and genesis block for with channel 'mychannel' and CLI timeout of '10000'
8690
Continue (y/n)?y
8791
proceeding ...
@@ -133,13 +137,17 @@ and a collection of configuration transactions required to configure a
133137
Bring Up the Network
134138
^^^^^^^^^^^^^^^^^^^^
135139

136-
Next, you can bring the network up with the following command. Once again, you
137-
will be prompted as to whether you wish to continue or abort. Respond with a
138-
``y``:
140+
Next, you can bring the network up with the following command:
139141

140142
.. code:: bash
141143
142144
./byfn.sh -m up
145+
146+
Once again, you will be prompted as to whether you wish to continue or abort.
147+
Respond with a ``y``:
148+
149+
.. code:: bash
150+
143151
Starting with channel 'mychannel' and CLI timeout of '10000'
144152
Continue (y/n)?y
145153
proceeding ...
@@ -185,20 +193,24 @@ completion, it should report the following in your terminal window:
185193
|_____| |_| \_| |____/
186194
187195
You can scroll through these logs to see the various transactions. If you don't
188-
get this result, then jump down to the Troubleshooting section and let's see
196+
get this result, then jump down to the :ref:`Troubleshoot` section and let's see
189197
whether we can help you discover what went wrong.
190198

191199
Bring Down the Network
192200
^^^^^^^^^^^^^^^^^^^^^^
193201

194202
Finally, let's bring it all down so we can explore the network setup one step
195203
at a time. The following will kill your containers, remove the crypto material
196-
and four artifacts, and delete the chaincode images from your Docker Registry.
197-
Once again, you will be prompted to continue, respond with a ``y``:
204+
and four artifacts, and delete the chaincode images from your Docker Registry:
198205

199206
.. code:: bash
200207
201208
./byfn.sh -m down
209+
210+
Once again, you will be prompted to continue, respond with a ``y``:
211+
212+
.. code:: bash
213+
202214
Stopping with channel 'mychannel' and CLI timeout of '10000'
203215
Continue (y/n)?y
204216
proceeding ...
@@ -359,12 +371,16 @@ Next, we need to tell the ``configtxgen`` tool where to look for the
359371
present working directory:
360372

361373
First, we need to set an environment variable to specify where ``configtxgen``
362-
should look for the configtx.yaml configuration file. Then, we'll invoke the
363-
``configtxgen`` tool which will create the orderer genesis block:
374+
should look for the configtx.yaml configuration file:
364375

365376
.. code:: bash
366377
367378
export FABRIC_CFG_PATH=$PWD
379+
380+
Then, we'll invoke the ``configtxgen`` tool which will create the orderer genesis block:
381+
382+
.. code:: bash
383+
368384
../bin/configtxgen -profile TwoOrgsOrdererGenesis -outputBlock ./channel-artifacts/genesis.block
369385
370386
You can ignore the log warnings regarding intermediate certificates, certificate
@@ -508,7 +524,7 @@ Now let's join ``peer0.org1.example.com`` to the channel.
508524
.. code:: bash
509525
510526
# By default, this joins ``peer0.org1.example.com`` only
511-
# the <channel-ID>.block was returned by the previous command
527+
# the <channel-ID.block> was returned by the previous command
512528
513529
peer channel join -b <channel-ID.block>
514530
@@ -525,7 +541,7 @@ Applications interact with the blockchain ledger through ``chaincode``. As
525541
such we need to install the chaincode on every peer that will execute and
526542
endorse our transactions, and then instantiate the chaincode on the channel.
527543

528-
First, install the sample go code onto one of the four peer nodes. This command
544+
First, install the sample Go code onto one of the four peer nodes. This command
529545
places the source code onto our peer's filesystem.
530546

531547
.. code:: bash
@@ -900,6 +916,8 @@ container specification:
900916
volumes:
901917
- /var/hyperledger/couchdb0:/opt/couchdb/data
902918
919+
.. _Troubleshoot:
920+
903921
Troubleshooting
904922
---------------
905923

@@ -912,7 +930,7 @@ Troubleshooting
912930
913931
- **YOU WILL SEE ERRORS IF YOU DO NOT REMOVE CONTAINERS AND IMAGES**
914932

915-
- If you see Docker errors, first check your version (should be 1.12 or above),
933+
- If you see Docker errors, first check your version (should be 17.03.1 or above),
916934
and then try restarting your Docker process. Problems with Docker are
917935
oftentimes not immediately recognizable. For example, you may see errors
918936
resulting from an inability to access crypto material mounted within a
@@ -950,7 +968,7 @@ again.
950968
Error connecting: rpc error: code = 14 desc = grpc: RPC failed fast due to transport failure
951969
Error: rpc error: code = 14 desc = grpc: RPC failed fast due to transport failure
952970
953-
Make sure you are running your network against the "1.0.0-rc1" images that have
971+
Make sure you are running your network against the "1.0.0" images that have
954972
been retagged as "latest".
955973

956974
If you see the below error:

docs/source/chaincode4ade.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -413,13 +413,13 @@ should see something similar to following:
413413
docker images
414414
REPOSITORY TAG IMAGE ID CREATED SIZE
415415
hyperledger/fabric-tools latest e09f38f8928d 4 hours ago 1.32 GB
416-
hyperledger/fabric-tools x86_64-1.0.0-rc1-snapshot-f20846c6 e09f38f8928d 4 hours ago 1.32 GB
416+
hyperledger/fabric-tools x86_64-1.0.0 e09f38f8928d 4 hours ago 1.32 GB
417417
hyperledger/fabric-orderer latest 0df93ba35a25 4 hours ago 179 MB
418-
hyperledger/fabric-orderer x86_64-1.0.0-rc1-snapshot-f20846c6 0df93ba35a25 4 hours ago 179 MB
418+
hyperledger/fabric-orderer x86_64-1.0.0 0df93ba35a25 4 hours ago 179 MB
419419
hyperledger/fabric-peer latest 533aec3f5a01 4 hours ago 182 MB
420-
hyperledger/fabric-peer x86_64-1.0.0-rc1-snapshot-f20846c6 533aec3f5a01 4 hours ago 182 MB
420+
hyperledger/fabric-peer x86_64-1.0.0 533aec3f5a01 4 hours ago 182 MB
421421
hyperledger/fabric-ccenv latest 4b70698a71d3 4 hours ago 1.29 GB
422-
hyperledger/fabric-ccenv x86_64-1.0.0-rc1-snapshot-f20846c6 4b70698a71d3 4 hours ago 1.29 GB
422+
hyperledger/fabric-ccenv x86_64-1.0.0 4b70698a71d3 4 hours ago 1.29 GB
423423
424424
.. note:: If you retrieved the images through the :ref:`download-platform-specific-binaries`,
425425
then you will see additional images listed. However, we are only concerned with

docs/source/samples.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,10 @@ The script lists out the Docker images installed upon conclusion.
7373

7474
Look at the names for each image; these are the components that will ultimately
7575
comprise our Hyperledger Fabric network. You will also notice that you have
76-
two instances of the same image ID - one tagged as "x86_64-1.0.0-rc1" and
76+
two instances of the same image ID - one tagged as "x86_64-1.0.0" and
7777
one tagged as "latest".
7878

79-
.. note:: Note that on different architectures, the x86_64 would be replaced
79+
.. note:: On different architectures, the x86_64 would be replaced
8080
with the string identifying your architecture.
8181

8282
.. Licensed under Creative Commons Attribution 4.0 International License

0 commit comments

Comments
 (0)