chore: add docker #114

Extheoisah · 2023-09-28T13:01:49Z

To run:

CONFIG_PATH=/path-to-project/sim-ln/config.json docker-compose run sim-cli

sr-gi

It may be worth moving all the docker-related stuff to a folder called docker so we can also add docs on how to run it.

sr-gi · 2023-09-29T15:25:45Z

Dockerfile

I've tweaked this a bit based on https://github.com/talaia-labs/rust-teos/blob/master/docker/Dockerfile:

# Use the rust image as the base image for the build stage FROM rust:latest AS builder # Copy the rust-teos source code COPY . /tmp/sim-ln # Install the dependencies required for building sim-ln RUN apt-get update \ && apt-get -y --no-install-recommends install protobuf-compiler musl-tools RUN cd /tmp/sim-ln \ && rustup target add x86_64-unknown-linux-musl \ # Rustfmt is needed to format the grpc stubs generated by tonic && rustup component add rustfmt \ # Cross compile with musl as the target, so teosd can run on alpine && RUSTFLAGS='-C target-feature=+crt-static' cargo build --locked --release --target x86_64-unknown-linux-musl # Use a new stage with a smaller base image to reduce image size FROM alpine:latest RUN apk update && apk upgrade # UID and GID for the teosd user ENV SIMLN_UID=1001 SIMLN_GID=1001 # Copy the sim-cli binaries from the build stage to the new stage COPY --from=builder /tmp/sim-ln/target/x86_64-unknown-linux-musl/release/sim-cli /usr/local/bin/ CMD ["sim-cli", "--config", "config.json"]

Notice this won't work atm given there's still an issue with how the config file is passed to the container. Hoewever, you can test this properly builds and executes the binary if yu change the cmd command to be sim-cli -help for instance.

Also, it may be worth adding an entrypoint script to the execution of the cli can be split to add different modifiers, such as the debug log or run time. I'd suggest you check: https://github.com/talaia-labs/rust-teos/tree/master/docker

carlaKC · 2023-10-02T14:28:22Z

docker-compose.yml

@@ -0,0 +1,9 @@
+version: '3'


I think that we can live without docker compose? Since the use case that we primarily forsee is simln dropping into other people's existing setups (they'll add it to their docker compose.

For including a volume we can just add instructions to include a volume with docker run?

Yeah. I've reworked the pr and removed compose. Finally got docker to work. turns out the arch of your pc affects the type of musl tool you download to use with protobuf. I am working on an entryscript to pass in the config and other commands.

carlaKC

This is going to be way trickier that I thought to do in a user-friendly way.

Specifically because we have a config because the paths/IPs need to be relative to code executing in the container.

I'd suggest that we add some docs around this outlining:

That you need to mount a volume when you docker run which includes all the "artifacts" you need.
That the paths in config.json should be expressed relative to the file structure in the volume.

That the IP addresses need to be docker IP addresses (not localhost).

docker/entrypoint.sh

carlaKC · 2023-10-03T20:24:44Z

Makefile

+start:
+	docker run -it -e ${ARGS} sim-ln:tag


One thing that I'm missing here is the ability to include a volume that contains the certs/macaroons etc that we'll need to read to talk to the node.

If our config provides local filesystem paths then sim-cli tries to read them from within the docker file it won't find them. I think that a simple approach could be to require that the user mounts a single volume that contains the macaroons etc and the config.json and then we look for everything in there.

Pretty brutal to be dealing with these IPs/paths in the docker context.

carlaKC · 2023-10-03T20:43:40Z

Makefile

@@ -0,0 +1,5 @@
+start-deps:


also nit that this should probably be build-docker and run-docker below.

okjodom · 2023-10-06T16:01:10Z

Rough ideas: we could have a CONFIG_DIR or DATA_DIRs, mounted on a volume

--config option is always relative to the config dir so you can have multiple config files in dir
in docker scenarios, we pre-process configs in CONFIG_DIR (create symlinks to replace paths to certs, keys?)
DATA_DIR is for the csv outs

Related: One thing that I'm missing here is the ability to include a volume that contains the certs/macaroons etc that we'll need to read to talk to the node.

Update: @sr-gi, I just saw your #130 changes related to how we pass sim file to the cli. WDYT of this proposal?
Maybe we can use one dir with sub-folders for the configs

