Merge pull request #2314 from valory-xyz/feat/multiarch-build-image

OjusWiZard · web-flow · commit a6702c493e2b · 2025-03-18T16:45:12.000+05:30
Feat: Support multi platform docker image builds
diff --git a/autonomy/cli/build_images.py b/autonomy/cli/build_images.py
@@ -67,6 +67,12 @@
     ),
     help="Specify custom dockerfile for building the agent",
 )
+@click.option(
+    "--platform",
+    type=str,
+    help="Specify the target architecture platform for the image.",
+)
+@click.option("--push", is_flag=True, help="Push image to docker hub.", default=False)
 @image_author_option
 def build_image(  # pylint: disable=too-many-arguments
     agent: Optional[PublicId],
@@ -77,6 +83,8 @@ def build_image(  # pylint: disable=too-many-arguments
     dev: bool = False,
     version: Optional[str] = None,
     image_author: Optional[str] = None,
+    platform: Optional[str] = None,
+    push: bool = False,
 ) -> None:
     """Build runtime images for autonomous agents."""
     if dev:
@@ -93,4 +101,6 @@ def build_image(  # pylint: disable=too-many-arguments
             version=version,
             image_author=image_author,
             dockerfile=dockerfile,
+            platform=platform,
+            push=push,
         )
diff --git a/autonomy/cli/helpers/image.py b/autonomy/cli/helpers/image.py
@@ -37,6 +37,8 @@ def build_image(  # pylint: disable=too-many-arguments
     image_author: Optional[str] = None,
     extra_dependencies: Optional[Tuple[Dependency, ...]] = None,
     dockerfile: Optional[Path] = None,
+    platform: Optional[str] = None,
+    push: bool = False,
 ) -> None:
     """Build agent/service image."""
     extra_dependencies = extra_dependencies or ()
@@ -54,4 +56,6 @@ def build_image(  # pylint: disable=too-many-arguments
         image_author=image_author,
         extra_dependencies=extra_dependencies,
         dockerfile=dockerfile,
+        platform=platform,
+        push=push,
     )
diff --git a/autonomy/deploy/image.py b/autonomy/deploy/image.py
@@ -20,9 +20,9 @@
 """Image building."""
 
 
-import json
+import subprocess  # nosec
 from pathlib import Path
-from typing import Dict, Optional, Tuple
+from typing import Optional, Tuple
 
 from aea.cli.utils.config import get_default_author_from_cli_config
 from aea.configurations.data_types import Dependency, PublicId
@@ -35,7 +35,6 @@
 )
 from autonomy.data import DATA_DIR
 from autonomy.deploy.constants import DOCKERFILES
-from autonomy.deploy.generators.docker_compose.base import get_docker_client
 
 
 def generate_dependency_flag_var(dependencies: Tuple[Dependency, ...]) -> str:
@@ -64,20 +63,13 @@ def build_image(  # pylint: disable=too-many-arguments,too-many-locals
     image_author: Optional[str] = None,
     extra_dependencies: Optional[Tuple[Dependency, ...]] = None,
     dockerfile: Optional[Path] = None,
+    platform: Optional[str] = None,
+    push: bool = False,
 ) -> None:
     """Command to build images from for skaffold deployment."""
 
     tag: str
     path: str
-    buildargs: Dict[str, str]
-    docker_client = get_docker_client()
-    buildargs = {
-        "AUTONOMY_IMAGE_NAME": AUTONOMY_IMAGE_NAME,
-        "AUTONOMY_IMAGE_VERSION": AUTONOMY_IMAGE_VERSION,
-        "AEA_AGENT": str(agent),
-        "AUTHOR": get_default_author_from_cli_config(),
-        "EXTRA_DEPENDENCIES": generate_dependency_flag_var(extra_dependencies or ()),
-    }
 
     image_version = version or agent.hash
     path = str(DATA_DIR / DOCKERFILES / "agent")
@@ -90,30 +82,35 @@ def build_image(  # pylint: disable=too-many-arguments,too-many-locals
         version=image_version,
     )
 
