node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/docker/DockerOperations.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.node.admin.docker;

import com.yahoo.vespa.hosted.dockerapi.Container;
import com.yahoo.vespa.hosted.dockerapi.ContainerName;
import com.yahoo.vespa.hosted.dockerapi.ContainerResources;
import com.yahoo.vespa.hosted.dockerapi.ContainerStats;
import com.yahoo.vespa.hosted.dockerapi.DockerImage;
import com.yahoo.vespa.hosted.dockerapi.ProcessResult;
import com.yahoo.vespa.hosted.node.admin.nodeagent.NodeAgentContext;
import com.yahoo.vespa.hosted.node.admin.nodeagent.ContainerData;

import java.util.List;
import java.util.Optional;

public interface DockerOperations {

    void createContainer(NodeAgentContext context, ContainerData containerData);

    void startContainer(NodeAgentContext context);

    void removeContainer(NodeAgentContext context, Container container);

    void updateContainer(NodeAgentContext context, ContainerResources containerResources);

    Optional<Container> getContainer(NodeAgentContext context);

    boolean pullImageAsyncIfNeeded(DockerImage dockerImage);

    ProcessResult executeCommandInContainerAsRoot(NodeAgentContext context, String... command);

    ProcessResult executeCommandInContainerAsRoot(NodeAgentContext context, Long timeoutSeconds, String... command);

    ProcessResult executeCommandInNetworkNamespace(ContainerName containerName, String... command);


    /** Resume node. Resuming a node means that it is ready to take on traffic. */
    void resumeNode(NodeAgentContext context);

    /**
     * Suspend node. Suspending a node means the node should be taken temporarly offline,
     * such that maintenance of the node can be done (upgrading, rebooting, etc).
     */
    void suspendNode(NodeAgentContext context);

    void restartVespa(NodeAgentContext context);

    void startServices(NodeAgentContext context);

    void stopServices(NodeAgentContext context);

    Optional<ContainerStats> getContainerStats(NodeAgentContext context);

    /**
     * Returns the list of containers managed by node-admin
     */
    List<Container> getAllManagedContainers();
}