Skip to content

Commit b3d0462

Browse files
committed
HLF Deployment Helper for K8s
0 parents  commit b3d0462

File tree

114 files changed

+8874
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+8874
-0
lines changed

.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Binaries for programs and plugins
2+
*.exe
3+
*.exe~
4+
*.dll
5+
*.so
6+
*.dylib
7+
8+
# Test binary, build with `go test -c`
9+
*.test
10+
11+
# Output of the go coverage tool, specifically when used with LiteIDE
12+
*.out
13+
**/.DS_Store

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Contributing
2+
3+
We welcome contributions to the Hyperledger Fabric Deployment Helper in many forms, and
4+
there's always plenty to do!
5+
6+
You are free to raise new feature requests or contribute a new feature or take up existing "good first issues" using the issues tab of the repository.

LICENSE

Lines changed: 674 additions & 0 deletions
Large diffs are not rendered by default.

MAINTAINERS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Maintainers
2+
===========
3+
4+
**Active Maintainers**
5+
6+
| Name | GitHub | email
7+
|------|--------|----------------------
8+
| Tittu Varghese | [tittuvarghese][tittuvarghese] | tittu.varghese[@]npci.org.in
9+
| Jithin D | [jithindevasia][jithindevasia] | jithin.devasia_inf[@]npci.org.in
10+
| Siddharth M | [siddharthmakwana][siddharthmakwana] | siddharth.m_inf[@]npci.org.in
11+
12+
13+
[tittuvarghese]: https://github.com/tittuvarghese
14+
[jithindevasia]: https://github.com/jithindevasia
15+
[siddharthmakwana]: https://github.com/siddharthmakwana
16+
17+
18+
For any support please reachout to opensource[@]npci.org.in

OSSMETADATA

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
osslifecycle=active

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
## Hyperledger Fabric Deployment Helper for Kubernetes
2+
3+
[![NPCIOSS Lifecycle](https://img.shields.io/badge/oss_lifecyce-active-green)](OSSMETADATA)
4+
[![HELM VERSION](https://img.shields.io/badge/helm_version-v3.10.1-blue)]()
5+
6+
[![HLF DEPLOYMENT HELPER](images/hlf-deployment-helper.png)]()
7+
8+
The Hyperledger Fabric Deployment Helper for Kubernetes is an open-source project designed to streamline the deployment and management of Hyperledger Fabric based blockchain networks on Kubernetes clusters. This tool simplifies the complex process of setting up, configuring, and maintaining Fabric nodes, peers, orderers, and channels within a Kubernetes environment. With templatised helm charts and customizable configuration options, the project empowers developers and administrators to effortlessly deploy and scale secure and robust Hyperledger Fabric networks, leveraging the flexibility and scalability of Kubernetes orchestration.
9+
10+
Whether you're a blockchain enthusiast, developer, or enterprise seeking to harness the power of distributed ledger technology using Hyperledger Fabric, the deployment helper for Kubernetes is your go-to solution for efficient, reliable, and automated Fabric network deployment.
11+
12+
`We are open for contributions, upgrades and features, please feel free to pickup any "good first issues" or propose new features to make the utility more powerful.`
13+
14+
### Features
15+
- [x] CA Management (Root CA, TLS CA & Intermediate CAs)
16+
- [x] Peer Creation
17+
- [x] Orderer Creation
18+
- [x] Channel Management
19+
- [x] Chaincode Lifecycle Management (Install, Approve, Commit and CC Upgrades)
20+
- [x] Cryptographic operations support and certification management
21+
- [x] Domain Name support and SNI Based Routing
22+
- [x] Ingress resource provisioning
23+
- [x] File Registry support for centralised config files
24+
- [x] Support for Hyperledger Fabric 2.3+
25+
- [x] Multi-zone, Multi-DC, Private Network (On-prem DCs) deployment support
26+
27+
### Roadmap
28+
- [ ] Multi-channel support
29+
- [ ] Automatic certificate renewal
30+
- [ ] GUI based deployment support
31+
- [ ] Optional Fabric Explorer
32+
- [ ] Optional Fabric Operations Console
33+
- [ ] Observability stack
34+
- [ ] Key Management using HSM / Vault
35+
36+
### Releases
37+
- v1.0-beta
38+
39+
### Samples
40+
Please refer our [examples](examples/README.md) for running a complete blockchain network using the deployment helper.
41+
42+
### Production Readiness
43+
The Hyperledger Fabric Deployment Helper is utilised across multiple blockchain projects within NPCI.
44+
45+
### Disclaimer
46+
This program is free software: you can redistribute it and/or modify
47+
it under the terms of the GNU General Public License as published by
48+
the Free Software Foundation, either version 3 of the License, or
49+
(at your option) any later version.
50+
51+
This program is distributed in the hope that it will be useful,
52+
but WITHOUT ANY WARRANTY; without even the implied warranty of
53+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
54+
GNU General Public License for more details.
55+
56+
You should have received a copy of the GNU General Public License
57+
along with this program. If not, see <https://www.gnu.org/licenses/>.
58+
59+
### License
60+
Hyperledger Fabric Deployment Helper for Kubernetes source code files are made available under the GNU General Public License, Version 3.0 (GPL-3.0), located in the LICENSE file.

docker/Dockerfile-hlf-builder

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
FROM hyperledger/fabric-tools:2.4
2+
RUN apk add openssl curl curl-dev
3+
RUN wget https://github.com/hyperledger/fabric-ca/releases/download/v1.5.6/hyperledger-fabric-ca-linux-arm64-1.5.6.tar.gz
4+
RUN tar -xvzf hyperledger-fabric-ca-linux-arm64-1.5.6.tar.gz
5+
RUN mv bin/fabric-ca-client /usr/local/bin/fabric-ca-client
6+
RUN wget https://storage.googleapis.com/kubernetes-release/release/v1.23.10/bin/linux/amd64/kubectl \
7+
&& mv kubectl /usr/local/bin/ \
8+
&& chmod 755 /usr/local/bin/fabric-ca-client \
9+
&& chmod 755 /usr/local/bin/kubectl
10+

0 commit comments

Comments
 (0)