Language:
Format:

第16章パフォーマンスプロファイルの作成

Performance Profile Creator (PPC) ツールおよび、PPC を使用してパフォーマンスプロファイルを作成する方法を説明します。

16.1. Performance Profile Creator の概要

Performance Profile Creator (PPC) は、Performance Addon Operator に含まれるコマンドラインツールでパフォーマンスプロファイルの作成に使用します。このツールは、クラスターからの must-gather データと、ユーザー指定のプロファイル引数を複数使用します。PPC は、ハードウェアとトポロジーに適したパフォーマンスプロファイルを作成します。

このツールは、以下のいずれかの方法で実行します。

podman の呼び出し
ラッパースクリプトの呼び出し

16.1.1. must-gather コマンドを使用したクラスターに関するデータの収集

Performance Profile Creator (PPC) ツールには must-gather データが必要です。クラスター管理者として、must-gather コマンドを実行してクラスターについての情報を取得します。

前提条件

cluster-admin ロールを持つユーザーとしてクラスターにアクセスできる。
Performance Addon Operator にアクセスできる。
OpenShift CLI (oc) がインストールされている。

手順

must-gather データを保存するディレクトリーに移動します。
クラスターで must-gather を実行します。
```
$ oc adm must-gather --image=<PAO_image> --dest-dir=<dir>
```
注記
must-gather コマンドは、performance-addon-operator-must-gather イメージで実行する必要があります。この出力はオプションで圧縮できます。Performance Profile Creator ラッパースクリプトを実行している場合は、出力を圧縮する必要があります。
例
```
$ oc adm must-gather --image=registry.redhat.io/openshift4/performance-addon-operator-must-gather-rhel8:v4.9 --dest-dir=must-gather
```
must-gather ディレクトリーから圧縮ファイルを作成します。
```
$ tar cvaf must-gather.tar.gz must-gather/
```

16.1.2. `podman` を使用した Performance Profile Creator の実行

クラスター管理者は、podman および Performance Profile Creator を実行してパフォーマンスプロファイルを作成できます。

前提条件

cluster-admin ロールを持つユーザーとしてクラスターにアクセスできる。
ベアメタルハードウェアにインストールされたクラスター。
podman および OpenShift CLI (oc) がインストールされているノード。

手順

マシン設定プールを確認します。

$ oc get mcp

出力例

NAME         CONFIG                                                 UPDATED   UPDATING   DEGRADED   MACHINECOUNT   READYMACHINECOUNT   UPDATEDMACHINECOUNT   DEGRADEDMACHINECOUNT   AGE
master       rendered-master-acd1358917e9f98cbdb599aea622d78b       True      False      False      3              3                   3                     0                      22h
worker-cnf   rendered-worker-cnf-1d871ac76e1951d32b2fe92369879826   False     True       False      2              1                   1                     0                      22h

Podman を使用して、registry.redhat.io への認証を行います。

$ podman login registry.redhat.io

Username: myrhusername
Password: ************

必要に応じて、PPC ツールのヘルプを表示します。

$ podman run --entrypoint performance-profile-creator registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.9 -h

出力例

A tool that automates creation of Performance Profiles

Usage:
  performance-profile-creator [flags]

Flags:
      --disable-ht                        Disable Hyperthreading
  -h, --help                              help for performance-profile-creator
      --info string                       Show cluster information; requires --must-gather-dir-path, ignore the other arguments. [Valid values: log, json] (default "log")
      --mcp-name string                   MCP name corresponding to the target machines (required)
      --must-gather-dir-path string       Must gather directory path (default "must-gather")
      --power-consumption-mode string     The power consumption mode.  [Valid values: default, low-latency, ultra-low-latency] (default "default")
      --profile-name string               Name of the performance profile to be created (default "performance")
      --reserved-cpu-count int            Number of reserved CPUs (required)
      --rt-kernel                         Enable Real Time Kernel (required)
      --split-reserved-cpus-across-numa   Split the Reserved CPUs across NUMA nodes
      --topology-manager-policy string    Kubelet Topology Manager Policy of the performance profile to be created. [Valid values: single-numa-node, best-effort, restricted] (default "restricted")
      --user-level-networking             Run with User level Networking(DPDK) enabled

