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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model.application.validation;
import com.yahoo.config.application.api.ValidationId;
import com.yahoo.config.application.api.ValidationOverrides;
import com.yahoo.config.application.api.ValidationOverrides.ValidationException;
import com.yahoo.config.model.api.ConfigChangeAction;
import com.yahoo.config.model.api.ValidationParameters;
import com.yahoo.config.model.deploy.DeployState;
import com.yahoo.vespa.model.VespaModel;
import com.yahoo.vespa.model.application.validation.change.CertificateRemovalChangeValidator;
import com.yahoo.vespa.model.application.validation.change.ConfigValueChangeValidator;
import com.yahoo.vespa.model.application.validation.change.ContainerRestartValidator;
import com.yahoo.vespa.model.application.validation.change.ContentClusterRemovalValidator;
import com.yahoo.vespa.model.application.validation.change.ContentTypeRemovalValidator;
import com.yahoo.vespa.model.application.validation.change.GlobalDocumentChangeValidator;
import com.yahoo.vespa.model.application.validation.change.IndexedSearchClusterChangeValidator;
import com.yahoo.vespa.model.application.validation.change.IndexingModeChangeValidator;
import com.yahoo.vespa.model.application.validation.change.NodeResourceChangeValidator;
import com.yahoo.vespa.model.application.validation.change.RedundancyIncreaseValidator;
import com.yahoo.vespa.model.application.validation.change.ResourcesReductionValidator;
import com.yahoo.vespa.model.application.validation.change.RestartOnDeployForOnnxModelChangesValidator;
import com.yahoo.vespa.model.application.validation.change.StartupCommandChangeValidator;
import com.yahoo.vespa.model.application.validation.change.StreamingSearchClusterChangeValidator;
import com.yahoo.vespa.model.application.validation.first.RedundancyValidator;
import com.yahoo.yolean.Exceptions;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.logging.Level;
/**
* Executor of validators. This defines the right order of validator execution.
*
* @author hmusum
*/
public class Validation {
private final List<Validator> additionalValidators;
public Validation() { this(List.of()); }
/** Create instance taking additional validators (e.g., for cloud applications) */
public Validation(List<Validator> additionalValidators) { this.additionalValidators = additionalValidators; }
/**
* Validates the model supplied, and if there already exists a model for the application validates changes
* between the previous and current model
*
* @return a list of required changes needed to make this configuration live
* @throws ValidationOverrides.ValidationException if the change fails validation
*/
public List<ConfigChangeAction> validate(VespaModel model, ValidationParameters validationParameters, DeployState deployState) {
Execution execution = new Execution(model, deployState);
if (validationParameters.checkRouting()) {
validateRouting(execution);
}
validateModel(validationParameters, execution);
for (Validator validator : additionalValidators) {
validator.validate(execution);
}
if (deployState.getProperties().isFirstTimeDeployment()) {
validateFirstTimeDeployment(execution);
}
else if (deployState.getPreviousModel().isPresent() && (deployState.getPreviousModel().get() instanceof VespaModel)) {
validateChanges(execution);
}
execution.throwIfFailed();
return execution.actions;
}
private static void validateRouting(Execution execution) {
new RoutingValidator().validate(execution);
}
private static void validateModel(ValidationParameters validationParameters, Execution execution) {
new SchemasDirValidator().validate(execution);
new BundleValidator().validate(execution);
new PublicApiBundleValidator().validate(execution);
new SearchDataTypeValidator().validate(execution);
new ComplexFieldsWithStructFieldAttributesValidator().validate(execution);
new ComplexFieldsWithStructFieldIndexesValidator().validate(execution);
new StreamingValidator().validate(execution);
new RankSetupValidator(validationParameters.ignoreValidationErrors()).validate(execution);
new NoPrefixForIndexes().validate(execution);
new ContainerInCloudValidator().validate(execution);
new DeploymentSpecValidator().validate(execution);
new ValidationOverridesValidator().validate(execution);
new ConstantValidator().validate(execution);
new SecretStoreValidator().validate(execution);
new AccessControlFilterValidator().validate(execution);
new QuotaValidator().validate(execution);
new UriBindingsValidator().validate(execution);
new CloudDataPlaneFilterValidator().validate(execution);
new AccessControlFilterExcludeValidator().validate(execution);
new CloudUserFilterValidator().validate(execution);
new CloudHttpConnectorValidator().validate(execution);
new UrlConfigValidator().validate(execution);
new JvmHeapSizeValidator().validate(execution);
new InfrastructureDeploymentValidator().validate(execution);
new EndpointCertificateSecretsValidator().validate(execution);
new CloudClientsValidator().validate(execution);
}
private static void validateFirstTimeDeployment(Execution execution) {
new RedundancyValidator().validate((Context) execution);
}
private static void validateChanges(Execution execution) {
new IndexingModeChangeValidator().validate(execution);
new GlobalDocumentChangeValidator().validate(execution);
new IndexedSearchClusterChangeValidator().validate(execution);
new StreamingSearchClusterChangeValidator().validate(execution);
new ConfigValueChangeValidator().validate(execution);
new StartupCommandChangeValidator().validate(execution);
new ContentTypeRemovalValidator().validate(execution);
new ContentClusterRemovalValidator().validate(execution);
new ResourcesReductionValidator().validate(execution);
new ContainerRestartValidator().validate(execution);
new NodeResourceChangeValidator().validate(execution);
new RedundancyIncreaseValidator().validate(execution);
new CertificateRemovalChangeValidator().validate(execution);
new RedundancyValidator().validate(execution);
new RestartOnDeployForOnnxModelChangesValidator().validate(execution);
}
public interface Context {
/** Auxiliary deploy state of the application. */
DeployState deployState();
/** The model to validate. */
VespaModel model();
/** Report a failed validation which cannot be overridden; this results in an {@link IllegalArgumentException}. */
default void illegal(String message) { illegal(message, null); }
/** Report a failed validation which cannot be overridden; this results in an {@link IllegalArgumentException}. */
void illegal(String message, Throwable cause);
/** Report a failed validation which can be overridden; this results in a {@link ValidationException}. */
void invalid(ValidationId id, String message);
}
public interface ChangeContext extends Context {
/** The previous model, if any. */
VespaModel previousModel();
/**
* Report an action the user must take to change to the new configuration.
* If the action has a {@link ValidationId}, {@link #invalid} is also called for this id, and the action's message.
*/
void require(ConfigChangeAction action);
}
static class Execution implements ChangeContext {
private final List<String> errors = new ArrayList<>();
private final Map<ValidationId, List<String>> failures = new LinkedHashMap<>();
private final VespaModel model;
private final DeployState deployState;
private final List<ConfigChangeAction> actions = new ArrayList<>();
Execution(VespaModel model, DeployState deployState) {
this.model = model;
this.deployState = deployState;
}
void throwIfFailed() {
Optional<ValidationException> invalidException = deployState.validationOverrides().invalidException(failures, deployState.now());
if (invalidException.isPresent() && deployState.isHosted() && deployState.zone().environment().isManuallyDeployed()) {
deployState.getDeployLogger().logApplicationPackage(Level.WARNING,
"Auto-overriding validation which would be disallowed in production: " +
Exceptions.toMessageString(invalidException.get()));
invalidException = Optional.empty();
}
if ( ! errors.isEmpty()) {
String illegalMessage = errors.size() == 1 ? errors.get(0)
: "multiple errors:\n\t" + String.join("\n\t", errors);
if (invalidException.isPresent())
illegalMessage += "\n" + invalidException.get().getMessage();
throw new IllegalArgumentException(illegalMessage);
}
invalidException.ifPresent(e -> { throw e; });
}
List<ConfigChangeAction> actions() {
return actions;
}
List<String> errors() {
return errors;
}
@Override
public DeployState deployState() {
return deployState;
}
@Override
public VespaModel model() {
return model;
}
@Override
public VespaModel previousModel() {
return (VespaModel) deployState.getPreviousModel().get();
}
@Override
public void require(ConfigChangeAction action) {
actions.add(action);
action.validationId().ifPresent(id -> invalid(id, action.getMessage()));
}
@Override
public void illegal(String message, Throwable cause) {
if (cause != null) message += ": " + Exceptions.toMessageString(cause);
errors.add(message);
}
@Override
public void invalid(ValidationId id, String message) {
failures.computeIfAbsent(id, __ -> new ArrayList<>()).add(message);
}
}
}
|
