Convert demo to a tutorial

Also remove --profile from docker compose demo setup.
input-output-hk · May 8, 2024 · 1a3a9d9 · 1a3a9d9
1 parent 0db5268
commit 1a3a9d9
Show file tree

Hide file tree

Showing 10 changed files with 101 additions and 173 deletions.
diff --git a/demo/docker-compose.yaml b/demo/docker-compose.yaml
@@ -27,8 +27,6 @@ services:
     build:
       context: ../
       target: hydra-node
-    profiles:
-      - hydra-node
     volumes:
       - .:/keys:ro
       - ./devnet:/devnet
@@ -64,8 +62,6 @@ services:
     build:
       context: ../
       target: hydra-node
-    profiles:
-      - hydra-node
     volumes:
       - .:/keys:ro
       - ./devnet:/devnet
@@ -101,8 +97,6 @@ services:
     build:
       context: ../
       target: hydra-node
-    profiles:
-      - hydra-node
     volumes:
       - .:/keys:ro
       - ./devnet:/devnet
@@ -137,8 +131,6 @@ services:
     build:
        context: ../
        target: hydra-tui
-    profiles:
-      - tui
     command:
       [ "--connect", "172.16.238.10:4001"
       , "--node-socket", "/devnet/node.socket"
@@ -156,8 +148,6 @@ services:
     build:
        context: ../
        target: hydra-tui
-    profiles:
-      - tui
     command:
       [ "--connect", "172.16.238.20:4001"
       , "--node-socket", "/devnet/node.socket"
@@ -175,8 +165,6 @@ services:
     build:
        context: ../
        target: hydra-tui
-    profiles:
-      - tui
     command:
       [ "--connect", "172.16.238.30:4001"
       , "--node-socket", "/devnet/node.socket"

diff --git a/demo/run-docker.sh b/demo/run-docker.sh
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 #
-# Prepare environment to run the demo cluster, then launches docker-compose demo.
-# If there's already a demo running, bail out.
+# Prepare environment to run the demo cluster, then launches docker compose
+# demo. If there's already a demo running, bail out.
 set -e
 
 SCRIPT_DIR=$(dirname $(realpath $0))
@@ -25,7 +25,7 @@ fi
 "${SCRIPT_DIR}/prepare-devnet.sh"
 ${DOCKER_COMPOSE_CMD} up -d cardano-node
 "${SCRIPT_DIR}/seed-devnet.sh"
-${DOCKER_COMPOSE_CMD} --profile hydra-node up -d
-echo >&2 -e "\n# Launch TUI on hydra-node-1: ${DOCKER_COMPOSE_CMD} --profile tui run hydra-tui-1"
+${DOCKER_COMPOSE_CMD} up -d hydra-node-{1,2,3}
+echo >&2 -e "\n# Launch TUI on hydra-node-1: ${DOCKER_COMPOSE_CMD} run hydra-tui-1"
 echo >&2 -e "\n# Stop the demo: ${DOCKER_COMPOSE_CMD} down\n"
-${DOCKER_COMPOSE_CMD} --profile tui run hydra-tui-1
+${DOCKER_COMPOSE_CMD} run hydra-tui-1
diff --git a/docs/docs/getting-started/demo/_category_.json b/docs/docs/getting-started/demo/_category_.json
diff --git a/docs/docs/getting-started/demo/index.md b/docs/docs/getting-started/demo/index.md
diff --git a/docs/docs/getting-started/demo/with-docker.md b/docs/docs/getting-started/demo/with-docker.md
diff --git a/docs/docs/open-head.png b/docs/docs/open-head.png
diff --git a/...cs/getting-started/demo/without-docker.md → docs/docs/tutorial-devnet-without-docker.md b/...cs/getting-started/demo/without-docker.md → docs/docs/tutorial-devnet-without-docker.md
@@ -2,10 +2,9 @@
 sidebar_position: 3
 ---
 
-# Without Docker
+# Quickstart without Docker
 
 ```mdx-code-block
-import TerminalWindow from '@site/src/components/TerminalWindow';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 ```
@@ -29,12 +28,10 @@ All further commands are written as if executed from the `demo` folder in the pr
 Allowing the `demo/.envrc` will ensure you have the nix shell environment available whenever you are in the `demo/` directory. To use this, opt-in via `direnv allow` after `cd demo`.
 :::
 
-## Setting-up The Chain
+## Set up the devnet
 
 First, let's prepare and start an ad-hoc, single `cardano-node` devnet using our configuration. Note that this will create a `devnet` directory in your current working directory:
 
-<TerminalWindow>
-
 ```
 ./prepare-devnet.sh
 cd devnet
@@ -48,24 +45,16 @@ cardano-node run \
   --shelley-vrf-key vrf.skey
 ```
 
-</TerminalWindow>
-
-## Seeding The Network
-
 From the `demo` folder you can use the `seed-devnet.sh` script by passing it the path/command to a cardano-cli and hydra-node executable to use, instead of having it using the Docker container. For example:
 
-<TerminalWindow>
-
 ```
 export CARDANO_NODE_SOCKET_PATH=devnet/node.socket
 ./seed-devnet.sh $(which cardano-cli) $(which hydra-node)
 ```
 
-</TerminalWindow>
-
 Note, should you want to use `cabal`, pass the invocation for example like this `"cabal exec hydra-node --"`.
 
-## Setting-up The Hydra Network
+## Start Hydra nodes
 
 Then, in 3 different terminals, start 3 Hydra nodes from the `demo/` directory:
 
@@ -78,7 +67,6 @@ If you don't see any connected peers in the tui it probably means that your syst
 <Tabs>
 
 <TabItem value="Alice">
-<TerminalWindow>
 
 ```
 source .env && hydra-node \
@@ -98,11 +86,9 @@ source .env && hydra-node \
   --persistence-dir devnet/persistence/alice
 ```
 
-</TerminalWindow>
 </TabItem>
 
 <TabItem value="Bob">
-<TerminalWindow>
 
 ```
 source .env && hydra-node \
@@ -122,11 +108,9 @@ source .env && hydra-node \
   --persistence-dir devnet/persistence/bob
 ```
 
-</TerminalWindow>
 </TabItem>
 
 <TabItem value="Carol">
-<TerminalWindow>
 
 ```
 source .env && hydra-node \
@@ -146,7 +130,6 @@ source .env && hydra-node \
   --persistence-dir devnet/persistence/carol
 ```
 
-</TerminalWindow>
 </TabItem>
 
 
@@ -155,15 +138,14 @@ source .env && hydra-node \
 
 If things go well, the nodes should start logging once connected to the chain.
 
-## Running The Clients
+## Run Hydra clients
 
 Connect to the nodes using hydra-tui.
 
 ````mdx-code-block
 <Tabs>
 
 <TabItem value="Alice">
-<TerminalWindow>
 
 ```
 hydra-tui \
@@ -173,11 +155,9 @@ hydra-tui \
   --node-socket devnet/node.socket
 ```
 
-</TerminalWindow>
 </TabItem>
 
 <TabItem value="Bob">
-<TerminalWindow>
 
 ```
 hydra-tui \
@@ -187,11 +167,9 @@ hydra-tui \
   --node-socket devnet/node.socket
 ```
 
-</TerminalWindow>
 </TabItem>
 
 <TabItem value="Carol">
-<TerminalWindow>
 
 ```
 hydra-tui \
@@ -201,7 +179,6 @@ hydra-tui \
   --node-socket devnet/node.socket
 ```
 
-</TerminalWindow>
 </TabItem>
 
 </Tabs>