arcsecond 4.4.2__tar.gz → 4.4.3__tar.gz

{arcsecond-4.4.2 → arcsecond-4.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: arcsecond
-Version: 4.4.2
+Version: 4.4.3
 Summary: CLI for arcsecond.io
 Project-URL: Homepage, https://github.com/arcsecond-io/cli
 Project-URL: Issues, https://github.com/arcsecond-io/cli/issues

{arcsecond-4.4.2 → arcsecond-4.4.3}/arcsecond/hosting/composedoc.py

@@ -34,6 +34,7 @@ from .local import (
 MARKER_START = re.compile(r"^\s*# >>> arcsecond:(\S+)\s*$")
 MARKER_END = re.compile(r"^\s*# <<< arcsecond:(\S+)\s*$")
 ENV_REF = re.compile(r"\$\{([A-Z_][A-Z0-9_]*)(?::-[^}]*)?\}")
+ENV_DEFAULT = re.compile(r"^\$\{[A-Z_][A-Z0-9_]*:-([^}]*)\}$")
 
 
 @dataclass
@@ -58,6 +59,12 @@ def _strip_comment(line: str) -> str:
     return line.strip().lstrip("#").strip()
 
 
+def _as_shipped(value: str) -> str:
+    """A `${VAR:-default}` value as an installation that leaves VAR unset runs it."""
+    match = ENV_DEFAULT.match(value)
+    return match.group(1) if match else value
+
+
 class _Reader:
     """Walks the template line by line, keeping the comments."""
 
@@ -134,7 +141,7 @@ class _Reader:
             "stop_grace_period": "stop_grace_period",
         }
         if key in scalar:
-            setattr(self.current, scalar[key], value)
+            setattr(self.current, scalar[key], _as_shipped(value))
         elif key == "healthcheck":
             self.current.healthcheck = True
         elif key == "ports" and value.startswith("["):
@@ -289,6 +296,28 @@ ENV_KEYS: Dict[str, tuple] = {
         OPERATOR,
         "How many jobs the data worker runs at once. Default 2; each can hold a few hundred MB.",
     ),
+    "ARCSECOND_API_IMAGE": (
+        OPERATOR,
+        "The image the backend, both workers, beat and the alerts consumer run instead of the published one: "
+        "one built from the backend's sources, e.g. `arcsecond-api:latest`. Empty: the published image. Set "
+        "ARCSECOND_API_PULL_POLICY to `never` with it, then `arcsecond restart`.",
+    ),
+    "ARCSECOND_API_PULL_POLICY": (
+        OPERATOR,
+        "`never` when ARCSECOND_API_IMAGE names an image that exists on this machine only, so `arcsecond update` "
+        "and `arcsecond start --pull` leave it alone rather than fail to download it. Default `missing`.",
+    ),
+    "ARCSECOND_WEB_IMAGE": (
+        OPERATOR,
+        "The image the web interface runs instead of the published one: one built from the webapp's sources, "
+        "e.g. `arcsecond-web:latest`. Empty: the published image. Set ARCSECOND_WEB_PULL_POLICY to `never` "
+        "with it, then `arcsecond restart web`.",
+    ),
+    "ARCSECOND_WEB_PULL_POLICY": (
+        OPERATOR,
+        "`never` when ARCSECOND_WEB_IMAGE names an image that exists on this machine only, as "
+        "ARCSECOND_API_PULL_POLICY does for the backend's. Default `missing`.",
+    ),
 }
 
 

{arcsecond-4.4.2 → arcsecond-4.4.3}/arcsecond/hosting/docker/docker-compose.yml

@@ -1,6 +1,6 @@
 # === Arcsecond.local config. ===
 # *** DO NOT change any name or port number. ***
-# Version 7.4
+# Version 7.5
 
 services:
   # Database (PostgresQL)
@@ -29,7 +29,12 @@ services:
 
   # Arcsecond backend (REST APIs). Can be used for API calls and external pipelines, scripts etc.
   backend:
-    image: ghcr.io/arcsecond-io/arcsecond-api:latest
+    # ARCSECOND_API_IMAGE swaps the published image for one built from the
+    # backend's sources, here and on every service below that runs it.
+    # ARCSECOND_API_PULL_POLICY=never goes with it: such an image exists on
+    # this machine only, and `arcsecond update` must not try to download it.
+    image: ${ARCSECOND_API_IMAGE:-ghcr.io/arcsecond-io/arcsecond-api:latest}
+    pull_policy: ${ARCSECOND_API_PULL_POLICY:-missing}
     container_name: arcsecond-api
     restart: unless-stopped
     entrypoint: /home/app/entrypoint-server.sh
@@ -72,7 +77,8 @@ services:
   # Arcsecond worker, for offloading background work: the Control Room's
   # exposures and procedures, and everything else someone is waiting on.
   worker:
