Skip to content
This repository was archived by the owner on Apr 25, 2025. It is now read-only.

Commit fc535d1

Browse files
nyetwurktroyronda
authored andcommitted
[FABG-787] Document BCCSP section as optional
Cosmetic. Update example `config.yaml`s to document that `BCCSP` section is optional. Change-Id: Ie0ee8c402c2ff215ff13e7cf49e15d9a43511d15 Signed-off-by: Nye Liu <nye@blockdaemon.com>
1 parent b490519 commit fc535d1

9 files changed

+19
-19
lines changed

test/fixtures/config/config_e2e.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ client:
8080
# Specific to the underlying KeyValueStore that backs the crypto key store.
8181
path: /tmp/msp
8282

83-
# BCCSP config for the client. Used by GO SDK.
83+
# [Optional] BCCSP config for the client. Used by GO SDK.
8484
BCCSP:
8585
security:
8686
enabled: true
@@ -111,7 +111,7 @@ channels:
111111
# Default channel is used if channel configuration is missing or if defined channel configuration is missing info
112112
# If channel doesn't define peers then peers from default channel will be used
113113
# If channel doesn't define orderes then orderes from default channel will be used
114-
# If channel doesn't define policies then policies from default channel will be used.
114+
# If channel doesn't define policies then policies from default channel will be used.
115115
# Also, if channel defines policies and some policy info is missing than that missing info will be filled from default channel.
116116
_default:
117117

@@ -207,14 +207,14 @@ channels:
207207
# - Setting this value too low may cause the event client to disconnect/reconnect too frequently, thereby
208208
# affecting performance.
209209
reconnectBlockHeightLagThreshold: 8
210-
210+
211211
# [Optional] peerMonitorPeriod is the period in which the connected peer is monitored to see if
212212
# the event client should disconnect from it and reconnect to another peer.
213213
# Default: 0 (disabled) for Balanced resolverStrategy; 5s for PreferOrg and MinBlockHeight strategy
214214
peerMonitorPeriod: 6s
215215

216216

217-
#[Required if _default not defined; Optional if _default defined].
217+
#[Required if _default not defined; Optional if _default defined].
218218
# name of the channel
219219
mychannel:
220220

@@ -249,7 +249,7 @@ channels:
249249
# Default: true
250250
eventSource: true
251251

252-
252+
253253
#
254254
# list of participating organizations in this network
255255
#

test/fixtures/config/config_e2e_multiorg_bootstrap.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ client:
4242
# Specific to the underlying KeyValueStore that backs the crypto key store.
4343
path: /tmp/msp
4444

45-
# BCCSP config for the client. Used by GO SDK.
45+
# [Optional] BCCSP config for the client. Used by GO SDK.
4646
BCCSP:
4747
security:
4848
enabled: true
@@ -199,4 +199,4 @@ entityMatchers:
199199
- pattern: (\w+).org2.example.com:(\d+)
200200
urlSubstitutionExp: ${1}.org2.example.com:${2}
201201
sslTargetOverrideUrlSubstitutionExp: ${1}.org2.example.com
202-
mappedHost: peer0.org2.example.com
202+
mappedHost: peer0.org2.example.com

test/fixtures/config/config_e2e_no_orderer.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ client:
4444
# Specific to the underlying KeyValueStore that backs the crypto key store.
4545
path: /tmp/msp
4646

47-
# BCCSP config for the client. Used by GO SDK.
47+
# [Optional] BCCSP config for the client. Used by GO SDK.
4848
BCCSP:
4949
security:
5050
enabled: true

test/fixtures/config/config_e2e_pkcs11.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ client:
3939
# Specific to the underlying KeyValueStore that backs the crypto key store.
4040
path: /tmp/msp
4141

42-
# BCCSP config for the client. Used by GO SDK.
42+
# [Optional] BCCSP config for the client. Used by GO SDK.
4343
BCCSP:
4444
security:
4545
enabled: true

test/fixtures/config/config_e2e_single_org.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ client:
8080
# Specific to the underlying KeyValueStore that backs the crypto key store.
8181
path: /tmp/msp
8282

