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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.restapi.os;
import com.yahoo.component.Version;
import com.yahoo.config.provision.CloudName;
import com.yahoo.config.provision.Environment;
import com.yahoo.config.provision.RegionName;
import com.yahoo.config.provision.zone.ZoneApi;
import com.yahoo.config.provision.zone.ZoneId;
import com.yahoo.config.provision.zone.ZoneList;
import com.yahoo.container.jdisc.HttpRequest;
import com.yahoo.container.jdisc.HttpResponse;
import com.yahoo.io.IOUtils;
import com.yahoo.restapi.ErrorResponse;
import com.yahoo.restapi.MessageResponse;
import com.yahoo.restapi.Path;
import com.yahoo.restapi.SlimeJsonResponse;
import com.yahoo.slime.Cursor;
import com.yahoo.slime.Inspector;
import com.yahoo.slime.Slime;
import com.yahoo.slime.SlimeUtils;
import com.yahoo.slime.Type;
import com.yahoo.vespa.hosted.controller.Controller;
import com.yahoo.vespa.hosted.controller.auditlog.AuditLoggingRequestHandler;
import com.yahoo.vespa.hosted.controller.maintenance.ControllerMaintenance;
import com.yahoo.vespa.hosted.controller.maintenance.OsUpgradeScheduler;
import com.yahoo.vespa.hosted.controller.maintenance.OsUpgradeScheduler.Change;
import com.yahoo.vespa.hosted.controller.restapi.ErrorResponses;
import com.yahoo.vespa.hosted.controller.versions.CertifiedOsVersion;
import com.yahoo.vespa.hosted.controller.versions.OsVersionTarget;
import com.yahoo.yolean.Exceptions;
import java.io.IOException;
import java.io.InputStream;
import java.io.UncheckedIOException;
import java.time.Duration;
import java.time.Instant;
import java.util.List;
import java.util.Optional;
import java.util.Scanner;
import java.util.Set;
import java.util.StringJoiner;
import java.util.function.Function;
/**
* This implements the /os/v1 API which provides operators with information about, and scheduling of OS upgrades for
* nodes in the system.
*
* @author mpolden
*/
@SuppressWarnings("unused") // Injected
public class OsApiHandler extends AuditLoggingRequestHandler {
private final Controller controller;
private final OsUpgradeScheduler osUpgradeScheduler;
public OsApiHandler(Context ctx, Controller controller, ControllerMaintenance controllerMaintenance) {
super(ctx, controller.auditLogger());
this.controller = controller;
this.osUpgradeScheduler = controllerMaintenance.osUpgradeScheduler();
}
@Override
public HttpResponse auditAndHandle(HttpRequest request) {
try {
return switch (request.getMethod()) {
case GET -> get(request);
case POST -> post(request);
case DELETE -> delete(request);
case PATCH -> patch(request);
default -> ErrorResponse.methodNotAllowed("Method '" + request.getMethod() + "' is unsupported");
};
} catch (IllegalArgumentException e) {
return ErrorResponse.badRequest(Exceptions.toMessageString(e));
} catch (RuntimeException e) {
return ErrorResponses.logThrowing(request, log, e);
}
}
private HttpResponse patch(HttpRequest request) {
Path path = new Path(request.getUri());
if (path.matches("/os/v1/")) return setOsVersion(request);
return ErrorResponse.notFoundError("Nothing at " + path);
}
private HttpResponse get(HttpRequest request) {
Path path = new Path(request.getUri());
if (path.matches("/os/v1/")) return new SlimeJsonResponse(osVersions());
if (path.matches("/os/v1/certify")) return new SlimeJsonResponse(certifiedOsVersions());
return ErrorResponse.notFoundError("Nothing at " + path);
}
private HttpResponse post(HttpRequest request) {
Path path = new Path(request.getUri());
if (path.matches("/os/v1/certify/{cloud}/{version}")) return certifyVersion(request, path.get("version"), path.get("cloud"));
if (path.matches("/os/v1/firmware/")) return requestFirmwareCheckResponse(path);
if (path.matches("/os/v1/firmware/{environment}/")) return requestFirmwareCheckResponse(path);
if (path.matches("/os/v1/firmware/{environment}/{region}/")) return requestFirmwareCheckResponse(path);
return ErrorResponse.notFoundError("Nothing at " + path);
}
private HttpResponse delete(HttpRequest request) {
Path path = new Path(request.getUri());
if (path.matches("/os/v1/certify/{cloud}/{version}")) return uncertifyVersion(request, path.get("version"), path.get("cloud"));
if (path.matches("/os/v1/firmware/")) return cancelFirmwareCheckResponse(path);
if (path.matches("/os/v1/firmware/{environment}/")) return cancelFirmwareCheckResponse(path);
if (path.matches("/os/v1/firmware/{environment}/{region}/")) return cancelFirmwareCheckResponse(path);
return ErrorResponse.notFoundError("Nothing at " + path);
}
private HttpResponse certifyVersion(HttpRequest request, String versionString, String cloudName) {
Version version = Version.fromString(versionString);
CloudName cloud = CloudName.from(cloudName);
String vespaVersionString = asString(request.getData());
if (vespaVersionString.isEmpty()) {
throw new IllegalArgumentException("Missing Vespa version in request body");
}
Version vespaVersion = Version.fromString(vespaVersionString);
CertifiedOsVersion certified = controller.os().certify(version, cloud, vespaVersion);
if (certified.vespaVersion().equals(vespaVersion)) {
return new MessageResponse("Certified " + version.toFullString() + " in cloud " + cloud +
" as compatible with Vespa version " + vespaVersion.toFullString());
}
return new MessageResponse(version.toFullString() + " is already certified in cloud " + cloud +
" as compatible with Vespa version " + certified.vespaVersion().toFullString() +
". Leaving certification unchanged");
}
private HttpResponse uncertifyVersion(HttpRequest request, String versionString, String cloudName) {
Version version = Version.fromString(versionString);
CloudName cloud = CloudName.from(cloudName);
controller.os().uncertify(version, cloud);
return new MessageResponse("Removed certification of " + version.toFullString() + " in cloud " + cloud);
}
private HttpResponse requestFirmwareCheckResponse(Path path) {
List<ZoneId> zones = zonesAt(path);
if (zones.isEmpty())
return ErrorResponse.notFoundError("No zones at " + path);
StringJoiner response = new StringJoiner(", ", "Requested firmware checks in ", ".");
for (ZoneId zone : zones) {
controller.serviceRegistry().configServer().nodeRepository().requestFirmwareCheck(zone);
response.add(zone.value());
}
return new MessageResponse(response.toString());
}
private HttpResponse cancelFirmwareCheckResponse(Path path) {
List<ZoneId> zones = zonesAt(path);
if (zones.isEmpty())
return ErrorResponse.notFoundError("No zones at " + path);
StringJoiner response = new StringJoiner(", ", "Cancelled firmware checks in ", ".");
for (ZoneId zone : zones) {
controller.serviceRegistry().configServer().nodeRepository().cancelFirmwareCheck(zone);
response.add(zone.value());
}
return new MessageResponse(response.toString());
}
private List<ZoneId> zonesAt(Path path) {
ZoneList zones = controller.zoneRegistry().zones().controllerUpgraded();
if (path.get("region") != null) zones = zones.in(RegionName.from(path.get("region")));
if (path.get("environment") != null) zones = zones.in(Environment.from(path.get("environment")));
return zones.zones().stream().map(ZoneApi::getId).toList();
}
private HttpResponse setOsVersion(HttpRequest request) {
Slime requestData = toSlime(request.getData());
Inspector root = requestData.get();
CloudName cloud = parseStringField("cloud", root, CloudName::from);
if (requireField("version", root).type() == Type.NIX) {
controller.os().cancelUpgrade(cloud);
return new MessageResponse("Cleared target OS version for cloud '" + cloud.value() + "'");
}
Version target = parseStringField("version", root, Version::fromString);
boolean force = root.field("force").asBool();
boolean pin = root.field("pin").asBool();
controller.os().upgradeTo(target, cloud, force, pin);
return new MessageResponse("Set target OS version for cloud '" + cloud.value() + "' to " +
target.toFullString() + (pin ? " (pinned)" : ""));
}
private Slime certifiedOsVersions() {
Slime slime = new Slime();
Cursor array = slime.setArray();
controller.os().readCertified().stream().sorted().forEach(cv -> {
Cursor object = array.addObject();
object.setString("version", cv.osVersion().version().toFullString());
object.setString("cloud", cv.osVersion().cloud().value());
object.setString("vespaVersion", cv.vespaVersion().toFullString());
});
return slime;
}
private Slime osVersions() {
Slime slime = new Slime();
Cursor root = slime.setObject();
Set<OsVersionTarget> targets = controller.os().targets();
Cursor versions = root.setArray("versions");
Instant now = controller.clock().instant();
controller.os().status().versions().forEach((osVersion, nodeVersions) -> {
Cursor currentVersionObject = versions.addObject();
currentVersionObject.setString("version", osVersion.version().toFullString());
Optional<OsVersionTarget> target = targets.stream().filter(t -> t.osVersion().equals(osVersion)).findFirst();
currentVersionObject.setBool("targetVersion", target.isPresent());
target.ifPresent(t -> {
currentVersionObject.setString("upgradeBudget", Duration.ZERO.toString());
currentVersionObject.setLong("scheduledAt", t.scheduledAt().toEpochMilli());
currentVersionObject.setBool("pinned", t.pinned());
Optional<Change> nextChange = osUpgradeScheduler.changeIn(t.osVersion().cloud(), now);
nextChange.ifPresent(c -> {
currentVersionObject.setString("nextVersion", c.osVersion().version().toFullString());
currentVersionObject.setLong("nextScheduledAt", c.scheduleAt().toEpochMilli());
});
});
currentVersionObject.setString("cloud", osVersion.cloud().value());
Cursor nodesArray = currentVersionObject.setArray("nodes");
nodeVersions.forEach(nodeVersion -> {
Cursor nodeObject = nodesArray.addObject();
nodeObject.setString("hostname", nodeVersion.hostname().value());
nodeObject.setString("environment", nodeVersion.zone().environment().value());
nodeObject.setString("region", nodeVersion.zone().region().value());
});
});
return slime;
}
private static Slime toSlime(InputStream json) {
try {
return SlimeUtils.jsonToSlime(IOUtils.readBytes(json, 1000 * 1000));
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
private static <T> T parseStringField(String name, Inspector root, Function<String, T> parser) {
String fieldValue = requireField(name, root).asString();
try {
return parser.apply(fieldValue);
} catch (Exception e) {
throw new IllegalArgumentException("Invalid " + name + " '" + fieldValue + "'", e);
}
}
private static Inspector requireField(String name, Inspector root) {
Inspector field = root.field(name);
if (!field.valid()) throw new IllegalArgumentException("Field '" + name + "' is required");
return field;
}
private static String asString(InputStream in) {
Scanner scanner = new Scanner(in).useDelimiter("\\A");
if (scanner.hasNext()) {
return scanner.next();
}
return "";
}
}
|
