Skip to content

Commit

Permalink
Merge pull request #60549 from openshift-cherrypick-robot/cherry-pick…
Browse files Browse the repository at this point in the history
…-60437-to-enterprise-4.13

[enterprise-4.13] CNV-26734: updates to VM latency checkup's documentation
  • Loading branch information
bergerhoffer authored May 25, 2023
2 parents f011502 + 1bde645 commit 9d8abe9
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions modules/virt-measuring-latency-vm-secondary-network.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -108,17 +108,17 @@ metadata:
name: kubevirt-vm-latency-checkup-config
data:
spec.timeout: 5m
spec.param.network_attachment_definition_namespace: <target_namespace>
spec.param.network_attachment_definition_name: "blue-network" <1>
spec.param.max_desired_latency_milliseconds: "10" <2>
spec.param.sample_duration_seconds: "5" <3>
spec.param.source_node: "worker1" <4>
spec.param.target_node: "worker2" <5>
spec.param.networkAttachmentDefinitionNamespace: <target_namespace>
spec.param.networkAttachmentDefinitionName: "blue-network" <1>
spec.param.maxDesiredLatencyMilliseconds: "10" <2>
spec.param.sampleDurationSeconds: "5" <3>
spec.param.sourceNode: "worker1" <4>
spec.param.targetNode: "worker2" <5>
----
<1> The name of the `NetworkAttachmentDefinition` object.
<2> Optional: The maximum desired latency, in milliseconds, between the virtual machines. If the measured latency exceeds this value, the checkup fails.
<3> Optional: The duration of the latency check, in seconds.
<4> Optional: When specified, latency is measured from this node to the target node. If the source node is specified, the `spec.param.target_node` field cannot be empty.
<4> Optional: When specified, latency is measured from this node to the target node. If the source node is specified, the `spec.param.targetNode` field cannot be empty.
<5> Optional: When specified, latency is measured from the source node to this node.
. Apply the config map manifest in the target namespace:
Expand Down Expand Up @@ -158,6 +158,10 @@ spec:
value: <target_namespace>
- name: CONFIGMAP_NAME
value: kubevirt-vm-latency-checkup-config
- name: POD_UID
valueFrom:
fieldRef:
fieldPath: metadata.uid
----
. Apply the `Job` manifest:
Expand All @@ -174,7 +178,7 @@ $ oc apply -n <target_namespace> -f <latency_job>.yaml
$ oc wait job kubevirt-vm-latency-checkup -n <target_namespace> --for condition=complete --timeout 6m
----
. Review the results of the latency checkup by running the following command. If the maximum measured latency is greater than the value of the `spec.param.max_desired_latency_milliseconds` attribute, the checkup fails and returns an error.
. Review the results of the latency checkup by running the following command. If the maximum measured latency is greater than the value of the `spec.param.maxDesiredLatencyMilliseconds` attribute, the checkup fails and returns an error.
+
[source,terminal]
----
Expand All @@ -191,12 +195,12 @@ metadata:
namespace: <target_namespace>
data:
spec.timeout: 5m
spec.param.network_attachment_definition_namespace: <target_namespace>
spec.param.network_attachment_definition_name: "blue-network"
spec.param.max_desired_latency_milliseconds: "10"
spec.param.sample_duration_seconds: "5"
spec.param.source_node: "worker1"
spec.param.target_node: "worker2"
spec.param.networkAttachmentDefinitionNamespace: <target_namespace>
spec.param.networkAttachmentDefinitionName: "blue-network"
spec.param.maxDesiredLatencyMilliseconds: "10"
spec.param.sampleDurationSeconds: "5"
spec.param.sourceNode: "worker1"
spec.param.targetNode: "worker2"
status.succeeded: "true"
status.failureReason: ""
status.completionTimestamp: "2022-01-01T09:00:00Z"
Expand Down

0 comments on commit 9d8abe9

Please sign in to comment.