Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 10.9 KB

README.md

File metadata and controls

97 lines (71 loc) · 10.9 KB
Raw

TLDR

Our project uses Docker Compose. Please install Docker and Docker Compose using the official documentation:

For windows users, once it's installed, you may have to use powershell or equivalent in order to type (replace ... with your MAIN_ADDRESS):

MAIN_ADDRESS=... rss=1 bit=1 jvc=1 ch4=1 for=1 hac=1 mas=1 nos=1 a7d=1 ap9=1 lem=1 wei=1 fol=1 you=1 tra=1 new=1 docker compose -f spotters.yaml -f docker-compose.yaml up -d

This will launch a spotter for every possible driver. You are then able to configure their distribution based on your liking.

Available parameters

  • MAIN_ADDRESS rewarded eth wallet
  • UPIPE_SIZE: allow to spawn multiple upipe service, which are responsible for CPU unit-processing
  • UPIPE_PROCESSING_TIMEOUT: allows you to specify the timeout on CPU processing logic, a short time can be used on better machine while slower machine will fall in the 8s range.

More parameters (pros)

  • TRACE: enable tracing (this requires the `monitoring stack to be set up, please ignore if you don't know what this is)

Example

  • with automaticly managed spotters (2 spotters)
MAIN_ADDRESS=... SPOTTERS_AMOUNT=2 docker compose up -d
  • only core
MAIN_ADDRESS=... docker compose up -d

Enable GPU

You can enable GPU processing on your bpipe instance using the gpu.yaml

MAIN_ADDRES=... docker compose -f docker-compose.yaml -f gpu.yaml up -d

1️⃣ Core

image Image size description Version Pulls
transactioneer Docker Image Size Web3 interaction Docker Image Version Docker Pulls
bpipe Docker Image Size Batch processing Docker Image Version Docker Pulls
upipe Docker Image Size Unit processing Docker Image Version Docker Pulls
orchestrator Docker Image Size Orchestration & Monitoring Docker Image Version Docker Pulls

Custom spotters distribution

spotters.yaml provides an easy way to launch the different spotters with different redundancy parameters, each module is parametrable with it's three first leters (jumping over spot)

rss=1 bit=1 jvc=1 ch4=1 for=1 hac=1 mas=1 nos=1 a7d=1 ap9=1 lem=1 wei=1 fol=1 you=1 tra=1 docker compose -f spotters.yaml up -d

The spotters.yaml is connected with services in docker-compose trough a docker network called exorde-network. You do not have to launch them together as they will automaticly reach out.

2️⃣ Spotters

image Image size Version Pulls
spotseekingalphad89ba32s Docker Image Size Docker Image Version Docker Pulls
spotbitcointalk4de40ec26 Docker Image Size Docker Image Version Docker Pulls
spotjvc8439846094ced03ff Docker Image Size Docker Image Version Docker Pulls
spotrss007d0675444aa13fc Docker Image Size Docker Image Version Docker Pulls
spotch4875eda56be56000ac Docker Image Size Docker Image Version Docker Pulls
spotforocoches86019fc2d4 Docker Image Size Docker Image Version Docker Pulls
spothackbc9419ab11eebe56 Docker Image Size Docker Image Version Docker Pulls
spotmasto65ezfd86424f69a Docker Image Size Docker Image Version Docker Pulls
spotnostr5fa856e7234fbee Docker Image Size Docker Image Version Docker Pulls
spota7df32de3a60dfdb7a0b Docker Image Size Docker Image Version Docker Pulls
spotap98j3envoubi3fco1kc Docker Image Size Docker Image Version Docker Pulls
spotlemmyw04b6eb792ca4a1 Docker Image Size Docker Image Version Docker Pulls
spotwei223be19ab11e891bo Docker Image Size Docker Image Version Docker Pulls
spotfollowinc645fc950d7f Docker Image Size Docker Image Version Docker Pulls
spotyoutube00e1f862e5eff Docker Image Size Docker Image Version Docker Pulls
spottradview251ae30a11ee Docker Image Size Docker Image Version Docker Pulls
spotnews8a841d781095471c Docker Image Size Docker Image Version Docker Pulls

Custom Spotter Logic

  • Pushing data is as simple as making a POST request to a upipe instance on /

  • You can use orchestrator to streamline the access to your different services,

      curl 'http://orchestrator/get?network.exorde.service=upipe' -> will return a list of `upipe` ips

    You select a random one and are ready to push data

    note: all services use port 8000

    ⚠️ We infer the location of each service at runtime because of live-update which cause your services location to be inconsistent in time. This is NOT an option if you want something stable, EVEN if your custom spotters are not updated (exorde ones are) the upipe, bpipe etc.. ARE