Skip to content
This repository was archived by the owner on Jan 27, 2022. It is now read-only.

Commit 38eb3df

Browse files
rranjan3Manjunath A C
authored andcommitted
Minor updates to Fabric Proxy guide
Signed-off-by: Rajeev Ranjan <[email protected]>
1 parent 641aa6b commit 38eb3df

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

docs/TestingFabricProxyModel.rst

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Testing Hyperledger Avalon Proxy Model with Hyperledger Fabric
55
==============================================================
66

77
Hyperledger Fabric is an enterprise, private, permissioned blockchain network.
8-
To run Fabric with Hyperledger Avalon on a single machine (both Avalon and Fabric network are running on same machine.)
8+
To run Fabric with Hyperledger Avalon on a single machine (both Avalon and Fabric network running on same machine),
99
follow these steps:
1010

1111
1. Set the environment variable ``TCF_HOME`` to the Avalon root directory.
@@ -17,7 +17,7 @@ follow these steps:
1717
1818
2. Install ``curl``, ``docker`` and ``docker-compose``.
1919
See `PREREQUISITES <../PREREQUISITES.md#docker>`_
20-
for instructions for Docker.
20+
for instructions on Docker.
2121

2222
3. Proxy configuration (optional).
2323
If the host machine is behind any network firewall/proxy, you need to
@@ -28,7 +28,7 @@ follow these steps:
2828
http_proxy=<http-proxy-url>:<port>
2929
https_proxy=<https-proxy-url>:<port>
3030
31-
By default minifab creates 3 orderers, 2 peers with 2 organisations.
31+
By default minifab creates 3 orderers, 2 peers with 2 organizations.
3232
The ``no_proxy`` for this setup is as follows (all on one line):
3333

3434
.. code:: sh
@@ -38,7 +38,7 @@ follow these steps:
3838
peer2.org0.example.com,peer1.org0.example.com
3939
export NO_PROXY=$no_proxy
4040
41-
If you modify the number of orderers, peers, or organisations,
41+
If you modify the number of orderers, peers, or organizations,
4242
please update the ``no_proxy`` list accordingly.
4343

4444
4. Start the Fabric network with 2 organizations, 4 peers and 3 orderers
@@ -49,13 +49,13 @@ follow these steps:
4949
cd $TCF_HOME
5050
./scripts/start_fabric.sh -u
5151
52-
Starting Fabric Docker containers will take some time.
52+
Starting Fabric docker containers will take some time.
5353
Once it is up and running, type
5454
``docker ps``
5555
and check for Fabric Docker containers named
5656
``peer-*``, ``orderer-*``, and ``dev-*``
5757

58-
5. Start the Avalon Docker containers
58+
5. Start the Avalon docker containers
5959

6060
.. code:: sh
6161
@@ -69,10 +69,10 @@ follow these steps:
6969
7070
To run in Intel SGX hardware mode, use the corresponding docker compose file for singleton or worker pool mode (as specified in `BUILD.md <../BUILD.md>`_).
7171

72-
Once the Fabric containers are up and running we can start and stop Avalon
72+
Once the Fabric containers are up and running, we can start and stop Avalon
7373
containers any number of times without restarting the Fabric containers.
7474
To save time, omit the ``--build`` parameter after running the first time
75-
so it will not rebuild Avalon.
75+
so you do not rebuild Avalon.
7676

7777
6. Go to the ``avalon-shell`` container to run ``generic_client.py``:
7878

@@ -93,36 +93,36 @@ follow these steps:
9393
9494
./scripts/start_fabric.sh -d
9595
96-
Setup Hyperledger Avalon Fabric Proxy Model on multiple machine
96+
Setup Hyperledger Avalon Fabric Proxy Model on multiple machines
9797
----------------------------------------------------------------
98-
Multinode Hyperledger Avalon fabric proxy model setup requires certain modifications to existing
99-
Docker files. For example to setup the fabric blockchain network on a separate machine and Avalon on a separate machine
98+
Multinode Hyperledger Avalon Fabric proxy model setup requires certain modifications to the existing
99+
docker files. For example to setup the Fabric blockchain network on a separate machine and Avalon on a separate machine
100100
requires below changes.
101101

