@@ -2,15 +2,15 @@ Building Your First Network
2
2
===========================
3
3
4
4
.. 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-rc1" tagged Docker images and the pre-compiled
6
6
setup utilities within the supplied tar file. If you run
7
7
these commands with images or tools from the current master
8
8
branch, it is possible that you will see configuration and panic
9
9
errors.
10
10
11
- The build your first network (BYFN) scenario provisions a sample Fabric network
12
- consisting of two organizations, each maintaining two peer nodes, and a "solo"
13
- ordering service.
11
+ The build your first network (BYFN) scenario provisions a sample Hyperledger
12
+ Fabric network consisting of two organizations, each maintaining two peer
13
+ nodes, and a "solo" ordering service.
14
14
15
15
Install prerequisites
16
16
---------------------
@@ -38,12 +38,12 @@ sub-directory now.
38
38
Want to run it now?
39
39
-------------------
40
40
41
- We provide a fully annotated script ``byfn.sh `` that leverages these docker
42
- images to quickly bootstrap a Fabric network comprised of 4 peers representing
43
- two different organizations, and an orderer node. It will also launch a
44
- container to run a scripted execution that will join peers to a channel, deploy
45
- and instantiate chaincode and drive execution of transactions against the
46
- deployed chaincode.
41
+ We provide a fully annotated script ``byfn.sh `` that leverages these Docker
42
+ images to quickly bootstrap a Hyperledger Fabric network comprised of 4 peers
43
+ representing two different organizations, and an orderer node. It will also
44
+ launch a container to run a scripted execution that will join peers to a
45
+ channel, deploy and instantiate chaincode and drive execution of transactions
46
+ against the deployed chaincode.
47
47
48
48
Here's the help text for the ``byfn.sh `` script:
49
49
@@ -213,7 +213,7 @@ Once again, you will be prompted to continue, respond with a ``y``:
213
213
214
214
If you'd like to learn more about the underlying tooling and bootstrap mechanics,
215
215
continue reading. In these next sections we'll walk through the various steps
216
- and requirements to build a fully-functional Fabric network.
216
+ and requirements to build a fully-functional Hyperledger Fabric network.
217
217
218
218
Crypto Generator
219
219
----------------
@@ -229,15 +229,17 @@ How does it work?
229
229
Cryptogen consumes a file - ``crypto-config.yaml `` - that contains the network
230
230
topology and allows us to generate a set of certificates and keys for both the
231
231
Organizations and the components that belong to those Organizations. Each
232
- Organization is provisioned a unique root certificate (``ca-cert ``), that binds
232
+ Organization is provisioned a unique root certificate (``ca-cert ``) that binds
233
233
specific components (peers and orderers) to that Org. By assigning each
234
234
Organization a unique CA certificate, we are mimicking a typical network where
235
235
a participating :ref: `Member ` would use its own Certificate Authority.
236
- Transactions and communications within Fabric are signed by an entity's private
237
- key (``keystore ``), and then verified by means of a public key (``signcerts ``).
238
- You will notice a "count" variable within this file. We use this to specify
239
- the number of peers per Organization; in our case it's two peers per Org. We
240
- won't delve into the minutiae of `x.509 certificates and public key
236
+ Transactions and communications within Hyperledger Fabric are signed by an
237
+ entity's private key (``keystore ``), and then verified by means of a public
238
+ key (``signcerts ``).
239
+
240
+ You will notice a ``count `` variable within this file. We use this to specify
241
+ the number of peers per Organization; in our case there are two peers per Org.
242
+ We won't delve into the minutiae of `x.509 certificates and public key
241
243
infrastructure <https://en.wikipedia.org/wiki/Public_key_infrastructure> `__
242
244
right now. If you're interested, you can peruse these topics on your own time.
243
245
@@ -284,7 +286,7 @@ Configuration Transaction Generator
284
286
The ``configtxgen tool `` is used to create four configuration artifacts:
285
287
286
288
* orderer ``genesis block ``,
287
- * fabric ``channel configuration transaction ``,
289
+ * channel ``channel configuration transaction ``,
288
290
* and two ``anchor peer transactions `` - one for each Peer Org.
289
291
290
292
Please see :doc: `configtxgen ` for a complete description of the use of this
@@ -677,7 +679,7 @@ traditional transaction - read/write - is performed against that chaincode (e.g.
677
679
the value of "a"). The transaction causes the container to start. Also,
678
680
all peers in a channel maintain an exact copy of the ledger which
679
681
comprises the blockchain to store the immutable, sequenced record in
680
- blocks, as well as a state database to maintain current fabric state.
682
+ blocks, as well as a state database to maintain a snapshot of the current state.
681
683
This includes those peers that do not have chaincode installed on them
682
684
(like ``peer1.org1.example.com `` in the above example) . Finally, the chaincode is accessible
683
685
after it is installed (like ``peer1.org2.example.com `` in the above example) because it
@@ -686,7 +688,7 @@ has already been instantiated.
686
688
How do I see these transactions?
687
689
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
688
690
689
- Check the logs for the CLI docker container.
691
+ Check the logs for the CLI Docker container.
690
692
691
693
.. code :: bash
692
694
@@ -741,17 +743,17 @@ output from each container:
741
743
ex02 Invoke
742
744
Query Response:{" Name" :" a" ," Amount" :" 90" }
743
745
744
- Understanding the docker-compose topology
746
+ Understanding the Docker Compose topology
745
747
-----------------------------------------
746
748
747
- The BYFN sample offers us two flavors of docker-compose files, both of which
749
+ The BYFN sample offers us two flavors of Docker Compose files, both of which
748
750
are extended from the ``docker-compose-base.yaml `` (located in the ``base ``
749
751
folder). Our first flavor, ``docker-compose-cli.yaml ``, provides us with a
750
- CLI container, along with an orderer, four peers. We use this docker-compose
752
+ CLI container, along with an orderer, four peers. We use this file
751
753
for the entirety of the instructions on this page.
752
754
753
755
.. note :: the remainder of this section covers a docker-compose file designed for the
754
- SDK. Refer to the `Node.js SDK <https://github.com/hyperledger/fabric-sdk-node >`__
756
+ SDK. Refer to the `Node SDK <https://github.com/hyperledger/fabric-sdk-node >`__
755
757
repo for details on running these tests.
756
758
757
759
The second flavor, ``docker-compose-e2e.yaml ``, is constructed to run end-to-end tests
@@ -782,7 +784,7 @@ data content contingent upon the chaincode data being modeled as JSON.
782
784
783
785
To use CouchDB instead of the default database (goleveldb), follow the same
784
786
procedures outlined earlier for generating the artifacts, except when starting
785
- the network pass the couchdb docker-compose as well:
787
+ the network pass `` docker-compose-couch.yaml `` as well:
786
788
787
789
.. code :: bash
788
790
@@ -910,8 +912,8 @@ Troubleshooting
910
912
911
913
- **YOU WILL SEE ERRORS IF YOU DO NOT REMOVE CONTAINERS AND IMAGES **
912
914
913
- - If you see docker errors, first check your version (should be 1.12 or above),
914
- and then try restarting your docker process. Problems with Docker are
915
+ - If you see Docker errors, first check your version (should be 1.12 or above),
916
+ and then try restarting your Docker process. Problems with Docker are
915
917
oftentimes not immediately recognizable. For example, you may see errors
916
918
resulting from an inability to access crypto material mounted within a
917
919
container.
@@ -970,7 +972,7 @@ channel artifacts.
970
972
./byfn.sh -m down
971
973
972
974
- If you see an error stating that you still have "active endpoints", then prune
973
- your docker networks. This will wipe your previous networks and start you with a
975
+ your Docker networks. This will wipe your previous networks and start you with a
974
976
fresh environment:
975
977
976
978
.. code :: bash
0 commit comments