blob: 872b8a8096bc26896101b1cec03506b80036db1b (
plain) (
blame)
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
// Copyright 2020 Oath Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.node.admin.nodeagent;
import com.yahoo.config.provision.HostName;
import com.yahoo.config.provision.NodeType;
import com.yahoo.config.provision.zone.ZoneApi;
import com.yahoo.vespa.athenz.api.AthenzIdentity;
import com.yahoo.vespa.hosted.dockerapi.ContainerName;
import com.yahoo.vespa.hosted.node.admin.component.TaskContext;
import com.yahoo.vespa.hosted.node.admin.configserver.noderepository.Acl;
import com.yahoo.vespa.hosted.node.admin.configserver.noderepository.NodeSpec;
import com.yahoo.vespa.hosted.node.admin.docker.DockerNetworking;
import java.nio.file.FileSystem;
import java.nio.file.Path;
public interface NodeAgentContext extends TaskContext {
/** @return node specification from node-repository */
NodeSpec node();
/** @return node ACL from node-repository */
Acl acl();
/** @return name of the docker container this context applies to */
ContainerName containerName();
/** @return hostname of the docker container this context applies to */
default HostName hostname() {
return HostName.from(node().hostname());
}
default NodeType nodeType() {
return node().type();
}
AthenzIdentity identity();
DockerNetworking dockerNetworking();
ZoneApi zone();
String vespaUser();
String vespaUserOnHost();
default boolean isDisabled(NodeAgentTask task) {
return false;
};
/**
* The vcpu value in NodeSpec is multiplied by the speedup factor per cpu core compared to a historical baseline
* for a particular cpu generation of the host (see flavors.def cpuSpeedup).
*
* @return node vcpu without the cpu speedup factor.
*/
double unscaledVcpu();
/** The file system used by the NodeAgentContext. All paths must have the same provider. */
FileSystem fileSystem();
/**
* This method is the inverse of {@link #pathInNodeFromPathOnHost(Path)}}
*
* @param pathInNode absolute path in the container
* @return the absolute path on host pointing at the same inode
*/
Path pathOnHostFromPathInNode(Path pathInNode);
default Path pathOnHostFromPathInNode(String pathInNode) {
return pathOnHostFromPathInNode(fileSystem().getPath(pathInNode));
}
/**
* This method is the inverse of {@link #pathOnHostFromPathInNode(Path)}
*
* @param pathOnHost absolute path on host
* @return the absolute path in the container pointing at the same inode
*/
Path pathInNodeFromPathOnHost(Path pathOnHost);
default Path pathInNodeFromPathOnHost(String pathOnHost) {
return pathInNodeFromPathOnHost(fileSystem().getPath(pathOnHost));
}
/**
* @param relativePath relative path under Vespa home in container
* @return the absolute path under Vespa home in the container
*/
Path pathInNodeUnderVespaHome(Path relativePath);
default Path pathInNodeUnderVespaHome(String relativePath) {
return pathInNodeUnderVespaHome(fileSystem().getPath(relativePath));
}
/**
* Rewrite the given path in node to a path required by the image.
* WARNING: This method should only be used when starting the docker container, e.g. writing container data or
* configuring mounts.
* TODO: Remove when everyone has migrated of vespa/ci image
*/
Path rewritePathInNodeForWantedDockerImage(Path path);
}
|
