Skip to content

Commit 63e1a38

Browse files
johnwilkinsjohnwilkins
committed
TELCODOCS-580: Updates PAO to NTO where required, and bumps version number on images..
1 parent 6871168 commit 63e1a38

4 files changed

+20
-23
lines changed

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Performance Profile Creator (PPC) tool requires `must-gather` data. As a clu
1111
.Prerequisites
1212

1313
* Access to the cluster as a user with the `cluster-admin` role.
14-
* Access to the Performance Addon Operator image.
14+
* Access to the Performance Addon Operator `must gather` image.
1515
* The OpenShift CLI (`oc`) installed.
1616
1717
.Procedure
@@ -22,20 +22,19 @@ The Performance Profile Creator (PPC) tool requires `must-gather` data. As a clu
2222
+
2323
[source,terminal]
2424
----
25-
$ oc adm must-gather --image=<PAO_image> --dest-dir=<dir>
25+
$ oc adm must-gather --image=<PAO_must_gather_image> --dest-dir=<dir>
2626
----
2727
+
2828
[NOTE]
2929
====
3030
`must-gather` must be run with the `performance-addon-operator-must-gather` image. The output can optionally be compressed. Compressed output is required if you are running the Performance Profile Creator wrapper script.
3131
====
32-
3332
+
3433
.Example
3534
+
3635
[source,terminal]
3736
----
38-
$ oc adm must-gather --image=registry.redhat.io/openshift4/performance-addon-operator-must-gather-rhel8:v4.10 --dest-dir=must-gather
37+
$ oc adm must-gather --image=registry.redhat.io/openshift4/performance-addon-operator-must-gather-rhel8:v4.11 --dest-dir=must-gather
3938
----
4039
. Create a compressed file from the `must-gather` directory:
4140
+

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Run `podman` to create the performance profile:
1818

1919
[source,terminal]
2020
----
21-
$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.10 --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: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
2222
----
2323

2424
The created profile is described in the following YAML:

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The performance profile wrapper script simplifies the running of the Performance
1010

1111
.Prerequisites
1212

13-
* Access to the Performance Addon Operator image.
13+
* Access to the Node Tuning Operator image.
1414
* Access to the `must-gather` tarball.
1515
1616
.Procedure
@@ -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-
PAO_IMG="registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.10"
38+
NTO_IMG="registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.11"
3939
MG_TARBALL=""
4040
DATA_DIR=""
4141

@@ -45,10 +45,10 @@ usage() {
4545
print ""
4646
print "Options:"
4747
print " -h help for ${CURRENT_SCRIPT}"
48-
print " -p Performance Addon Operator image"
48+
print " -p Node Tuning Operator image"
4949
print " -t path to a must-gather tarball"
5050

51-
${IMG_EXISTS_CMD} "${PAO_IMG}" && ${CMD} "${PAO_IMG}" -h
51+
${IMG_EXISTS_CMD} "${NTO_IMG}" && ${CMD} "${NTO_IMG}" -h
5252
}
5353

5454
function cleanup {
@@ -67,8 +67,8 @@ print() {
6767
}
6868

6969
check_requirements() {
70-
${IMG_EXISTS_CMD} "${PAO_IMG}" || ${IMG_PULL_CMD} "${PAO_IMG}" || \
71-
exit_error "Performance Addon Operator image not found"
70+
${IMG_EXISTS_CMD} "${NTO_IMG}" || ${IMG_PULL_CMD} "${NTO_IMG}" || \
71+
exit_error "Node Tuning Operator image not found"
7272

7373
[ -n "${MG_TARBALL}" ] || exit_error "Must-gather tarball file path is mandatory"
7474
[ -f "${MG_TARBALL}" ] || exit_error "Must-gather tarball file not found"
@@ -88,7 +88,7 @@ main() {
8888
exit 0
8989
;;
9090
p)
91-
PAO_IMG="${OPTARG}"
91+
NTO_IMG="${OPTARG}"
9292
;;
9393
t)
9494
MG_TARBALL="${OPTARG}"
@@ -102,7 +102,7 @@ main() {
102102

103103
check_requirements || exit 1
104104

105-
${CMD} -v "${DATA_DIR}:${MUST_GATHER_VOL}:z" "${PAO_IMG}" "$@" --must-gather-dir-path "${MUST_GATHER_VOL}"
105+
${CMD} -v "${DATA_DIR}:${MUST_GATHER_VOL}:z" "${NTO_IMG}" "$@" --must-gather-dir-path "${MUST_GATHER_VOL}"
106106
echo "" 1>&2
107107
}
108108

@@ -132,7 +132,7 @@ Wrapper usage:
132132

133133
Options:
134134
-h help for run-perf-profile-creator.sh
135-
-p Performance Addon Operator image <1>
135+
-p Node Tuning Operator image <1>
136136
-t path to a must-gather tarball <2>
137137

138138
A tool that automates creation of Performance Profiles
@@ -163,7 +163,7 @@ There two types of arguments:
163163
* PPC arguments
164164
====
165165
+
166-
<1> Optional: Specify the Performance Addon Operator image. If not set, the default upstream image is used: `registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.10`.
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`.
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 & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,11 @@ As a cluster administrator, you can run `podman` and the Performance Profile Cre
1313
* Access to the cluster as a user with the `cluster-admin` role.
1414
* A cluster installed on bare metal hardware.
1515
* A node with `podman` and OpenShift CLI (`oc`) installed.
16-
16+
* Access to the Node Tuning Operator image.
1717
1818
.Procedure
1919

2020
. Check the machine config pool:
21-
2221
+
2322
[source,terminal]
2423
----
@@ -50,7 +49,7 @@ Password: ************
5049
+
5150
[source,terminal]
5251
----
53-
$ podman run --entrypoint performance-profile-creator registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.10 -h
52+
$ podman run --entrypoint performance-profile-creator registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.11 -h
5453
----
5554
+
5655
.Example output
@@ -91,7 +90,7 @@ Using this information you can set appropriate values for some of the arguments
9190
+
9291
[source,terminal]
9392
----
94-
$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.10 --info log --must-gather-dir-path /must-gather
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
9594
----
9695
+
9796
[NOTE]
@@ -105,12 +104,12 @@ The `-v` option can be the path to either:
105104
106105
The `info` option requires a value which specifies the output format. Possible values are log and JSON. The JSON format is reserved for debugging.
107106
====
108-
+
107+
109108
. Run `podman`:
110109
+
111110
[source,terminal]
112111
----
113-
$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.10 --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: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
114113
----
115114
+
116115
[NOTE]
@@ -123,7 +122,7 @@ The Performance Profile Creator arguments are shown in the Performance Profile C
123122
124123
The `mcp-name` argument in this example is set to `worker-cnf` based on the output of the command `oc get mcp`. For Single Node OpenShift (SNO) use `--mcp-name=master`.
125124
====
126-
+
125+
127126
. Review the created YAML file:
128127
+
129128
[source,terminal]
@@ -163,7 +162,6 @@ spec:
163162
====
164163
Install the Performance Addon Operator before applying the profile.
165164
====
166-
167165
+
168166
[source,terminal]
169167
----

0 commit comments

Comments
 (0)