sr-gi · 2023-10-09T11:42:00Z

Rough ideas: we could have a CONFIG_DIR or DATA_DIRs, mounted on a volume

--config option is always relative to the config dir so you can have multiple config files in dir

in docker scenarios, we pre-process configs in CONFIG_DIR (create symlinks to replace paths to certs, keys?)

DATA_DIR is for the csv outs

Related: One thing that I'm missing here is the ability to include a volume that contains the certs/macaroons etc that we'll need to read to talk to the node.

Update: @sr-gi, I just saw your #130 changes related to how we pass sim file to the cli. WDYT of this proposal? Maybe we can use one dir with sub-folders for the configs

I think it makes sense if you're running a certain scenario more than once, but I'm not sure how that applies to running different ones. How would this work if I want to run with scenario_a.json, followed by scenario_b.json, would I need to re-deploy?

okjodom · 2023-10-09T15:55:33Z

How would this work if I want to run with scenario_a.json, followed by scenario_b.json, would I need to re-deploy?

User would need to add all scenario_*.json files to the data dir. Re-reploy is just adding scenario_b.json to the data dir and then running sim-cli again, this time selecting scenario_b.json as the sim file.

Extheoisah · 2023-10-09T19:01:40Z

How would this work if I want to run with scenario_a.json, followed by scenario_b.json, would I need to re-deploy?

User would need to add all scenario_*.json files to the data dir. Re-reploy is just adding scenario_b.json to the data dir and then running sim-cli again, this time selecting scenario_b.json as the sim file.

Hmm.... I'm not sure about this flow. Its a bit tacky to me except If I don't fully grasp it

carlaKC

tACK.

This is ✨ the nicest ✨ docker setup and docs I have ever encountered. The automated setup of config makes it an absolute joy to work with. Really, really great stuff.

I have a few nits on naming and fixing up documentation which I'd like to get in for the release - specifically making a note that folks can bring their own volume if they don't want to use our script (which will be useful in the case where we don't have everything we need locally, so we can't just copy it into a volume).

carlaKC · 2023-10-10T13:21:57Z

Makefile

+	@echo "HELP              Set to true to print the help message (default: false) e.g. <make run HELP=true>"
+	@echo "PRINT_BATCH_SIZE  Set the batch size for printing the results (default: 1000) e.g. <make run PRINT_BATCH_SIZE=100>"
+
+run:


nit: make these docker-run and docker-stop, since we may want to use run for cargo run.

carlaKC · 2023-10-10T13:37:04Z

Makefile

+	@echo "PRINT_BATCH_SIZE  Set the batch size for printing the results (default: 1000) e.g. <make run PRINT_BATCH_SIZE=100>"
+
+run:
+	docker run --rm --name sim-ln --init -v simln-config:/data -e CONFIG_PATH=/data/config.json -e LOG_LEVEL=$(LOG_LEVEL) -e HELP=${HELP} -e PRINT_BATCH_SIZE=${PRINT_BATCH_SIZE} -e TOTAL_TIME=${TOTAL_TIME} sim-ln


docker run -d so that this runs fully in the background?

carlaKC · 2023-10-10T13:38:03Z

docker/docker.md

+
+## Mounting the Volume
+
+To ensure that the Docker container can access the configuration and other necessary data, we use Docker volumes. Before you can run the container, you need to set up the volume with the necessary data.


"other necessary data" -> "authentication credentials"

carlaKC · 2023-10-10T13:43:14Z

docker/docker.md

+
+To ensure that the Docker container can access the configuration and other necessary data, we use Docker volumes. Before you can run the container, you need to set up the volume with the necessary data.
+
+To do this:


I think that it would be helpful to note that we've provided an easy way to do this, but you can also do it yourself (eg in the case where the macaroons etc are on another machine).

Something along the lines of:

If you're running nodes locally -> you can use this script, it'll copy everything and create a config suitable for the container.

If you're running nodes remotely, you'll need to provide your own volume and config that points to the files location in the volume.

Can also add a note about IP addresses here.

carlaKC · 2023-10-10T13:45:58Z

docker/docker.md

+- `PRINT_BATCH_SIZE`: Set the batch size for printing the results.
+- `TOTAL_TIME`: Adjusts the total time.


nits on the variable docs:

PRINT_BATCH_SIZE: determines the number of payment results that will be written to disk at a time.

