Docker compose update: migrate to new container name syntax (#557)

* skyportal_web_1 -> skyportal-web-1 to work with new versions of docker compose * update docker-compose cmd to docker compose * pin kowalski to cc5304c600423ced63197d40ef657a7a6cc952ee * update redoc-cli version used * add some amount of caching to the ci for the docs
fritz-marshal · Aug 8, 2024 · 3de0dc1 · 3de0dc1
1 parent e50265b
commit 3de0dc1
Show file tree

Hide file tree

Showing 12 changed files with 37 additions and 23 deletions.
diff --git a/.github/workflows/build-test-doc_upload.yaml b/.github/workflows/build-test-doc_upload.yaml
@@ -25,6 +25,18 @@ jobs:
       with:
         node-version: 20
 
+    - uses: actions/cache@v2
+      with:
+        path: |
+          ~/.npm
+        key: ${{ runner.os }}-npm-${{ hashFiles('package.json') }}
+
+    - uses: actions/cache@v2
+      with:
+        path: |
+          ~/.cache/pip
+        key: ${{ runner.os }}-${{ hashFiles('**/requirements*.txt') }}
+
     - name: Install system dependencies
       run: |
         sudo apt update -y && sudo apt install -y libcurl4-gnutls-dev libgnutls28-dev

diff --git a/fritz.defaults.yaml b/fritz.defaults.yaml
@@ -181,18 +181,18 @@ skyportal:
 
     kowalski:
       protocol: http
-      host: kowalski_api_1
+      host: kowalski-api-1
       port: 4000
       token:
     # a (dedicated) Kowalski instance holding the ZTF light curve data referred to as Gloria
     gloria:
       protocol: http
-      host: kowalski_api_1
+      host: kowalski-api-1
       port: 4000
       token:
     melman:
       protocol: http
-      host: kowalski_api_1
+      host: kowalski-api-1
       port: 4000
       token:
 
@@ -1924,7 +1924,7 @@ kowalski:
 
   skyportal:
     protocol: "http"
-    host: skyportal_web_1
+    host: skyportal-web-1
     port: 5000
     username: kowalski
     token: <token>

diff --git a/kowalski b/kowalski
diff --git a/launcher/commands/build.py b/launcher/commands/build.py
@@ -101,7 +101,7 @@ def build(
         # start up skyportal
         # docker-compose.skyportal.yaml bind-mounts the fritz-specific config.yaml and db_seed.yaml
         p = subprocess.run(
-            ["docker-compose", "-f", "docker-compose.skyportal.yaml", "up", "-d"],
+            ["docker", "compose", "-f", "docker-compose.skyportal.yaml", "up", "-d"],
             cwd="skyportal",
             check=True,
         )
@@ -116,7 +116,7 @@ def build(
                     "docker",
                     "exec",
                     "-i",
-                    "skyportal_web_1",
+                    "skyportal-web-1",
                     "/bin/bash",
                     "-c",
                     "source /skyportal_env/bin/activate; make db_clear; make db_init;"
@@ -169,7 +169,7 @@ def build(
     if init:
         # stop SkyPortal
         subprocess.run(
-            ["docker-compose", "-f", "docker-compose.skyportal.yaml", "down"],
+            ["docker", "compose", "-f", "docker-compose.skyportal.yaml", "down"],
             cwd="skyportal",
         )
 

diff --git a/launcher/commands/doc.py b/launcher/commands/doc.py
@@ -49,7 +49,7 @@ def doc(yes: bool = False, upload: bool = False):
     subprocess.run(
         [
             "npx",
-            "redoc-cli@0.9.8",
+            "redoc-cli@0.13.21",
             "bundle",
             "openapi.json",
             "--title",

diff --git a/launcher/commands/log.py b/launcher/commands/log.py
@@ -8,7 +8,7 @@ def log():
             "docker",
             "exec",
             "-i",
-            "skyportal_web_1",
+            "skyportal-web-1",
             "/bin/bash",
             "-c",
             "source /skyportal_env/bin/activate; make log",

diff --git a/launcher/commands/run.py b/launcher/commands/run.py
@@ -40,7 +40,7 @@ def run(
     # start up skyportal
     # docker-compose.skyportal.yaml bind-mounts the fritz-specific config.yaml and db_seed.yaml
     p = subprocess.run(
-        ["docker-compose", "-f", "docker-compose.skyportal.yaml", "up", "-d"],
+        ["docker", "compose", "-f", "docker-compose.skyportal.yaml", "up", "-d"],
         cwd="skyportal",
         check=True,
     )
@@ -69,7 +69,7 @@ def run(
         check_config_exists(cfg="docker-compose.traefik.defaults.yaml", yes=yes)
         # fire up traefik
         p = subprocess.run(
-            ["docker-compose", "-f", "docker-compose.traefik.yaml", "up", "-d"],
+            ["docker", "compose", "-f", "docker-compose.traefik.yaml", "up", "-d"],
             check=True,
         )
         if p.returncode != 0:

diff --git a/launcher/commands/stop.py b/launcher/commands/stop.py
@@ -15,12 +15,14 @@ def stop():
     traefik_is_running = any("traefik" in x.lower() for x in running_container_images)
     if traefik_is_running:
         print("Shutting down Traefik")
-        subprocess.run(["docker-compose", "-f", "docker-compose.traefik.yaml", "down"])
+        subprocess.run(
+            ["docker", "compose", "-f", "docker-compose.traefik.yaml", "down"]
+        )
 
     # stop Kowalski and SkyPortal
     subprocess.run(["python", "kowalski.py", "down"], cwd="kowalski")
     subprocess.run(
-        ["docker-compose", "-f", "docker-compose.skyportal.yaml", "down"],
+        ["docker", "compose", "-f", "docker-compose.skyportal.yaml", "down"],
         cwd="skyportal",
     )
 

diff --git a/launcher/commands/test.py b/launcher/commands/test.py
@@ -44,9 +44,9 @@ def test():
             )
             > 0
             for container_name in (
-                "kowalski_ingester_1",
-                "kowalski_api_1",
-                "skyportal_web_1",
+                "kowalski-ingester-1",
+                "kowalski-api-1",
+                "skyportal-web-1",
             )
         )
 
@@ -62,7 +62,7 @@ def test():
         if i == num_retries - 1:
             raise RuntimeError("SkyPortal failed to spin up")
 
-        command = ["docker", "exec", "-i", "skyportal_web_1", "ps", "-ef"]
+        command = ["docker", "exec", "-i", "skyportal-web-1", "ps", "-ef"]
         process_list = subprocess.check_output(command, universal_newlines=True).strip()
 
         if "app.py" not in process_list:
@@ -113,7 +113,7 @@ def test():
         "docker",
         "exec",
         "-i",
-        "skyportal_web_1",
+        "skyportal-web-1",
         "cp",
         "docker.yaml",
         "test_config.yaml",
@@ -136,7 +136,7 @@ def test():
             "docker",
             "exec",
             "-i",
-            "skyportal_web_1",
+            "skyportal-web-1",
             "/bin/bash",
             "-c",
             "source /skyportal_env/bin/activate &&"

diff --git a/launcher/skyportal.py b/launcher/skyportal.py
@@ -17,7 +17,7 @@ def get_token():
             "docker",
             "exec",
             "-i",
-            "skyportal_web_1",
+            "skyportal-web-1",
             "/bin/bash",
             "-c",
             "cat /skyportal/.tokens.yaml",

diff --git a/skyportal b/skyportal
diff --git a/tools/check_environment.py b/tools/check_environment.py
@@ -34,7 +34,7 @@ def output(cmd):
     ),
     "docker-compose": (
         # Command to get version
-        ["docker-compose", "--version"],
+        ["docker", "compose", "version"],
         # Extract *only* the version number
         lambda v: re.search(r"\s*([\d.]+)", v).group(0).strip(),
         # It must be >= 1.22.0