Performance Profile Creator ツールを検出モードで実行します。
注記
検出モードは、must-gather からの出力を使用してクラスターを検査します。生成された出力には、以下のような情報が含まれます。
- 割り当てられた CPU ID でパーティションされた NUMA セル
- ハイパースレッディングが有効にされているかどうか
この情報を使用して、Performance Profile Creator ツールにわたす一部の引数に適切な値を設定できます。
```
$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.9 --info log --must-gather-dir-path /must-gather
```
注記
このコマンドは、Performance Profile Creator を、podman への新規エントリーポイントとして使用します。これは、ホストの must-gather データをコンテナーイメージにマッピングし、ユーザーが提示した必須のプロファイル引数を呼び出し、my-performance-profile.yaml ファイルを生成します。
-v オプションでは、以下のいずれかへのパスを指定できます。
- must-gather 出力ディレクトリー
- must-gather の展開済みの tarball を含む既存のディレクトリー
info オプションでは、出力形式を指定する値が必要です。使用できる値は log と JSON です。JSON 形式はデバッグ用に確保されています。
podman を実行します。
```
$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.9 --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
```
注記
Performance Profile Creator の引数については Performance Profile Creator 引数の表に示しています。必要な引数は、以下の通りです。
- reserved-cpu-count
- mcp-name
- rt-kernel
この例の mcp-name 引数は、コマンド oc get mcp の出力に基づいて worker-cnf に設定されます。シングルノード OpenShift の場合は、--mcp-name=master を使用します。

作成した YAML ファイルを確認します。

$ cat my-performance-profile.yaml

出力例

apiVersion: performance.openshift.io/v2
kind: PerformanceProfile
metadata:
  name: performance
spec:
  additionalKernelArgs:
  - nmi_watchdog=0
  - audit=0
  - mce=off
  - processor.max_cstate=1
  - intel_idle.max_cstate=0
  - idle=poll
  cpu:
    isolated: 1,3,5,7,9,11,13,15,17,19-39,41,43,45,47,49,51,53,55,57,59-79
    reserved: 0,2,4,6,8,10,12,14,16,18,40,42,44,46,48,50,52,54,56,58
  nodeSelector:
    node-role.kubernetes.io/worker-cnf: ""
  numa:
    topologyPolicy: single-numa-node
  realTimeKernel:
    enabled: true

生成されたプロファイルを適用します。
注記
プロファイルを適用する前に、Performance Addon Operator をインストールしてください。
```
$ oc apply -f my-performance-profile.yaml
```

16.1.2.1. `podman` を実行してパフォーマンスプロファイルを作成する方法

以下の例では、podman を実行して、NUMA ノード間で分割される、予約済み CPU 20 個を指定してパフォーマンスプロファイルを作成する方法を説明します。

ノードのハードウェア設定:

CPU 80 個
ハイパースレッディングを有効にする
NUMA ノード 2 つ
NUMA ノード 0 に偶数個の CPU、NUMA ノード 1 に奇数個の CPU を稼働させる

podman を実行してパフォーマンスプロファイルを作成します。

$ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.9 --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

作成されたプロファイルは以下の YAML に記述されます。

  apiVersion: performance.openshift.io/v2
  kind: PerformanceProfile
  metadata:
    name: performance
  spec:
    cpu:
      isolated: 10-39,50-79
      reserved: 0-9,40-49
    nodeSelector:
      node-role.kubernetes.io/worker-cnf: ""
    numa:
      topologyPolicy: restricted
    realTimeKernel:
      enabled: true

注記

