-
Notifications
You must be signed in to change notification settings - Fork 0
1. Installation
The platform repository is the entry point for prospective Sedimark participants to deploy all the necessary components to join the Sedimark ecosystem. If offers two ways to do so:
- a marketplace only installation: it is enough to become a Sedimark member and start providing offerings or consuming assets from other participants. It is a lightweight way to take a peek at the Sedimark ecosystem.
- a full installation: it contains both the marketplace and all the added value tools from the Sedimark toolbox. Ideal for users willing to leverage the power of Sedimark's data processing and AI modelling tools to boost their offerings.
Sedimark simplifies the deployment of its components by using Docker compose. The official Docker documentation gathers all information to install the Docker suite on the main platforms (Windows, Linux, MacOS).
To enable interactions between its participants, Sedimark requires a few of the participants' services to be exposed publicly, namely:
- the offering manager self-listing endpoints: to expose the participant's offerings in the Sedimark catalogue.
- the connector's data space protocol API: to enable transactions between participants.
- the participant's profile server: to expose the participant's description.
Consequently, participants need a domain name and to set a reverse-proxy such as Traefik or Nginx to expose such services.
All files to configure and install the marketplace can be found in the mvm directory in the root of the platform repository. So to get started:
git clone https://github.com/Sedimark/platform.git
cd platform/mvmThe marketplace components can be configured using environment variables. The fastest way to get started is to copy the provided example env file:
cp .env.example .envMost of the default values in the environment will suffice to get most users started, however we do recommend users to take the time to modify default credentials such as databases passwords.
Then, the marketplace can be simply deployed using:
docker compose --env-file .env up -dAfter a bit of time (typically less than 2/3 min), the marketplace should be available at http://localhost:3001
All files to configure and install the marketplace with the SEDIMARK ToolBox alongside it can be found in the mvm_mvi directory in the root of the platform repository.
To get started you need to init all the submodules present in the repo:
git clone https://github.com/Sedimark/platform.git
cd platform
git submodule update --init --recursiveThen go to mvm_mvi folder:
cd mvm_mviThe marketplace components can be configured using environment variables. The fastest way to get started is to copy the provided example env file:
cp ../mvm/.env.example ../mvm/.envThe toolbox components can also be configured using environment variables. Most of the default values can be used directly, but they can be modified in the following two places:
./Sedimark-Toolbox/ngsild_broker_deployment/.env - for broker related variables
./Sedimark-Toolbox/toolbox_deployment/.env - for toolbox related comonents variables.To deploy the marketplace and the toolbox do:
docker compose up -dAfter some time (less then 3-4 minutes) all the components are deployed:
- The marketplace is available at http://localhost:3001
- The Orchestrator UI, which is the main entry point for the toolbox, is available at http://localhost:3000