summaryrefslogtreecommitdiffstats
path: root/node-admin
diff options
context:
space:
mode:
authorMartin Polden <mpolden@mpolden.no>2021-07-05 17:16:07 +0200
committerMartin Polden <mpolden@mpolden.no>2021-07-05 17:16:07 +0200
commit242df340641cb96119ab3958155ce65c3c3c14f9 (patch)
tree03ec130df28c9ab55d708cd7cff0161f1bfa1abc /node-admin
parent46983e70141a23e00304dd74eed64c469759f5a0 (diff)
Fix javadoc typos
Diffstat (limited to 'node-admin')
-rw-r--r--node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/container/ContainerEngine.java12
-rw-r--r--node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/container/ContainerOperations.java5
2 files changed, 8 insertions, 9 deletions
diff --git a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/container/ContainerEngine.java b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/container/ContainerEngine.java
index 58ff1af4681..75069fa815e 100644
--- a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/container/ContainerEngine.java
+++ b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/container/ContainerEngine.java
@@ -25,7 +25,7 @@ public interface ContainerEngine {
/** Start a created container */
void startContainer(NodeAgentContext context);
- /** Update an existing container */
+ /** Update an existing container with new resources */
void updateContainer(NodeAgentContext context, ContainerId containerId, ContainerResources containerResources);
/** Remove given container. The container will be stopped if necessary */
@@ -34,25 +34,25 @@ public interface ContainerEngine {
/** Get container for given context */
Optional<Container> getContainer(NodeAgentContext context);
- /** List containers managed by this */
+ /** Returns all containers known by this */
List<PartialContainer> listContainers(TaskContext context);
/** Returns the network interface used by container in given context */
String networkInterface(NodeAgentContext context);
- /** Executes a command in inside container as root user, throws on non-zero exit code */
+ /** Execute command inside container as root. Ignores non-zero exit code */
CommandResult executeAsRoot(NodeAgentContext context, Duration timeout, String... command);
- /** Executes a command in inside containers network namespace, throws on non-zero exit code */
+ /** Execute command inside the container's network namespace. Throws on non-zero exit code */
CommandResult executeInNetworkNamespace(NodeAgentContext context, String... command);
- /** Download giving image */
+ /** Download given image */
void pullImage(TaskContext context, DockerImage image, RegistryCredentials registryCredentials);
/** Returns whether given image is already downloaded */
boolean hasImage(TaskContext context, DockerImage image);
- /** Remove given image */
+ /** Remove image by id */
void removeImage(TaskContext context, String id);
/** Returns images available in this */
diff --git a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/container/ContainerOperations.java b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/container/ContainerOperations.java
index 444e92e793f..49216ddfdaf 100644
--- a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/container/ContainerOperations.java
+++ b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/container/ContainerOperations.java
@@ -70,17 +70,16 @@ public class ContainerOperations {
return executeCommandInContainerAsRoot(context, CommandLine.DEFAULT_TIMEOUT.toSeconds(), command);
}
- /** Executes a command inside container identified by given context. Does NOT throw on non-zero exit code */
+ /** Execute command inside container identified by given context. Does NOT throw on non-zero exit code */
public CommandResult executeCommandInContainerAsRoot(NodeAgentContext context, Long timeoutSeconds, String... command) {
return containerEngine.executeAsRoot(context, Duration.ofSeconds(timeoutSeconds), command);
}
- /** Executes a command in inside containers network namespace, throws on non-zero exit code */
+ /** Execute command in inside containers network namespace, identified by given context. Throws on non-zero exit code */
public CommandResult executeCommandInNetworkNamespace(NodeAgentContext context, String... command) {
return containerEngine.executeInNetworkNamespace(context, command);
}
-
/** Resume node. Resuming a node means that it is ready to receive traffic */
public String resumeNode(NodeAgentContext context) {
return executeNodeCtlInContainer(context, "resume");