Deployer for Hyperledger Fabric networks onto Kubernetes
Project description
[![Known Vulnerabilities](https://snyk.io/test/github/aidtechnology/nephos/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/aidtechnology/nephos?targetFile=requirements.txt)
# nephos
Library to deploy Hyperledger Fabric projects to a Kubernetes cloud
[Prerequisites](#prerequisites)
- [Installation](#installation)
[Pip](#pip)
- [Git repository](#git-repository)
[Virtual environment](#virtual-environment)
[Requirements](#requirements)
- [Testing](#testing)
[Unit tests](#unit-tests)
[Usage](#usage)
## Prerequisites
This library requires an existing Kubernetes cluster.
For best results, use a real cluster (e.g. on a cloud like AWS, GCP, Azure, IBM Cloud, etc.). However, you may also use [Minikube](https://kubernetes.io/docs/setup/minikube/).
Either way, you will need to have the following tools installed:
[python 3.7.0](https://www.python.org/downloads/release/python-370/) or above
[kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
## Installation
### Pip
You can install nephos from PyPI by running:
pip install nephos
### Git repository
You can also download the git repository with:
And work locally by installing the following:
#### Virtual environment
This library currently only supports Python 3:
python3 -m venv ./venv
source ./venv/bin/activate
#### Requirements
All requirments are held in the requirements.txt file
pip install -r requirements.txt
## Testing
### Unit tests
Once you have all requirments installed, all the unit tests should pass:
PYTHONPATH=. pytest –cov=. –cov-report term-missing
## Usage
To use nephos, run the deploy.py executable CLI script.
For instance, you can see available commands/options by running:
./nephos/deploy.py –help
To install a full end-to-end fabric network, you can run:
./nephos/deploy.py -f ./PATH_TO_YOUR_SETTINGS/file.yaml fabric
You can also upgrade a network:
./nephos/deploy.py –upgrade -f ./PATH_TO_YOUR_SETTINGS/file.yaml fabric
> Example of development/production networks will be provided in future
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nephos-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 302e6c94bc385b6831008cec8bb226eb6e979bb0298177b7090e4626d0e04a97 |
|
MD5 | 938aec751af8e05a7a99f985a3f11ee0 |
|
BLAKE2b-256 | bb3692e31ddf3c5ef50479b70782300c072a357a6dcc3d97028a5206415a70e7 |