Skip to content

Commit f7a6990

Browse files
Padraig O'Gradyopenshift-cherrypick-robot
Padraig O'Grady
authored and
openshift-cherrypick-robot
committed
TELCODOCS-1990: Docfooding feedback openshift#1 applied
TELCODOCS-1990: Docfooding feedback openshift#2 applied TELCODOCS-1990: Docfooding feedback openshift#3 applied TELCODOCS-1990: Docfooding feedback openshift#4 applied TELCODOCS-1990: Docfooding feedback openshift#5 applied TELCODOCS-1990: Docfooding feedback openshift#6 applied TELCODOCS-1990: Docfooding feedback openshift#7 applied TELCODOCS-1990: Docfooding feedback openshift#8 applied TELCODOCS-1990: Docfooding feedback openshift#9 applied TELCODOCS-1990: Docfooding feedback openshift#10 applied TELCODOCS-1990: Docfooding feedback openshift#11 applied TELCODOCS-1990: Peer review feedback applied TELCODOCS-1990: Dev review feedback applied TELCODOCS-1990: Dev/Peer review feedback applied TELCODOCS-1990: Dev/Peer openshift#2 review feedback applied TELCODOCS-1990: Dev openshift#2 review feedback applied TELCODOCS-1990: Peer review squad feedback applied
1 parent e610a57 commit f7a6990

5 files changed

+31
-30
lines changed

modules/cnf-performing-end-to-end-tests-running-cyclictest.adoc

+3-7
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,12 @@ The `cyclictest` tool measures the real-time kernel scheduler latency on the spe
1010

1111
[NOTE]
1212
====
13-
When executing `podman` commands as a non-root or non-privileged user, mounting paths can fail with `permission denied` errors. To make the `podman` command work, append `:Z` to the volumes creation; for example, `-v $(pwd)/:/kubeconfig:Z`. This allows `podman` to do the proper SELinux relabeling.
13+
When executing `podman` commands as a non-root or non-privileged user, mounting paths can fail with `permission denied` errors. Depending on your local operating system and SELinux configuration, you might also experience issues running these commands from your home directory. To make the `podman` commands work, run the commands from a folder that is not your home/<username> directory, and append `:Z` to the volumes creation. For example, `-v $(pwd)/:/kubeconfig:Z`. This allows `podman` to do the proper SELinux relabeling.
1414
====
1515

1616
.Prerequisites
1717

18-
* You have logged in to `registry.redhat.io` with your Customer Portal credentials.
19-
20-
* You have installed the real-time kernel in the cluster.
21-
22-
* You have applied a cluster performance profile by using Node Tuning Operator.
18+
* You have reviewed the prerequisites for running latency tests.
2319
2420
.Procedure
2521

@@ -39,7 +35,7 @@ If the results exceed the latency threshold, the test fails.
3935
+
4036
[IMPORTANT]
4137
====
42-
For valid results, the test should run for at least 12 hours.
38+
During testing shorter time periods, as shown, can be used to run the tests. However, for final verification and valid results, the test should run for at least 12 hours (43200 seconds).
4339
====
4440
+
4541
.Example failure output

modules/cnf-performing-end-to-end-tests-running-hwlatdetect.adoc

+3-5
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,12 @@ The `hwlatdetect` tool is available in the `rt-kernel` package with a regular su
1010

1111
[NOTE]
1212
====
13-
When executing `podman` commands as a non-root or non-privileged user, mounting paths can fail with `permission denied` errors. To make the `podman` command work, append `:Z` to the volumes creation; for example, `-v $(pwd)/:/kubeconfig:Z`. This allows `podman` to do the proper SELinux relabeling.
13+
When executing `podman` commands as a non-root or non-privileged user, mounting paths can fail with `permission denied` errors. Depending on your local operating system and SELinux configuration, you might also experience issues running these commands from your home directory. To make the `podman` commands work, run the commands from a folder that is not your home/<username> directory, and append `:Z` to the volumes creation. For example, `-v $(pwd)/:/kubeconfig:Z`. This allows `podman` to do the proper SELinux relabeling.
1414
====
1515

1616
.Prerequisites
1717

18-
* You have installed the real-time kernel in the cluster.
19-
20-
* You have logged in to `registry.redhat.io` with your Customer Portal credentials.
18+
* You have reviewed the prerequisites for running latency tests.
2119
2220
.Procedure
2321

@@ -37,7 +35,7 @@ If the results exceed the latency threshold, the test fails.
3735
+
3836
[IMPORTANT]
3937
====
40-
For valid results, the test should run for at least 12 hours.
38+
During testing shorter time periods, as shown, can be used to run the tests. However, for final verification and valid results, the test should run for at least 12 hours (43200 seconds).
4139
====
4240
+
4341
.Example failure output

modules/cnf-performing-end-to-end-tests-running-oslat.adoc

+3-4
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,12 @@ The `oslat` test simulates a CPU-intensive DPDK application and measures all the
1010

1111
[NOTE]
1212
====
13-
When executing `podman` commands as a non-root or non-privileged user, mounting paths can fail with `permission denied` errors. To make the `podman` command work, append `:Z` to the volumes creation; for example, `-v $(pwd)/:/kubeconfig:Z`. This allows `podman` to do the proper SELinux relabeling.
13+
When executing `podman` commands as a non-root or non-privileged user, mounting paths can fail with `permission denied` errors. Depending on your local operating system and SELinux configuration, you might also experience issues running these commands from your home directory. To make the `podman` commands work, run the commands from a folder that is not your home/<username> directory, and append `:Z` to the volumes creation. For example, `-v $(pwd)/:/kubeconfig:Z`. This allows `podman` to do the proper SELinux relabeling.
1414
====
1515

