Feat/add docker compose (#128)

* add docker-compose.yaml

* update

* update cmd

* update

* add promethues

* add grafana

* multiarch

* revert dockerfile

* format dockerfile

* format

* format

* format

* remove platform

* typo

Author: georgehao

.github/workflows/release.yml

@@ -44,14 +44,14 @@ jobs:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_TOKEN }}
 
-    - name: Build docker image
+    - name: Build and push multi-arch docker image
       uses: docker/build-push-action@1dc73863535b631f98b2378be8619f83b136f4a0 # v6.17.0
       with:
         context: .
         file: Dockerfile
-        # push: ${{ startsWith(github.ref, 'refs/tags/') }}
+        platforms: linux/amd64,linux/arm64
         push: true
         tags: ${{ steps.meta.outputs.tags }}
         labels: ${{ steps.meta.outputs.labels }}
-        # cache-from: type=gha,scope=${{ github.workflow }}
-        # cache-to: type=gha,scope=${{ github.workflow }}
+        cache-from: type=gha,scope=${{ github.workflow }}
+        cache-to: type=gha,scope=${{ github.workflow }}

.gitignore

@@ -22,4 +22,7 @@ target/
 
 .vscode/
 
-.idea/
+.idea/
+docker-compose/grafana_data/
+docker-compose/l2reth/
+docker-compose/prometheus_data/

Dockerfile

@@ -32,4 +32,3 @@ COPY --from=builder /app-target/release/rollup-node /bin/
 EXPOSE 30303 30303/udp 9001 8545 8546
 
 ENTRYPOINT ["rollup-node"]
-

MULTIARCH_BUILD.md

@@ -0,0 +1,126 @@
+# Multi-Architecture Docker Image Build Guide
+
+## Overview
+
+This project now supports building multi-architecture Docker images for both `linux/amd64` and `linux/arm64` platforms.
+
+## Prerequisites
+
+1. Docker version >= 19.03
+2. Docker Buildx (usually included in newer Docker versions)
+
+## Quick Start
+
+### 1. Setup Docker Buildx
+
+Before first use, you need to set up the buildx builder:
+
+```bash
+make docker-setup-buildx
+```
+
+Or execute manually:
+
+```bash
+docker buildx create --name multiarch --driver docker-container --bootstrap --use
+```
+
+### 2. Build Multi-Architecture Images
+
+#### Local Build (without pushing to registry)
+
+```bash
+make docker-multiarch
+```
+
+This will build images for both `linux/amd64` and `linux/arm64` architectures, but will only save them in the local build cache.
+
+
+### 3. Single Architecture Build (Traditional Way)
+
+If you only need to build an image for the current platform:
+
+```bash
+make docker
+```
+
+## Technical Details
+
+### Dockerfile Modifications
+
+1. **Multi-platform Base Images**: Uses `--platform=$BUILDPLATFORM` to ensure base images support multi-architecture
+2. **Cross-compilation Support**: 
+   - Added `gcc-aarch64-linux-gnu` cross-compiler for ARM64
+   - Configured corresponding Rust targets and linkers
+3. **Conditional Building**: Selects the correct compilation target based on `$TARGETPLATFORM` environment variable
+4. **Smart Binary Copying**: Copies the correct binary file based on the target platform
+
+### Supported Platforms
+
+- `linux/amd64` (x86_64)
+- `linux/arm64` (aarch64)
+
+### Build Time Optimization
+
+- Uses `cargo-chef` to cache dependency builds
+- Leverages Docker multi-stage builds to reduce final image size
+- BuildKit cache mechanism improves repeated build performance
+
+## Troubleshooting
+
+### Issue: buildx not available
+
+**Solution**: Update Docker to the latest version, or manually install buildx:
+
+```bash
+# Check if buildx is available
+docker buildx version
+
+# If not available, you can install it with:
+docker buildx install
+```
+
+### Issue: Cross-compilation failures
+
+**Solution**: Ensure your system has sufficient memory and storage space, as cross-compilation typically requires more resources.
+
+### Issue: ARM64 builds are slow on Apple Silicon Macs
+
+**Solution**: This is normal behavior, as even on ARM64 hosts, Docker still needs to emulate the Linux ARM64 environment.
+
+## Verifying Build Results
+
+After the build is complete, you can check if the image contains multiple architectures:
+
+```bash
+docker buildx imagetools inspect scrolltech/rollup-node:latest
+```
+
+## Usage Recommendations
+
+1. **Development Phase**: Use `make docker` for fast single-architecture builds
+2. **Testing Phase**: Use `make docker-multiarch` for multi-architecture validation
+3. **Release Phase**: GitHub Actions will automatically build and push multi-architecture images when you create a release or push a tag
+
+## GitHub Actions Integration
+
+The project includes a GitHub Actions workflow (`.github/workflows/release.yml`) that automatically builds and pushes multi-architecture images to Docker Hub when:
+
+- A new tag is pushed
+- A GitHub release is published
+
+### Workflow Features
+
+- **Multi-platform builds**: Automatically builds for `linux/amd64` and `linux/arm64`
+- **Smart caching**: Uses GitHub Actions cache to speed up builds
+- **Automatic tagging**: Tags images based on Git tags and releases
+- **Secure authentication**: Uses Docker Hub credentials stored in GitHub Secrets
+
+### Required Secrets
+
+Make sure the following secrets are configured in your GitHub repository:
+
+- `DOCKERHUB_USERNAME`: Your Docker Hub username
+- `DOCKERHUB_TOKEN`: Your Docker Hub access token
+
+## Performance Notes

Makefile

@@ -80,3 +80,11 @@ pr: lint test docs
 .PHONY: docker
 docker:
 	docker build -t scrolltech/rollup-node:latest . -f Dockerfile
