Skip to content

Commit 1c129e9

Browse files
committed
[FAB-9794] Remove docs refs to byfn.sh "-m" flag
Since the byfn.sh script has been stripped of its old references to the -m flag for specifying the mode, get rid of those references from the docs page as well. Change-Id: I2d531b259b556a4fca375f021d056fee8d54323d Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
1 parent 9015790 commit 1c129e9

File tree

1 file changed

+37
-27
lines changed

1 file changed

+37
-27
lines changed

docs/source/build_network.rst

+37-27
Original file line numberDiff line numberDiff line change
@@ -49,28 +49,38 @@ Here's the help text for the ``byfn.sh`` script:
4949

5050
.. code:: bash
5151
52-
./byfn.sh --help
5352
Usage:
54-
byfn.sh up|down|restart|generate [-c <channel name>] [-t <timeout>] [-d <delay>] [-f <docker-compose-file>] [-s <dbtype>]
55-
byfn.sh -h|--help (print this message)
56-
-m <mode> - one of 'up', 'down', 'restart' or 'generate'
57-
- 'up' - bring up the network with docker-compose up
58-
- 'down' - clear the network with docker-compose down
59-
- 'restart' - restart the network
60-
- 'generate' - generate required certificates and genesis block
61-
-c <channel name> - channel name to use (defaults to "mychannel")
62-
-t <timeout> - CLI timeout duration in seconds (defaults to 10)
63-
-d <delay> - delay duration in seconds (defaults to 3)
64-
-f <docker-compose-file> - specify which docker-compose file use (defaults to docker-compose-cli.yaml)
65-
-s <dbtype> - the database backend to use: goleveldb (default) or couchdb
66-
-l <language> - the chaincode language: golang (default) or node
67-
-a - don't ask for confirmation before proceeding
68-
69-
Typically, one would first generate the required certificates and
70-
genesis block, then bring up the network. e.g.:
71-
72-
byfn.sh -m generate -c mychannel
73-
byfn.sh -m up -c mychannel -s couchdb
53+
byfn.sh <mode> [-c <channel name>] [-t <timeout>] [-d <delay>] [-f <docker-compose-file>] [-s <dbtype>] [-l <language>] [-i <imagetag>] [-v]
54+
<mode> - one of 'up', 'down', 'restart', 'generate' or 'upgrade'
55+
- 'up' - bring up the network with docker-compose up
56+
- 'down' - clear the network with docker-compose down
57+
- 'restart' - restart the network
58+
- 'generate' - generate required certificates and genesis block
59+
- 'upgrade' - upgrade the network from v1.0.x to v1.1
60+
-c <channel name> - channel name to use (defaults to "mychannel")
61+
-t <timeout> - CLI timeout duration in seconds (defaults to 10)
62+
-d <delay> - delay duration in seconds (defaults to 3)
63+
-f <docker-compose-file> - specify which docker-compose file use (defaults to docker-compose-cli.yaml)
64+
-s <dbtype> - the database backend to use: goleveldb (default) or couchdb
65+
-l <language> - the chaincode language: golang (default) or node
66+
-i <imagetag> - the tag to be used to launch the network (defaults to "latest")
67+
-v - verbose mode
68+
byfn.sh -h (print this message)
69+
70+
Typically, one would first generate the required certificates and
71+
genesis block, then bring up the network. e.g.:
72+
73+
byfn.sh generate -c mychannel
74+
byfn.sh up -c mychannel -s couchdb
75+
byfn.sh up -c mychannel -s couchdb -i 1.1.0-alpha
76+
byfn.sh up -l node
77+
byfn.sh down -c mychannel
78+
byfn.sh upgrade -c mychannel
79+
80+
Taking all defaults:
81+
byfn.sh generate
82+
byfn.sh up
83+
byfn.sh down
7484
7585
If you choose not to supply a channel name, then the
7686
script will use a default name of ``mychannel``. The CLI timeout parameter
@@ -85,7 +95,7 @@ Ready to give it a go? Okay then! Execute the following command:
8595

8696
.. code:: bash
8797
88-
./byfn.sh -m generate
98+
./byfn.sh generate
8999
90100
You will see a brief description as to what will occur, along with a yes/no command line
91101
prompt. Respond with a ``y`` or hit the return key to execute the described action.
@@ -147,7 +157,7 @@ Next, you can bring the network up with one of the following commands:
147157

148158
.. code:: bash
149159
150-
./byfn.sh -m up
160+
./byfn.sh up
151161
152162
The above command will compile Golang chaincode images and spin up the corresponding
153163
containers. Go is the default chaincode language, however there is also support
@@ -159,7 +169,7 @@ chaincode, pass the following command instead:
159169
# we use the -l flag to specify the chaincode language
160170
# forgoing the -l flag will default to Golang
161171
162-
./byfn.sh -m up -l node
172+
./byfn.sh up -l node
163173
164174
.. note:: View the `Hyperledger Fabric Shim <https://fabric-shim.github.io/ChaincodeStub.html>`__
165175
documentation for more info on the node.js chaincode shim APIs.
@@ -222,7 +232,7 @@ and four artifacts, and delete the chaincode images from your Docker Registry:
222232

223233
.. code:: bash
224234
225-
./byfn.sh -m down
235+
./byfn.sh down
226236
227237
Once again, you will be prompted to continue, respond with a ``y`` or hit the return key:
228238

@@ -1083,7 +1093,7 @@ Troubleshooting
10831093

10841094
.. code:: bash
10851095
1086-
./byfn.sh -m down
1096+
./byfn.sh down
10871097
10881098
.. note:: You **will** see errors if you do not remove old containers
10891099
and images.
@@ -1146,7 +1156,7 @@ Troubleshooting
11461156

11471157
.. code:: bash
11481158
1149-
./byfn.sh -m down
1159+
./byfn.sh down
11501160
11511161
- If you see an error stating that you still have "active endpoints", then prune
11521162
your Docker networks. This will wipe your previous networks and start you with a

0 commit comments

Comments
 (0)