Merge pull request #1138 from erubboli/master

Create a docker build script

Author: erubboli

.dockerignore

@@ -0,0 +1,2 @@
+target
+.git

.gitignore

@@ -14,6 +14,9 @@
 # VSCode
 .vscode/
 
+#exclude python env
+env/
+
 # Test Python cache
 test/**/__pycache__
 

build-tools/docker/BUILD.md

@@ -0,0 +1,39 @@
+# Building Docker Images for Mintlayer
+
+This document outlines the steps to build Docker images for the Mintlayer node daemon, wallet-cli, and node-gui. 
+
+Before building make sure you clone the repository and change the current directory in the root of the repository.
+
+# The python build script
+
+Make sure you have python installed together with the `toml` package, you may want to create a specific environment:
+
+```bash
+python3 -m venv env
+source env/bin/activate
+python3 -m pip install --upgrade pip
+python3 -m pip install toml
+```
+
+In order to build the images run:
+
+```bash
+python3 build-tools/docker/build.py
+```
+
+NOTE: to change the version of the images use the `-version` flag such as `--version=1.2.3`.
+
+For verifing images are built with use the following command:
+
+```bash
+docker images | grep mintlayer
+```
+
+The result should similar to the following:
+
+```
+$ docker images |grep mintlayer
+mintlayer/wallet-cli           0.1.1     57dcc4898a30   2 minutes ago   125MB
+mintlayer/node-gui             0.1.1     a2ed3937e081   2 minutes ago   290MB
+mintlayer/node-daemon          0.1.1     ad830bf576e3   3 minutes ago   119MB
+```

build-tools/docker/Dockerfile.builder

@@ -0,0 +1,8 @@
+FROM rust AS builder
+
+WORKDIR /usr/src/
+
+COPY . .
+
+ARG NUM_JOBS=1
+RUN cargo build --release -j${NUM_JOBS}

build-tools/docker/Dockerfile.node-daemon

@@ -0,0 +1,16 @@
+# Build Stage
+FROM mintlayer-builder:latest AS builder
+
+
+# Runtime Stage
+FROM debian:bookworm-slim
+
+COPY --from=builder /usr/src/target/release/node-daemon /usr/bin
+
+# Node daemon listens on ports 3030 and 13031
+EXPOSE 3030 13031
+
+# Define mintlayer directory as a volume
+VOLUME ["/root/.mintlayer"]
+
+CMD ["node-daemon"]

build-tools/docker/Dockerfile.node-gui

@@ -0,0 +1,13 @@
+# Build Stage
+FROM mintlayer-builder:latest AS builder
+
+# Runtime Stage
+FROM debian:bookworm-slim
+
+# Install any necessary dependencies for your GUI (such as X11, GTK, etc.)
+# Replace libgtk-3-0 with the appropriate dependencies for your application
+RUN apt-get update && apt-get install -y ca-certificates libgtk-3-0 && rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/src/target/release/node-gui /usr/bin/node-gui
+
+CMD ["node-gui"]

build-tools/docker/Dockerfile.wallet-cli

@@ -0,0 +1,11 @@
+# Build Stage
+FROM mintlayer-builder:latest AS builder
+
+# Runtime Stage
+FROM debian:bookworm-slim
+
+RUN apt-get update && apt-get install -y ca-certificates && rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/src/target/release/wallet-cli /usr/bin/wallet-cli
+
+CMD ["wallet-cli"]

build-tools/docker/README.md

