Skip to content

Commit

Permalink
added documentation for onDemand
Browse files Browse the repository at this point in the history
  • Loading branch information
XaverStiensmeier committed Apr 8, 2024
1 parent a9f0094 commit 62b1de2
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion documentation/markdown/features/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ Other infrastructures would be [AWS](https://aws.amazon.com/) and so on.
`cloud` decides which entry in the `clouds.yaml` is used. When using OpenStack the entry is named `openstack`.
You can read more about the `clouds.yaml` [here](cloud_specification_data.md).

#### workerInstances (optional)
#### workerInstances

`workerInstances` expects a list of worker groups (instance definitions with `count` key).
If `count` is omitted, `count: 1` is assumed.
Expand All @@ -189,11 +189,13 @@ workerInstance:
- type: de.NBI tiny
image: Ubuntu 22.04 LTS (2022-10-14)
count: 2
onDemand: True # optional only on master cloud for now. Default True.
```

- `type` sets the instance's hardware configuration.
- `image` sets the bootable operating system to be installed on the instance.
- `count` sets how many workers of that `type` `image` combination are in this work group
- `onDemand` defines whether nodes in the worker group are scheduled on demand (True) or are started permanently (False). This option only works on the master cloud for now.

##### Find your active `images`

Expand Down

0 comments on commit 62b1de2

Please sign in to comment.