[Overview] Docker v1

[kilrau]

Overview issue for https://github.com/ExchangeUnion/xud-docker/

Global req: All images clean FROM golang:alpine AS build-stage

Stage 1:

• xud only, make things work via simnet, neutrino and ltcd
  wait for hold invoice to be stable on simnet for below issues:
• (Add controller container (ctl) #1)
• (Move xud-simnet-legacy and xud-simnet into dev-tools folder #2)

Stage 2 (1.0.0-testnet):
Setup and connect dependencies as docker images

• BTC: bitcoind + lndbtc
• LTC litecoind + lndltc
• ERC20: partity + raiden
• ([simnet] upgrade to new xud and lnd #5)
• Test regular testnet sync
• xud.sh update mechanism (xud.sh: auto-update #48)
• Choose network (simnet/testnet/mainnet): (xud.sh: choose network #52)

answer: simnet (Starting Simnet...)
answer: testnet (Starting Testnet...)
answer: mainnet (Not available just yet.)

• xud master password (xud master password integration #63)

Stage 3 (1.0.0-beta):

• choose if the xud system should be started and synced automatically on reboot (Configurable: restart=no / always #15)
• choose choose coins/tokens one wants to swap.

• ask for pre-existing nodes (https://github.com/ExchangeUnion/xud/issues/891), (TBD: user needs to provide wallet, rpc passwords for these)

• choose location for backup files (cloud, local network), Backup xud#917
• choose connection mode (connect to everyone, connect to white-list only). Dependency: Whitelist P2P Mode xud#179. Needs great explainer.
• choose channel strategy (multi-hop (autopilot = random channels), direct channels (only works with white-list atm). Needs great explainer. Difficulties to consider when operating this in production here. More details tbd

[sangaman]

I think it's worth discussing whether we should necessarily include lnd and raiden in the docker image. Since we have the option to disable either of those, . I don't we might not always need both. I don't know if it's reasonable to have multiple docker images or the option to exclude certain components from the image for people who only want to run one or the other, but I thought I'd bring it up.

[kilrau]

Definitely worth discussing:
how about a docker 'setup' asking which coins/tokens the person wants to swap with a small hint what that means (download, disk space) based on this different docker images are chosen.

[reliveyy]

I think xud dockerfile should only care about xud itself. And we provide a docker-compose file or a k8s yaml file to describe the setup process of the whole system instead.

[kilrau]

That sounds about right! @reliveyy

We can expect to use official docker lnd and raiden in future.

[reliveyy]

https://github.com/reliveyy/xud-docker A quick PoC here (some services may not run properly and I will fix them later). If you have any suggestions please fire an issue in this PoC project and If the dockerization enhancement to xud is acceptable I will create a PR to this project

[kilrau]

I learned quite a bit from the sprkswap's docker flow today. This is the level of experience we want - things are pretty clear for me now. Added more details to the description above. Please check and let me know what you think @reliveyy @sangaman @erkarl

[kilrau]

I think it's worth discussing whether we should necessarily include lnd and raiden in the docker image. Since we have the option to disable either of those, . I don't we might not always need both. I don't know if it's reasonable to have multiple docker images or the option to exclude certain components from the image for people who only want to run one or the other, but I thought I'd bring it up.

Btw: That's taken care of by a) user choosing supported coins/tokens and also b) ask for pre-existing nodes (#891) @sangaman .

[kilrau]

Continuing in #30. Closing here.