Skip to content

Commit 3b9e85f

Browse files
Anil Ambatidenyeart
authored andcommitted
[FAB-8412] Added doc for peer node command
Added doc for the peer node start and peer node status commands. Change-Id: I8e20961ed5a11da79f83150d5db145070b712ca8 Signed-off-by: Anil Ambati <aambati@us.ibm.com> Signed-off-by: David Enyeart <enyeart@us.ibm.com>
1 parent ff15100 commit 3b9e85f

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-0
lines changed

docs/source/commands/peernode.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# peer node
2+
3+
## Description
4+
5+
The `peer node` subcommand allows an administrator to start a peer node or check
6+
the status of a peer node.
7+
8+
## Syntax
9+
10+
The `peer node` subcommand has the following syntax:
11+
12+
```
13+
peer node start [flags]
14+
peer node status
15+
```
16+
17+
## peer node start
18+
19+
### Start Description
20+
The `peer node start` command allows administrators to start the peer node process.
21+
22+
The peer node process can be configured using configuration file *core.yaml*, which
23+
must be located in the directory specified by the environment variable **FABRIC_CFG_PATH**.
24+
For docker deployments, *core.yaml* is pre-configured in the peer container **FABRIC_CFG_PATH** directory.
25+
For native binary deployments, *core.yaml* is included with the release artifact distribution.
26+
The configuration properties located in *core.yaml* can be overridden using environment variables.
27+
For example, `peer.mspConfigPath` configuration property can be specified by defining
28+
**CORE_PEER_MSPCONFIGPATH** environment variable, where **CORE_** is the prefix for the
29+
environment variables.
30+
31+
### Start Syntax
32+
The `peer node start` command has the following syntax:
33+
34+
```
35+
peer node start [flags]
36+
37+
```
38+
39+
### Start Flags
40+
The `peer node start` command has the following command specific flags:
41+
42+
* `-o, --orderer <string>`
43+
44+
specifies the ordering service endpoint. Default value is "orderer:7050"
45+
46+
* `--peer-chaincodedev`
47+
48+
starts peer node in chaincode development mode. Normally chaincode containers are started
49+
and maintained by peer. However in devlopment mode, chaincode is built and started by the user.
50+
This mode is useful during chaincode development phase for iterative development.
51+
See more information on development mode in the [chaincode tutorial](../chaincode4ade.html).
52+
53+
The global `peer` command flags also apply as described in the topic [`peer command`](./peercommand.html):
54+
55+
* --logging-level
56+
57+
## peer node status
58+
59+
### Status Description
60+
The `peer node status` command allows administrators to see the status of the peer node process.
61+
It will show the status of the peer node process running at the `peer.address` specified in the
62+
peer configuration, or overridden by **CORE_PEER_ADDRESS** environment variable.
63+
64+
### Status Syntax
65+
The `peer node status` command has the following syntax:
66+
67+
```
68+
peer node status
69+
```
70+
71+
### Status Flags
72+
The `peer node status` command has no command specific flags.

docs/source/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,10 @@ Business:
8282
:caption: Command Reference
8383

8484
commands/peercommand.md
85+
commands/peerchaincode.md
8586
commands/peerchannel.md
8687
commands/peerlogging.md
88+
commands/peernode.md
8789
commands/configtxgen.md
8890
commands/configtxlator.md
8991

0 commit comments

Comments
 (0)