Skip to content

Commit d484313

Browse files
Merge pull request #2621 from suvajit-sarkar/develop
chore: merged changes from main to develop
2 parents da424e4 + 09b5437 commit d484313

File tree

13 files changed

+45
-28
lines changed

13 files changed

+45
-28
lines changed

docs/source/guides/besu/add-new-member-org.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This guide explains how to add a new validator node to an existing organization
2727

2828
1. **Update network.yaml file**
2929

30-
Refer [this guide](../networkyaml-besu.md) for details on editing the configuration file.
30+
Make sure that the genesis file is provided in base64 encoding. Also, if you are adding node to the same cluster as of another node, make sure that you add the ambassador ports of the existing node present in the cluster to the network.yaml
3131

3232
The `network.yaml` file should contain the specific `network.organization` details along with the enode information, genesis file in base64 encoding and tessera transaction manager details
3333

docs/source/guides/besu/add-new-validator-node.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,25 @@ This guide explains how to add a new validator node to an existing organization
1717

1818
To add a new node in Besu, an existing besu network should be running, enode information of all existing nodes present in the network should be available, genesis file should be available in base64 encoding and the information of transaction manager nodes and existing validator nodes should be available. The new node account should be unlocked prior adding the new node to the existing besu network.
1919

20-
---
21-
**NOTE**: Addition of a new validator node has been tested on an existing network which is created by Bevel. Networks created using other methods may be suitable but this has not been tested by Bevel team.
20+
The `network.yaml` file should contain the specific `network.organization` details along with the tessera transaction manager node details and existing validator and member node details.
21+
22+
---
23+
**NOTE**: Make sure that the genesis file is provided in base64 encoding. Also, if you are adding node to the same cluster as of another node, make sure that you add the ambassador ports of the existing node present in the cluster to the network.yaml
24+
25+
---
26+
For reference, sample `network-besu-new-validatornode.yaml` file [here](https://github.com/hyperledger/bevel/blob/main/platforms/hyperledger-besu/configuration/samples/network-besu-new-validatornode.yaml)
27+
28+
```yaml
29+
--8<-- "platforms/hyperledger-besu/configuration/samples/network-besu-new-validatornode.yaml:1:201"
30+
```
31+
32+
Three new sections are added to the network.yaml
33+
34+
| Field | Description |
35+
|-------------|----------------------------------------------------------|
36+
| tm_nodes | Existing network's transaction manager nodes' public addresses with nodeport.|
37+
| besu_nodes | Existing network's besu nodes' public addresses with rpc port.|
38+
| genesis | Path to existing network's genesis.json in base64.|
2239

2340

2441
1. **Update configuration file**

docs/source/guides/besu/add-new-validator-org.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Refer [this guide](../networkyaml-besu.md) for details on editing the configurat
2727
The `network.yaml` file should contain the specific `network.organization` details along with the transaction manager node details and existing validator and member node details.
2828

2929
---
30-
**NOTE**: Make sure that the genesis flie is provided in base64 encoding. Also, if you are adding node to the same cluster as of another node, make sure that you add the ambassador ports of the existing node present in the cluster to the network.yaml
30+
**NOTE**: Make sure that the genesis file is provided in base64 encoding. Also, if you are adding node to the same cluster as of another node, make sure that you add the ambassador ports of the existing node present in the cluster to the network.yaml
3131

3232
---
3333
For reference, sample `network-besu-new-validatororg.yaml` file [here](https://github.com/hyperledger/bevel/blob/main/platforms/hyperledger-besu/configuration/samples/network-besu-new-validatororg.yaml)

docs/source/guides/networkyaml-besu.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Although, the file itself has comments for each key-value, here is a more detail
3939
The sections in the sample configuration file are
4040
<a name="type"></a>
4141
type
42-
: `type` defines the platform choice like corda/fabric/indy/quorum/besu, here in the example its **besu**.
42+
: `type` defines the platform choice like corda/fabric/indy/quorum/besu, here in the example it's **besu**.
4343

4444
<a name="version"></a>
4545
version
@@ -55,7 +55,7 @@ permissioning
5555

5656
<a name="env"></a>
5757
env
58-
: `env` section contains the environment type and additional (other than 443) Ambassador port configuration. Vaule for proxy field under this section can be 'ambassador' as 'haproxy' has not been implemented for Besu.
58+
: `env` section contains the environment type and additional (other than 443) Ambassador port configuration. Value for proxy field under this section can be 'ambassador' as 'haproxy' has not been implemented for Besu.
5959

6060
The snippet of the `env` section with example value is below
6161

@@ -70,7 +70,7 @@ The fields under `env` section are
7070
| type | Environment type. Can be like dev/test/prod.|
7171
| proxy | Choice of the Cluster Ingress controller. Currently supports 'ambassador' only as 'haproxy' has not been implemented for Hyperledger Besu |
7272
| ambassadorPorts | Any additional Ambassador ports can be given here. This is only valid if `proxy: ambassador`. These ports are enabled per cluster, so if you have multiple clusters you do not need so many ports to be opened on Ambassador. Our sample uses a single cluster, so we have to open 4 ports for each Node. These ports are again specified in the `organization` section. |
73-
| loadBalancerSourceRanges | (Optional) Restrict inbound access to a single or list of IP adresses for the public Ambassador ports to enhance Bevel network security. This is only valid if `proxy: ambassador`. |
73+
| loadBalancerSourceRanges | (Optional) Restrict inbound access to a single or list of IP addresses for the public Ambassador ports to enhance Bevel network security. This is only valid if `proxy: ambassador`. |
7474
| retry_count | Retry count for the checks. Use a high number if your cluster is slow. |
7575
|external_dns | If the cluster has the external DNS service, this has to be set `enabled` so that the hosted zone is automatically updated. |
7676
| namespace | (Optional) K8s Namespace on which proxy will be installed. Default value is `default`|
@@ -206,7 +206,7 @@ The fields under `peer` service are
206206
| tm_nodeport.ambassador | The tm port when exposed on ambassador service. |
207207
| tm_clientport.port | Client Port used by Transaction manager `tessera`. This is the port where Besu nodes connect to their respective transaction manager. |
208208

209-
The peer in an organization with type as `member` can be used to deploy the smarcontracts with additional field `peer.smart_contract`. The snapshot of peers service with example values is below
209+
The peer in an organization with type as `member` can be used to deploy the smartcontracts with additional field `peer.smart_contract`. The snapshot of peers service with example values is below
210210
```yaml
211211
peers:
212212
- peer:
@@ -246,7 +246,7 @@ The additional fields under `peer` service are
246246
| smart_contract.contract_path | Path of the smart contract folder relative to deployjs_path |
247247
| smart_contract.iterations | Number of Iteration of executions for which the gas and the code is optimised |
248248
| smart_contract.entrypoint | Main entrypoint solidity file of the smart contract |
249-
| smart_contract.private_for | Comma seperated string of `tessera` Public keys for the `privateFor` |
249+
| smart_contract.private_for | Comma separated string of `tessera` Public keys for the `privateFor` |
250250

251251
Each organization with type as `validator` will have a validator service. The snippet of validator service with example values is below
252252
```yaml

docs/source/guides/networkyaml-fabric.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Use this [sample configuration file](https://github.com/hyperledger/bevel/blob/m
4646

4747
<a name="type"></a>
4848
type
49-
: `type` defines the platform choice like corda/fabric/quorum, here in the example its **Fabric**.
49+
: `type` defines the platform choice like corda/fabric/quorum, here in the example it's **Fabric**.
5050

5151
<a name="version"></a>
5252
version
@@ -162,7 +162,7 @@ Each `organization` field under `participants` field of the channel contains the
162162
|---------------------------------|------------------------------------------------------------|
163163
| name | Organization name of the peer participating in the channel |
164164
| type | This field can be creator/joiner of channel |
165-
| org_status | `new` (for inital setup) or `existing` (for add new org) |
165+
| org_status | `new` (for initial setup) or `existing` (for add new org) |
166166
| ordererAddress | URL of the orderer this peer connects to, including port |
167167
| peer.name | Name of the peer |
168168
| peer.type | Type can be `anchor` and `nonanchor` for Peer |
@@ -202,15 +202,15 @@ Each `organization` under the `organizations` section has the following fields.
202202
| location | Location of the organization |
203203
| subject | Subject format can be referred at [OpenSSL Subject](https://www.openssl.org/docs/man1.0.2/man1/openssl-req.html) |
204204
| external_url_suffix | Public url suffix of the cluster. |
205-
| org_status | `new` (for inital setup) or `existing` (for add new org) |
205+
| org_status | `new` (for initial setup) or `existing` (for add new org) |
206206
| orderer_org | Ordering service provider. |
207207
| ca_data | Contains the certificate path; this has not been implemented yet |
208208
| cloud_provider | Cloud provider of the Kubernetes cluster for this organization. This field can be aws, azure, gcp or minikube |
209209
| aws | When the organization cluster is on AWS |
210210
| k8s | Kubernetes cluster deployment variables.|
211211
| vault | Contains Hashicorp Vault server address and root-token in the example |
212212
| gitops | Git Repo details which will be used by GitOps/Flux. |
213-
| services | Contains list of services which could ca/peer/orderers/concensus based on the type of organization |
213+
| services | Contains list of services which could ca/peer/orderers/consensus based on the type of organization |
214214

215215
For the aws and k8s field the snapshot with sample values is below
216216

@@ -273,7 +273,7 @@ The fields under `user` are
273273
| Field | Description |
274274
|-------------|----------------------------------------------------------|
275275
| identity | The name of the user |
276-
| attribute | key value pair for the different attributes supported in Fabric, details about the attribues are [here](https://hyperledger-fabric-ca.readthedocs.io/en/latest/users-guide.html#attribute-based-access-control) |
276+
| attribute | key value pair for the different attributes supported in Fabric, details about the attributes are [here](https://hyperledger-fabric-ca.readthedocs.io/en/latest/users-guide.html#attribute-based-access-control) |
277277

278278

279279
The services field for each organization under `organizations` section of Fabric contains list of `services` which could be ca/orderers/consensus/peers based on if the type of organization.
@@ -341,7 +341,7 @@ The chaincodes section contains the list of chaincode for the peer, the fields u
341341
| image | Mandatory for external_chaincode, the container from docker registry applicable for this chaincode. For private registry, ensure password is passed in `network.docker` section |
342342
| crypto_mount_path | Required only when `tls: true`, the path where the crypto materials will be stored |
343343

344-
The organization with orderer type will have concensus service. The snapshot of consensus service with example values is below
344+
The organization with orderer type will have consensus service. The snapshot of consensus service with example values is below
345345

346346
```yaml
347347
--8<-- "platforms/hyperledger-fabric/configuration/samples/network-fabricv2.yaml:228:229"

docs/source/guides/networkyaml-quorum.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The sections in the sample configuration file are
4141

4242
<a name="type"></a>
4343
type
44-
: `type` defines the platform choice like corda/fabric/indy/quorum, here in the example its **quorum**.
44+
: `type` defines the platform choice like corda/fabric/indy/quorum, here in the example it's **quorum**.
4545

4646
<a name="version"></a>
4747
version
@@ -53,7 +53,7 @@ version
5353

5454
<a name="env"></a>
5555
env
56-
: `env` section contains the environment type and additional (other than 443) Ambassador port configuration. Vaule for proxy field under this section can be 'ambassador' or 'haproxy'
56+
: `env` section contains the environment type and additional (other than 443) Ambassador port configuration. Value for proxy field under this section can be 'ambassador' or 'haproxy'
5757

5858
The snippet of the `env` section with example value is below
5959

@@ -68,7 +68,7 @@ The fields under `env` section are
6868
| type | Environment type. Can be like dev/test/prod.|
6969
| proxy | Choice of the Cluster Ingress controller. Currently supports 'ambassador' only as 'haproxy' has not been implemented for Quorum |
7070
| ambassadorPorts | Any additional Ambassador ports can be given here. This is only valid if `proxy: ambassador`. These ports are enabled per cluster, so if you have multiple clusters you do not need so many ports to be opened on Ambassador. Our sample uses a single cluster, so we have to open 4 ports for each Node. These ports are again specified in the `organization` section. |
71-
| loadBalancerSourceRanges | Restrict inbound access to a single or list of IP adresses for the public Ambassador ports to enhance Bevel network security. This is only valid if `proxy: ambassador`. |
71+
| loadBalancerSourceRanges | Restrict inbound access to a single or list of IP addresses for the public Ambassador ports to enhance Bevel network security. This is only valid if `proxy: ambassador`. |
7272
| retry_count | Retry count for the checks. Use a high number if your cluster is slow. |
7373
|external_dns | If the cluster has the external DNS service, this has to be set `enabled` so that the hosted zone is automatically updated. |
7474

@@ -136,7 +136,7 @@ Each `organization` under the `organizations` section has the following fields.
136136
| k8s | Kubernetes cluster deployment variables.|
137137
| vault | Contains Hashicorp Vault server address and root-token in the example |
138138
| gitops | Git Repo details which will be used by GitOps/Flux. |
139-
| services | Contains list of services which could ca/peer/orderers/concensus based on the type of organization |
139+
| services | Contains list of services which could ca/peer/orderers/consensus based on the type of organization |
140140

141141
For the `aws` `vault` and `k8s` field the snippet with sample values is below
142142
```yaml

docs/source/guides/networkyaml-substrate.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Use this [sample configuration file](https://github.com/hyperledger/bevel/blob/m
4040
<a name="type"></a>
4141

4242
## type
43-
- `type` defines the platform choice like corda/fabric/indy/substrate, here in the example its **substrate**.
43+
- `type` defines the platform choice like corda/fabric/indy/substrate, here in the example it's **substrate**.
4444

4545
<a name="version"></a>
4646

@@ -135,7 +135,7 @@ The `organization` under the `organizations` section has the following fields.
135135
| k8s | Kubernetes cluster deployment variables.|
136136
| vault | Contains Hashicorp Vault server address and root-token in the example |
137137
| gitops | Git Repo details which will be used by GitOps/Flux. |
138-
| services | Contains list of services which could ca/peer/orderers/concensus based on the type of organization |
138+
| services | Contains list of services which could ca/peer/orderers/consensus based on the type of organization |
139139

140140
For the `aws`, `k8s` and `vault` field the snapshot with sample values is below
141141

platforms/hyperledger-besu/charts/besu-node/requirements.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ dependencies:
1010
repository: "file://../besu-tessera-node"
1111
tags:
1212
- tessera
13-
version: ~1.0.0
13+
version: ~1.1.0
1414
condition: tessera.enabled
1515
- name: besu-tlscert-gen
1616
alias: tls
1717
repository: "file://../besu-tlscert-gen"
1818
tags:
1919
- bevel
20-
version: ~1.0.0
20+
version: ~1.1.0
2121
condition: tls.enabled

platforms/hyperledger-indy/charts/indy-node/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
apiVersion: v1
77
name: indy-node
88
description: Hyperledger Indy nodes for a SSI network
9-
version: 1.0.1
9+
version: 1.1.0
1010
appVersion: latest
1111
keywords:
1212
- bevel

platforms/substrate/charts/dscp-ipfs-node/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ apiVersion: v2
88
name: dscp-ipfs-node
99
appVersion: '2.6.1'
1010
description: dscp-ipfs is a component of the DSCP project that provides a distributed IPFS based storage solution for the DSCP platform.
11-
version: 1.0.0
11+
version: 1.1.0
1212
type: application
1313
annotations:
1414
hyperledger-bevel/platform: substrate

platforms/substrate/charts/substrate-genesis/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ apiVersion: v2
99
name: substrate-genesis
1010
description: A Helm chart to generate the genesis for Substrate Nodes
1111
type: application
12-
version: 1.0.0
12+
version: 1.1.0
1313
appVersion: latest
1414
keywords:
1515
- bevel

platforms/substrate/charts/substrate-key-mgmt/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ apiVersion: v2
77
name: substrate-key-mgmt
88
appVersion: 'latest'
99
description: A Helm chart to generate the keys for Substrate Nodes
10-
version: 1.0.0
10+
version: 1.1.0
1111
type: application
1212
annotations:
1313
hyperledger-bevel/platform: substrate

platforms/substrate/charts/substrate-node/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ apiVersion: v2
88
name: substrate-node
99
description: A Helm chart to deploy Substrate/Polkadot nodes
1010
type: application
11-
version: 1.0.0
11+
version: 1.1.0
1212
appVersion: latest
1313
keywords:
1414
- bevel

0 commit comments

Comments
 (0)