Add Annotations option to HostConfig (#2422)

emirhandurmus · web-flow · commit 9ccbd8fdfc85 · 2025-07-04T07:31:33.000-06:00
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/HostConfig.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/HostConfig.java
@@ -73,6 +73,9 @@ public static HostConfig newHostConfig() {
     @JsonProperty("NanoCpus")
     private Long nanoCPUs;
 
+    @JsonProperty("Annotations")
+    private Map<String, String> annotations;
+
     @JsonProperty("CapAdd")
     private Capability[] capAdd;
 
@@ -304,6 +307,11 @@ public Integer getBlkioWeight() {
         return blkioWeight;
     }
 
+    @CheckForNull
+    public Map<String, String> getAnnotations() {
+        return annotations;
+    }
+
     public Capability[] getCapAdd() {
         return capAdd;
     }
@@ -636,6 +644,11 @@ public HostConfig withBlkioWeightDevice(List<BlkioWeightDevice> blkioWeightDevic
         return this;
     }
 
+    public HostConfig withAnnotations(Map<String, String> annotations) {
+        this.annotations = annotations;
+        return this;
+    }
+
     /**
      * @see #capAdd
      */
diff --git a/docker-java/src/test/java/com/github/dockerjava/cmd/CreateContainerCmdIT.java b/docker-java/src/test/java/com/github/dockerjava/cmd/CreateContainerCmdIT.java
@@ -10,6 +10,8 @@
 import com.github.dockerjava.api.command.InspectContainerResponse;
 import com.github.dockerjava.api.exception.ConflictException;
 import com.github.dockerjava.api.exception.DockerException;
+import com.github.dockerjava.api.DockerClient;
+import com.github.dockerjava.core.DefaultDockerClientConfig;
 import com.github.dockerjava.api.exception.InternalServerErrorException;
 import com.github.dockerjava.api.exception.NotFoundException;
 import com.github.dockerjava.api.model.AuthConfig;
@@ -58,6 +60,7 @@
 import static com.github.dockerjava.api.model.HostConfig.newHostConfig;
 import static com.github.dockerjava.core.RemoteApiVersion.VERSION_1_23;
 import static com.github.dockerjava.core.RemoteApiVersion.VERSION_1_24;
+import static com.github.dockerjava.core.RemoteApiVersion.VERSION_1_43;
 import static com.github.dockerjava.junit.DockerMatchers.isGreaterOrEqual;
 import static com.github.dockerjava.junit.DockerMatchers.mountedVolumes;
 import static com.github.dockerjava.core.DockerRule.DEFAULT_IMAGE;
@@ -1141,4 +1144,33 @@ public void shouldHandleANetworkAliasWithoutACustomNetworkGracefully() {
             .withCmd("sleep", "9999")
             .exec();
     }
+
+    @Test
+    public void createContainerWithAnnotations() throws DockerException {
+        DefaultDockerClientConfig forcedConfig = DefaultDockerClientConfig.createDefaultConfigBuilder()
+        .withApiVersion(VERSION_1_43)
+        .withRegistryUrl("https://index.docker.io/v1/")
+        .build();
+        
+        DockerClient forcedClient = CmdIT.createDockerClient(forcedConfig);
+        Map<String, String> annotations = new HashMap<>();
+        annotations.put("com.example.key1", "value1");
+        annotations.put("com.example.key2", "value2");
+
+        CreateContainerResponse container = forcedClient.createContainerCmd(DEFAULT_IMAGE)
+                .withCmd("sleep", "9999")
+                .withHostConfig(newHostConfig()
+                        .withAnnotations(annotations))
+                .exec();
+
+        LOG.info("Created container {}", container.toString());
+
+        assertThat(container.getId(), not(is(emptyString())));
+
+        InspectContainerResponse inspectContainerResponse = forcedClient.inspectContainerCmd(container.getId()).exec();
+
+        assertThat(inspectContainerResponse.getHostConfig().getAnnotations(), equalTo(annotations));
+        assertThat(inspectContainerResponse.getHostConfig().getAnnotations().get("com.example.key1"), equalTo("value1"));
+        assertThat(inspectContainerResponse.getHostConfig().getAnnotations().get("com.example.key2"), equalTo("value2"));
+    }
 }
