Skip to content

Commit 3be572e

Browse files
author
Kostas Christidis
committed
[FAB-8366] Fix wording on configtx YAML
This changeset fixes the comment for `SampleOrg.Name`. Everything else (proper hard-wrapping at 80 characters, small fixes here and there for consistency) is a freebie. Change-Id: Ic86f6f87350ef0e60702fe5c83f4d387b1de02cb Signed-off-by: Kostas Christidis <kostas@christidis.io>
1 parent 5dcaee8 commit 3be572e

File tree

1 file changed

+53
-51
lines changed

1 file changed

+53
-51
lines changed

sampleconfig/configtx.yaml

Lines changed: 53 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@
66
---
77
################################################################################
88
#
9-
# Profiles
9+
# PROFILES
1010
#
11-
# - Different configuration profiles may be encoded here to be specified
12-
# as parameters to the configtxgen tool. The profiles which specify consortiums
13-
# are to be used for generating the orderer genesis block. With the correct
11+
# Different configuration profiles may be encoded here to be specified as
12+
# parameters to the configtxgen tool. The profiles which specify consortiums
13+
# are to be used for generating the orderer genesis block. With the correct
1414
# consortium members defined in the orderer genesis block, channel creation
15-
# requests may be generated with only the org member names and a consortium name
15+
# requests may be generated with only the org member names and a consortium
16+
# name.
1617
#
1718
################################################################################
1819
Profiles:
@@ -59,9 +60,9 @@ Profiles:
5960
- <<: *SampleOrg
6061
AdminPrincipal: Role.MEMBER
6162

62-
# SampleDevModeSoloV1.1 mimics the SampleDevModeSolo definition
63-
# but additionally defines the v1.1 only capabilities which do
64-
# not allow a mixed v1.0.x v1.1.x network
63+
# SampleDevModeSoloV1.1 mimics the SampleDevModeSolo definition but
64+
# additionally defines the v1.1 only capabilities which do not allow a
65+
# mixed v1.0.x v1.1.x network.
6566
SampleDevModeSoloV1_1:
6667
Capabilities:
6768
<<: *ChannelCapabilities
@@ -105,9 +106,9 @@ Profiles:
105106
- <<: *SampleOrg
106107
AdminPrincipal: Role.MEMBER
107108

108-
# SampleDevModeKafkaV1_1 mimics the SampleDevModeKafka definition
109-
# but additionally defines the v1.1 only capabilities which do
110-
# not allow a mixed v1.0.x v1.1.x network
109+
# SampleDevModeKafkaV1_1 mimics the SampleDevModeKafka definition but
110+
# additionally defines the v1.1 only capabilities which do not allow a
111+
# mixed v1.0.x v1.1.x network.
111112
SampleDevModeKafkaV1_1:
112113
Capabilities:
113114
<<: *ChannelCapabilities
@@ -198,8 +199,8 @@ Profiles:
198199
Orderer:
199200
<<: *OrdererDefaults
200201

201-
# SampleEmptyInsecureChannel defines a channel with no members and therefore
202-
# no access control.
202+
# SampleEmptyInsecureChannel defines a channel with no members and
203+
# therefore no access control.
203204
SampleEmptyInsecureChannel:
204205
Consortium: SampleConsortium
205206
Application:
@@ -214,9 +215,9 @@ Profiles:
214215
Organizations:
215216
- *SampleOrg
216217

217-
# SampleSingleMSPChannelV1_1 defines a channel just as SampleSingleMSPChannel
218-
# However, it also defines the capabilities map which makes this channel
219-
# incompatible with v1.0.x peers.
218+
# SampleSingleMSPChannelV1_1 defines a channel just as
219+
# SampleSingleMSPChannel. However, it also defines the capabilities map which
220+
# makes this channel incompatible with v1.0.x peers.
220221
SampleSingleMSPChannelV1_1:
221222
Consortium: SampleConsortium
222223
Application:
@@ -227,22 +228,22 @@ Profiles:
227228

228229
################################################################################
229230
#
230-
# Section: Organizations
231+
# ORGANIZATIONS
231232
#
232-
# - This section defines the different organizational identities which will be
233-
# referenced later in the configuration.
233+
# This section defines the organizational identities that can be referenced
234+
# in the configuration profiles.
234235
#
235236
################################################################################
236237
Organizations:
237238

238239
# SampleOrg defines an MSP using the sampleconfig. It should never be used
239240
# in production but may be used as a template for other definitions.
240241
- &SampleOrg
241-
# DefaultOrg defines the organization which is used in the sampleconfig
242-
# of the fabric.git development environment.
242+
# Name is the key by which this org will be referenced in channel
243+
# configuration transactions.
243244
Name: SampleOrg
244245

245-
# ID to load the MSP definition as.
246+
# ID is the key by which this org's MSP definition will be referenced.
246247
ID: DEFAULT
247248

248249
# MSPDir is the filesystem path which contains the MSP configuration.
@@ -254,18 +255,18 @@ Organizations:
254255
# ADMIN and role type MEMBER respectively.
255256
AdminPrincipal: Role.ADMIN
256257