-    image: ghcr.io/arcsecond-io/arcsecond-api:latest
+    image: ${ARCSECOND_API_IMAGE:-ghcr.io/arcsecond-io/arcsecond-api:latest}
+    pull_policy: ${ARCSECOND_API_PULL_POLICY:-missing}
     container_name: arcsecond-worker
     restart: unless-stopped
     entrypoint: /home/app/entrypoint-worker.sh
@@ -100,7 +106,8 @@ services:
   # storages, database backups, keograms, catalogue refreshes. On its own
   # queue, so a long zip can never hold up a frame the observer is waiting for.
   dataworker:
-    image: ghcr.io/arcsecond-io/arcsecond-api:latest
+    image: ${ARCSECOND_API_IMAGE:-ghcr.io/arcsecond-io/arcsecond-api:latest}
+    pull_policy: ${ARCSECOND_API_PULL_POLICY:-missing}
     container_name: arcsecond-dataworker
     restart: unless-stopped
     entrypoint: /home/app/entrypoint-worker.sh
@@ -126,7 +133,8 @@ services:
 
   # Arcsecond beat, to launch specific background tasks at specific times.
   beat:
-    image: ghcr.io/arcsecond-io/arcsecond-api:latest
+    image: ${ARCSECOND_API_IMAGE:-ghcr.io/arcsecond-io/arcsecond-api:latest}
+    pull_policy: ${ARCSECOND_API_PULL_POLICY:-missing}
     container_name: arcsecond-beat
     restart: unless-stopped
     entrypoint: /home/app/entrypoint-beat.sh
@@ -149,7 +157,10 @@ services:
   # organisation-based and therefore always a portal, so the second port that
   # used to be here (5577) served the very same app.
   web:
-    image: ghcr.io/arcsecond-io/arcsecond-web:latest
+    # ARCSECOND_WEB_IMAGE and ARCSECOND_WEB_PULL_POLICY: the same as the
+    # backend's pair above, for an image built from the webapp's sources.
+    image: ${ARCSECOND_WEB_IMAGE:-ghcr.io/arcsecond-io/arcsecond-web:latest}
+    pull_policy: ${ARCSECOND_WEB_PULL_POLICY:-missing}
     container_name: arcsecond-web
     restart: unless-stopped
     depends_on:
@@ -183,7 +194,8 @@ services:
   # GCN_CONSUMER_CLIENT_SECRET in .env; idles harmlessly when they are absent.
   # Single instance only — do not scale it.
   alerts:
-    image: ghcr.io/arcsecond-io/arcsecond-api:latest
+    image: ${ARCSECOND_API_IMAGE:-ghcr.io/arcsecond-io/arcsecond-api:latest}
+    pull_policy: ${ARCSECOND_API_PULL_POLICY:-missing}
     container_name: arcsecond-alerts
     restart: unless-stopped
     entrypoint: /home/app/entrypoint-alerts.sh

{arcsecond-4.4.2 → arcsecond-4.4.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "arcsecond"
-version = "4.4.2"
+version = "4.4.3"
 authors = [
     { name = "Cedric Foellmi", email = "cedric@arcsecond.io" },
 ]

{arcsecond-4.4.2 → arcsecond-4.4.3}/tests/test_hosting_composedoc.py

@@ -58,6 +58,30 @@ def test_optional_services_are_recognised_by_their_markers():
     assert "GCN_CONSUMER_CLIENT_ID" in " ".join(s["alerts"].description)
 
 
+def test_every_service_on_the_backend_image_can_be_given_a_local_build():
+    s = _services()
+    api = [name for name, service in s.items() if "arcsecond-api" in service.image]
+    assert api == ["backend", "worker", "dataworker", "beat", "alerts"]
+    for name in api:
+        assert "ARCSECOND_API_IMAGE" in s[name].env_vars, name
+        assert "ARCSECOND_API_PULL_POLICY" in s[name].env_vars, name
+
+
+def test_the_web_interface_can_be_given_a_local_build():
+    web = _services()["web"]
+    assert (
+        web.image == "ghcr.io/arcsecond-io/arcsecond-web:latest"
+    )  # what an unset key runs
+    assert "ARCSECOND_WEB_IMAGE" in web.env_vars
+    assert "ARCSECOND_WEB_PULL_POLICY" in web.env_vars
+
+
+def test_every_key_the_template_reads_is_documented():
+    for service in composedoc.parse_services(local.packaged_compose_text()):
+        for key in service.env_vars:
+            assert key in composedoc.ENV_KEYS, (service.name, key)
+
+
 def test_every_key_setup_writes_is_documented():
     for key in local.REQUIRED_ENV_PROVIDERS:
         assert key in composedoc.ENV_KEYS, key

{arcsecond-4.4.2 → arcsecond-4.4.3}/uv.lock

@@ -155,7 +155,7 @@ wheels = [
 
 [[package]]
 name = "arcsecond"
-version = "4.4.2"
+version = "4.4.3"
 source = { editable = "." }
 dependencies = [
     { name = "alpyca" },