Deployment Documentation

[AusIV]

We should document the deployment process in case anyone else wants to run OpenRelay.

[sheluchin]

Yes, please. This would be very helpful.

[compasses]

ditto, but seems this project not activity any more

[AusIV]

This project is still very much alive. Most of the recent work has been on the order-watchres branch: https://github.com/NoteGio/openrelay/tree/29-order-watcher - We'll start seeing some of that merged into our main branch soon.

[ershadul]

How can I run it locally? did not find any guide for that :-(

[AusIV]

It's run with a cluster of docker containers. You should be able to check out the git repository and run

docker-compose -f docker-compose-testrpc.yml up

To start all the containers. After that you will be able to submit orders to localhost:8081 and query orders from localhost:8082. This will include an Ganache server to simulate a blockchain, though at this point its ports are not publicly exposed.

If you're looking to test code that interacts with OpenRelay, rather than trying to contribute to OpenRelay itself, I'd recommend just using https://api.openrelay.xyz/ - It supports orders for the Ropsten testnet, so you can test without having to set up your own OpenRelay environment.

[ershadul]

@AusIV the docker command gives me the following error:

Step 1/3 : FROM scratch
 --->
Step 2/3 : COPY bin/ingest /ingest
ERROR: Service 'ingest' failed to build: COPY failed: stat /var/lib/docker/tmp/docker-builder353238625/bin/ingest: no such file or directory```

[AusIV]

Ah, I was thinking it would pull the docker images from DockerHub unless you ran docker-compose build. It appears this isn't the case. It might work by running docker-compose -f docker-compose-testrpc.yml pull to pull the images from docker hub, then running docker-compose -f docker-compose-testrpc.yml up to start it.

If that doesn't work, or if you're trying to test your own changes to the system, you'll need to build the code yourself. You'll need a Go compiler, then run make all to build the go binaries, then docker-compose -f docker-compose-testrpc.yml build should create the docker containers, and finally docker-compose -f docker-compose-testrpc.yml up should get them started.

I should probably note I've only ever run this from Linux, and I'm not certain if / how it will work on other platforms.

[dogecrypto]

Hi, how's it going on?

I tried this command.

docker-compose -f docker-compose-testrpc.yml pull

but got errors.

docker-compose -f docker-compose-testrpc.yml pull
WARNING: Some services (allowancemonitor, blockmonitorng, delayrelay1, ethnode, exchangesplitter, fillmonitor, fillupdate, fundcheckrelay, ingest, multisigmonitor, pgapi, postgres, queuemonitor, redis, simplerelay, spendmonitor, spendrecorder) use the 'deploy' key, which will be ignored. Compose does not support 'deploy' configuration - use `docker stack deploy` to deploy to a swarm.
Pulling redis            ... done
Pulling postgres         ... done
Pulling ethnode          ... done
Pulling ingest           ... done
Pulling exchangesplitter ... done
Pulling fillupdate       ... done
Pulling fundcheckrelay   ... done
Pulling delayrelay1      ... done
Pulling fillmonitor      ... error
Pulling multisigmonitor  ... error
Pulling pgfillindexer    ... done
Pulling initialize       ... done
Pulling contractinit     ... done
Pulling entrypoint       ... done
Pulling pgindexer        ... done
Pulling pgautomigrate    ... done
Pulling pgapi            ... done
Pulling simplerelay      ... done
Pulling blockmonitorng   ... error
Pulling allowancemonitor ... error
Pulling spendmonitor     ... error
Pulling spendrecorder    ... error
Pulling queuemonitor     ... error

ERROR: for fillmonitor  manifest for openrelay/fillmonitorng:latest not found

ERROR: for allowancemonitor  manifest for openrelay/allowancemonitor:latest not found

ERROR: for spendmonitor  manifest for openrelay/spendmonitor:latest not found

ERROR: for blockmonitorng  manifest for openrelay/blockmonitorng:latest not found

ERROR: for spendrecorder  manifest for openrelay/spendrecorder:latest not found

ERROR: for queuemonitor  manifest for openrelay/queuemonitor:latest not found

ERROR: for multisigmonitor  manifest for openrelay/multisigmonitor:latest not found
ERROR: manifest for openrelay/fillmonitorng:latest not found
manifest for openrelay/allowancemonitor:latest not found
manifest for openrelay/spendmonitor:latest not found
manifest for openrelay/blockmonitorng:latest not found
manifest for openrelay/spendrecorder:latest not found
manifest for openrelay/queuemonitor:latest not found
manifest for openrelay/multisigmonitor:latest not found

How developer team is locally making dev environment?

[AusIV]

Some time ago, we used to deploy to production based on the :latest tag for each image. At times, this made upgrades difficult, because docker wouldn't always pick up the latest version of the "latest" tag.

So we set it to specify the tags with an environment variable. When we do a deployment, we run:

TAG=$(date +"%s") docker-compose -f docker-compose-testrpc.yml build

To build, then check the tag that was created, and do something like:

TAG=1526503938 docker-compose -f docker-compose-testrpc.yml push

to push out a specifically named version. Then in our production environment we can drop in that tag number to change our deployments to that specific tag.

If not set, the environment variable defaults to "latest", which we don't actually build or push.

You have a couple of options:

You could grab the latest build number from dockerhub, and pull that. Here you can see that the latest version of fundcheckrelay is 1527786153. We update all our tags at once, so you can do:

TAG=1527786153 docker-compose -f docker-compose-testrpc.yml pull

to get that specific version.

Alternatively, you could build your own with:

docker-compose -f docker-compose-testrpc.yml build

Which will build the docker files on your local system.

[dogecrypto]

OK, I will try it later. Thanks!

[dogecrypto]

I'm somohow use it working, but I do not know how you make ca-certificates.crt, and its role. How you make this certificaiton? (I'm mac user, Perhaps in ubuntsu, it is standardly located...?).

docker-cfg/ca-certificates.crt:
	cp /etc/ssl/certs/ca-certificates.crt docker-cfg/ca-certificates.crt

[AusIV]

I'm not sure about macs, but on virtually every linux system I've looked at it's in the same place. I'll do some digging and see if I can see where macs keep it.

[AusIV]

Actually, in the 0x v2 support branch of OpenRelay, I've changed this to:

COPY --from=corebuild /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt

Which grabs the cert file from the docker image where the go binaries are built. I don't really want to change it in the master branch until I merge v2 support, but if you're comfortable modifying the docker repositories it should fix your problem.

The other option is instead of building the images yourself, you could pull them (if you're not trying to build local modifications). You could do that by prefixing all of your docker-compose commands with:

TAG=1527786153

for example:

TAG=1527786153 docker-compose -f docker-compose-testrpc.yml pull

Then

TAG=1527786153 docker-compose -f docker-compose-testrpc.yml up

[dogecrypto]

OK, thanks a lot!