258+
# AnchorPeers defines the location of peers which can be used for
259+
# cross-org gossip communication. Note, this value is only encoded in
260+
# the genesis block in the Application section context.
257261
AnchorPeers:
258-
# AnchorPeers defines the location of peers which can be used for
259-
# cross-org gossip communication. Note, this value is only encoded
260-
# in the genesis block in the Application section context.
261262
- Host: 127.0.0.1
262263
Port: 7051
263264

264265
################################################################################
265266
#
266-
# SECTION: Orderer
267+
# ORDERER
267268
#
268-
# - This section defines the values to encode into a config transaction or
269+
# This section defines the values to encode into a config transaction or
269270
# genesis block for orderer related parameters.
270271
#
271272
################################################################################
@@ -290,12 +291,12 @@ Orderer: &OrdererDefaults
290291

291292
# Absolute Max Bytes: The absolute maximum number of bytes allowed for
292293
# the serialized messages in a batch. If the "kafka" OrdererType is
293-
# selected, set 'message.max.bytes' and 'replica.fetch.max.bytes' on the
294-
# Kafka brokers to a value that is larger than this one.
294+
# selected, set 'message.max.bytes' and 'replica.fetch.max.bytes' on
295+
# the Kafka brokers to a value that is larger than this one.
295296
AbsoluteMaxBytes: 10 MB
296297

297-
# Preferred Max Bytes: The preferred maximum number of bytes allowed for
298-
# the serialized messages in a batch. A message larger than the
298+
# Preferred Max Bytes: The preferred maximum number of bytes allowed
299+
# for the serialized messages in a batch. A message larger than the
299300
# preferred max bytes will result in a batch larger than preferred max
300301
# bytes.
301302
PreferredMaxBytes: 512 KB
@@ -313,29 +314,29 @@ Orderer: &OrdererDefaults
313314
- kafka1:9092
314315
- kafka2:9092
315316

316-
# Organizations is the list of orgs which are defined as participants on
317-
# the orderer side of the network.
317+
# Organizations lists the orgs participating on the orderer side of the
318+
# network.
318319
Organizations:
319320

320321
################################################################################
321322
#
322-
# SECTION: Application
323+
# APPLICATION
323324
#
324-
# - This section defines the values to encode into a config transaction or
325-
# genesis block for application related parameters.
325+
# This section defines the values to encode into a config transaction or
326+
# genesis block for application-related parameters.
326327
#
327328
################################################################################
328329
Application: &ApplicationDefaults
329330

330-
# Organizations is the list of orgs which are defined as participants on
331-
# the application side of the network.
331+
# Organizations lists the orgs participating on the application side of the
332+
# network.
332333
Organizations:
333334

334335
################################################################################
335336
#
336-
# SECTION: Capabilities
337+
# CAPABILITIES
337338
#
338-
# - This section defines the capabilities of fabric network. This is a new
339+
# This section defines the capabilities of fabric network. This is a new
339340
# concept as of v1.1.0 and should not be utilized in mixed networks with
340341
# v1.0.x peers and orderers. Capabilities define features which must be
341342
# present in a fabric binary for that binary to safely participate in the
@@ -370,9 +371,9 @@ Capabilities:
370371
# leave this flag set to true.
371372
V1_1: true
372373

373-
# Application capabilities apply only to the peer network, and may be safely
374-
# manipulated without concern for upgrading orderers. Set the value of the
375-
# capability to true to require it.
374+
# Application capabilities apply only to the peer network, and may be
375+
# safely manipulated without concern for upgrading orderers. Set the value
376+
# of the capability to true to require it.
376377
Application: &ApplicationCapabilities
377378
# V1.1 for Application is a catchall flag for behavior which has been
378379
# determined to be desired for all peers running v1.0.x, but the
@@ -384,14 +385,15 @@ Capabilities:
384385
# with experimental build tag. When set to true, private data
385386
# collections can be configured upon chaincode instantiation and
386387
# utilized within chaincode Invokes.
387-
# Note that use of this feature with non "experimental" binaries on
388-
# the network may cause a fork.
388+
# NOTE: Use of this feature with non "experimental" binaries on the
389+
# network may cause a fork.
389390
V1_1_PVTDATA_EXPERIMENTAL: false
390-
# V1_1_RESOURCETREE_EXPERIMENTAL is an Application capability to enable the
391-
# resources capability. Currently this is needed for defining resource based
392-
# access control (RBAC). RBAC helps set fine-grained access control on system
393-
# resources such as the endorser and various system chaincodes. Default is V1.0
394-
# based access control based on CHANNEL_READERS and CHANNEL_WRITERS
395-
# Note that use of this feature with non "experimental" binaries on
391+
# V1_1_RESOURCETREE_EXPERIMENTAL is an Application capability to enable
392+
# the resources capability. Currently this is needed for defining
393+
# resource-based access control (RBAC). RBAC helps set fine-grained
394+
# access control on system resources such as the endorser and various
395+
# system chaincodes. Default is v1.0-based access control based on
396+
# CHANNEL_READERS and CHANNEL_WRITERS.
397+
# NOTE: Use of this feature with non "experimental" binaries on
396398
# the network may cause a fork.
397399
V1_1_RESOURCETREE_EXPERIMENTAL: false

0 commit comments

Comments
 (0)