この場合、CPU 10 個が NUMA ノード 0 に、残りの 10 個は NUMA ノード 1 に予約されます。

16.1.3. Performance Profile Creator ラッパースクリプトの実行

パフォーマンスプロファイルラッパースクリプトをし用すると、Performance Profile Creator (PPC) ツールの実行を簡素化できます。podman の実行に関連する煩雑性がなくなり、パフォーマンスプロファイルの作成が可能になります。

前提条件

Performance Addon Operator にアクセスできる。
must-gather tarball にアクセスできる。

手順

ローカルマシンにファイル (例: run-perf-profile-creator.sh) を作成します。
```
$ vi run-perf-profile-creator.sh
```

ファイルに以下のコードを貼り付けます。

#!/bin/bash

readonly CONTAINER_RUNTIME=${CONTAINER_RUNTIME:-podman}
readonly CURRENT_SCRIPT=$(basename "$0")
readonly CMD="${CONTAINER_RUNTIME} run --entrypoint performance-profile-creator"
readonly IMG_EXISTS_CMD="${CONTAINER_RUNTIME} image exists"
readonly IMG_PULL_CMD="${CONTAINER_RUNTIME} image pull"
readonly MUST_GATHER_VOL="/must-gather"

PAO_IMG="registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.9"
MG_TARBALL=""
DATA_DIR=""

usage() {
  print "Wrapper usage:"
  print "  ${CURRENT_SCRIPT} [-h] [-p image][-t path] -- [performance-profile-creator flags]"
  print ""
  print "Options:"
  print "   -h                 help for ${CURRENT_SCRIPT}"
  print "   -p                 Performance Addon Operator image"
  print "   -t                 path to a must-gather tarball"

  ${IMG_EXISTS_CMD} "${PAO_IMG}" && ${CMD} "${PAO_IMG}" -h
}

function cleanup {
  [ -d "${DATA_DIR}" ] && rm -rf "${DATA_DIR}"
}
trap cleanup EXIT

exit_error() {
  print "error: $*"
  usage
  exit 1
}

print() {
  echo  "$*" >&2
}

check_requirements() {
  ${IMG_EXISTS_CMD} "${PAO_IMG}" || ${IMG_PULL_CMD} "${PAO_IMG}" || \
      exit_error "Performance Addon Operator image not found"

  [ -n "${MG_TARBALL}" ] || exit_error "Must-gather tarball file path is mandatory"
  [ -f "${MG_TARBALL}" ] || exit_error "Must-gather tarball file not found"

  DATA_DIR=$(mktemp -d -t "${CURRENT_SCRIPT}XXXX") || exit_error "Cannot create the data directory"
  tar -zxf "${MG_TARBALL}" --directory "${DATA_DIR}" || exit_error "Cannot decompress the must-gather tarball"
  chmod a+rx "${DATA_DIR}"

  return 0
}

main() {
  while getopts ':hp:t:' OPT; do
    case "${OPT}" in
      h)
        usage
        exit 0
        ;;
      p)
        PAO_IMG="${OPTARG}"
        ;;
      t)
        MG_TARBALL="${OPTARG}"
        ;;
      ?)
        exit_error "invalid argument: ${OPTARG}"
        ;;
    esac
  done
  shift $((OPTIND - 1))

  check_requirements || exit 1

  ${CMD} -v "${DATA_DIR}:${MUST_GATHER_VOL}:z" "${PAO_IMG}" "$@" --must-gather-dir-path "${MUST_GATHER_VOL}"
  echo "" 1>&2
}

main "$@"

このスクリプトの実行権限を全員に追加します。
```
$ chmod a+x run-perf-profile-creator.sh
```

オプション: run-perf-profile-creator.sh コマンドの使用方法を表示します。

$ ./run-perf-profile-creator.sh -h

予想される出力

Wrapper usage:
  run-perf-profile-creator.sh [-h] [-p image][-t path] -- [performance-profile-creator flags]

