diff options
author | Valerij Fredriksen <freva@users.noreply.github.com> | 2021-07-06 17:29:31 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-07-06 17:29:31 +0200 |
commit | ecf81c57a29ae9b8cb684195a74ee3595d8c99c1 (patch) | |
tree | 0087edb1ad3c60aa2afd5e4926f077a9126b0179 | |
parent | 5c93196e92ab5390abe1ece2f839a5fecc96b8c8 (diff) | |
parent | 242df340641cb96119ab3958155ce65c3c3c14f9 (diff) |
Merge pull request #18546 from vespa-engine/mpolden/fix-javadoc
Fix javadoc typos
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"); |