Skip to content

Commit

Permalink
README: Make vmUnderTestContainerDiskImage mandatory
Browse files Browse the repository at this point in the history 
Following the previous commit, adjust the documentation
accordingly.

Signed-off-by: Orel Misan <omisan@redhat.com>
  • Loading branch information
@orelmisan
orelmisan committed Apr 8, 2024
1 parent 9501e6f commit acd1d1d
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,13 @@ roleRef:
## Configuration
| Key | Description | Is Mandatory | Remarks |
|----------------------------------------------|-----------------------------------------------------------------|--------------|------------------------------------------------------------------|
| spec.timeout | How much time before the checkup will try to close itself | True | |
| spec.param.vmUnderTestContainerDiskImage | VM under test container disk image | False | Defaults to `quay.io/kiagnose/kubevirt-realtime-checkup-vm:main` |
| spec.param.vmUnderTestTargetNodeName | Node Name on which the VM under test will be scheduled to | False | Assumed to be configured to nodes that allow realtime traffic |
| spec.param.oslatDuration | How much time will the oslat program run | False | Defaults to TBD |
| spec.param.oslatLatencyThresholdMicroSeconds | A latency higher than this value will cause the checkup to fail | False | Defaults to TBD |
| Key | Description | Is Mandatory | Remarks |
|----------------------------------------------|-----------------------------------------------------------------|--------------|---------------------------------------------------------------|
| spec.timeout | How much time before the checkup will try to close itself | True | |
| spec.param.vmUnderTestContainerDiskImage | VM under test container disk image | True | |
| spec.param.vmUnderTestTargetNodeName | Node Name on which the VM under test will be scheduled to | False | Assumed to be configured to nodes that allow realtime traffic |
| spec.param.oslatDuration | How much time will the oslat program run | False | Defaults to TBD |
| spec.param.oslatLatencyThresholdMicroSeconds | A latency higher than this value will cause the checkup to fail | False | Defaults to TBD |
### Example
Expand All @@ -82,6 +82,7 @@ metadata:
name: realtime-checkup-config
data:
spec.timeout: 10m
spec.param.vmUnderTestContainerDiskImage: quay.io/kiagnose/kubevirt-realtime-checkup-vm:main
spec.param.oslatDuration: 1h
```
Expand Down

0 comments on commit acd1d1d

Please sign in to comment.