+
+.PHONY: docker-multiarch
+docker-multiarch:
+	docker buildx build --platform linux/amd64,linux/arm64 -t scrolltech/rollup-node:latest . -f Dockerfile
+
+.PHONY: docker-setup-buildx
+docker-setup-buildx:
+	docker buildx create --name multiarch --driver docker-container --bootstrap --use || docker buildx use multiarch

docker-compose/docker-compose.yml

@@ -0,0 +1,74 @@
+version: '3'
+
+services:
+  rollup-node:
+    image: scrolltech/rollup-node:v0.0.1-rc9
+    container_name: rollup-node
+    entrypoint: ["sh", "-c"]
+    command: >
+      '
+      if [ "$${ENV:-}" = "dev" ]; then
+        exec rollup-node node --chain dev --datadir=/l2reth  --metrics=0.0.0.0:6060 --disable-discovery --http --http.addr=0.0.0.0 --http.port=8545 --http.corsdomain "*" --http.api admin,debug,eth,net,trace,txpool,web3,rpc,reth,ots,flashbots,miner,mev --ws --ws.addr 0.0.0.0 --ws.port 8546 --ws.api admin,debug,eth,net,trace,txpool,web3,rpc,reth,ots,flashbots,miner,mev --log.stdout.format log-fmt -vvv --sequencer.enabled --sequencer.block-time 250 --sequencer.payload-building-duration 230 --txpool.pending-max-count=1000000 --builder.gaslimit=10000000000 --rpc.max-connections=5000
+      elif [ "$${ENV:-}" = "sepolia" ]; then
+        exec rollup-node node --chain scroll-sepolia --datadir=/l2reth --metrics=0.0.0.0:6060 --disable-discovery --http --http.addr=0.0.0.0 --http.port=8545 --http.corsdomain "*" --http.api admin,debug,eth,net,trace,txpool,web3,rpc,reth,ots,flashbots,miner,mev --ws --ws.addr 0.0.0.0 --ws.port 8546 --ws.api admin,debug,eth,net,trace,txpool,web3,rpc,reth,ots,flashbots,miner,mev --log.stdout.format log-fmt -vvv --l1.url http://l1geth-rpc.sepolia.scroll.tech:8545/l1 --l1.cups 10000 --network.bridge --scroll-wire.enabled --optimistic-sync --builder.gaslimit 20000000 --trusted-peers enode://29cee709c400533ae038a875b9ca975c8abef9eade956dcf3585e940acd5c0ae916968f514bd37d1278775aad1b7db30f7032a70202a87fd7365bd8de3c9f5fc@44.242.39.33:30303
+      elif [ "$${ENV:-}" = "mainnet" ]; then
+        exec rollup-node node --chain scroll --datadir=/l2reth --metrics=0.0.0.0:6060 --disable-discovery --http --http.addr=0.0.0.0 --http.port=8545 --http.corsdomain "*" --http.api admin,debug,eth,net,trace,txpool,web3,rpc,reth,ots,flashbots,miner,mev --ws --ws.addr 0.0.0.0 --ws.port 8546 --ws.api admin,debug,eth,net,trace,txpool,web3,rpc,reth,ots,flashbots,miner,mev --log.stdout.format log-fmt -vvv --l1.url http://l1geth-rpc.mainnet.scroll.tech:8545/l1 --l1.cups 10000 --network.bridge --scroll-wire.enabled --optimistic-sync --builder.gaslimit 30000000
+      fi
+      '
+    environment:
+      - ENV=${ENV:-dev}
+    ports:
+      - "8545:8545"  # JSON-RPC
+      - "8546:8546"  # WebSocket
+      - "6060:6060"  # Metrics
+    volumes:
+      - ./l2reth:/l2reth
+    networks:
+      - scroll-network
+
+  prometheus:
+    image: prom/prometheus:latest
+    container_name: prometheus
+    ports:
+      - "19090:9090"  # Prometheus Web UI
+    volumes:
+      - ./resource/prometheus.yml:/etc/prometheus/prometheus.yml:ro
+      - ./prometheus_data:/prometheus
+    command:
+      - '--config.file=/etc/prometheus/prometheus.yml'
+      - '--storage.tsdb.path=/prometheus'
+      - '--storage.tsdb.retention.time=1d'
+      - '--storage.tsdb.retention.size=512MB'
+      - '--storage.tsdb.wal-compression'
+      - '--web.console.libraries=/etc/prometheus/console_libraries'
+      - '--web.console.templates=/etc/prometheus/consoles'
+      - '--web.enable-lifecycle'
+    networks:
+      - scroll-network
+    depends_on:
+      - rollup-node
+
+  grafana:
+    image: grafana/grafana:latest
+    container_name: grafana
+    ports:
+      - "13000:3000"  # Grafana Web UI
+    volumes:
+      - ./resource/grafana-datasource.yml:/config/datasources/datasource.yml:ro
+      - ./resource/grafana-dashboard-providers.yml:/config/dashboards/dashboard-providers.yml:ro
+      - ./resource/dashboards:/dashboards:ro
+      - ./grafana_data:/var/lib/grafana
+    environment:
+      - GF_AUTH_ANONYMOUS_ENABLED=true
+      - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
+      - GF_AUTH_ANONYMOUS_ORG_NAME=Main Org.
+      - GF_DASHBOARDS_DEFAULT_HOME_DASHBOARD_PATH=/dashboards/overview.json
+      - GF_PATHS_PROVISIONING=/config
+    networks:
+      - scroll-network
+    depends_on:
+      - prometheus
+
+networks:
+  scroll-network:
+    driver: bridge