Skip to content

Commit c0148df

Browse files
committed
TELCODOCS-891 creating my own PR for dev created PR 49350
1 parent a698aed commit c0148df

4 files changed

+13
-13
lines changed

modules/cnf-gathering-data-about-cluster-using-must-gather.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ $ oc adm must-gather --image=<PAO_must_gather_image> --dest-dir=<dir>
3232
+
3333
.Example
3434
+
35-
[source,terminal]
35+
[source,terminal,subs="attributes+"]
3636
----
37-
$ oc adm must-gather --image=registry.redhat.io/openshift4/performance-addon-operator-must-gather-rhel8:v4.11 --dest-dir=must-gather
37+
$ oc adm must-gather --image=registry.redhat.io/openshift4/performance-addon-operator-must-gather-rhel8:v{product-version} --dest-dir=<path_to_must-gather>/must-gather
3838
----
3939
. Create a compressed file from the `must-gather` directory:
4040
+

modules/cnf-how-run-podman-to-create-profile.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Node hardware configuration:
1616

1717
Run `podman` to create the performance profile:
1818

19-
[source,terminal]
19+
[source,terminal,subs="attributes+"]
2020
----
21-
$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.11 --mcp-name=worker-cnf --reserved-cpu-count=20 --rt-kernel=true --split-reserved-cpus-across-numa=true --must-gather-dir-path /must-gather > my-performance-profile.yaml
21+
$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v{product-version} --mcp-name=worker-cnf --reserved-cpu-count=20 --rt-kernel=true --split-reserved-cpus-across-numa=true --must-gather-dir-path /must-gather > my-performance-profile.yaml
2222
----
2323

2424
The created profile is described in the following YAML:

modules/cnf-running-the-performance-creator-profile-offline.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ $ vi run-perf-profile-creator.sh
2424

2525
. Paste the following code into the file:
2626
+
27-
[source,bash]
27+
[source,bash,subs="attributes+"]
2828
----
2929
#!/bin/bash
3030

@@ -35,7 +35,7 @@ readonly IMG_EXISTS_CMD="${CONTAINER_RUNTIME} image exists"
3535
readonly IMG_PULL_CMD="${CONTAINER_RUNTIME} image pull"
3636
readonly MUST_GATHER_VOL="/must-gather"
3737

38-
NTO_IMG="registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.11"
38+
NTO_IMG="registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v{product-version}"
3939
MG_TARBALL=""
4040
DATA_DIR=""
4141

@@ -163,7 +163,7 @@ There two types of arguments:
163163
* PPC arguments
164164
====
165165
+
166-
<1> Optional: Specify the Node Tuning Operator image. If not set, the default upstream image is used: `registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.11`.
166+
<1> Optional: Specify the Node Tuning Operator image. If not set, the default upstream image is used: `registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v{product-version}`.
167167
<2> `-t` is a required wrapper script argument and specifies the path to a `must-gather` tarball.
168168
169169
. Run the performance profile creator tool in discovery mode:

modules/cnf-running-the-performance-creator-profile.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ Password: ************
4747

4848
. Optional: Display help for the PPC tool:
4949
+
50-
[source,terminal]
50+
[source,terminal,subs="attributes+"]
5151
----
52-
$ podman run --entrypoint performance-profile-creator registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.11 -h
52+
$ podman run --rm --entrypoint performance-profile-creator registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v{product-version} -h
5353
----
5454
+
5555
.Example output
@@ -88,9 +88,9 @@ Discovery mode inspects your cluster using the output from `must-gather`. The ou
8888
Using this information you can set appropriate values for some of the arguments supplied to the Performance Profile Creator tool.
8989
====
9090
+
91-
[source,terminal]
91+
[source,terminal,subs="attributes+"]
9292
----
93-
$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.11 --info log --must-gather-dir-path /must-gather
93+
$ podman run --entrypoint performance-profile-creator -v <path_to_must-gather>/must-gather:/must-gather:z registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v{product-version} --info log --must-gather-dir-path /must-gather
9494
----
9595
+
9696
[NOTE]
@@ -107,9 +107,9 @@ The `info` option requires a value which specifies the output format. Possible v
107107

108108
. Run `podman`:
109109
+
110-
[source,terminal]
110+
[source,terminal,subs="attributes+"]
111111
----
112-
$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.11 --mcp-name=worker-cnf --reserved-cpu-count=20 --rt-kernel=true --split-reserved-cpus-across-numa=false --topology-manager-policy=single-numa-node --must-gather-dir-path /must-gather --power-consumption-mode=ultra-low-latency > my-performance-profile.yaml
112+
$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v{product-version} --mcp-name=worker-cnf --reserved-cpu-count=20 --rt-kernel=true --split-reserved-cpus-across-numa=false --topology-manager-policy=single-numa-node --must-gather-dir-path /must-gather --power-consumption-mode=ultra-low-latency > my-performance-profile.yaml
113113
----
114114
+
115115
[NOTE]

0 commit comments

Comments
 (0)