Chapitre 18. Création d'un profil de performance

Procédure

1. Facultatif : Vérifiez qu'il existe un pool de configuration machine correspondant avec une étiquette :

   $ oc describe mcp/worker-rt

   Exemple de sortie

   Name:         worker-rt
   Namespace:
   Labels:       machineconfiguration.openshift.io/role=worker-rt

2. S'il n'existe pas d'étiquette correspondante, ajoutez une étiquette pour un pool de configuration de machine (MCP) qui correspond au nom du MCP :

   $ oc label mcp <mcp_name> <mcp_name>=""

3. Accédez au répertoire dans lequel vous souhaitez stocker les données must-gather.

4. Exécutez must-gather sur votre cluster :

   oc adm must-gather --image=<PAO_must_gather_image> --dest-dir=<dir> $ oc adm must-gather --image=<PAO_must_gather_image>

   Note

   La commande must-gather doit être exécutée avec l'image performance-addon-operator-must-gather. La sortie peut éventuellement être compressée. La sortie compressée est nécessaire si vous exécutez le script wrapper Performance Profile Creator.

   Exemple :

   oc adm must-gather --image=registry.redhat.io/openshift4/performance-addon-operator-must-gather-rhel8:v4.12 --dest-dir=<path_to_must-gather>/must-gather

5. Créer un fichier compressé à partir du répertoire must-gather:

   $ tar cvaf must-gather.tar.gz must-gather/

Procédure

1. Vérifiez le pool de configuration de la machine :

   $ oc get mcp

   Exemple de sortie

   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

2. Utilisez Podman pour vous authentifier sur registry.redhat.io:

   $ podman login registry.redhat.io

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

3. Facultatif : Affiche l'aide pour l'outil PPC :

   $ podman run --rm --entrypoint performance-profile-creator registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.12 -h

   Exemple de sortie

   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")
         --offlined-cpu-count int            Number of offlined CPUs
         --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

4. Exécutez l'outil Performance Profile Creator en mode découverte :

   Note

   Le mode découverte inspecte votre cluster à l'aide de la sortie de must-gather. La sortie produite comprend des informations sur :

   • Le partitionnement de la cellule NUMA avec les identifiants de l'unité centrale alloués
   • Si l'hyperthreading est activé

   En utilisant ces informations, vous pouvez définir des valeurs appropriées pour certains des arguments fournis à l'outil Performance Profile Creator.

   $ 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:v4.12 --info log --must-gather-dir-path /must-gather

   Note

   Cette commande utilise le créateur de profil de performance comme nouveau point d'entrée vers podman. Elle mappe les données must-gather pour l'hôte dans l'image du conteneur et invoque les arguments de profil fournis par l'utilisateur pour produire le fichier my-performance-profile.yaml.

   L'option -v peut être le chemin d'accès à l'un ou l'autre :

   • Le répertoire de sortie de must-gather
   • Un répertoire existant contenant l'archive décompressée must-gather

   L'option info requiert une valeur qui spécifie le format de sortie. Les valeurs possibles sont log et JSON. Le format JSON est réservé au débogage.

5. Exécuter podman:

   $ podman run --entrypoint performance-profile-creator -v /must-gather:/must-gather:z registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.12 --mcp-name=worker-cnf --reserved-cpu-count=4 --rt-kernel=true --split-reserved-cpus-across-numa=false --must-gather-dir-path /must-gather --power-consumption-mode=ultra-low-latency --offlined-cpu-count=6 > my-performance-profile.yaml

   Note

   Les arguments du Créateur de profil de performance sont présentés dans le tableau des arguments du Créateur de profil de performance. Les arguments suivants sont nécessaires :

   • reserved-cpu-count
   • mcp-name
   • rt-kernel

   Dans cet exemple, l'argument mcp-name est défini sur worker-cnf en fonction de la sortie de la commande oc get mcp. Pour OpenShift à nœud unique, utilisez --mcp-name=master.

