Skip to content

project-construct-x/script-collection

Construct-X Script Collection

A collection of scripts to easily configure and run Construct-X data space components with Docker or Kubernetes.

About

The Construct-X data space requires participants to use various components (like a Connector, a wallet, etc.), located in different repositories in the Construct-X GitHub Organization. While these components work together and can be deployed and configured differently, this repository aims to collect different Docker and Docker Compose files, Kubernetes configurations and Helm charts, as well as automatic configuration scripts to help participants get onboarded.

Getting Started

If you want to get started, review the local testbed in docker/local-testbed which starts a minimal data space with two participants and all necessary components on your machine.

Repository Structure

The repository is organized by artifact type. Each folder contains its own README.md with more details.

.
├── docker/                 # Docker Compose deployments
│   ├── single-node/        # One Connector + one Wallet (minimal setup)
│   └── local-testbed/      # Two Connectors + wallets for end-to-end testing
├── helm/                   # Kubernetes Helm charts
│   └── single-node/        # Umbrella chart: one Connector + one Wallet
├── bruno/                  # Bruno HTTP collections
│   └── local-testbed/      # Collection for the local testbed
└── configurator/           # Python script to start & configure a node

Documentation

This documentation is located in different READMEs in the dedicated folders.

License

All code files are distributed under the Apache 2.0 license. See LICENSE for more information.

All non-code files are distributed under the Creative Commons Attribution 4.0 International license. See LICENSE_non-code for more information.

About

Script and deployment collection to run and auto-configure Construct-X components via Docker or Kubernetes

Resources

License

Apache-2.0, CC-BY-4.0 licenses found

Licenses found

Apache-2.0
LICENSE
CC-BY-4.0
LICENSE_non-code

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Contributors