akc-mamba 2.0.1

A production ready, complete experience in deploying a Hyperledger Fabric

AKC-MAMBA manuals

1. Installation Instructions

a. Install AKC-Mamba

Install AKC-Mamba with

pip3 install akc-mamba

We now can use the Mamba tool to prepare required helm and k8s components

find . -type f -iname "*.sh" -exec chmod +x {} \;
mamba environment

Configuration parameters in ~/.akachain/akc-mamba/mamba/config/.env, the file content is pretty much self-explained.

b. Deploy and bootstrap network

mamba start

The mamba start command executes a series of sub commands that installs various network components. For more information on each command for individual components, please refer to help section

mamba --help

To terminate the network, just run

mamba terminate

2. Development Guide

2.1 Project structure

Mamba makes use of Click_, an elegant python package for creating command line interfaces. The project structure is depicted in the tree below.

.
├── command_group_1
│   ├── commands.py
│   ├── __init__.py
│
├── utils
│   ├── __init__.py
│   ├── kube.py
│
├── mamba.py
├── settings
├   ├──settings.py

There are 4 main components:

• mamba.py : The bootstrap instance module of Mamba
• settings/settings.py : Contains global variables that are shared accross all sub modules
• command_group : Each command group is separated into its own directory.
• utils : helper functions that must be initialized via settings.py

2.2 Coding Convention

Please follow PEP8 - Style guide for Python Code.

Another example can be found here

There are several notes that are different with other languages

Function names should be lowercase, with words separated by underscores as necessary to improve readability.

Camel case is for class name

2.3 Logging instruction

A snake must know how hiss ... or sometimes rattle.

Normally we can just use echo to print out message during execution However:

• It is mandatory to hiss when there is error
• also, rattle is needed when a snake meet something ... at the beginning or at the end of an execution.

For more information about logging, please follow the standard convention in mamba/utils/hiss.py