@@ -0,0 +1,63 @@
+# Mintlayer Node-Daemon and Wallet-CLI Docker Deployment
+
+This guide will cover how to use Docker to deploy and run the Mintlayer `node-daemon` and `wallet-cli`.
+
+## Prerequisites
+
+You need to have Docker installed on your system. For Docker installation guide, please visit [official Docker documentation](https://docs.docker.com/get-docker/).
+
+## Mintlayer Node-Daemon
+
+First, let's pull the docker image for `node-daemon`:
+
+```bash
+docker pull mintlayer/node-daemon:latest
+```
+
+Create a network for the containers to communicate:
+
+```bash
+docker network create mintlayer-net
+```
+
+To run the `node-daemon` detached and on the testnet network:
+
+```bash
+docker run -d -p 3030:3030 -p 13031:13031 --network=mintlayer-net --name mintlayer_node_daemon --user "$(id -u):$(id -g)" -v ~/.mintlayer:/root/.mintlayer mintlayer/node-daemon:latest node-daemon testnet  --http-rpc-addr 0.0.0.0:3030
+```
+
+The `-v` option is used to mount a local directory (in this case `~/.mintlayer`) as a volume in the Docker container.
+The `--user` option is used to specify the user that will write to the `~/.mintlayer` directory. 
+NOTE: this won't work on windows hosts. 
+
+If you want to display logs you can pass the `-e RUST_LOG=info` argument, such as:
+
+```bash
+docker run -d -p 3030:3030 -p 13031:13031 -e RUST_LOG=info --network=mintlayer-net --name mintlayer_node_daemon --user "$(id -u):$(id -g)" -v ~/.mintlayer:/root/.mintlayer mintlayer/node-daemon:latest node-daemon testnet  --http-rpc-addr 0.0.0.0:3030
+```
+
+## Mintlayer Wallet-CLI
+
+Pull the docker image for `wallet-cli`:
+
+```bash
+docker pull mintlayer/wallet-cli:latest
+```
+
+Before running `wallet-cli`, ensure that the `node-daemon` container is running, as it generates the `.cookie` file required by wallet-cli, then find the IP address of the node:
+
+```bash
+docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' $(docker ps -aqf "name=mintlayer_node_daemon")
+```
+
+this will display the IP address of your node in the `mintlayer-net`
+
+To run `wallet-cli` with the RPC cookie file:
+
+```bash
+docker run -it --network=mintlayer-net -v ~/.mintlayer:/root/.mintlayer mintlayer/wallet-cli:latest wallet-cli --rpc-cookie-file /root/.mintlayer/<NETWORK>/.cookie --rpc-address <IP_ADDRESS>:3030
+```
+
+replace `<NETWORK>` with `mainnet` or `testnet` depending on what network you're running and `<IP_ADDRESS>` with the result of the command above.
+
+This command mounts the same `~/.mintlayer` directory as a volume in the `wallet-cli` container and uses the `--rpc-cookie-file` option to specify the path to the cookie file.

build-tools/docker/build.py

@@ -0,0 +1,111 @@
+import toml
+import os
+import subprocess
+import argparse
+
+
+def get_cargo_version(cargo_toml_path):
+    if not os.path.exists(cargo_toml_path):
+        raise ValueError(f"No such file: {cargo_toml_path}")
+
+    # Read the Cargo.toml file
+    config = toml.load(cargo_toml_path)
+
+    # Get the version
+    version = config.get('package', {}).get('version')
+
+    if version is None:
+        raise ValueError(f"No version specified in {cargo_toml_path}")
+
+    return version
+
+
+def build_docker_image(dockerfile_path, image_name, version, num_jobs=None):
+    # Docker build command
+    command = f"docker build -t {image_name}:{version} -f {dockerfile_path}"
+    if num_jobs:
+        command += f" --build-arg NUM_JOBS={num_jobs}"
+    command += " ."
+
+    try: 
+        # Run the command
+        subprocess.check_call(command, shell=True)
+        print(f"Built {image_name}:{version} successfully.")
+    catch:
+        print(f"Error occurred: {error}")
+        exit(1) # stop the build 
+
+
+def push_docker_image(image_name, version, latest=False):
+    # Docker tag command
+    full_image_name = f"{image_name}:{version}"
+    if latest:
+        latest_image_name = f"{image_name}:latest"
+        tag_command = f"docker tag {full_image_name} {latest_image_name}"
+        subprocess.check_call(tag_command, shell=True)
+
+    # Docker push command
+    push_command = f"docker push {full_image_name}"
+    subprocess.check_call(push_command, shell=True)
+
+    # if latest flag is true, push the image with 'latest' tag
+    if latest:
+        push_command_latest = f"docker push {latest_image_name}"
+        subprocess.check_call(push_command_latest, shell=True)
+
+    print(f"Pushed {full_image_name} successfully.")
+    if latest:
+        print(f"Pushed {latest_image_name} successfully.")
+
+
+def delete_docker_image(image_name, version):
+    # Full image name
+    full_image_name = f"{image_name}:{version}"
+
+    # Docker rmi command
+    command = f"docker rmi {full_image_name}"
+
+    # Run the command
+    try:
+        subprocess.check_call(command, shell=True)
+        print(f"Deleted {full_image_name} successfully.")
+    except subprocess.CalledProcessError:
+        print(f"Failed to delete {full_image_name}.")
+
+
+def build_instances(version, num_jobs=None):
+    build_docker_image("build-tools/docker/Dockerfile.builder", "mintlayer-builder", "latest", num_jobs)
+    build_docker_image("build-tools/docker/Dockerfile.node-daemon", "mintlayer/node-daemon", version)
+    build_docker_image("build-tools/docker/Dockerfile.node-gui", "mintlayer/node-gui", version)
+    build_docker_image("build-tools/docker/Dockerfile.wallet-cli", "mintlayer/wallet-cli", version)
+    delete_docker_image("mintlayer-builder", "latest")
+
+
+def push_instances(version, latest):
+    push_docker_image("mintlayer/node-daemon",version , latest)
+    push_docker_image("mintlayer/node-gui",version , latest)
+    push_docker_image("mintlayer/wallet-cli",version , latest)
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--push', action='store_true', help='Push the Docker image to Docker Hub')
+    parser.add_argument('--latest', action='store_true', help='Tag the Docker image as latest while pushing')
+    parser.add_argument('--build', type=lambda x: (str(x).lower() == 'true'), default=True, help="Set to false avoid the build")
+    parser.add_argument('--version', help='Override version number', default=None)
+    parser.add_argument('--num_jobs', help='Number of parallel jobs, defaults to # of CPUs', default=None)
+    args = parser.parse_args()
+
+    version = args.version if args.version else get_cargo_version("Cargo.toml")
+
+    if args.build:
+        build_instances(version, num_jobs)
+
+    # Only push the image if the --push flag is provided
+    if args.push:
+        latest = args.latest
+        push_instances(version, latest)
+
+
+if __name__ == "__main__":
+    main()