Skip to content

Commit 59f440b

Browse files
kalexand-rhkalexand-rh
authored
Merge pull request #52144 from kquinn1204/OCPBUGS-2524
OCPBUGS-2524 correcting version numbers and adding variable substitution
2 parents 24fdacb + 4ff7ccb commit 59f440b

4 files changed

+36
-36
lines changed

‎modules/cnf-checking-numa-aware-scheduler-logs.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,14 @@ numaresourcesscheduler.nodetopology.openshift.io "numaresourcesscheduler" delete
5151

5252
. Save the following YAML in the file `nro-scheduler-debug.yaml`. This example changes the log level to `Debug`:
5353
+
54-
[source,yaml]
54+
[source,yaml,subs="attributes+"]
5555
----
5656
apiVersion: nodetopology.openshift.io/v1alpha1
5757
kind: NUMAResourcesScheduler
5858
metadata:
5959
name: numaresourcesscheduler
6060
spec:
61-
imageSpec: "registry.redhat.io/openshift4/noderesourcetopology-scheduler-container-rhel8:v4.10"
61+
imageSpec: "registry.redhat.io/openshift4/noderesourcetopology-scheduler-container-rhel8:v{product-version}"
6262
logLevel: Debug
6363
----
6464

‎modules/cnf-deploying-the-numa-aware-scheduler.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,14 @@ $ oc create -f nro-kubeletconfig.yaml
7070

7171
.. Save the following YAML in the `nro-scheduler.yaml` file:
7272
+
73-
[source,yaml]
73+
[source,yaml,subs="attributes+"]
7474
----
7575
apiVersion: nodetopology.openshift.io/v1alpha1
7676
kind: NUMAResourcesScheduler
7777
metadata:
7878
name: numaresourcesscheduler
7979
spec:
80-
imageSpec: "registry.redhat.io/openshift4/noderesourcetopology-scheduler-container-rhel8:v4.10"
80+
imageSpec: "registry.redhat.io/openshift4/noderesourcetopology-scheduler-container-rhel8:v{product-version}"
8181
----
8282

8383
.. Create the `NUMAResourcesScheduler` CR by running the following command:

‎modules/cnf-installing-numa-resources-operator-cli.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ $ oc create -f nro-operatorgroup.yaml
6262

6363
.. Save the following YAML in the `nro-sub.yaml` file:
6464
+
65-
[source,yaml]
65+
[source,yaml,subs="attributes+"]
6666
----
6767
apiVersion: operators.coreos.com/v1alpha1
6868
kind: Subscription
@@ -94,8 +94,8 @@ $ oc get csv -n openshift-numaresources
9494
+
9595
.Example output
9696

97-
[source,terminal]
97+
[source,terminal,subs="attributes+"]
9898
----
99-
NAME DISPLAY VERSION REPLACES PHASE
100-
numaresources-operator.v4.10.0 NUMA Resources Operator 4.10.0 Succeeded
99+
NAME DISPLAY VERSION REPLACES PHASE
100+
numaresources-operator.v{product-version}.2 numaresources-operator {product-version}.2 Succeeded
101101
----

‎modules/cnf-performing-end-to-end-tests-for-platform-verification.adoc

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ spec:
6565
+
6666
You can use the `ROLE_WORKER_CNF` variable to override the worker pool name:
6767
+
68-
[source,terminal]
68+
[source,terminal,subs="attributes+"]
6969
----
7070
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig -e
71-
ROLE_WORKER_CNF=custom-worker-pool registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/test-run.sh
71+
ROLE_WORKER_CNF=custom-worker-pool registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/test-run.sh
7272
----
7373
+
7474
[NOTE]
@@ -81,9 +81,9 @@ Currently, not all tests run selectively on the nodes belonging to the pool.
8181

8282
Use this command to run in dry-run mode. This is useful for checking what is in the test suite and provides output for all of the tests the image would run.
8383

84-
[source,terminal]
84+
[source,terminal,subs="attributes+"]
8585
----
86-
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/test-run.sh -ginkgo.dryRun -ginkgo.v
86+
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/test-run.sh -ginkgo.dryRun -ginkgo.v
8787
----
8888

