Skip to content

Commit

Permalink
Update help text in test net tutorial
Browse files Browse the repository at this point in the history
Signed-off-by: NIKHIL E GUPTA <ngupta@symbridge.com>
  • Loading branch information
nikhil550 authored and denyeart committed Oct 10, 2020
1 parent e6fcef5 commit 9adde2e
Showing 1 changed file with 26 additions and 29 deletions.
55 changes: 26 additions & 29 deletions docs/source/test_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,45 +41,42 @@ up a Fabric network using the Docker images on your local machine. You can run
Usage:
network.sh <Mode> [Flags]
Modes:
up - bring up fabric orderer and peer nodes. No channel is created
up createChannel - bring up fabric network with one channel
createChannel - create and join a channel after the network is created
deployCC - deploy the asset transfer basic chaincode on the channel or specify
down - clear the network with docker-compose down
restart - restart the network
up - Bring up Fabric orderer and peer nodes. No channel is created
up createChannel - Bring up fabric network with one channel
createChannel - Create and join a channel after the network is created
deployCC - Deploy a chaincode to a channel (defaults to asset-transfer-basic)
down - Bring down the network
Flags:
Used with network.sh up, network.sh createChannel:
-ca <use CAs> - create Certificate Authorities to generate the crypto material
-c <channel name> - channel name to use (defaults to "mychannel")
-s <dbtype> - the database backend to use: goleveldb (default) or couchdb
-ca <use CAs> - Use Certificate Authorities to generate network crypto material
-c <channel name> - Name of channel to create (defaults to "mychannel")
-s <dbtype> - Peer state database to deploy: goleveldb (default) or couchdb
-r <max retry> - CLI times out after certain number of attempts (defaults to 5)
-d <delay> - delay duration in seconds (defaults to 3)
-i <imagetag> - the tag to be used to launch the network (defaults to "latest")
-cai <ca_imagetag> - the image tag to be used for CA (defaults to "latest")
-verbose - verbose mode
-d <delay> - CLI delays for a certain number of seconds (defaults to 3)
-i <imagetag> - Docker image tag of Fabric to deploy (defaults to "latest")
-cai <ca_imagetag> - Docker image tag of Fabric CA to deploy (defaults to "latest")
-verbose - Verbose mode
Used with network.sh deployCC
-c <channel name> - deploy chaincode to channel
-ccn <name> - the short name of the chaincode to deploy: basic (default),ledger, private, sbe, secured
-ccl <language> - the programming language of the chaincode to deploy: go (default), java, javascript, typescript
-ccv <version> - chaincode version. 1.0 (default)
-ccs <sequence> - chaincode definition sequence. Must be an integer, 1 (default), 2, 3, etc
-ccp <path> - Optional, path to the chaincode. When provided the -ccn will be used as the deployed name and not the short name of the known chaincodes.
-ccep <policy> - Optional, chaincode endorsement policy, using signature policy syntax. The default policy requires an endorsement from Org1 and Org2
-cccg <collection-config> - Optional, path to a private data collections configuration file
-cci <fcn name> - Optional, chaincode init required function to invoke. When provided this function will be invoked after deployment of the chaincode and will define the chaincode as initialization required.
-h - print this message
-c <channel name> - Name of channel to deploy chaincode to
-ccn <name> - Chaincode name. This flag can be used to deploy one of the asset transfer samples to a channel. Sample options: basic (default),ledger, private, sbe, secured
-ccl <language> - Programming language of the chaincode to deploy: go (default), java, javascript, typescript
-ccv <version> - Chaincode version. 1.0 (default), v2, version3.x, etc
-ccs <sequence> - Chaincode definition sequence. Must be an integer, 1 (default), 2, 3, etc
-ccp <path> - (Optional) File path to the chaincode. When provided, the -ccn flag will be used only for the chaincode name.
-ccep <policy> - (Optional) Chaincode endorsement policy using signature policy syntax. The default policy requires an endorsement from Org1 and Org2
-cccg <collection-config> - (Optional) File path to private data collections configuration file
-cci <fcn name> - (Optional) Name of chaincode initialization function. When a function is provided, the execution of init will be requested and the function will be invoked.
-h - Print this message
Possible Mode and flag combinations
up -ca -c -r -d -s -i -verbose
up createChannel -ca -c -r -d -s -i -verbose
up -ca -r -d -s -i -cai -verbose
up createChannel -ca -c -r -d -s -i -cai -verbose
createChannel -c -r -d -verbose
deployCC -ccn -ccl -ccv -ccs -ccp -cci -r -d -verbose
Taking all defaults:
network.sh up
Examples:
network.sh up createChannel -ca -c mychannel -s couchdb -i 2.0.0
network.sh createChannel -c channelName
Expand Down

0 comments on commit 9adde2e

Please sign in to comment.