1616
.Prerequisites
1717

18-
* You have logged in to `registry.redhat.io` with your Customer Portal credentials.
19-
* You have applied a cluster performance profile by using the Node Tuning Operator.
18+
* You have reviewed the prerequisites for running latency tests.
2019
2120
.Procedure
2221

@@ -38,7 +37,7 @@ If the results exceed the latency threshold, the test fails.
3837
+
3938
[IMPORTANT]
4039
====
41-
For valid results, the test should run for at least 12 hours.
40+
During testing shorter time periods, as shown, can be used to run the tests. However, for final verification and valid results, the test should run for at least 12 hours (43200 seconds).
4241
====
4342
+
4443
.Example failure output

modules/cnf-performing-end-to-end-tests-running-the-tests.adoc

+20-10
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,44 @@ Run the cluster latency tests to validate node tuning for your Cloud-native Netw
1010

1111
[NOTE]
1212
====
13-
When executing `podman` commands as a non-root or non-privileged user, mounting paths can fail with `permission denied` errors. To make the `podman` command work, append `:Z` to the volumes creation; for example, `-v $(pwd)/:/kubeconfig:Z`. This allows `podman` to do the proper SELinux relabeling.
13+
When executing `podman` commands as a non-root or non-privileged user, mounting paths can fail with `permission denied` errors. Depending on your local operating system and SELinux configuration, you might also experience issues running these commands from your home directory. To make the `podman` commands work, run the commands from a folder that is not your home/<username> directory, and append `:Z` to the volumes creation. For example, `-v $(pwd)/:/kubeconfig:Z`. This allows `podman` to do the proper SELinux relabeling.
1414
====
1515

16+
This procedure runs the three individual tests `hwlatdetect`, `cyclictest`, and `oslat`. For details on these individual tests, see their individual sections.
17+
1618
.Procedure
1719

1820
. Open a shell prompt in the directory containing the `kubeconfig` file.
1921
+
20-
You provide the test image with a `kubeconfig` file in current directory and its related `$KUBECONFIG` environment variable, mounted through a volume. This allows the running container to use the `kubeconfig` file from inside the container.
21-
22-
. Run the latency tests by entering the following command:
22+
You provide the test image with a `kubeconfig` file in current directory and its related `$KUBECONFIG` environment variable, mounted through a volume. This allows the running container to use the `kubeconfig` file from inside the container.
23+
+
24+
[NOTE]
25+
====
26+
In the following command, your local `kubeconfig` is mounted to kubeconfig/kubeconfig in the cnf-tests container, which allows access to the cluster.
27+
====
28+
+
29+
. To run the latency tests, run the following command, substituting variable values as appropriate:
2330
+
2431
[source,terminal,subs="attributes+"]
2532
----
2633
$ podman run -v $(pwd)/:/kubeconfig:Z -e KUBECONFIG=/kubeconfig/kubeconfig \
27-
-e LATENCY_TEST_RUNTIME=<time_in_seconds>\
28-
-e MAXIMUM_LATENCY=<time_in_microseconds> \
34+
-e LATENCY_TEST_RUNTIME=600\
35+
-e MAXIMUM_LATENCY=20 \
2936
registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/test-run.sh \
3037
--ginkgo.v --ginkgo.timeout="24h"
3138
----
32-
33-
. Optional: Append `--ginkgo.dryRun` flag to run the latency tests in dry-run mode. This is useful for checking what commands the tests run.
39+
+
40+
The LATENCY_TEST_RUNTIME is shown in seconds, in this case 600 seconds (10 minutes). The test runs successfully when the maximum observed latency is lower than MAXIMUM_LATENCY (20 μs).
41+
+
42+
If the results exceed the latency threshold, the test fails.
43+
+
44+
. Optional: Append `--ginkgo.dry-run` flag to run the latency tests in dry-run mode. This is useful for checking what commands the tests run.
3445

3546
. Optional: Append `--ginkgo.v` flag to run the tests with increased verbosity.
3647

3748
. Optional: Append `--ginkgo.timeout="24h"` flag to ensure the Ginkgo 2.0 test suite does not timeout before the latency tests complete.
3849
+
3950
[IMPORTANT]
4051
====
41-
The default runtime for each test is 300 seconds.
42-
For valid latency test results, run the tests for at least 12 hours by updating the `LATENCY_TEST_RUNTIME` variable.
52+
During testing shorter time periods, as shown, can be used to run the tests. However, for final verification and valid results, the test should run for at least 12 hours (43200 seconds).
4353
====

scalability_and_performance/low_latency_tuning/cnf-performing-platform-verification-latency-tests.adoc

+2-4
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,9 @@ The `cnf-tests` container image is available at `registry.redhat.io/openshift4/c
1515

1616
Your cluster must meet the following requirements before you can run the latency tests:
1717

18-
. You have configured a performance profile with the Node Tuning Operator.
18+
* You have applied all the required CNF configurations. This includes the `PerformanceProfile` cluster and other configuration according to the reference design specifications (RDS) or your specific requirements.
1919

20-
. You have applied all the required CNF configurations in the cluster.
21-
22-
. You have a pre-existing `MachineConfigPool` CR applied in the cluster. The default worker pool is `worker-cnf`.
20+
* You have logged in to `registry.redhat.io` with your Customer Portal credentials by using the `podman login` command.
2321

2422
[role="_additional-resources"]
2523
.Additional resources

0 commit comments

Comments
 (0)