8989
[id="cnf-performing-end-to-end-tests-disconnected-mode_{context}"]
@@ -102,9 +102,9 @@ A `mirror` executable is shipped in the image to provide the input required by `
102102

103103
Run this command from an intermediate machine that has access both to the cluster and to link:https://catalog.redhat.com/software/containers/explore[registry.redhat.io] over the internet:
104104

105-
[source,terminal]
105+
[source,terminal,subs="attributes+"]
106106
----
107-
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/mirror -registry my.local.registry:5000/ | oc image mirror -f -
107+
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/mirror -registry my.local.registry:5000/ | oc image mirror -f -
108108
----
109109

110110
Then, follow the instructions in the following section about overriding the registry used to fetch the images.
@@ -114,9 +114,9 @@ Then, follow the instructions in the following section about overriding the regi
114114

115115
This is done by setting the `IMAGE_REGISTRY` environment variable:
116116

117-
[source,terminal]
117+
[source,terminal,subs="attributes+"]
118118
----
119-
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig -e IMAGE_REGISTRY="my.local.registry:5000/" -e CNF_TESTS_IMAGE="custom-cnf-tests-image:latests" registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/test-run.sh
119+
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig -e IMAGE_REGISTRY="my.local.registry:5000/" -e CNF_TESTS_IMAGE="custom-cnf-tests-image:latests" registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/test-run.sh
120120
----
121121

122122
[id="cnf-performing-end-to-end-tests-mirroring-to-cluster-internal-registry_{context}"]
@@ -211,9 +211,9 @@ echo "{\"auths\": { \"$REGISTRY\": { \"auth\": $TOKEN } }}" > dockerauth.json
211211

212212
. Do the mirroring:
213213
+
214-
[source,terminal]
214+
[source,terminal,subs="attributes+"]
215215
----
216-
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/mirror -registry $REGISTRY/cnftests | oc image mirror --insecure=true -a=$(pwd)/dockerauth.json -f -
216+
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/mirror -registry $REGISTRY/cnftests | oc image mirror --insecure=true -a=$(pwd)/dockerauth.json -f -
217217
----
218218

219219
. Run the tests:
@@ -230,25 +230,25 @@ $ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig -e IMAG
230230

231231
. The `mirror` command tries to mirror the u/s images by default. This can be overridden by passing a file with the following format to the image:
232232
+
233-
[source,yaml]
233+
[source,yaml,subs="attributes+"]
234234
----
235235
[
236236
{
237237
"registry": "public.registry.io:5000",
238-
"image": "imageforcnftests:4.11"
238+
"image": "imageforcnftests:{product-version}"
239239
},
240240
{
241241
"registry": "public.registry.io:5000",
242-
"image": "imagefordpdk:4.11"
242+
"image": "imagefordpdk:{product-version}"
243243
}
244244
]
245245
----
246246

247247
. Pass it to the `mirror` command, for example saving it locally as `images.json`. With the following command, the local path is mounted in `/kubeconfig` inside the container and that can be passed to the mirror command.
248248
+
249-
[source,terminal]
249+
[source,terminal,subs="attributes+"]
250250
----
251-
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/mirror --registry "my.local.registry:5000/" --images "/kubeconfig/images.json" | oc image mirror -f -
251+
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/mirror --registry "my.local.registry:5000/" --images "/kubeconfig/images.json" | oc image mirror -f -
252252
----
253253

254254
[id="cnf-performing-end-to-end-tests-running-in-single-node-cluster_{context}"]
@@ -340,9 +340,9 @@ Depending on the requirements, the tests can use different images. There are two
340340

341341
For example, to change the `CNF_TESTS_IMAGE` with a custom registry run the following command:
342342

343-
[source,terminal]
343+
[source,terminal,subs="attributes+"]
344344
----
345-
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig -e CNF_TESTS_IMAGE="custom-cnf-tests-image:latests" registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/test-run.sh
345+
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig -e CNF_TESTS_IMAGE="custom-cnf-tests-image:latests" registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/test-run.sh
346346
----
347347

348348
[id="cnf-performing-end-to-end-tests-ginkgo-parameters_{context}"]
@@ -352,18 +352,18 @@ The Ginkgo BDD (Behavior-Driven Development) framework serves as the base for th
352352

353353
You can use the `-ginkgo.focus` parameter to filter a set of tests:
354354

355-
[source,terminal]
355+
[source,terminal,subs="attributes+"]
356356
----
357-
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/test-run.sh -ginkgo.focus="performance|sctp"
357+
$ docker run -v $(pwd)/:/kubeconfig -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/test-run.sh -ginkgo.focus="performance|sctp"
358358
----
359359

360360
You can run only the latency test using the `-ginkgo.focus` parameter.
361361

362362
To run only the latency test, you must provide the `-ginkgo.focus` parameter and the `PERF_TEST_PROFILE` environment variable that has the name of the `PerformanceProfile` that needs to be tested. For example:
363363

364-
[source,terminal]
364+
[source,terminal,subs="attributes+"]
365365
----
366-
$ docker run --rm -v $KUBECONFIG:/kubeconfig -e KUBECONFIG=/kubeconfig -e LATENCY_TEST_RUN=true -e LATENCY_TEST_RUNTIME=600 -e OSLAT_MAXIMUM_LATENCY=20 -e PERF_TEST_PROFILE=<performance_profile_name> registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/test-run.sh -ginkgo.focus="\[performance\]\[config\]|\[performance\]\ Latency\ Test"
366+
$ docker run --rm -v $KUBECONFIG:/kubeconfig -e KUBECONFIG=/kubeconfig -e LATENCY_TEST_RUN=true -e LATENCY_TEST_RUNTIME=600 -e OSLAT_MAXIMUM_LATENCY=20 -e PERF_TEST_PROFILE=<performance_profile_name> registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/test-run.sh -ginkgo.focus="\[performance\]\[config\]|\[performance\]\ Latency\ Test"
367367
----
368368

369369
[NOTE]
@@ -524,7 +524,7 @@ CLEAN_PERFORMANCE_PROFILE="false" registry.redhat.io/openshift-kni/cnf-tests /us
524524

525525
If the `kubeconfig` file is in the current folder, you can run the test suite by using the following command:
526526

527-
[source,terminal]
527+
[source,terminal,subs="attributes+"]
528528
----
529529
$ podman run -v $(pwd)/:/kubeconfig:Z -e KUBECONFIG=/kubeconfig/kubeconfig -e \
530530
DISCOVERY_MODE=true registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} \
@@ -1116,19 +1116,19 @@ CNF end-to-end tests produce two outputs: a JUnit test output and a test failure
11161116

11171117
A JUnit-compliant XML is produced by passing the `--junit` parameter together with the path where the report is dumped:
11181118

1119-
[source,terminal]
1119+
[source,terminal,subs="attributes+"]
11201120
----
1121-
$ docker run -v $(pwd)/:/kubeconfig -v $(pwd)/junitdest:/path/to/junit -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/test-run.sh --junit /path/to/junit
1121+
$ docker run -v $(pwd)/:/kubeconfig -v $(pwd)/junitdest:/path/to/junit -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/test-run.sh --junit /path/to/junit
11221122
----
11231123

11241124
[id="cnf-performing-end-to-end-tests-test-failure-report_{context}"]
11251125
=== Test failure report
11261126

11271127
A report with information about the cluster state and resources for troubleshooting can be produced by passing the `--report` parameter with the path where the report is dumped:
11281128

1129-
[source,terminal]
1129+
[source,terminal,subs="attributes+"]
11301130
----
1131-
$ docker run -v $(pwd)/:/kubeconfig -v $(pwd)/reportdest:/path/to/report -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/test-run.sh --report /path/to/report
1131+
$ docker run -v $(pwd)/:/kubeconfig -v $(pwd)/reportdest:/path/to/report -e KUBECONFIG=/kubeconfig/kubeconfig registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/test-run.sh --report /path/to/report
11321132
----
11331133

11341134
[id="cnf-performing-end-to-end-tests-podman_{context}"]
@@ -1187,7 +1187,7 @@ When you configure reserved and isolated CPUs, the infra containers in pods use
11871187

11881188
To override the performance profile, the manifest must be mounted inside the container and the tests must be instructed by setting the `PERFORMANCE_PROFILE_MANIFEST_OVERRIDE`:
11891189

1190-
[source,termal]
1190+
[source,terminal,subs="attributes+"]
11911191
----
1192-
$ docker run -v $(pwd)/:/kubeconfig:Z -e KUBECONFIG=/kubeconfig/kubeconfig -e PERFORMANCE_PROFILE_MANIFEST_OVERRIDE=/kubeconfig/manifest.yaml registry.redhat.io/openshift4/cnf-tests-rhel8:v4.11 /usr/bin/test-run.sh
1192+
$ docker run -v $(pwd)/:/kubeconfig:Z -e KUBECONFIG=/kubeconfig/kubeconfig -e PERFORMANCE_PROFILE_MANIFEST_OVERRIDE=/kubeconfig/manifest.yaml registry.redhat.io/openshift4/cnf-tests-rhel8:v{product-version} /usr/bin/test-run.sh
11931193
----

0 commit comments

Comments
 (0)