You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/measuring/usage-scenario.md
+44-1Lines changed: 44 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,8 +15,11 @@ The `usage_scenario.yml` consists of these main blocks:
15
15
-`compose-file` - (optional) A compose file to include
16
16
17
17
Its format is an extended subset of the [Docker Compose Specification](https://docs.docker.com/compose/compose-file/), which means that we keep the same format, but disallow some options and also add some exclusive options to our tool. However, keys that have the same name are also identical in function - thought potentially with some limitations.
18
+
See also the note on [unsupported features](#unsupported-docker-compose-features) to disable the warning about that.
19
+
20
+
Inside the `usage_scenario.yml` you can use variables. See [variables](#variables) for details.
21
+
18
22
19
-
See also the note on [unsupported features](#unsupported-docker-compose-features)
20
23
21
24
### Basic root level keys
22
25
@@ -291,3 +294,43 @@ All features not listed here are not supported by the Green Metrics Tool.
291
294
Since we allow the import of [Docker Compose](https://docs.docker.com/compose/compose-file) files this can lead to importing unsupported features.
292
295
293
296
GMT will error in this case. If you do not want that add the `ignore-unsupported-compose` key after you have tested your *usage_scenario.yml* file.
297
+
298
+
299
+
## Variables
300
+
301
+
A variable must adhere to the format `__GMT_VAR_[\w]+__`. An example would be `__GMT_VAR_NUMBER__`.
302
+
303
+
The value of the variable is a string. It will be replaced as is without adding " or ' though.
See more details in [Runner switches →]({{< relref "/docs/measuring/runner-switches/" >}})
335
+
336
+
The API accepts these variables as arguments also to the `/v1/software/add` endpoint. See the [API documentation →]({{< relref "/docs/api/overview" >}}) for details.
0 commit comments