Add container platform to docker command

Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
nextflow-io · Mar 4, 2025 · 8580bd7 · 8580bd7
1 parent 15c6f3c
commit 8580bd7
Show file tree

Hide file tree

Showing 11 changed files with 68 additions and 5 deletions.
diff --git a/modules/nextflow/src/main/groovy/nextflow/container/ContainerBuilder.groovy b/modules/nextflow/src/main/groovy/nextflow/container/ContainerBuilder.groovy
@@ -84,6 +84,8 @@ abstract class ContainerBuilder<V extends ContainerBuilder> {
 
     protected boolean privileged
 
+    protected  String platform
+
     String getImage() { image }
 
     V addRunOptions(String str) {
@@ -121,6 +123,11 @@ abstract class ContainerBuilder<V extends ContainerBuilder> {
         return (V)this
     }
 
+    V setPlatform(String platform) {
+        this.platform = platform
+        return (V)this
+    }
+
     V setWorkDir( Path path ) {
         this.workDir = path
         return (V)this

diff --git a/modules/nextflow/src/main/groovy/nextflow/container/DockerBuilder.groovy b/modules/nextflow/src/main/groovy/nextflow/container/DockerBuilder.groovy
@@ -141,6 +141,9 @@ class DockerBuilder extends ContainerBuilder<DockerBuilder> {
         if( memory )
             result << "--memory ${memory} "
 
+        if( platform )
+            result << "--platform ${platform} "
+
         if( tty )
             result << '-t '
 

diff --git a/modules/nextflow/src/main/groovy/nextflow/container/PodmanBuilder.groovy b/modules/nextflow/src/main/groovy/nextflow/container/PodmanBuilder.groovy
@@ -137,6 +137,10 @@ class PodmanBuilder extends ContainerBuilder<PodmanBuilder> {
             result << "--memory ${memory} "
         }
 
+        if( platform ) {
+            result << "--platform ${platform} "
+        }
+
         // the name is after the user option so it has precedence over any options provided by the user
         if ( name )
             result << '--name ' << name << ' '

diff --git a/modules/nextflow/src/main/groovy/nextflow/executor/BashWrapperBuilder.groovy b/modules/nextflow/src/main/groovy/nextflow/executor/BashWrapperBuilder.groovy
@@ -701,6 +701,9 @@ class BashWrapperBuilder {
         if( this.containerCpuset )
             builder.addRunOptions(containerCpuset)
 
+        if( this.containerPlatform )
+            builder.setPlatform(this.containerPlatform)
+
         // export task work directory
         builder.addEnv('NXF_TASK_WORKDIR')
         // export the nextflow script debug variable

diff --git a/modules/nextflow/src/main/groovy/nextflow/processor/TaskBean.groovy b/modules/nextflow/src/main/groovy/nextflow/processor/TaskBean.groovy
@@ -24,7 +24,6 @@ import nextflow.container.ContainerConfig
 import nextflow.executor.BashWrapperBuilder
 import nextflow.executor.TaskArrayExecutor
 import nextflow.util.MemoryUnit
-
 /**
  * Serializable task value object. Holds configuration values required to
  * launch the task execution
@@ -88,6 +87,8 @@ class TaskBean implements Serializable, Cloneable {
 
     String containerOptions
 
+    String containerPlatform
+
     Map<String,Path> inputFiles
 
     List<String> outputFiles
@@ -152,6 +153,7 @@ class TaskBean implements Serializable, Cloneable {
         this.containerNative = task.isContainerNative()
         this.containerEnabled = task.isContainerEnabled()
         this.containerOptions = task.config.getContainerOptions()
+        this.containerPlatform = task.config.getContainerPlatform()
         // secret management
         this.secretNative = task.isSecretNative()
         this.secretNames = task.config.getSecret()

diff --git a/modules/nextflow/src/main/groovy/nextflow/processor/TaskConfig.groovy b/modules/nextflow/src/main/groovy/nextflow/processor/TaskConfig.groovy
@@ -36,6 +36,8 @@ import nextflow.util.CmdLineHelper
 import nextflow.util.CmdLineOptionMap
 import nextflow.util.Duration
 import nextflow.util.MemoryUnit
+import nextflow.util.SysHelper
+
 /**
  * Task local configuration properties
  *
@@ -450,6 +452,11 @@ class TaskConfig extends LazyMap implements Cloneable {
         return null
     }
 
+    String getContainerPlatform() {
+        final result = getArchitecture()
+        return result ? result.getDockerArch() : SysHelper.DEFAULT_DOCKER_PLATFORM
+    }
+
     def getClusterOptions() {
         return get('clusterOptions')
     }

diff --git a/modules/nextflow/src/test/groovy/nextflow/container/DockerBuilderTest.groovy b/modules/nextflow/src/test/groovy/nextflow/container/DockerBuilderTest.groovy
@@ -188,6 +188,23 @@ class DockerBuilderTest extends Specification {
                 .runCommand == 'docker run -i -v "$NXF_TASK_WORKDIR":"$NXF_TASK_WORKDIR" -w "$NXF_TASK_WORKDIR" --device /dev/fuse --cap-add SYS_ADMIN fedora'
     }
 
+    def 'test container platform' () {
+        expect:
+        new DockerBuilder('fedora')
+            .build()
+            .runCommand == 'docker run -i -v "$NXF_TASK_WORKDIR":"$NXF_TASK_WORKDIR" -w "$NXF_TASK_WORKDIR" fedora'
+
+        new DockerBuilder('fedora')
+            .setPlatform('amd64')
+            .build()
+            .runCommand == 'docker run -i --platform amd64 -v "$NXF_TASK_WORKDIR":"$NXF_TASK_WORKDIR" -w "$NXF_TASK_WORKDIR" fedora'
+
+        new DockerBuilder('fedora')
+            .setPlatform('linux/arm64')
+            .build()
+            .runCommand == 'docker run -i --platform linux/arm64 -v "$NXF_TASK_WORKDIR":"$NXF_TASK_WORKDIR" -w "$NXF_TASK_WORKDIR" fedora'
+    }
+
     def 'test add mount'() {
 
         when:

diff --git a/modules/nextflow/src/test/groovy/nextflow/container/PodmanBuilderTest.groovy b/modules/nextflow/src/test/groovy/nextflow/container/PodmanBuilderTest.groovy
@@ -240,4 +240,21 @@ class PodmanBuilderTest extends Specification {
                 .runCommand == 'podman run -i -v "$NXF_TASK_WORKDIR":"$NXF_TASK_WORKDIR" -w "$NXF_TASK_WORKDIR" --cpu-shares 1024 --memory 400m fedora'
 
     }
+
+    def 'test container platform' () {
+        expect:
+        new PodmanBuilder('fedora')
+            .build()
+            .runCommand == 'podman run -i -v "$NXF_TASK_WORKDIR":"$NXF_TASK_WORKDIR" -w "$NXF_TASK_WORKDIR" fedora'
+
+        new PodmanBuilder('fedora')
+            .setPlatform('amd64')
+            .build()
+            .runCommand == 'podman run -i -v "$NXF_TASK_WORKDIR":"$NXF_TASK_WORKDIR" -w "$NXF_TASK_WORKDIR" --platform amd64 fedora'
+
+        new PodmanBuilder('fedora')
+            .setPlatform('linux/arm64')
+            .build()
+            .runCommand == 'podman run -i -v "$NXF_TASK_WORKDIR":"$NXF_TASK_WORKDIR" -w "$NXF_TASK_WORKDIR" --platform linux/arm64 fedora'
+    }
 }
diff --git a/modules/nextflow/src/test/groovy/nextflow/executor/BashWrapperBuilderTest.groovy b/modules/nextflow/src/test/groovy/nextflow/executor/BashWrapperBuilderTest.groovy
@@ -213,6 +213,7 @@ class BashWrapperBuilderTest extends Specification {
         bash.getContainerCpus() >> null
         bash.getContainerCpuset() >> null
         bash.getContainerOptions() >> null
+        bash.getContainerPlatform() >> 'amd64'
         bash.isSecretNative() >> false
         bash.getSecretNames() >> []
 

diff --git a/modules/nf-commons/src/main/nextflow/util/SysHelper.groovy b/modules/nf-commons/src/main/nextflow/util/SysHelper.groovy
@@ -35,6 +35,8 @@ import nextflow.file.FileHelper
 @CompileStatic
 class SysHelper {
 
+    public static final String DEFAULT_DOCKER_PLATFORM = 'linux/amd64'
+
     private static String DATE_FORMAT = 'dd-MMM-yyyy HH:mm'
 
     /**
@@ -195,4 +197,5 @@ class SysHelper {
 
         return buffer.toString()
     }
+
 }
diff --git a/plugins/nf-wave/src/main/io/seqera/wave/plugin/WaveClient.groovy b/plugins/nf-wave/src/main/io/seqera/wave/plugin/WaveClient.groovy
@@ -71,6 +71,8 @@ import nextflow.util.SysHelper
 import nextflow.util.Threads
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
+import static nextflow.util.SysHelper.DEFAULT_DOCKER_PLATFORM
+
 /**
  * Wave client service
  *
@@ -93,8 +95,6 @@ class WaveClient {
 
     public static final List<String> DEFAULT_CONDA_CHANNELS = ['conda-forge','bioconda']
 
-    private static final String DEFAULT_DOCKER_PLATFORM = 'linux/amd64'
-
     final private HttpClient httpClient
 
     final private WaveConfig config
@@ -473,8 +473,7 @@ class WaveClient {
         // get the bundle
         final bundle = task.getModuleBundle()
         // get the architecture
-        final arch = task.config.getArchitecture()
-        final dockerArch = arch? arch.dockerArch : DEFAULT_DOCKER_PLATFORM
+        final dockerArch = task.config.getContainerPlatform()
         // compose the request attributes
         def attrs = new HashMap<String,String>()
         attrs.container = containerImage