diff --git a/docs/docker/docker.md b/docs/docker/docker.md index 6b5d7cd34..a9a1df980 100644 --- a/docs/docker/docker.md +++ b/docs/docker/docker.md @@ -16,12 +16,19 @@ Running your own Cardano node has never been so fast and easy. - cardano-hw-cli - cardano-node - cardano-submit-api +- mithril-client +- mithril-signer + +#### Mithril ### 🔔 Built-in tools - CNTools - gLiveView - CNCLI +- Ogmios +- Cardano Hardware CLI +- Cardano Signer - Monitoring ready (with EKG and Prometheus) #### Docker Splash screen @@ -48,11 +55,13 @@ Running your own Cardano node has never been so fast and easy. Modular docker images based on Debian. -Based on the Guild's work we decided to build the Cardano Node images in 3 stages: +Based on the Guild's work the Cardano Node image is built in a single stage: -> [dockerfile_bin](https://github.com/cardano-community/guild-operators/blob/master/files/docker/node/dockerfile_bin) + +- Uses `guild-deploy.sh` to: + - Install the os prerequisites + - Add the cardano software from release binaries + - Add the guild's SPO tools and the node's configuration files. -- 1st stage: it uses `prereq.sh` to prepare the development environment before compiling the node source code. -> [Stage1](https://github.com/cardano-community/guild-operators/blob/master/files/docker/node/dockerfile_stage1) -- 2nd stage: based on stage1, this stage intent is to compile and produce the binaries of the node. -> [Stage2](https://github.com/cardano-community/guild-operators/blob/master/files/docker/node/dockerfile_stage2) -- 3rd stage: based upon a minimal debian image it incorporates the node's binaries as well as all the Koios' SPO tools. -> [Stage3](https://github.com/cardano-community/guild-operators/blob/master/files/docker/node/dockerfile_stage3) ### Additional docs diff --git a/docs/docker/run.md b/docs/docker/run.md index 4f37f925d..bc3d9abe8 100644 --- a/docs/docker/run.md +++ b/docs/docker/run.md @@ -56,4 +56,5 @@ !!! info "Note" 1) `--entrypoint=bash` # This option won't start the node's container but only the OS running (the node software wont actually start, you'll need to manually execute entrypoint.sh ), ready to get in (trough the command ``` docker exec -it < container name or hash > /bin/bash ```) and play/explore around with it in command line mode. 2) all guild tools env variable can be used to start a new container using custom values by using the "-e" option. - 3) CPU and RAM and SHared Memory allocation option for the container can be used when you start the container (i.e. --shm-size or --memory or --cpus [official docker resource docs](https://docs.docker.com/config/containers/resource_constraints/)) + 3) CPU and RAM and Shared Memory allocation option for the container can be used when you start the container (i.e. --shm-size or --memory or --cpus [official docker resource docs](https://docs.docker.com/config/containers/resource_constraints/)) + 4) `--env MITHRIL_DOWNLOAD=Y` # This option will allow Mithril client to download the latest Mithril snapshot of the blockchain when the container starts and does not have a copy of the blockchain yet. This is useful when you want to start a new node from scratch and don't want to wait for the node to sync from the network. This option is only available for the mainnet, preprod, and preview networks. diff --git a/files/docker/node/dockerfile_bin b/files/docker/node/dockerfile_bin index b6aa4104e..d3ff4da0a 100644 --- a/files/docker/node/dockerfile_bin +++ b/files/docker/node/dockerfile_bin @@ -58,11 +58,11 @@ RUN set -x && apt update \ RUN set -x && export SUDO='N' \ && export UPDATE_CHECK='N' \ && export SKIP_DBSYNC_DOWNLOAD='Y' \ - && ./guild-deploy.sh -b master -s dcowx \ + && ./guild-deploy.sh -b master -s dcmowx \ && cd /usr/bin \ && wget http://www.vdberg.org/~richard/tcpping \ && chmod 755 tcpping \ - && chown -R guild:guild $CNODE_HOME/* \ + && chown -R guild:guild $CNODE_HOME \ && mv /root/.local/bin /home/guild/.local/ \ && chown -R guild:guild /home/guild/.* \ && chmod a+x /home/guild/.scripts/*.sh /opt/cardano/cnode/scripts/*.sh @@ -89,15 +89,18 @@ RUN curl -sL -H "Accept: application/vnd.github.everest-preview+json" -H "Conte # ENTRY SCRIPT -ADD https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/files/docker/node/addons/banner.txt /home/guild/.scripts/ -ADD https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/files/docker/node/addons/guild-topology.sh /home/guild/.scripts/ -ADD https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/files/docker/node/addons/block_watcher.sh /home/guild/.scripts/ -ADD https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/files/docker/node/addons/healthcheck.sh /home/guild/.scripts/ -ADD https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/scripts/cnode-helper-scripts/guild-deploy.sh /opt/cardano/cnode/scripts/ +ADD https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/files/docker/node/addons/banner.txt \ + https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/files/docker/node/addons/guild-topology.sh \ + https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/files/docker/node/addons/block_watcher.sh \ + https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/files/docker/node/addons/healthcheck.sh /home/guild/.scripts/ +ADD https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/scripts/cnode-helper-scripts/guild-deploy.sh \ + https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/scripts/cnode-helper-scripts/mithril-client.sh \ + https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/scripts/cnode-helper-scripts/mithril-signer.sh \ + https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/scripts/cnode-helper-scripts/mithril-relay.sh /opt/cardano/cnode/scripts/ ADD https://raw.githubusercontent.com/${G_ACCOUNT}/guild-operators/master/files/docker/node/addons/entrypoint.sh ./ RUN sudo chmod a+rx /home/guild/.scripts/*.sh /opt/cardano/cnode/scripts/*.sh /home/guild/entrypoint.sh \ - && sudo chown -R guild:guild /home/guild/.* $CNODE_HOME/* + && sudo chown -R guild:guild /home/guild/.* $CNODE_HOME HEALTHCHECK --start-period=5m --interval=5m --timeout=100s CMD /home/guild/.scripts/healthcheck.sh