102-
1. On machine1(with ip address IP1) need to run the minifab if you are choose to setup fabric on single machine.
103-
Or else if you chose the any customized way other than minifab to setup a fabric network on multiple nodes, then it is mandatory to deploy
104-
the Avalon chaincodes which are located in (https://github.com/hyperledger/avalon/tree/master/sdk/avalon_sdk/connector/blockchains/fabric/chaincode)
102+
1. On machine1(with ip address IP1), you need to run the minifab if you choose to setup fabric on single machine.
103+
Otherwise if you choose any customized way other than minifab to setup a fabric network on multiple nodes, then it is mandatory to deploy
104+
the Avalon chaincodes which are located at https://github.com/hyperledger/avalon/tree/master/sdk/avalon_sdk/connector/blockchains/fabric/chaincode.
105105

106106
.. code:: sh
107107
108108
cd $TCF_HOME
109109
./scripts/start_fabric.sh -e
110110
111-
start_fabric.sh with option -e exposes the ports to host machine and it generates the network profile with host ip in network config file.
111+
start_fabric.sh with option -e exposes the ports to host machine and it generates the network profile with host ip in the network config file.
112112

113-
2. On machine2 (with ip address IP2) where Avalon is going to setup, copy the crypto materials used to setup the fabric network to home directory.
114-
Avalon shell and Avalon fabric connector need these crypto materials to interact with the blockchain.
113+
2. On machine2 (with ip address IP2) where Avalon is going to be setup, copy the crypto materials used to setup the Fabric network to home directory.
114+
Avalon shell and Avalon Fabric connector need these crypto materials to interact with the blockchain.
115115

116116
.. code:: sh
117117
118118
scp -r $TCF_HOME/mywork <user_name>@<IP1>:~/
119119
120-
3. If you choose the customized setup other than the start_fabric.sh (minifab) then create the network.json as in (https://github.com/hyperledger/avalon/blob/master/sdk/avalon_sdk/connector/blockchains/fabric/network.json)
120+
3. If you choose a customized setup other than start_fabric.sh (minifab) then create the network.json as in https://github.com/hyperledger/avalon/blob/master/sdk/avalon_sdk/connector/blockchains/fabric/network.json
121121

122-
4. If these 2 matchines are behind the corporate network please update environment variables `no_proxy` and `NO_PROXY`
122+
4. If these 2 machines are in corporate network, please update environment variables `no_proxy` and `NO_PROXY`
123123
with the IP1 on machine2 as mentioned above.
124124

125-
5. Remove the network tag from the Docker compose file - https://github.com/hyperledger/avalon/blob/master/docker/compose/avalon-fabric.yaml#L55
125+
5. Remove the network tag from the Docker compose file - https://github.com/hyperledger/avalon/blob/master/docker/compose/avalon-fabric.yaml#L62
126126

127127
6. Start the Avalon components.
128128

@@ -138,7 +138,7 @@ requires below changes.
138138
139139
To run in Intel SGX hardware mode, use the corresponding Docker compose file for singleton or worker pool mode (as specified in BUILD.md).
140140

141-
7. To test using fabric generic client.
141+
7. To test using Fabric generic client.
142142
Go to the avalon-shell container to run generic_client.py
143143

144144
.. code:: sh
@@ -201,4 +201,4 @@ Troubleshooting
201201
202202
Group ``docker`` should appear in the output.
203203
The Docker ``hello-world`` container should download, run without error,
204-
and print the message ``Hello from Docker!``
204+
and print the message ``Hello from Docker!``.

0 commit comments

Comments
 (0)