Merge pull request #187 from cerc-io/dboreham/document-build-stack

Add some doc for build stack

Former-commit-id: c52f9e655d

app/base.py

@@ -69,9 +69,3 @@ class package_registry_stack(base_stack):
 
     def get_url(self):
         return self.url
-
-# Temporary helper functions while we figure out a good interface to the stack deploy code
-
-
-def _get_stack_mapped_port(stack, service, exposed_port):
-    return 3000

app/build_npms.py

@@ -20,6 +20,7 @@
 
 import os
 import sys
+from shutil import rmtree, copytree
 from decouple import config
 import click
 import importlib.resources
@@ -65,11 +66,17 @@ def command(ctx, include, exclude):
     else:
         dev_root_path = os.path.expanduser(config("CERC_REPO_BASE_DIR", default="~/cerc"))
 
-    if not quiet:
+    build_root_path = os.path.join(dev_root_path, "build-trees")
+
+    if verbose:
         print(f'Dev Root is: {dev_root_path}')
 
     if not os.path.isdir(dev_root_path):
         print('Dev root directory doesn\'t exist, creating')
+        os.makedirs(dev_root_path)
+    if not os.path.isdir(dev_root_path):
+        print('Build root directory doesn\'t exist, creating')
+        os.makedirs(build_root_path)
 
     # See: https://stackoverflow.com/a/20885799/1701505
     from . import data
@@ -92,7 +99,19 @@ def command(ctx, include, exclude):
             print(f"Building npm package: {package}")
         repo_dir = package
         repo_full_path = os.path.join(dev_root_path, repo_dir)
-        # TODO: make the npm registry url configurable.
+        # Copy the repo and build that to avoid propagating JS tooling file changes back into the cloned repo
+        repo_copy_path = os.path.join(build_root_path, repo_dir)
+        # First delete any old build tree
+        if os.path.isdir(repo_copy_path):
+            if verbose:
+                print(f"Deleting old build tree: {repo_copy_path}")
+            if not dry_run:
+                rmtree(repo_copy_path)
+        # Now copy the repo into the build tree location
+        if verbose:
+            print(f"Copying build tree from: {repo_full_path} to: {repo_copy_path}")
+        if not dry_run:
+            copytree(repo_full_path, repo_copy_path)
         build_command = ["sh", "-c", f"cd /workspace && build-npm-package-local-dependencies.sh {npm_registry_url}"]
         if not dry_run:
             if verbose:
@@ -107,7 +126,7 @@ def command(ctx, include, exclude):
                            envs=envs,
                            # TODO: detect this host name in npm_registry_url rather than hard-wiring it
                            add_hosts=[("gitea.local", "host-gateway")],
-                           volumes=[(repo_full_path, "/workspace")],
+                           volumes=[(repo_copy_path, "/workspace")],
                            command=build_command
                            )
                 # Note that although the docs say that build_result should contain

app/data/compose/docker-compose-kubo.yml

@@ -0,0 +1,13 @@
+version: "3.2"
+# See: https://docs.ipfs.tech/install/run-ipfs-inside-docker/#set-up
+services:
+  ipfs:
+    image: ipfs/kubo:master-2023-02-20-714a968
+    restart: always
+    volumes:
+      - ./ipfs/import:/import
+      - ./ipfs/data:/data/ipfs
+    ports:
+      - "8080"
+      - "4001"
+      - "5001"

app/data/pod-list.txt

@@ -18,3 +18,4 @@ test
 eth-probe
 keycloak
 tx-spammer
+kubo

app/data/stacks/erc721/README.md

@@ -6,23 +6,23 @@ Instructions to deploy a local ERC721 watcher stack (core + watcher) for demonst
 
 * Clone / pull required repositories:
 
-  ```bash
-  $ laconic-so setup-repositories --include cerc-io/go-ethereum,cerc-io/ipld-eth-db,cerc-io/ipld-eth-server,cerc-io/watcher-ts --pull
-  ```
+```bash
+laconic-so --stack erc721 setup-repositories
+```
 
 * Build the core and watcher container images:
 
-  ```bash
-  $ laconic-so build-containers --include cerc/go-ethereum,cerc/go-ethereum-foundry,cerc/ipld-eth-db,cerc/ipld-eth-server,cerc/watcher-erc721
-  ```
+```bash
+laconic-so --stack erc721 build-containers
+```
 
   This should create the required docker images in the local image registry.
 
 * Deploy the stack:
 
-  ```bash
-  $ laconic-so deploy-system --include db,go-ethereum-foundry,ipld-eth-server,watcher-erc721 up
-  ```
+```bash
+laconic-so --stack erc721 deploy-system up
+```
 
 ## Demo
 
@@ -209,6 +209,6 @@ Instructions to deploy a local ERC721 watcher stack (core + watcher) for demonst
 
 * To stop all the services running in background:
 
-  ```bash
-  $ laconic-so deploy-system --include db,go-ethereum-foundry,ipld-eth-server,watcher-erc721 down
-  ```
+```bash
+laconic-so --stack erc721 deploy-system down
+```

app/data/version.txt

@@ -1,2 +1,2 @@
 # This file should be re-generated running: scripts/update-version-file.sh script
-v1.0.19-10f2fba
+v1.0.20-6c1bedc