TOTAL_TIME: the total runtime for the simulation expressed in seconds.

nit: I'd call this SIM_TIME.

PS: I just realized this is also called total_time in the CLI. Should we take the opportunity and rename it?

carlaKC · 2023-10-10T13:46:47Z

docker/docker.md

+## Notes for Developers:
+
+- When you use the `mount-volume` command, it sets up a Docker volume named `simln-config`. This volume contains your `config.json` file and other necessary files, ensuring that the data is accessible inside the Docker container.
+- The paths to certificates, macaroons, etc., in your `config.json` are automatically adjusted to point to their corresponding paths inside the Docker volume.


re-emphasize that IP address is not converted while we're here

Agreed. I had to go look for the host.docker.internal thing to make it run with polar

carlaKC · 2023-10-10T13:48:35Z

docker/entrypoint.sh

+# Check for a custom configuration path
+if [[ ! -z ${CONFIG_PATH} ]]; then
+    START_COMMAND="$START_COMMAND --config $CONFIG_PATH"


Needs rebase, we removed --config recently so now it's just sim-cli sim.json (since it's always required).
Also decided to refer to that file as sim.json since we may one day want to have a config file for the actual simulation (containing things like log level and print batch etc).

sr-gi

Looks really good. I have a few comments, check inline.

Something I'm also wondering: should both .dockerignore and the Makefile be moved to the docker folder? They only make sense within docker, and you may be reading the docker readme from within that folder already, so I may expect to run the commands there too.

Lastly, this needs rebase (aliases are not available atm), and commits should be squashed IMO, given they don't make sense standalone

sr-gi · 2023-10-10T14:08:46Z

Makefile

+	@echo "Variables:"
+	@echo "CONFIG_PATH       Path to the config.json file."
+	@echo "LOG_LEVEL         Set the logging level (default: info) e.g. <make run LOG_LEVEL=debug>"
+	@echo "HELP              Set to true to print the help message (default: false) e.g. <make run HELP=true>"


Can we make this a flag (and make it lower-case because why not)? i.e. if passed, it is true, otherwise, it is false.

make run help

Makefile

sr-gi · 2023-10-10T14:10:57Z

docker/docker.md

+- `PRINT_BATCH_SIZE`: Set the batch size for printing the results.
+- `TOTAL_TIME`: Adjusts the total time.


nit: I'd call this SIM_TIME.

PS: I just realized this is also called total_time in the CLI. Should we take the opportunity and rename it?

sr-gi · 2023-10-10T14:14:26Z

Makefile

+	@echo "stop              Stops the Docker container."
+	@echo ""
+	@echo "Variables:"
+	@echo "CONFIG_PATH       Path to the config.json file."


nit: SIMFILE_PATH?

Makefile

docker/docker.md

sr-gi · 2023-10-10T14:24:23Z

docker/docker.md

+
+Other configurable variables include:
+
+- `HELP`: Set to `true` to print the help message.


Is this help the makefile help, or sim-cli help?

If it is the latter, I left a comment regarding making it a flag and lowercase, disregard the lowercase part

sr-gi · 2023-10-10T14:52:19Z

docker/docker.md

