Feat/flower containers

armadillo/src/main/java/org/molgenis/armadillo/container/ContainerConfig.java

@@ -9,16 +9,20 @@
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
 @JsonSubTypes({
   @JsonSubTypes.Type(value = DatashieldContainerConfig.class, name = "ds"),
-  @JsonSubTypes.Type(value = VanillaContainerConfig.class, name = "vanilla")
+  @JsonSubTypes.Type(value = VanillaContainerConfig.class, name = "vanilla"),
+  @JsonSubTypes.Type(value = FlowerSupernodeContainerConfig.class, name = "flower-supernode"),
+  @JsonSubTypes.Type(value = FlowerSuperexecContainerConfig.class, name = "flower-superexec")
 })
 public interface ContainerConfig {
 
   String getName();
 
   String getImage();
 
+  @Nullable
   String getHost();
 
+  @Nullable
   Integer getPort();
 
   @Nullable

armadillo/src/main/java/org/molgenis/armadillo/container/DockerService.java

@@ -157,6 +157,9 @@
     containerStatusService.updateStatus(containerName, "Container installed", null, null);
     stopContainer(dockerContainerName);
     removeContainer(dockerContainerName);
+    if (containerConfig instanceof FlowerContainer) {
+      createNetworkIfNotExists(FlowerContainer.NETWORK_NAME);
+    }
     installImage(containerConfig);
     startContainer(dockerContainerName);
 
@@ -250,27 +253,87 @@
     }
   }
 
