Skip to content

Commit 77f8335

Browse files
committed
Document cluster-scoped template variables for resource tags
- Add ${clustername} and ${clustertype} to the template variables list - Note they resolve per host at apply time, not at deployment time - Add example showing per-cluster cost tracking pattern
1 parent 474b5f1 commit 77f8335

1 file changed

Lines changed: 43 additions & 12 deletions

File tree

en/reference/applications/deployment.html

Lines changed: 43 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -386,18 +386,49 @@ <h2 id="resource-tags">resource-tags</h2>
386386
</p>
387387

388388
<p id="resource-tags-template-variables"><strong>Template variables.</strong>
389-
Tag values may reference the following template variables, which are resolved at deployment time:</p>
390-
<ul>
391-
<li><code>${tenant}</code></li>
392-
<li><code>${application}</code></li>
393-
<li><code>${instance}</code></li>
394-
<li><code>${environment}</code></li>
395-
<li><code>${region}</code></li>
396-
</ul>
397-
<p>
398-
Resolved values are lowercased to match the label constraints above. Referencing an unknown
399-
variable causes the deployment to fail.
400-
</p>
389+
Tag values may reference the following template variables.
390+
Resolved values are lowercased to match the label constraints above.
391+
Referencing an unknown variable causes the deployment to fail.
392+
Variables can be combined, e.g. <code>value="${environment}-${clustertype}"</code>.</p>
393+
<table class="table">
394+
<thead>
395+
<tr>
396+
<th style="width:200px">Variable</th>
397+
<th>Description</th>
398+
</tr>
399+
</thead>
400+
<tbody>
401+
<tr>
402+
<td><code>${tenant}</code></td>
403+
<td>The tenant name.</td>
404+
</tr>
405+
<tr>
406+
<td><code>${application}</code></td>
407+
<td>The application name.</td>
408+
</tr>
409+
<tr>
410+
<td><code>${instance}</code></td>
411+
<td>The instance name.</td>
412+
</tr>
413+
<tr>
414+
<td><code>${environment}</code></td>
415+
<td>The deployment environment, e.g. <code>prod</code>, <code>dev</code>.</td>
416+
</tr>
417+
<tr>
418+
<td><code>${region}</code></td>
419+
<td>The deployment region, e.g. <code>aws-us-east-1c</code>.</td>
420+
</tr>
421+
<tr>
422+
<td><code>${clustername}</code></td>
423+
<td>The cluster ID from <a href="services.html">services.xml</a>,
424+
e.g. <code>default</code>, <code>music</code>.</td>
425+
</tr>
426+
<tr>
427+
<td><code>${clustertype}</code></td>
428+
<td>The Vespa cluster type: <code>container</code>, <code>content</code>, or <code>admin</code>.</td>
429+
</tr>
430+
</tbody>
431+
</table>
401432

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

0 commit comments

Comments
 (0)