Merge pull request #35 from PLEBNET-PLAYGROUND/compose-template

Compose template + change to TRIPLET syntax vs ARCH

Author: rsafier

.github/workflows/plebnet-playground.yml

@@ -48,6 +48,7 @@ jobs:
           sudo apt install python python3
           sudo apt install -y mkdocs
           pip install -r docs/requirements.txt
+          pip install -r requirements.txt
           make init report
           play
           make install
@@ -66,6 +67,7 @@ jobs:
           sudo apt install python python3
           sudo apt install -y mkdocs
           pip install -r docs/requirements.txt
+          pip install -r requirements.txt
           make init report
           play
           make install

.gitignore

@@ -11,7 +11,7 @@
 *.sln.docstates
 /signet/*
 up.sh 
-
+docker-compose.yaml
 # User-specific files (MonoDevelop/Xamarin Studio)
 *.userprefs
 

.vscode/settings.json

@@ -2,5 +2,6 @@
     "cSpell.words": [
         "Plebnet",
         "bitcoind"
-    ]
+    ],
+    "cSpell.enabled": true
 }

README.md

@@ -32,13 +32,30 @@ cd plebnet-playground-docker
 |  arm 32-bit linux | arm-linux-gnueabihf |
 | ARM64 linux |  aarch64-linux-gnu |
 
-
-### Install and start containers (Intel x64 example)
+### Services
+| Service      | Description  |
+| ----------- | ----------- |
+|  bitcoind | Bitcoin Core Daemon |
+|  lnd | Lightning Labs LND Daemon  |
+|  tor | tor network daemon |
+| rtl |  Ride The Lightning Daemon |
+| thunderhub |  Thunderhub Lightning UI |
+| docs |  MKDocs documentation |
+| notebook |  Jupyter Notebook environment setup for lightning development |
+| dashboard |  Jupyter Dashboard |
+
+### Install and start all services (Intel x64 example)
 ***
+
+```sh
+TRIPLET=x86_64-linux-gnu ./install.sh   
 ```
-./install.sh x86_64-linux-gnu
-docker-compose up -d
+
+### Install and start just the `bitcoind`,`lnd` services (comma seperate them)
+```sh
+TRIPLET=x86_64-linux-gnu services=bitcoind,lnd ./install.sh   
 ```
+
 ### Stop containers
 ***
 ```

bitcoin-signet/Dockerfile

@@ -1,7 +1,7 @@
 FROM debian:buster-slim as builder
 
 ARG BITCOIN_VERSION=22.0
-ARG ARCH=${ARCH}
+ARG TRIPLET=${TRIPLET}
 
 
 #RUN apt-add-repository ppa:bitcoin/bitcoin && apt-get update && apt-get install bitcoin
@@ -13,8 +13,8 @@ RUN  apt-get update && \
 WORKDIR /tmp
 
 # install bitcoin binaries
-RUN BITCOIN_URL="https://bitcoincore.org/bin/bitcoin-core-${BITCOIN_VERSION}/bitcoin-${BITCOIN_VERSION}-${ARCH}.tar.gz" && \
-    BITCOIN_FILE="bitcoin-${BITCOIN_VERSION}-${ARCH}.tar.gz" && \
+RUN BITCOIN_URL="https://bitcoincore.org/bin/bitcoin-core-${BITCOIN_VERSION}/bitcoin-${BITCOIN_VERSION}-${TRIPLET}.tar.gz" && \
+    BITCOIN_FILE="bitcoin-${BITCOIN_VERSION}-${TRIPLET}.tar.gz" && \
     BITCOIN_SHA_URL="https://bitcoincore.org/bin/bitcoin-core-${BITCOIN_VERSION}/SHA256SUMS" && \
     wget -qO "${BITCOIN_FILE}" "${BITCOIN_URL}" && wget -qO SHA256SUMS.asc "${BITCOIN_SHA_URL}" && \
     grep "${BITCOIN_FILE}" SHA256SUMS.asc | sha256sum -c - && \

btcd/Dockerfile

@@ -1,4 +1,4 @@
-ARG ARCH=amd64
+ARG TRIPLET=amd64
 FROM golang:1.14-alpine3.12 AS build-container
 USER root
 ENV GO111MODULE=on
@@ -10,9 +10,9 @@ WORKDIR /root/btcd
 ARG BTCD_VERSION=63438c6d3661a7dec09013f7731035abdf1eb4bc
 RUN git fetch --all && git checkout ${BTCD_VERSION}
 RUN set -ex \
-  && if [ "${ARCH}" = "amd64" ]; then export GOARCH=amd64; fi \
-  && if [ "${ARCH}" = "arm32v7" ]; then export GOARCH=arm; fi \
-  && if [ "${ARCH}" = "arm64v8" ]; then export GOARCH=arm64; fi \
+  && if [ "${TRIPLET}" = "amd64" ]; then export GOARCH=amd64; fi \
+  && if [ "${TRIPLET}" = "arm32v7" ]; then export GOARCH=arm; fi \
+  && if [ "${TRIPLET}" = "arm64v8" ]; then export GOARCH=arm64; fi \
   && echo "Compiling for $GOARCH" \
   && go install -v . ./cmd/...
 

docker-compose.yaml renamed to docker-compose.yaml.template

@@ -2,20 +2,21 @@ version: "3.4"
 networks: {}
 services:
   bitcoind:
+    build: 
+      context: ./bitcoin-signet
+      dockerfile: Dockerfile
+      args:
+        - TRIPLET=${TRIPLET}
+    image: playground-docker-bitcoind
     links:
     - tor
     depends_on: 
     - tor
     restart: unless-stopped
     container_name: playground-bitcoind
     environment:
-      ARCH: ${ARCH}
+      TRIPLET: ${TRIPLET}
       GET_COINS_ON_STARTUP: 'true'
-    build: 
-      context: ./bitcoin-signet
-      dockerfile: Dockerfile
-      args:
-        - ARCH=${ARCH}
     expose:
     - "38332"
     - "38333"
@@ -24,7 +25,7 @@ services:
     - "38333:38333"
     volumes:
       - type: bind
-        source: ${PWD}/volumes/bitcoin_datadir
+        source: ${oc.env:PWD}/volumes/bitcoin_datadir
         target: /root/.bitcoin/
   lnd:
     links:
@@ -34,7 +35,7 @@ services:
     - bitcoind
     - tor
     environment:
-      ARCH: '${ARCH}'
+      TRIPLET: '${TRIPLET}'
       LND_ALIAS: 'NewNode'
       LND_LISTEN: 'playground-lnd:9735'
       LND_RPCLISTEN: 'playground-lnd:10009'
@@ -62,7 +63,7 @@ services:
     - "10009:10009"
     volumes:
       - type: bind
-        source: ${PWD}/volumes/lnd_datadir
+        source: ${oc.env:PWD}/volumes/lnd_datadir
         target: /root/.lnd/
   tor:
       restart: unless-stopped
@@ -73,18 +74,15 @@ services:
       expose:
       - 9050
       - 9051
-      ports:
-      - "9050:9050"
-      - "9051:9051"
       volumes:
         - type: bind
-          source: ${PWD}/volumes/tor_datadir
+          source: ${oc.env:PWD}/volumes/tor_datadir
           target: /home/tor/.tor
         - type: bind
-          source: ${PWD}/volumes/tor_torrcdir
+          source: ${oc.env:PWD}/volumes/tor_torrcdir
           target: /usr/local/etc/tor
         - type: bind
-          source: ${PWD}/volumes/tor_servicesdir
+          source: ${oc.env:PWD}/volumes/tor_servicesdir
           target: /var/lib/tor/hidden_services
   thunderhub:
     container_name: playground-thub
@@ -105,11 +103,11 @@ services:
       LOG_LEVEL: debug
     volumes:
       - type: bind
-        source: ${PWD}/volumes/lnd_datadir
+        source: ${oc.env:PWD}/volumes/lnd_datadir
         target: /etc/lnd
         read_only: true
       - type: bind
-        source: ${PWD}/volumes/thub_datadir
+        source: ${oc.env:PWD}/volumes/thub_datadir
         target: /data
     ports:
       - '3001:3000'  
@@ -138,15 +136,15 @@ services:
       image: shahanafarooqui/rtl:0.11.0 
       volumes:
         - type: bind
-          source: ${PWD}/volumes/lnd_datadir
+          source: ${oc.env:PWD}/volumes/lnd_datadir
           target: /root/.lnd/
           read_only: true
         - type: bind
-          source: ${PWD}/volumes/bitcoin_datadir
+          source: ${oc.env:PWD}/volumes/bitcoin_datadir
           target: /etc/bitcoin/
           read_only: true
         - type: bind
-          source: ${PWD}/volumes/rtl_datadir
+          source: ${oc.env:PWD}/volumes/rtl_datadir
           target: /data
   notebook:
     container_name: playground-notebook
@@ -162,10 +160,10 @@ services:
     image: plebnet-playground-docker_dashboard
     volumes:
       - type: bind
-        source: ${PWD}/notebooks
+        source: ${oc.env:PWD}/notebooks
         target: /notebooks
       - type: bind
-        source: ${PWD}/volumes/lnd_datadir
+        source: ${oc.env:PWD}/volumes/lnd_datadir
         target: /root/.lnd/
         read_only: true
     environment:
@@ -194,10 +192,10 @@ services:
     image: plebnet-playground-docker_dashboard
     volumes:
       - type: bind
-        source: ${PWD}/dashboard
+        source: ${oc.env:PWD}/dashboard
         target: /dashboard
       - type: bind
-        source: ${PWD}/volumes/lnd_datadir
+        source: ${oc.env:PWD}/volumes/lnd_datadir
         target: /root/.lnd/
         read_only: true
     environment:
@@ -218,19 +216,19 @@ services:
     restart: unless-stopped
     container_name: playground-docs
     environment:
-      - ARCH=${ARCH}
+      - TRIPLET=${TRIPLET}
     build: 
-      context: ${PWD}/docs
+      context: ${oc.env:PWD}/docs
       dockerfile: Dockerfile
       args:
-        - ARCH=${ARCH}
+        - TRIPLET=${TRIPLET}
     expose:
     - "8000"
     ports:
     - "8000:8000"
     volumes:
       - type: bind
-        source: ${PWD}/docs
+        source: ${oc.env:PWD}/docs
         target: /docs
 
 

docs/docs/index.md

@@ -32,13 +32,19 @@ cd plebnet-playground-docker
 |  arm 32-bit linux | arm-linux-gnueabihf |
 | ARM64 linux |  aarch64-linux-gnu |
 
-
-### Install and start containers (Intel x64 example)
+### Install and start all services (Intel x64 example)
 ***
+
+```sh
+ARCH=x86_64-linux-gnu ./install.sh   
 ```
-./install.sh x86_64-linux-gnu
-docker-compose up -d
+
+### Install and start just the `rtl` service (ride-the-lightning)
+***
+```sh
+ARCH=x86_64-linux-gnu services=rtl ./install.sh   
 ```
+
 ### Stop containers
 ***
 ```

install.sh

@@ -1,13 +1,20 @@
-if [ -z "$1" ]
-    then 
-    echo 'You must provide ARCH as first parameter'
-    echo './install.sh x86_64-linux-gnu'
-    exit;
-fi
+# if [ -z "$1" ]
+#     then 
+#     echo 'You must provide TRIPLET as first parameter'
+#     echo './install.sh x86_64-linux-gnu'
+#     exit;
+# fi
+
+# TRIPLET=$1
+
+: ${TRIPLET:=x86_64-linux-gnu}
+: ${services:=Null}
 
-ARCH=$1
 #Remove any old version
 docker-compose down 
+
+python plebnet_generate.py TRIPLET=$TRIPLET services=$services
+
 sudo rm -rf volumes
 
 #Create Datafile
@@ -19,5 +26,6 @@ mkdir volumes/rtl_datadir
 mkdir volumes/tor_datadir
 mkdir volumes/tor_servicesdir
 mkdir volumes/tor_torrcdir
-docker-compose build --build-arg ARCH=$ARCH
-docker-compose up -d
+
+docker-compose build --build-arg TRIPLET=$TRIPLET
+docker-compose up --remove-orphans -d