-  void installImage(ContainerConfig containerConfig) {
-    if (containerConfig.getImage() == null) {
-      throw new MissingImageException(containerConfig.getImage());
+  void installImage(ContainerConfig config) {
+    if (config.getImage() == null) {
+      throw new MissingImageException(config.getImage());
     }
 
-    // if rock is in the image name, it's rock
-    int imageExposed = containerConfig.getImage().contains("rock") ? 8085 : 6311;
+    try (CreateContainerCmd cmd = dockerClient.createContainerCmd(config.getImage())) {
+      HostConfig hostConfig =
+          new HostConfig().withRestartPolicy(RestartPolicy.unlessStoppedRestart());
+
+      configurePortBindings(cmd, hostConfig, config);
+      configureNetworkMode(hostConfig, config);
+      configureVolumes(hostConfig, config);
+
+      cmd.withHostConfig(hostConfig).withName(config.getName());
+      configureEnv(cmd, config);
+      configureDockerCmd(cmd, config);
+
+      cmd.exec();
+    } catch (DockerException e) {
+      throw new ImageStartFailedException(config.getImage(), e);
+    }
+  }
+
+  /** Binds container port to host. Skipped when port is null (e.g. flower containers). */
+  private void configurePortBindings(
+      CreateContainerCmd cmd, HostConfig hostConfig, ContainerConfig config) {
+    if (config.getPort() == null) return;
+
+    int imageExposed = config.getImage().contains("rock") ? 8085 : 6311;
     ExposedPort exposed = ExposedPort.tcp(imageExposed);
     Ports portBindings = new Ports();
-    portBindings.bind(exposed, Ports.Binding.bindPort(containerConfig.getPort()));
-    try (CreateContainerCmd cmd = dockerClient.createContainerCmd(containerConfig.getImage())) {
-      cmd.withExposedPorts(exposed)
-          .withHostConfig(
-              new HostConfig()
-                  .withPortBindings(portBindings)
-                  .withRestartPolicy(RestartPolicy.unlessStoppedRestart()))
-          .withName(containerConfig.getName())
-          .withEnv("DEBUG=FALSE")
-          .exec();
-    } catch (DockerException e) {
-      throw new ImageStartFailedException(containerConfig.getImage(), e);
+    portBindings.bind(exposed, Ports.Binding.bindPort(config.getPort()));
+    hostConfig.withPortBindings(portBindings);
+    cmd.withExposedPorts(exposed);
+  }
+
+  private void configureNetworkMode(HostConfig hostConfig, ContainerConfig config) {
+    if (config instanceof FlowerContainer) {
+      hostConfig.withNetworkMode(FlowerContainer.NETWORK_NAME);
+    }
+  }
+
+  private void configureEnv(CreateContainerCmd cmd, ContainerConfig config) {
+    if (config instanceof FlowerSuperexecContainerConfig) {
+      cmd.withEnv("DEBUG=FALSE", "ARMADILLO_CONTAINER_NAME=" + config.getName());
+    } else {
+      cmd.withEnv("DEBUG=FALSE");
+    }
+  }
+
+  /** Mounts host paths into the container. Only supported for flower supernodes. */
+  private void configureVolumes(HostConfig hostConfig, ContainerConfig config) {
+    if (!(config instanceof FlowerSupernodeContainerConfig)) return;
+    Map<String, Object> opts = config.getDockerOptions();
+    if (opts == null || !opts.containsKey("volumes")) return;
+
+    Object volumesObj = opts.get("volumes");
+    if (!(volumesObj instanceof Map<?, ?> rawMap)) return;
+
+    Bind[] binds =
+        rawMap.entrySet().stream()
+            .filter(e -> e.getKey() instanceof String && e.getValue() instanceof String)
+            .map(
+                e ->
+                    new Bind((String) e.getKey(), new Volume((String) e.getValue()), AccessMode.ro))
+            .toArray(Bind[]::new);
+    hostConfig.withBinds(binds);
+  }
+
+  private void configureDockerCmd(CreateContainerCmd cmd, ContainerConfig config) {
+    List<String> args = config.getDockerArgs();
+    if (args != null && !args.isEmpty()) {
+      cmd.withCmd(args.toArray(new String[0]));
+    }
+  }
+
+  private void createNetworkIfNotExists(String networkName) {
+    List<Network> networks = dockerClient.listNetworksCmd().withNameFilter(networkName).exec();
+    if (networks.isEmpty()) {
+      LOG.info("Creating docker network '{}'", networkName);
+      dockerClient.createNetworkCmd().withName(networkName).withDriver("bridge").exec();
     }
   }
 

armadillo/src/main/java/org/molgenis/armadillo/container/FlowerContainer.java

@@ -0,0 +1,6 @@
+package org.molgenis.armadillo.container;
+
+/** Marker interface for Flower federated learning containers. */
+public interface FlowerContainer {
+  String NETWORK_NAME = "flower-network";
+}

armadillo/src/main/java/org/molgenis/armadillo/container/FlowerSuperexecContainerConfig.java

@@ -0,0 +1,126 @@
+package org.molgenis.armadillo.container;
+
+import com.fasterxml.jackson.annotation.*;
+import com.google.auto.value.AutoValue;
+import jakarta.annotation.Nullable;
+import java.util.List;
+import java.util.Map;
+
+@AutoValue
+@JsonTypeName("flower-superexec")
+// AutoValue requires redeclaring interface methods as abstract - suppress S1161
+@SuppressWarnings("java:S1161")
+public abstract class FlowerSuperexecContainerConfig
+    implements ContainerConfig, OpenContainer, FlowerContainer {
+
+  @Override
+  public abstract String getName();
+
+  @Override
+  public abstract String getImage();
+
+  @Override
+  @Nullable
+  public abstract String getHost();
+
+  @Override
+  @Nullable
+  public abstract Integer getPort();
+
+  @Override
+  @Nullable
+  public abstract Long getImageSize();
+
+  @Override
+  @Nullable
+  public abstract String getInstallDate();
+
+  @Override
+  @Nullable
+  public abstract String getLastImageId();
+
+  @Override
+  @Nullable
+  public abstract List<String> getDockerArgs();
+
+  @Override
+  @Nullable
+  public abstract Map<String, Object> getDockerOptions();
+
+  @Override
+  @Nullable
+  public abstract String getVersionId();
+
+  @Override
+  @Nullable
+  public abstract String getCreationDate();
+
+  @Override
+  @JsonIgnore
+  public String getType() {
+    return "flower-superexec";
+  }
+
+  @JsonCreator
+  public static FlowerSuperexecContainerConfig create(
+      @JsonProperty("name") String name,
+      @JsonProperty("image") String image,
+      @JsonProperty("host") @Nullable String host,
+      @JsonProperty("port") @Nullable Integer port,
+      @JsonProperty("imageSize") @Nullable Long imageSize,
+      @JsonProperty("installDate") @Nullable String installDate,
+      @JsonProperty("lastImageId") @Nullable String lastImageId,
+      @JsonProperty("dockerArgs") @Nullable List<String> dockerArgs,
+      @JsonProperty("dockerOptions") @Nullable Map<String, Object> dockerOptions,
+      @JsonProperty("versionId") @Nullable String versionId,
+      @JsonProperty("creationDate") @Nullable String creationDate) {
+
+    return builder()
+        .name(name)
+        .image(image)
+        .host(host)
+        .port(port)
+        .imageSize(imageSize)
+        .installDate(installDate)
+        .lastImageId(lastImageId)
+        .dockerArgs(dockerArgs)
+        .dockerOptions(dockerOptions)
+        .versionId(versionId)
+        .creationDate(creationDate)
+        .build();
+  }
+
+  public static FlowerSuperexecContainerConfig.Builder builder() {
+    return new AutoValue_FlowerSuperexecContainerConfig.Builder();
+  }
+
+  public abstract Builder toBuilder();
+
+  @AutoValue.Builder
+  public abstract static class Builder {
+
+    public abstract Builder name(String name);
+
+    public abstract Builder image(String image);
+
+    public abstract Builder host(@Nullable String host);
+
+    public abstract Builder port(@Nullable Integer port);
+
+    public abstract Builder imageSize(@Nullable Long imageSize);
+
+    public abstract Builder installDate(@Nullable String installDate);
+
+    public abstract Builder lastImageId(@Nullable String lastImageId);
+
+    public abstract Builder dockerArgs(@Nullable List<String> dockerArgs);
+
+    public abstract Builder dockerOptions(@Nullable Map<String, Object> dockerOptions);
+
+    public abstract Builder versionId(@Nullable String versionId);
+
+    public abstract Builder creationDate(@Nullable String creationDate);
+
+    public abstract FlowerSuperexecContainerConfig build();
+  }
+}

armadillo/src/main/java/org/molgenis/armadillo/container/FlowerSuperexecContainerUpdater.java

@@ -0,0 +1,38 @@
+package org.molgenis.armadillo.container;
+
+import org.molgenis.armadillo.metadata.DefaultImageMetadata;
+import org.molgenis.armadillo.metadata.OpenContainersImageMetadata;
+import org.springframework.stereotype.Component;
+
+@Component
+public class FlowerSuperexecContainerUpdater
+    implements ContainerUpdater<FlowerSuperexecContainerConfig>,
+        OpenContainersUpdater<FlowerSuperexecContainerConfig> {
+
+  @Override
+  public Class<FlowerSuperexecContainerConfig> getSupportedType() {
+    return FlowerSuperexecContainerConfig.class;
+  }
+
+  @Override
+  public ContainerConfig updateDefaultImageMetadata(
+      FlowerSuperexecContainerConfig existingConfig, DefaultImageMetadata metadata) {
+    return existingConfig.toBuilder()
+        .lastImageId(metadata.currentImageId())
+        .imageSize(metadata.imageSize())
+        .installDate(
+            metadata.installDate() != null
+                ? metadata.installDate()
+                : existingConfig.getInstallDate())
+        .build();
+  }
+
+  @Override
+  public ContainerConfig updateOpenContainersMetaData(
+      FlowerSuperexecContainerConfig existingConfig, OpenContainersImageMetadata metadata) {
+    return existingConfig.toBuilder()
+        .versionId(metadata.openContainersId())
+        .creationDate(metadata.creationDate())
+        .build();
+  }
+}