Options:
   -h                 help for run-perf-profile-creator.sh
   -p                 Performance Addon Operator image 1
   -t                 path to a must-gather tarball 2

A tool that automates creation of Performance Profiles

   Usage:
     performance-profile-creator [flags]

   Flags:
         --disable-ht                        Disable Hyperthreading
     -h, --help                              help for performance-profile-creator
         --info string                       Show cluster information; requires --must-gather-dir-path, ignore the other arguments. [Valid values: log, json] (default "log")
         --mcp-name string                   MCP name corresponding to the target machines (required)
         --must-gather-dir-path string       Must gather directory path (default "must-gather")
         --power-consumption-mode string     The power consumption mode.  [Valid values: default, low-latency, ultra-low-latency] (default "default")
         --profile-name string               Name of the performance profile to be created (default "performance")
         --reserved-cpu-count int            Number of reserved CPUs (required)
         --rt-kernel                         Enable Real Time Kernel (required)
         --split-reserved-cpus-across-numa   Split the Reserved CPUs across NUMA nodes
         --topology-manager-policy string    Kubelet Topology Manager Policy of the performance profile to be created. [Valid values: single-numa-node, best-effort, restricted] (default "restricted")
         --user-level-networking             Run with User level Networking(DPDK) enabled

注記

引数には、以下の 2 つのタイプがあります。

ラッパー引数名は、-h、-p、および -t です。
PPC 引数

1: オプション: Performance Addon Operator イメージを指定します。設定されていない場合、デフォルトのアップストリームイメージが使用されます: registry.redhat.io/openshift4/performance-addon-rhel8-operator:v4.9。
2: -t は、必須のラッパースクリプトの引数で、must-gather tarball へのパスを指定します。

Performance Profile Creator ツールを検出モードで実行します。
注記
検出モードは、must-gather からの出力を使用してクラスターを検査します。生成された出力には、以下のような情報が含まれます。
- 割り当てられた CPU ID を使用した NUMA セルのパーティション設定
- ハイパースレッディングが有効にされているかどうか
この情報を使用して、Performance Profile Creator ツールにわたす一部の引数に適切な値を設定できます。
```
$ ./run-perf-profile-creator.sh -t /must-gather/must-gather.tar.gz -- --info=log
```
注記
info オプションでは、出力形式を指定する値が必要です。使用できる値は log と JSON です。JSON 形式はデバッグ用に確保されています。

マシン設定プールを確認します。

$ oc get mcp

出力例

NAME         CONFIG                                                 UPDATED   UPDATING   DEGRADED   MACHINECOUNT   READYMACHINECOUNT   UPDATEDMACHINECOUNT   DEGRADEDMACHINECOUNT   AGE
master       rendered-master-acd1358917e9f98cbdb599aea622d78b       True      False      False      3              3                   3                     0                      22h
worker-cnf   rendered-worker-cnf-1d871ac76e1951d32b2fe92369879826   False     True       False      2              1                   1                     0                      22h

パフォーマンスプロファイルを作成します。
```
$ ./run-perf-profile-creator.sh -t /must-gather/must-gather.tar.gz -- --mcp-name=worker-cnf --reserved-cpu-count=2 --rt-kernel=true > my-performance-profile.yaml
```
注記
Performance Profile Creator の引数については Performance Profile Creator 引数の表に示しています。必要な引数は、以下の通りです。
- reserved-cpu-count
- mcp-name
- rt-kernel
この例の mcp-name 引数は、コマンド oc get mcp の出力に基づいて worker-cnf に設定されます。シングルノード OpenShift の場合は、--mcp-name=master を使用します。

作成した YAML ファイルを確認します。

$ cat my-performance-profile.yaml

出力例

apiVersion: performance.openshift.io/v2
kind: PerformanceProfile
metadata:
  name: performance
