Skip to content

Document cluster-scoped template variables for resource tags #4680

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

Open
gjoranv wants to merge 1 commit into
base: master
Choose a base branch
from
+43 −12
Open

Document cluster-scoped template variables for resource tags #4680

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
55 changes: 43 additions & 12 deletions en/reference/applications/deployment.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,18 +386,49 @@ <h2 id="resource-tags">resource-tags</h2>
</p>

<p id="resource-tags-template-variables"><strong>Template variables.</strong>
Tag values may reference the following template variables, which are resolved at deployment time:</p>
<ul>
<li><code>${tenant}</code></li>
<li><code>${application}</code></li>
<li><code>${instance}</code></li>
<li><code>${environment}</code></li>
<li><code>${region}</code></li>
</ul>
<p>
Resolved values are lowercased to match the label constraints above. Referencing an unknown
variable causes the deployment to fail.
</p>
Tag values may reference the following template variables.
Resolved values are lowercased to match the label constraints above.
Referencing an unknown variable causes the deployment to fail.
Variables can be combined, e.g. <code>value="${environment}-${clustertype}"</code>.</p>
<table class="table">
<thead>
<tr>
<th style="width:200px">Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>${tenant}</code></td>
<td>The tenant name.</td>
</tr>
<tr>
<td><code>${application}</code></td>
<td>The application name.</td>
</tr>
<tr>
<td><code>${instance}</code></td>
<td>The instance name.</td>
</tr>
<tr>
<td><code>${environment}</code></td>
<td>The deployment environment, e.g. <code>prod</code>, <code>dev</code>.</td>
</tr>
<tr>
<td><code>${region}</code></td>
<td>The deployment region, e.g. <code>aws-us-east-1c</code>.</td>
</tr>
<tr>
<td><code>${clustername}</code></td>
<td>The cluster ID from <a href="services/services.html">services.xml</a>,
e.g. <code>default</code>, <code>music</code>.</td>
</tr>
<tr>
<td><code>${clustertype}</code></td>
<td>The Vespa cluster type: <code>container</code>, <code>content</code>, or <code>admin</code>.</td>
</tr>
</tbody>
</table>

<p><strong>Reconciliation.</strong>
Tags are applied to virtual machines and attached disks. When tags are changed, added, or removed
Expand Down
⚡