Skip to content

Commit f0766ee

Browse files
authored
Merge pull request #4 from ScaleComputing/shoriminimoe-patch-1
docs: add details about template variables
2 parents 9b3c8cb + 47bd609 commit f0766ee

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/spec/overview.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,25 @@ capacity: 107374182400 # 100 GB
107107

108108
### Template Variables
109109

110-
Dynamic values using template syntax:
110+
> [!NOTE]
111+
> The template variable names and syntax are an experimental feature and subject to change.
112+
113+
Fleet Manager supports the following dynamic values:
114+
- `clusterName`: the name of the target cluster
115+
- `clusterId`: the ID of the target cluster
116+
117+
Values can be included in the manifest using the following template syntax:
111118

112119
```yaml
113-
metadata:
114-
name: "app-{{ cluster_name }}"
120+
resources:
121+
- type: virdomain
122+
name: "vm-{{ clusterName }}"
123+
description: "This VM is on cluster_name={{clusterName}} cluster_id={{clusterId}}"
115124
```
116125

126+
> [!TIP]
127+
> Kraken uses the application `metadata.name` field to uniquely identify applications. Due to this behavior, it is recommended to use dynamic values in resource definitions only and not in application metadata to avoid creating duplicate applications.
128+
117129
## Validation Rules
118130

119131
### Naming Conventions

0 commit comments

Comments
 (0)