Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 3.13 KB

README.md

File metadata and controls

96 lines (64 loc) · 3.13 KB
Raw

Blockstax Containers

Overview

Blockstax-Containers is an open-source project by Nimbostack that provides Melange and Apko declarations for building container images for Permissioned Blockchain Network projects. While our long-term goal is to support multiple Blockchain projects, we currently focus on Hyperledger Fabric components. This project aims to simplify and standardize the process of creating container images for all the required images to create your network.

🌟 Features

  • Reproducible Builds: Consistent environments across deployments
  • Enhanced Security: Built-in best practices from the ground up
  • Customizable: Easily modify build declarations for your needs
  • Community-Driven: Open-source collaboration for continuous improvement
  • No Dockerfiles: Eliminates the need for maintaining complex Dockerfiles

📁 Repository Structure

blockstax-containers/
├── fabric/
│   ├── peer/
│   ├── orderer/
│   ├── tools/
│   └── ca/
└── README.md

Currently, the repository contains subdirectories, each with Melange and Apko declarations for building the respective Blockchain network components. As we expand to support other Blockchain projects, new directories will be added.

🔧 How to Use

🛠️ Prerequisites

Quickstart

Before running the Melange Pipelines and Publishing/Building the applications with apko, you need to generate melange keys using (this assumes that the keys will be in the root of this directory):

 melange keygen

Each Blockchain project is represented by a directory containing all the components required to create the blockchain network. It is crucial to note that there is also a Makefile per component.

To package the components application you can run:

 make package

If you want to manually build the tarball for the packaged application, you can run:

 make build

To publish to your own container registry, you can either use:

 docker login

or

 apko login

Signing your Images (Optional)

If you intend to sign your published images, you can use the following command to generate self-signed keys using cosign:

 cosign generate-key-pair

🔮 Future Plans

  • Expand support to other Blockchain projects
  • Provide unified tooling across various Blockchain platforms
  • Foster cross-project innovation within the ecosystem

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

🙏 Acknowledgements

⭐️ If you find this project useful, please consider giving it a star! ⭐️