Skip to content

Commit 9660e5a

Browse files
wlahtiwlahti
committed
FAB-10847 Update peer channel docs
This CR updates the "peer channel" docs based on the current code, including the fact that the channel create timeout value should now be supplied as a duration instead of an integer. Change-Id: I74cc43983f21327a934e6872459bc4a4f7bb49f9 Signed-off-by: Will Lahti <wtlahti@us.ibm.com>
1 parent c899926 commit 9660e5a

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

‎docs/source/commands/peerchannel.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Flags:
3636
--cafile string Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
3737
--certfile string Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
3838
--clientauth Use mutual TLS when communicating with the orderer endpoint
39+
--connTimeout duration Timeout for client to connect (default 3s)
3940
-h, --help help for channel
4041
--keyfile string Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
4142
-o, --orderer string Ordering service endpoint
@@ -61,12 +62,13 @@ Flags:
6162
-f, --file string Configuration transaction file generated by a tool such as configtxgen for submitting to orderer
6263
-h, --help help for create
6364
--outputBlock string The path to write the genesis block for the channel. (default ./<channelID>.block)
64-
-t, --timeout int Channel creation timeout (default 5)
65+
-t, --timeout duration Channel creation timeout (default 5s)
6566
6667
Global Flags:
6768
--cafile string Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
6869
--certfile string Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
6970
--clientauth Use mutual TLS when communicating with the orderer endpoint
71+
--connTimeout duration Timeout for client to connect (default 3s)
7072
--keyfile string Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
7173
--logging-level string Default logging level and overrides, see core.yaml for full syntax
7274
-o, --orderer string Ordering service endpoint
@@ -90,6 +92,7 @@ Global Flags:
9092
--cafile string Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
9193
--certfile string Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
9294
--clientauth Use mutual TLS when communicating with the orderer endpoint
95+
--connTimeout duration Timeout for client to connect (default 3s)
9396
--keyfile string Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
9497
--logging-level string Default logging level and overrides, see core.yaml for full syntax
9598
-o, --orderer string Ordering service endpoint
@@ -113,6 +116,7 @@ Global Flags:
113116
--cafile string Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
114117
--certfile string Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
115118
--clientauth Use mutual TLS when communicating with the orderer endpoint
119+
--connTimeout duration Timeout for client to connect (default 3s)
116120
--keyfile string Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
117121
--logging-level string Default logging level and overrides, see core.yaml for full syntax
118122
-o, --orderer string Ordering service endpoint
@@ -136,6 +140,7 @@ Global Flags:
136140
--cafile string Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
137141
--certfile string Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
138142
--clientauth Use mutual TLS when communicating with the orderer endpoint
143+
--connTimeout duration Timeout for client to connect (default 3s)
139144
--keyfile string Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
140145
--logging-level string Default logging level and overrides, see core.yaml for full syntax
141146
-o, --orderer string Ordering service endpoint
@@ -158,6 +163,7 @@ Global Flags:
158163
--cafile string Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
159164
--certfile string Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
160165
--clientauth Use mutual TLS when communicating with the orderer endpoint
166+
--connTimeout duration Timeout for client to connect (default 3s)
161167
--keyfile string Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
162168
--logging-level string Default logging level and overrides, see core.yaml for full syntax
163169
-o, --orderer string Ordering service endpoint
@@ -181,6 +187,7 @@ Global Flags:
181187
--cafile string Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
182188
--certfile string Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
183189
--clientauth Use mutual TLS when communicating with the orderer endpoint
190+
--connTimeout duration Timeout for client to connect (default 3s)
184191
--keyfile string Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
185192
--logging-level string Default logging level and overrides, see core.yaml for full syntax
186193
-o, --orderer string Ordering service endpoint
@@ -205,6 +212,7 @@ Global Flags:
205212
--cafile string Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
206213
--certfile string Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
207214
--clientauth Use mutual TLS when communicating with the orderer endpoint
215+
--connTimeout duration Timeout for client to connect (default 3s)
208216
--keyfile string Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
209217
--logging-level string Default logging level and overrides, see core.yaml for full syntax
210218
-o, --orderer string Ordering service endpoint
@@ -242,7 +250,7 @@ Here's an example of the `peer channel create` command option.
242250
Wait 30 seconds for the channel to be created.
243251

244252
```
245-
peer channel create -c mychannel --orderer orderer.example.com:7050 -f ./createchannel.txn -t 30
253+
peer channel create -c mychannel --orderer orderer.example.com:7050 -f ./createchannel.txn -t 30s
246254
247255
2018-02-23 06:31:58.568 UTC [channelCmd] InitCmdFactory -> INFO 003 Endorser and orderer connections initialized
248256
2018-02-23 06:31:58.669 UTC [channelCmd] InitCmdFactory -> INFO 019 Endorser and orderer connections initialized

‎docs/wrappers/peer_channel_postscript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here's an example of the `peer channel create` command option.
2828
Wait 30 seconds for the channel to be created.
2929

3030
```
31-
peer channel create -c mychannel --orderer orderer.example.com:7050 -f ./createchannel.txn -t 30
31+
peer channel create -c mychannel --orderer orderer.example.com:7050 -f ./createchannel.txn -t 30s
3232
3333
2018-02-23 06:31:58.568 UTC [channelCmd] InitCmdFactory -> INFO 003 Endorser and orderer connections initialized
3434
2018-02-23 06:31:58.669 UTC [channelCmd] InitCmdFactory -> INFO 019 Endorser and orderer connections initialized

0 commit comments

Comments
 (0)