-    stream = docker_client.api.build(
-        path=path,
-        tag=tag,
-        buildargs=buildargs,
-        pull=pull,
+    build_process = subprocess.run(  # nosec # pylint: disable=subprocess-run-check
+        [
+            "docker",
+            "build",
+            "--build-arg",
+            f"AUTONOMY_IMAGE_NAME={AUTONOMY_IMAGE_NAME}",
+            "--build-arg",
+            f"AUTONOMY_IMAGE_VERSION={AUTONOMY_IMAGE_VERSION}",
+            "--build-arg",
+            f"AUTHOR={get_default_author_from_cli_config()}",
+            "--build-arg",
+            f"AEA_AGENT={str(agent)}",
+            "--build-arg",
+            f"EXTRA_DEPENDENCIES={generate_dependency_flag_var(extra_dependencies or ())}",
+            "--tag",
+            tag,
+            "--no-cache",
+        ]
+        + (["--platform", platform] if platform else [])
+        + []
+        + (["--push"] if push else [])
+        + []
+        + (["--pull"] if pull else [])
+        + [
+            path,
+        ]
     )
 
-    for stream_obj in stream:
-        for line in stream_obj.decode().split("\n"):
-            line = line.strip()
-            if not line:
-                continue
-            stream_data = json.loads(line)
-            if "stream" in stream_data:
-                print("[docker]" + stream_data["stream"], end="")
-            elif "errorDetail" in stream_data:
-                raise ImageBuildFailed(
-                    "Image build failed with error "
-                    + stream_data["errorDetail"]["message"]
-                )
-            elif "aux" in stream_data:
-                print("[docker]" + stream_data["aux"]["ID"], end="")
-            elif "status" in stream_data:  # pragma: no cover
-                print("[docker]" + stream_data["status"], end="")
+    build_process.check_returncode()
 
 
 class ImageBuildFailed(Exception):
diff --git a/deployments/Dockerfiles/autonomy/scripts/install.sh b/deployments/Dockerfiles/autonomy/scripts/install.sh
@@ -17,7 +17,7 @@ aea build || exit 1
 echo "Successfully built the host dependencies."
 
 echo "Installing the necessary python dependencies!"
-aea install --timeout 600 $EXTRA_DEPENDENCIES || exit 1
+aea install --timeout 1200 $EXTRA_DEPENDENCIES || exit 1
 echo "Successfully Installed the python dependencies."
 
 echo "Done."
diff --git a/docs/api/cli/build_images.md b/docs/api/cli/build_images.md
@@ -47,6 +47,15 @@ Build images.
     ),
     help="Specify custom dockerfile for building the agent",
 )
+@click.option(
+    "--platform",
+    type=str,
+    help="Specify the target architecture platform for the image.",
+)
+@click.option("--push",
+              is_flag=True,
+              help="Push image to docker hub.",
+              default=False)
 @image_author_option
 def build_image(agent: Optional[PublicId],
                 service_dir: Optional[Path],
@@ -55,7 +64,9 @@ def build_image(agent: Optional[PublicId],
                 pull: bool = False,
                 dev: bool = False,
                 version: Optional[str] = None,
-                image_author: Optional[str] = None) -> None
+                image_author: Optional[str] = None,
+                platform: Optional[str] = None,
+                push: bool = False) -> None
 ```
 
 Build runtime images for autonomous agents.
diff --git a/docs/api/cli/helpers/image.md b/docs/api/cli/helpers/image.md
@@ -15,7 +15,9 @@ def build_image(agent: Optional[PublicId],
                 version: Optional[str] = None,
                 image_author: Optional[str] = None,
                 extra_dependencies: Optional[Tuple[Dependency, ...]] = None,
-                dockerfile: Optional[Path] = None) -> None
+                dockerfile: Optional[Path] = None,
+                platform: Optional[str] = None,
+                push: bool = False) -> None
 ```
 
 Build agent/service image.
diff --git a/docs/api/deploy/image.md b/docs/api/deploy/image.md
@@ -34,7 +34,9 @@ def build_image(agent: PublicId,
                 version: Optional[str] = None,
                 image_author: Optional[str] = None,
                 extra_dependencies: Optional[Tuple[Dependency, ...]] = None,
-                dockerfile: Optional[Path] = None) -> None
+                dockerfile: Optional[Path] = None,
+                platform: Optional[str] = None,
+                push: bool = False) -> None
 ```
 
 Command to build images from for skaffold deployment.
diff --git a/tests/test_autonomy/test_cli/test_build_image.py b/tests/test_autonomy/test_cli/test_build_image.py
@@ -180,11 +180,11 @@ def test_service_file_missing(
     def test_image_build_fail(self) -> None:
         """Test prod build."""
 
-        result = self.run_cli(
+        exit_code, stdout, stderr = self.run_cli_subprocess(
             commands=(
                 "valory/agent:bafybeihyasfforsfualp6jnhh2jj7nreqmws2ygyfnh4p3idmfkm5yxu11",
             )
         )
 
-        assert result.exit_code == 1, result.output
-        assert "Error occured while downloading agent" in result.output
+        assert exit_code == 1, stdout
+        assert "Error occured while downloading agent" in stderr

Original file line number	Diff line number	Diff line change
`@@ -180,11 +180,11 @@ def test_service_file_missing(`
`180`	`180`	`def test_image_build_fail(self) -> None:`
`181`	`181`	`"""Test prod build."""`
`182`	`182`
`183`		`- result = self.run_cli(`
	`183`	`+ exit_code, stdout, stderr = self.run_cli_subprocess(`
`184`	`184`	`commands=(`
`185`	`185`	`"valory/agent:bafybeihyasfforsfualp6jnhh2jj7nreqmws2ygyfnh4p3idmfkm5yxu11",`
`186`	`186`	`)`
`187`	`187`	`)`
`188`	`188`
`189`		`- assert result.exit_code == 1, result.output`
`190`		`- assert "Error occured while downloading agent" in result.output`
	`189`	`+ assert exit_code == 1, stdout`
	`190`	`+ assert "Error occured while downloading agent" in stderr`