Skip to content

Latest commit

 

History

History
202 lines (144 loc) · 6.45 KB

README.md

File metadata and controls

202 lines (144 loc) · 6.45 KB
Raw

Fabric Operations Console

The console provides the following high level function:

  • Ability to import and manage all Hyperledger Fabric Components from a single web console, no matter where they are located.
  • Maintain complete control over identities, channels, and smart contracts.
  • Join Peers to Channels and view channel membership as well as individual transactions and channel details.
  • Register, view, delete, and re-enroll CA Users.
  • View Ordering cluster and node information as well as view and modify consortium and channel membership.
  • View and modify channel capabilities and ordering service parameters.
  • Install and Instantiate chaincode. Supports both 1.x and 2.x Lifecycle.
  • View, Create, Import and Export Organizations and Identities.
  • Role Based Access Control in UI to tightly control which Console users can perform which operations.

The console relies on GRPC web to allow GRPC based communication with Orderers and Peers via Node.js. Management of Certificate Authorities is done via REST API and does not require a GRPC Web Instance.

For more Information see the documentation for the current IBM production offerings which are driven by the code in this Lab proposal.

High level architecture

High level architecture

Running Fabric Operations Console

You can use the following steps to provision a network using Fabric test-network, add grpc-web proxy on that of that and import components into Console so that you can manage the test network.

Prerequisites

  • zip
  • jq
  • docker
  • docker-compose
  • WSL2 (Windows only)

Setup

Clone console

git clone https://github.com/hyperledger-labs/fabric-operations-console

cd fabric-operations-console

Bring up a Fabric 2.2.3 network

You can find more information on the test network setup from here https://hyperledger-fabric.readthedocs.io/en/latest/test_network.html

./scripts/setupNetwork.sh up

Bring up console

./scripts/setupConsole.sh up

Create zip file

Run the following command to create a zip of the console JSONs to match the network setup above

./scripts/createAssets.sh

Console setup

Import components into console

  • Switch to "Settings" page 
  • Click "Import"
  • Select zip file ./workarea/console_assets.zip

Create Identities

  • Switch to Nodes page and perform the following steps

ordererca

  • Select CA "ordererca-local"
  • Associate Identity
  • Enter admin/adminpw for enroll id and secret
  • Select the overflow menu (3 dots) against "ordererAdmin"
  • Select "Enroll identity"
  • Enter "ordererAdminpw" for Enroll secret
  • Next
  • Enter identity display name as "OrdererMSP Admin"
  • Click "Add Identity to wallet"

org1ca

  • Select CA "org1ca-local"
  • Associate Identity
  • Enter admin/adminpw for enroll id and secret
  • Select the overflow menu (3 dots) against "org1admin"
  • Select "Enroll identity"
  • Enter "org1adminpw" for Enroll secret
  • Next
  • Enter identity display name as "Org1MSP Admin"
  • Click "Add Identity to wallet"

org2ca

  • Select CA "org2ca-local"
  • Associate Identity
  • Enter admin/adminpw for enroll id and secret
  • Select the overflow menu (3 dots) against "org2admin"
  • Select "Enroll identity"
  • Enter "org2adminpw" for Enroll secret
  • Next
  • Enter identity display name as "Org2MSP Admin"
  • Click "Add Identity to wallet"

Associate Identity

  • Switch to Nodes page and perform the following steps

  • Select peer "org1_peer1 - local"

  • Associate Identity

  • Select "Org1MSP Admin"

  • Select peer "org2_peer1 - local"

  • Associate Identity

  • Select "Org2MSP Admin"

  • Select orderer "orderer_local"

  • Associate Identity

  • Select "OrdererMSP Admin"

Enjoy!

You should be able to manage channels, Using 2.0 lifecycle to install, approve, commit smart contracts following the guide

Bring down network

./scripts/setupConsole.sh down

./scripts/setupNetwork.sh down

couchdb credentials (for console)

Developing Fabric Operations Console

This repository is managed using Lerna.

It contains the following applications:

  • packages/apollo: Frontend React.js for the console
  • packages/athena: Backend server for the console
  • packages/stitch:

To run commands in this repository, install lerna:

npm install -g lerna

For more information, see the documentation at: https://lerna.js.org/

Install

lerna bootstrap

Note: You can use lerna clean && lerna bootstrap to delete existing node_modules before lerna runs npm install.

Usage

Developing Athena

Builds Apollo and starts the file watcher for Athena.

Before running, ensure that you have the necessary local env files in the packages/athena/env directory. See the athena readme for all the details on what these files should contain.

lerna run dev:athena

Developing Apollo

Starts Apollo and Athena in dev mode. Apollo proxies its backend requests to Athena.

lerna run build_all
lerna run dev:apollo

Note: even though this command is for running Apollo in dev mode, Athena still needs a production build of Apollo to start. If this command fails, it's likely because there is no Apollo build present.

Run tests

lerna run test

Build your own docker images (for console and grpc-web proxy)

Ensure that the docker has enough resources to be able to build the images. We recommend 2 CPUs and 4 GB RAM available to build.

./scripts/buildImages.sh

If you do not have enough memory allocated to docker, the following command will fail with out of memory error similar to the below.

#16 109.5 The build failed because the process exited too early. This probably means the system ran out of memory or someone called `kill -9` on the process.

Notes:

  • When making a Git commit, a pre-commit Git hook will call lerna run lint.
  • When pushing to Git, a pre-push Git hook that calls detect-secrets-hook will be run. To install this utility you'll need Python 3.x and pip. Once installed, run the following command from the root directory:
npm run install-detect-secrets