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: docs/orchestrate/saucectl-configuration.md
+49-1Lines changed: 49 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -246,7 +246,7 @@ suites:
246
246
247
247
### `env`
248
248
249
-
<p><small>| OPTIONAL | ARRAY |</small></p>
249
+
<p><small>| OPTIONAL | OBJECT |</small></p>
250
250
251
251
Environment variables to be injected into the container. Can be used for populating secrets used in your tests. These environment variables are not stored anywhere in Sauce Labs.
252
252
@@ -263,6 +263,54 @@ Environment variables set with the saucectl `--env` flag will overwrite those sp
263
263
The order of precedence is as follows: --env flag > root-level environment variables > suite-level environment variables.
264
264
:::
265
265
266
+
267
+
### `metadata`
268
+
269
+
<p><small>| OPTIONAL | OBJECT |</small></p>
270
+
271
+
This field's primary use case is for troubleshooting. Unless instructed by a
272
+
Sauce Labs employee, setting any random values here will serve you no purpose.
273
+
274
+
```yaml
275
+
suites:
276
+
- name: "saucy test"
277
+
metadata:
278
+
KEY: value
279
+
```
280
+
281
+
282
+
### `services`
283
+
284
+
<p><small>| OPTIONAL | ARRAY |</small></p>
285
+
286
+
Define service containers that are required to run alongside the main container
287
+
of the suite. The available configuration options for services are similar to
288
+
those of the main container.
289
+
290
+
291
+
```yaml
292
+
suites:
293
+
- name: "saucy test"
294
+
services:
295
+
- name: "a service"
296
+
image: your-org/your-service-image:0.0.1
297
+
imagePullAuth:
298
+
user: sauceuser
299
+
token: "123"
300
+
entrypoint: mvn test
301
+
files:
302
+
- src: "runsauce.json"
303
+
dst: "/workdir/runsauce.json"
304
+
env:
305
+
KEY: value
306
+
resourceProfile: c1m1
307
+
```
308
+
309
+
:::note
310
+
A service container may not be up and running by the time your main container
311
+
starts. Please take that into account when writing your tests.
0 commit comments