diff --git a/README.md b/README.md index ab465c8..7d07fe1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This tutorial walks you through setting up Hyperledger Fabric the hard way. Ther - Fabric 2.4.3 ## Labs -This lab required you to have understanding & installed system of Vagrant & Virtualbox +This lab requires you to have an understanding of, and have installed, both Vagrant and Virtualbox. - [Provisioning Infrastructure](docs/00-infrastructure.md) - [Installing prerequisites tools](docs/01-prerequisites.md) - [Setup Certificate Authority](docs/02-setup-ca.md) @@ -20,7 +20,7 @@ This lab required you to have understanding & installed system of Vagrant & Virt - [Setup & Testing Chaincode](docs/08-setup-chaincode.md) ## Architecture -There are 3 organizations in this tutorial, all of this organizations will join channel called QRIS. +There are three organizations in this tutorial, all of which will join a channel called 'QRIS'. - BI (Bank Indonesia), will host 3 Orderer services - GoPay, will host 2 peer services - DANA, will host 2 peer services diff --git a/docs/00-infrastructure.md b/docs/00-infrastructure.md index 2004d9a..80d4f99 100644 --- a/docs/00-infrastructure.md +++ b/docs/00-infrastructure.md @@ -5,13 +5,13 @@ First, we need to bring up the infrastructure. Clone this repository git clone https://github.com/zufardhiyaulhaq/hyperledger-fabric-the-hard-way.git ``` -Go to docs directory and start the VM +Navigate to the docs directory and start the Virtual Machine (VM) ```shell cd hyperledger-fabric-the-hard-way/docs vagrant up ``` -You can see severals VM +You can then check the status of various VMs ```shell vagrant status ==> vagrant: A new version of Vagrant is available: 2.2.19 (installed version: 2.2.9)! @@ -35,7 +35,7 @@ above with their current state. For more information about a specific VM, run `vagrant status NAME`. ``` -To access the VM, you can just simply use `vagrant ssh`, for example +To access a VM, you can simply use vagrant ssh. Here's an example: ```shell vagrant ssh payments-ca-server-0 ``` diff --git a/docs/01-prerequisites.md b/docs/01-prerequisites.md index ed63f80..5d182e5 100644 --- a/docs/01-prerequisites.md +++ b/docs/01-prerequisites.md @@ -1,5 +1,5 @@ # Prerequisites -There several different orerequisites for each organizations. You can check this for each organizations: +There are several different prerequisites for each organization. You can check these for each respective organization: - [BI](01-prerequisites/bi.md) - [Dana](01-prerequisites/dana.md) - [GoPay](01-prerequisites/gopay.md) diff --git a/docs/01-prerequisites/bi.md b/docs/01-prerequisites/bi.md index 13ee68c..574f59c 100644 --- a/docs/01-prerequisites/bi.md +++ b/docs/01-prerequisites/bi.md @@ -1,8 +1,8 @@ # Prerequisites -There several different prerequisites for different ledger subsystem. +There are several different prerequisites depending on the ledger subsystem. # CA server -ssh to the nodes +ssh into the nodes ```shell vagrant ssh bi-ca-server-0 ``` @@ -34,7 +34,8 @@ rm -rf config/ rm -rf hyperledger-fabric-linux-amd64-2.4.3.tar.gz ``` -install Docker & docker-compose, this is used to run postgresql that is used by Fabric CA server +Install Docker & Docker-compose, which are used to run PostgreSQL, required by the Fabric CA server. + ``` sudo apt-get install \ ca-certificates \ @@ -71,7 +72,7 @@ vagrant ssh bi-orderer-1 vagrant ssh bi-orderer-2 ``` -Install Hyperledger Fabric CA binary, this is used to communicate with Fabric CA server that Bank Indonesia managed. +Install the Hyperledger Fabric CA binary, which is used to communicate with the Fabric CA server managed by Bank Indonesia. ```shell wget https://github.com/hyperledger/fabric-ca/releases/download/v1.5.2/hyperledger-fabric-ca-linux-amd64-1.5.2.tar.gz tar xzvf hyperledger-fabric-ca-linux-amd64-1.5.2.tar.gz @@ -81,7 +82,7 @@ rm -rf bin/ rm -rf hyperledger-fabric-ca-linux-amd64-1.5.2.tar.gz ``` -Install Hyperledger Fabric binary, this is used to run orderer service. +Install the Hyperledger Fabric binary, which is used to run the orderer service. ``` wget https://github.com/hyperledger/fabric/releases/download/v2.4.3/hyperledger-fabric-linux-amd64-2.4.3.tar.gz tar xzvf hyperledger-fabric-linux-amd64-2.4.3.tar.gz diff --git a/docs/01-prerequisites/dana.md b/docs/01-prerequisites/dana.md index 60793f2..3280d78 100644 --- a/docs/01-prerequisites/dana.md +++ b/docs/01-prerequisites/dana.md @@ -1,20 +1,20 @@ # Prerequisites -There several different prerequisites for different ledger subsystem. +Different ledger subsystems have several distinct prerequisites. # CA server -ssh to the nodes +ssh into the nodes ```shell vagrant ssh dana-ca-server-0 ``` -Install step certificate binary, this is used to generate certificate authority on DANA organization. +Install the Step Certificate binary, which is used to generate a Certificate Authority for the DANA organization. ```shell wget https://dl.step.sm/gh-release/cli/docs-cli-install/v0.18.2/step-cli_0.18.2_amd64.deb sudo dpkg -i step-cli_0.18.2_amd64.deb rm -rf step-cli_0.18.2_amd64.deb ``` -Install Hyperledger Fabric CA binary, this is used to run Fabric CA server that serve creation of certificate under DANA organization. +Install the Hyperledger Fabric CA binary, used to run the Fabric CA server. This server manages the creation of certificates for the DANA organization. ```shell wget https://github.com/hyperledger/fabric-ca/releases/download/v1.5.2/hyperledger-fabric-ca-linux-amd64-1.5.2.tar.gz tar xzvf hyperledger-fabric-ca-linux-amd64-1.5.2.tar.gz @@ -24,7 +24,7 @@ rm -rf bin/ rm -rf hyperledger-fabric-ca-linux-amd64-1.5.2.tar.gz ``` -install Docker & docker-compose, this is used to run postgresql that is used by Fabric CA server +Install Docker & docker-compose. These are used to run PostgreSQL, which is utilized by the Fabric CA server ``` sudo apt-get install \ ca-certificates \ @@ -41,7 +41,8 @@ sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker- sudo chmod +x /usr/local/bin/docker-compose ``` -For simplicity to distribute the TLS CA certificate later, we can simply add CA server public key to peer nodes that managed by DANA. +To simplify the distribution of the TLS CA certificate later, we can add the CA server public key to peer nodes managed by DANA. + ```shell ssh-keygen @@ -51,14 +52,14 @@ sshpass -p "vagrant" ssh-copy-id -o StrictHostKeyChecking=no vagrant@10.250.252. ``` # Peer -for each peer nodes, do this following things +For each peer node, execute the following steps: ```shell vagrant ssh dana-peer-0 vagrant ssh dana-peer-1 ``` -Install Hyperledger Fabric CA binary, this is used to communicate with Fabric CA server that DANA managed. +Install the Hyperledger Fabric CA binary. This is used for communication with the Fabric CA server managed by DANA. ```shell wget https://github.com/hyperledger/fabric-ca/releases/download/v1.5.2/hyperledger-fabric-ca-linux-amd64-1.5.2.tar.gz tar xzvf hyperledger-fabric-ca-linux-amd64-1.5.2.tar.gz diff --git a/docs/02-setup-ca.md b/docs/02-setup-ca.md index 206d110..743f182 100644 --- a/docs/02-setup-ca.md +++ b/docs/02-setup-ca.md @@ -1,5 +1,5 @@ # Setup Root & Intermediate CA -Setup Root and Intermediate CA for each organizations, we don't use single Root CA since it's different organization at all: +Set up a Root and Intermediate CA for each organization. We don't use a single Root CA, as these are all distinct organizations: - [BI](02-setup-ca/bi.md) - [Dana](02-setup-ca/dana.md) - [GoPay](02-setup-ca/gopay.md)