6. Examinez le fichier YAML créé :

   $ cat my-performance-profile.yaml

   Exemple de sortie

   apiVersion: performance.openshift.io/v2
   kind: PerformanceProfile
   metadata:
     name: performance
   spec:
     cpu:
       isolated: 2-39,48-79
       offlined: 42-47
       reserved: 0-1,40-41
     machineConfigPoolSelector:
       machineconfiguration.openshift.io/role: worker-cnf
     nodeSelector:
       node-role.kubernetes.io/worker-cnf: ""
     numa:
       topologyPolicy: restricted
     realTimeKernel:
       enabled: true
     workloadHints:
       highPowerConsumption: true
       realTime: true

7. Appliquer le profil généré :

   $ oc apply -f my-performance-profile.yaml

Procédure

1. Créez un fichier sur votre machine locale nommé, par exemple, run-perf-profile-creator.sh:

   $ vi run-perf-profile-creator.sh

2. Collez le code suivant dans le fichier :

   #!/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"
   
   NTO_IMG="registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.12"
   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                 Node Tuning Operator image"
     print "   -t                 path to a must-gather tarball"
   
     ${IMG_EXISTS_CMD} "${NTO_IMG}" && ${CMD} "${NTO_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} "${NTO_IMG}" || ${IMG_PULL_CMD} "${NTO_IMG}" || \
         exit_error "Node Tuning 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)
           NTO_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" "${NTO_IMG}" "$@" --must-gather-dir-path "${MUST_GATHER_VOL}"
     echo "" 1>&2
   }
   
   main "$@"

3. Ajoutez des permissions d'exécution pour tout le monde sur ce script :

   $ chmod a+x run-perf-profile-creator.sh

4. Facultatif : Affichez l'utilisation de la commande run-perf-profile-creator.sh:

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

   Résultats attendus

   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                 Node Tuning 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")
         --offlined-cpu-count int            Number of offlined CPUs
         --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

   Note

   Il existe deux types d'arguments :

   • Les arguments enveloppants, à savoir -h, -p et -t
   • Arguments du CPP

   1

   En option : Spécifiez l'image de l'opérateur Node Tuning. Si elle n'est pas définie, l'image en amont par défaut est utilisée : registry.redhat.io/openshift4/ose-cluster-node-tuning-operator:v4.12.

   2

   -t est un argument obligatoire du script wrapper et spécifie le chemin d'accès à l'archive must-gather.

5. Exécutez l'outil de création de profils de performance en mode découverte :

   Note

   Le mode découverte inspecte votre cluster à l'aide de la sortie de must-gather. La sortie produite comprend des informations sur :

   • Le partitionnement de la cellule NUMA avec les ID d'unité centrale attribués
   • Si l'hyperthreading est activé

   En utilisant ces informations, vous pouvez définir des valeurs appropriées pour certains des arguments fournis à l'outil Performance Profile Creator.

   $ ./run-perf-profile-creator.sh -t /must-gather/must-gather.tar.gz -- --info=log

   Note

   L'option info requiert une valeur qui spécifie le format de sortie. Les valeurs possibles sont log et JSON. Le format JSON est réservé au débogage.

6. Vérifiez le pool de configuration de la machine :

   $ oc get mcp

   Exemple de sortie

   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

7. Créer un profil de performance :

   ./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

   Note

   Les arguments du Créateur de profil de performance sont présentés dans le tableau des arguments du Créateur de profil de performance. Les arguments suivants sont nécessaires :

   • reserved-cpu-count
   • mcp-name
   • rt-kernel

   Dans cet exemple, l'argument mcp-name est défini sur worker-cnf en fonction de la sortie de la commande oc get mcp. Pour OpenShift à nœud unique, utilisez --mcp-name=master.

8. Examinez le fichier YAML créé :

   $ cat my-performance-profile.yaml

   Exemple de sortie

   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

9. Appliquer le profil généré :

   Note

   Installez l'opérateur de réglage des nœuds avant d'appliquer le profil.

   $ oc apply -f my-performance-profile.yaml