spec:
  cpu:
    isolated: 1-39,41-79
    reserved: 0,40
  nodeSelector:
    node-role.kubernetes.io/worker-cnf: ""
  numa:
    topologyPolicy: restricted
  realTimeKernel:
    enabled: false

生成されたプロファイルを適用します。
注記
プロファイルを適用する前に、Performance Addon Operator をインストールしてください。
```
$ oc apply -f my-performance-profile.yaml
```

16.1.4. Performance Profile Creator の引数

表16.1 Performance Profile Creator の引数

引数	説明
`disable-ht`	ハイパースレッディングを無効にします。使用できる値は `true` または `false` です。デフォルト: `false`。警告この引数が `true` に設定されている場合は、BIOS でハイパースレッディングを無効にしないでください。ハイパースレッディングの無効化は、カーネルコマンドライン引数で実行できます。
`info`	この引数では、クラスター情報を取得します。使用できるのは検出モードのみです。検出モードでは、`must-gather-dir-path` 引数も必要です。他の引数が設定されている場合は無視されます。以下の値を使用できます。 `log` `JSON` 注記これらのオプションでは、デバッグ用に予約される JSON 形式で出力形式を定義します。デフォルト: `log`。
`mcp-name`	ターゲットマシンに対応する `worker-cnf` などの MCP 名。このパラメーターは必須です。
`must-gather-dir-path`	must gather のディレクトリーパス。このパラメーターは必須です。ラッパースクリプトでツールを実行する場合には、`must-gather` はスクリプト自体で指定されるので、ユーザーは指定しないでください。
`power-consumption-mode`	電力消費モード。以下の値を使用できます。 `default` `low-latency` `ultra-low-latency` デフォルト: `default`。
`profile-name`	作成するパフォーマンスプロファイルの名前。デフォルト: `performance`。
`reserved-cpu-count`	予約された CPU の数。このパラメーターは必須です。注記これは自然数でなければなりません。0 の値は使用できません。
`rt-kernel`	リアルタイムカーネルを有効にします。このパラメーターは必須です。使用できる値は `true` または `false` です。
`split-reserved-cpus-across-numa`	NUMA ノード全体で予約された CPU を分割します。使用できる値は `true` または `false` です。デフォルト: `false`。
`topology-manager-policy`	作成するパフォーマンスプロファイルの kubelet Topology Manager ポリシー。以下の値を使用できます。 `single-numa-node` `best-effort` `restricted` デフォルト: `restricted`。
`user-level-networking`	ユーザーレベルのネットワーク (DPDK) を有効にして実行します。使用できる値は `true` または `false` です。デフォルト: `false`。

Select Your Language

第16章パフォーマンスプロファイルの作成

16.1. Performance Profile Creator の概要

16.1.1. must-gather コマンドを使用したクラスターに関するデータの収集

16.1.2. `podman` を使用した Performance Profile Creator の実行

16.1.2.1. `podman` を実行してパフォーマンスプロファイルを作成する方法

16.1.3. Performance Profile Creator ラッパースクリプトの実行

16.1.4. Performance Profile Creator の引数

Quick Links

Help

Site Info

Related Sites

About

Red Hat legal and privacy links

Red Hat legal and privacy links

Language and Page Formatting Options

第16章 パフォーマンスプロファイルの作成

16.1. Performance Profile Creator の概要

16.1.1. must-gather コマンドを使用したクラスターに関するデータの収集

16.1.2. podman を使用した Performance Profile Creator の実行

16.1.2.1. podman を実行してパフォーマンスプロファイルを作成する方法

16.1.3. Performance Profile Creator ラッパースクリプトの実行

16.1.4. Performance Profile Creator の引数

Quick Links

Help

Site Info

Related Sites

Systems Status

About

Red Hat legal and privacy links

Red Hat legal and privacy links

第16章パフォーマンスプロファイルの作成

16.1.2. `podman` を使用した Performance Profile Creator の実行

16.1.2.1. `podman` を実行してパフォーマンスプロファイルを作成する方法