83-
# BCCSP config for the client. Used by GO SDK.
83+
# [Optional] BCCSP config for the client. Used by GO SDK.
8484
BCCSP:
8585
security:
8686
enabled: true

test/fixtures/config/config_test.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ client:
8181
# Specific to the underlying KeyValueStore that backs the crypto key store.
8282
path: /tmp/msp
8383

84-
# BCCSP config for the client. Used by GO SDK.
84+
# [Optional] BCCSP config for the client. Used by GO SDK.
8585
BCCSP:
8686
security:
8787
enabled: true
@@ -112,7 +112,7 @@ channels:
112112
# Default channel is used if channel configuration is missing or if defined channel configuration is missing info
113113
# If channel doesn't define peers then peers from default channel will be used
114114
# If channel doesn't define orderes then orderes from default channel will be used
115-
# If channel doesn't define policies then policies from default channel will be used.
115+
# If channel doesn't define policies then policies from default channel will be used.
116116
# Also, if channel defines policies and some policy info is missing than that missing info will be filled from default channel.
117117
_default:
118118

@@ -183,7 +183,7 @@ channels:
183183
maxBackoff: 5s
184184
#[Optional] he factor by which the initial back off period is exponentially incremented
185185
backoffFactor: 2.0
186-
186+
187187
#[Optional] options for the event service
188188
eventService:
189189
# [Optional] resolverStrategy specifies the peer resolver strategy to use when connecting to a peer

test/fixtures/config/config_test_crypto_bccsp.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ client:
3232
# Specific to the underlying KeyValueStore that backs the crypto key store.
3333
path: /tmp/msp
3434

35-
# BCCSP config for the client. Used by GO SDK.
35+
# [Optional] BCCSP config for the client. Used by GO SDK.
3636
BCCSP:
3737
security:
3838
enabled: true

test/fixtures/config/config_test_endpoints.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ client:
7171
# Specific to the underlying KeyValueStore that backs the crypto key store.
7272
path: /tmp/msp
7373

74-
# BCCSP config for the client. Used by GO SDK.
74+
# [Optional] BCCSP config for the client. Used by GO SDK.
7575
BCCSP:
7676
security:
7777
enabled: true
@@ -101,7 +101,7 @@ channels:
101101
# Default channel is used if channel configuration is missing or if defined channel configuration is missing info
102102
# If channel doesn't define peers then peers from default channel will be used
103103
# If channel doesn't define orderes then orderes from default channel will be used
104-
# If channel doesn't define policies then policies from default channel will be used.
104+
# If channel doesn't define policies then policies from default channel will be used.
105105
# Also, if channel defines policies and some policy info is missing than that missing info will be filled from default channel.
106106
_default:
107107
# Required. list of orderers designated by the application to use for transactions on this

test/fixtures/config/config_test_without_orderer.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ client:
4444
# Specific to the underlying KeyValueStore that backs the crypto key store.
4545
path: /tmp/msp
4646

47-
# BCCSP config for the client. Used by GO SDK.
47+
# [Optional] BCCSP config for the client. Used by GO SDK.
4848
BCCSP:
4949
security:
5050
enabled: true
@@ -75,7 +75,7 @@ channels:
7575
# Default channel is used if channel configuration is missing or if defined channel configuration is missing info
7676
# If channel doesn't define peers then peers from default channel will be used
7777
# If channel doesn't define orderes then orderes from default channel will be used
78-
# If channel doesn't define policies then policies from default channel will be used.
78+
# If channel doesn't define policies then policies from default channel will be used.
7979
# Also, if channel defines policies and some policy info is missing than that missing info will be filled from default channel.
8080
_default:
8181

@@ -146,7 +146,7 @@ channels:
146146
maxBackoff: 5s
147147
#[Optional] he factor by which the initial back off period is exponentially incremented
148148
backoffFactor: 2.0
149-
149+
150150
#[Optional] options for the event service
151151
eventService:
152152
# [Optional] resolverStrategy specifies the peer resolver strategy to use when connecting to a peer

0 commit comments

Comments
 (0)