Skip to content

Remove outdated validation id list and point to code instead #4155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 13, 2025
Merged

Remove outdated validation id list and point to code instead #4155

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05667e0
Remove outdated validation id list and point to code instead
hmusum Oct 10, 2025
700754d
Fix typo
hmusum Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 5 additions & 85 deletions en/reference/validation-overrides.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
s---
# Copyright Vespa.ai. All rights reserved.
title: validation-overrides.xml
---
Expand All @@ -8,10 +8,8 @@
<a href="application-packages-reference.html">application package</a>
(i.e. next to <a href="services.html">services.xml</a>)
to allow a deployment that otherwise fails to validate to proceed.
Validations which can be overridden in this way
are returned with a dash-separated validation-id preceding the validation message.
E.g. if the message is <code>field-type-change: Changing the type of field 'foo' to 'bar' is not supported</code>
the validation id is <code>field-type-change</code>.
The message will explain what the validation concerns and how to add
a validation override
</p>
<p>
Validations protect against inadvertently corrupting a production instance.
Expand Down Expand Up @@ -47,9 +45,8 @@ <h2 id="structure">Structure</h2>

<h2 id="allow">allow</h2>
<p>
An <code>allow</code> tag disables a particular validation for a limited time.
It contains a single validation id, see <a href="#list">list</a> below.
<code>allow</code> tags with unknown ids are ignored.
An <code>allow</code> tag disables a particular validation for a limited time and
contains a single validation id. <code>allow</code> tags with unknown ids are ignored.
</p>
<table class="table">
<thead>
Expand All @@ -76,83 +73,6 @@ <h2 id="allow">allow</h2>

<h2 id="list">List of validation overrides</h2>

<table class="table">
<thead>
<tr>
<th>ID</th>
<th>Required when...</th>
<th>Action needed or effect of change</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>indexing-change</code></td>
<td>Changing what tokens are expected and stored in field indexes.</td>
<td>Requires reindexing of data.</td>
</tr>
<tr>
<td><code>indexing-mode-change</code></td>
<td>Changing the index mode (streaming, indexed, store-only) of documents.</td>
<td>Requires reindexing of data.</td>
</tr>
<tr>
<td><code>field-type-change</code></td>
<td>Field type changes.</td>
<td>Requires re-feeding data.</td>
</tr>
<tr>
<td><code>resources-reduction</code></td>
<td>Large reductions in node resources (&gt; 50% of the current max total resources).</td>
<td>Might cause large load increase.</td>
</tr>
<tr>
<td><code>content-type-removal</code></td>
<td>Removal of a schema (causes deletion of all documents).</td>
<td>Causes loss of all documents in this schema.</td>
</tr>
<tr>
<td><code>content-cluster-removal</code></td>
<td>Removal (or id change) of content clusters.</td>
<td>Causes loss of all documents in the cluster.</td>
</tr>
<tr>
<td><code>deployment-removal</code></td>
<td>Removal of production zones from deployment.xml.</td>
<td>Causes removal of all clusters and data in the zones.</td>
</tr>
<tr>
<td><code>global-document-change</code></td>
<td>Changing global attribute for document types in content clusters.</td>
<td>Requires stopping all nodes, applying validation override and starting nodes again.</td>
</tr>
<tr>
<td><code>global-endpoint-change</code></td>
<td>Changing global endpoints.</td>
<td></td>
</tr>
<tr>
<td><code>zone-endpoint-change</code></td>
<td>Changing zone (possibly private) endpoint settings.</td>
<td></td>
</tr>
<tr>
<td><code>redundancy-one</code></td>
<td>The first deployment of an application with <code>redundancy=1</code> requires a validation override. A redundancy of 2 is required for clusters in production otherwise</td>
<td></td>
</tr>
<tr>
<td><code>paged-setting-removal</code></td>
<td>Typically removed due to <a href="/en/attributes.html#paged-attributes-disadvantages">disadvantages</a> described in doc. May cause content nodes to run out of memory.</td>
<td>More data will be loaded into memory, might cause OOM.</td>
</tr>
<tr>
<td><code>certificate-removal</code></td>
<td>Removing data plane certificates, typically when moving to new certificates.</td>
<td>Unable to access endpoint with removed certificates.</td>
</tr>
</tbody>
</table>
<p>
See <a href="https://github.com/vespa-engine/vespa/blob/master/config-model-api/src/main/java/com/yahoo/config/application/api/ValidationId.java">
ValidationId.java</a> for a complete list of validation overrides.
</p>