+To do this:
+
+```bash
+make mount-volume CONFIG_PATH=/path/to/your/config.json


If this is a required parameter we shouldn't need to specify the ENV variable. i.e:

make mount-volume /path/to/your/config.json

docker/setup-volume.sh

sr-gi · 2023-10-10T15:05:28Z

docker/docker.md

+## Notes for Developers:
+
+- When you use the `mount-volume` command, it sets up a Docker volume named `simln-config`. This volume contains your `config.json` file and other necessary files, ensuring that the data is accessible inside the Docker container.
+- The paths to certificates, macaroons, etc., in your `config.json` are automatically adjusted to point to their corresponding paths inside the Docker volume.


Agreed. I had to go look for the host.docker.internal thing to make it run with polar

carlaKC · 2023-10-10T15:13:19Z

Makefile be moved to the docker folder

I think that it would be nice to have a make install which handles cargo install --locked ... in future so I think it's fine leave where it is.

.dockerignore

No strong feelings about where this one lives.

carlaKC

tACK 🚀

Thanks for the lightning-fast turnaround on this one 🙏 🙇

Only last ask if to have run-docker updated to be a background deployment (-d) if you've got time for one last push. Otherwise let's shipppp it 🐑

carlaKC · 2023-10-10T16:12:39Z

Makefile

+run-docker:
+	docker run --rm --name sim-ln --init -v simln-data:/data -e SIMFILE_PATH=/data/sim.json -e LOG_LEVEL=$(LOG_LEVEL) -e HELP=${HELP} -e PRINT_BATCH_SIZE=${PRINT_BATCH_SIZE} -e TOTAL_TIME=${TOTAL_TIME} sim-ln


nit: docker run -d so that this is in the background?

sr-gi

utACK

There are some pending thigs but I'm happy to ship it with he current fixes and improve it down the line

sr-gi · 2023-10-10T16:29:20Z

Makefile

+	@echo "stop              Stops the Docker container."
+	@echo ""
+	@echo "Variables:"
+	@echo "SIMFILE_PATH       Path to the sim.json file."


nit: remove extra leading space

carlaKC

tACK @ d8576dc

sr-gi requested changes Sep 29, 2023

View reviewed changes

carlaKC reviewed Oct 2, 2023

View reviewed changes

carlaKC reviewed Oct 3, 2023

View reviewed changes

Makefile Outdated

@@ -0,0 +1,5 @@

start-deps:

Copy link

Contributor

carlaKC Oct 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also nit that this should probably be build-docker and run-docker below.

okjodom mentioned this pull request Oct 6, 2023

sim-cli: source simulation file from data directory #132

Merged

carlaKC reviewed Oct 10, 2023

View reviewed changes

sr-gi marked this pull request as ready for review October 10, 2023 14:40

sr-gi reviewed Oct 10, 2023

View reviewed changes

Extheoisah force-pushed the dockerize-proj branch 2 times, most recently from 4bf762b to 3bcfe8b Compare October 10, 2023 16:06

carlaKC approved these changes Oct 10, 2023

View reviewed changes

carlaKC requested a review from sr-gi October 10, 2023 16:14

feat: add docker setup

d8576dc

Extheoisah force-pushed the dockerize-proj branch from 3bcfe8b to d8576dc Compare October 10, 2023 16:24

sr-gi reviewed Oct 10, 2023

View reviewed changes

carlaKC approved these changes Oct 10, 2023

View reviewed changes

carlaKC merged commit 8d6d90a into main Oct 10, 2023

carlaKC mentioned this pull request Oct 11, 2023

Build: Add a dockerfile #89

Closed

sr-gi deleted the dockerize-proj branch October 20, 2023 19:23


		## Mounting the Volume

		To ensure that the Docker container can access the configuration and other necessary data, we use Docker volumes. Before you can run the container, you need to set up the volume with the necessary data.


		To ensure that the Docker container can access the configuration and other necessary data, we use Docker volumes. Before you can run the container, you need to set up the volume with the necessary data.

		To do this:

		- `PRINT_BATCH_SIZE`: Set the batch size for printing the results.
		- `TOTAL_TIME`: Adjusts the total time.


		Other configurable variables include:

		- `HELP`: Set to `true` to print the help message.

		run-docker:
		docker run --rm --name sim-ln --init -v simln-data:/data -e SIMFILE_PATH=/data/sim.json -e LOG_LEVEL=$(LOG_LEVEL) -e HELP=${HELP} -e PRINT_BATCH_SIZE=${PRINT_BATCH_SIZE} -e TOTAL_TIME=${TOTAL_TIME} sim-ln

chore: add docker #114

chore: add docker #114

Conversation

Extheoisah commented Sep 28, 2023 • edited Loading

sr-gi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sr-gi Sep 29, 2023 • edited Loading

Choose a reason for hiding this comment

sr-gi Sep 29, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlaKC left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

okjodom commented Oct 6, 2023 • edited Loading

sr-gi commented Oct 9, 2023

okjodom commented Oct 9, 2023

Extheoisah commented Oct 9, 2023

carlaKC left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sr-gi left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlaKC commented Oct 10, 2023

carlaKC left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sr-gi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlaKC left a comment

Choose a reason for hiding this comment

Extheoisah commented Sep 28, 2023 •

edited

Loading

sr-gi Sep 29, 2023 •

edited

Loading

sr-gi Sep 29, 2023 •

edited

Loading

okjodom commented Oct 6, 2023 •

edited

Loading

sr-gi left a comment •

edited

Loading