OpenShift Dedicated

Indique Prometheus comme type de déclencheur.

Indique l’adresse du serveur Prometheus. Cet exemple utilise OpenShift Dedicated Monitoring.

Facultatif : Spécifie l’espace de noms de l’objet que vous souhaitez mettre à l’échelle. Ce paramètre est obligatoire si vous utilisez OpenShift Dedicated Monitoring comme source pour les métriques.

Indique le nom pour identifier la métrique dans l’API externe.metrics.k8s.io. Lorsque vous utilisez plus d’un déclencheur, tous les noms métriques doivent être uniques.

5

Indique la valeur qui déclenche la mise à l’échelle. Doit être spécifié comme une valeur de chaîne citée.

6

Indique la requête Prometheus à utiliser.

7

Indique la méthode d’authentification à utiliser. Les échelles Prometheus prennent en charge l’authentification au porteur (porteur), l’authentification de base (basique) ou l’authentification TLS (tls). Comme indiqué dans une section suivante, vous configurez les paramètres d’authentification spécifiques dans une authentification de déclencheur. Au besoin, vous pouvez également utiliser un secret.

8

Facultatif : Passe l’en-tête X-Scope-OrgID à un stockage multi-locataires Cortex ou Mimir pour Prometheus. Ce paramètre n’est requis qu’avec le stockage Prometheus multi-locataires, pour indiquer quelles données Prometheus doit retourner.

9

Facultatif : Spécifie comment le déclencheur doit procéder si la cible Prometheus est perdue.

Dans l’affirmative, le déclencheur continue de fonctionner si la cible Prometheus est perdue. C’est le comportement par défaut.
En cas de faux, le déclencheur renvoie une erreur si la cible Prometheus est perdue.

10

Facultatif: Spécifie si la vérification du certificat doit être ignorée. À titre d’exemple, vous pouvez sauter la vérification si vous êtes en cours d’exécution dans un environnement de test et en utilisant des certificats autosignés au point de terminaison Prometheus.

En cas de faux, la vérification du certificat est effectuée. C’est le comportement par défaut.
Dans l’affirmative, la vérification du certificat n’est pas effectuée.
Important
Il n’est pas recommandé de sauter le chèque.

3.4.1.1. Configuration des métriques personnalisées autoscaler pour utiliser OpenShift Surveillance dédiée

La surveillance OpenShift Dedicated Prometheus installée peut être utilisée comme source pour les métriques utilisées par l’autoscaleur de mesures personnalisées. Cependant, il y a quelques configurations supplémentaires que vous devez effectuer.

Afin que vos objets mis à l’échelle puissent lire les métriques OpenShift Dedicated Prometheus, vous devez utiliser une authentification de déclenchement ou une authentification de déclenchement de cluster afin de fournir les informations d’authentification requises. La procédure suivante diffère selon la méthode d’authentification de déclenchement que vous utilisez. En savoir plus sur les authentifications de déclenchement, voir « Comprendre les authentifications automatiques des métriques personnalisées ».

Note

Ces étapes ne sont pas nécessaires pour une source externe de Prometheus.

Comme décrit dans cette section, vous devez effectuer les tâches suivantes:

Créer un compte de service.
Créez un secret qui génère un jeton pour le compte de service.
Créez l’authentification de déclencheur.
Créer un rôle.
Ajoutez ce rôle au compte de service.
Faites référence au jeton dans l’objet d’authentification de déclenchement utilisé par Prometheus.

Conditions préalables

La surveillance dédiée à OpenShift doit être installée.
La surveillance des charges de travail définies par l’utilisateur doit être activée dans OpenShift Dedicated Monitoring, comme décrit dans la section Création d’une carte de configuration de la charge de travail définie par l’utilisateur.
Le Custom Metrics Autoscaler Operator doit être installé.

Procédure

Changement au projet approprié:
```
oc project <project_name>
```
```
$ oc project <project_name> 
```
1
Copy to Clipboard
1
Indique l’un des projets suivants:
Lorsque vous utilisez une authentification de déclencheur, spécifiez le projet avec l’objet que vous souhaitez mettre à l’échelle.
Lorsque vous utilisez une authentification de déclencheur de cluster, spécifiez le projet openshift-keda.

Créez un compte de service et un jeton, si votre cluster n’en a pas:

Créer un objet de compte de service en utilisant la commande suivante:
```
oc create serviceaccount thanos
```
```
$ oc create serviceaccount thanos 
```
1
Copy to Clipboard
1
Indique le nom du compte de service.

Créez un YAML secret pour générer un jeton de compte de service:

apiVersion: v1
kind: Secret
metadata:
  name: thanos-token
  annotations:
    kubernetes.io/service-account.name: thanos 
type: kubernetes.io/service-account-token

apiVersion: v1
kind: Secret
metadata:
  name: thanos-token
  annotations:
    kubernetes.io/service-account.name: thanos


type: kubernetes.io/service-account-token

Copy to Clipboard

1: Indique le nom du compte de service.

Créez l’objet secret en utilisant la commande suivante:
```
oc create -f <file_name>.yaml
```
```
$ oc create -f <file_name>.yaml
```
Copy to Clipboard

À l’aide de la commande suivante pour localiser le jeton attribué au compte de service:

oc describe serviceaccount thanos

$ oc describe serviceaccount thanos

Copy to Clipboard

1: Indique le nom du compte de service.

Exemple de sortie

Name:                thanos
Namespace:           <namespace_name>
Labels:              <none>
Annotations:         <none>
Image pull secrets:  thanos-dockercfg-nnwgj
Mountable secrets:   thanos-dockercfg-nnwgj
Tokens:              thanos-token 
Events:              <none>

Name:                thanos
Namespace:           <namespace_name>
Labels:              <none>
Annotations:         <none>
Image pull secrets:  thanos-dockercfg-nnwgj
Mountable secrets:   thanos-dockercfg-nnwgj
Tokens:              thanos-token


Events:              <none>

Copy to Clipboard

1: Utilisez ce jeton dans l’authentification de déclencheur.

Créer une authentification de déclenchement avec le jeton de compte de service:
1. Créez un fichier YAML similaire à ce qui suit:
  apiVersion: keda.sh/v1alpha1 kind: <authentication_method>
  1
  metadata: name: keda-trigger-auth-prometheus spec: secretTargetRef:
  2
  - parameter: bearerToken
  3
  name: thanos-token
  4
  key: token
  5
  - parameter: ca name: thanos-token key: ca.crt
  Copy to Clipboard
  1
  Indique l’une des méthodes d’authentification de déclenchement suivantes:
  Lorsque vous utilisez une authentification de déclencheur, spécifiez TriggerAuthentication. Cet exemple configure une authentification de déclenchement.
  Lorsque vous utilisez une authentification de déclencheur de cluster, spécifiez ClusterTriggerAuthentication.
  2
  Indique que cet objet utilise un secret pour l’autorisation.
  3
  Indique le paramètre d’authentification à fournir en utilisant le jeton.
  4
  Indique le nom du jeton à utiliser.
  5
  Indique la clé dans le jeton à utiliser avec le paramètre spécifié.
2. Créer l’objet CR:
  $ oc create -f <file-name>.yaml
  Copy to Clipboard

Créer un rôle pour lire les métriques Thanos:

Créez un fichier YAML avec les paramètres suivants:

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: thanos-metrics-reader
rules:
- apiGroups:
  - ""
  resources:
  - pods
  verbs:
  - get
- apiGroups:
  - metrics.k8s.io
  resources:
  - pods
  - nodes
  verbs:
  - get
  - list
  - watch

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: thanos-metrics-reader
rules:
- apiGroups:
  - ""
  resources:
  - pods
  verbs:
  - get
- apiGroups:
  - metrics.k8s.io
  resources:
  - pods
  - nodes
  verbs:
  - get
  - list
  - watch

Copy to Clipboard

Créer l’objet CR:

oc create -f <file-name>.yaml

$ oc create -f <file-name>.yaml

Copy to Clipboard

Créer une liaison de rôle pour lire les métriques Thanos:
1. Créez un fichier YAML similaire à ce qui suit:
  apiVersion: rbac.authorization.k8s.io/v1 kind: <binding_type>
  1
  metadata: name: thanos-metrics-reader
  2
  namespace: my-project
  3
  roleRef: apiGroup: rbac.authorization.k8s.io kind: Role name: thanos-metrics-reader subjects: - kind: ServiceAccount name: thanos
  4
  namespace: <namespace_name>
  5
  Copy to Clipboard
  1
  Indique l’un des types d’objets suivants:
  Lorsque vous utilisez une authentification de déclencheur, spécifiez RoleBinding.
  Lorsque vous utilisez une authentification de déclencheur de cluster, spécifiez ClusterRoleBinding.
  2
  Indique le nom du rôle que vous avez créé.
  3
  Indique l’un des projets suivants:
  Lorsque vous utilisez une authentification de déclencheur, spécifiez le projet avec l’objet que vous souhaitez mettre à l’échelle.
  Lorsque vous utilisez une authentification de déclencheur de cluster, spécifiez le projet openshift-keda.
  4
  Indique le nom du compte de service pour se lier au rôle.
  5
  Indique le projet où vous avez précédemment créé le compte de service.
2. Créer l’objet CR:
  $ oc create -f <file-name>.yaml
  Copy to Clipboard

Comme décrit dans « Comprendre comment ajouter des métriques personnalisées », vous pouvez maintenant déployer un objet à l’échelle ou une tâche mise à l’échelle pour activer l’autoscaling de votre application. Afin d’utiliser OpenShift Dedicated Monitoring comme source, dans le déclencheur ou l’échelleur, vous devez inclure les paramètres suivants:

triggers.type doit être promisheus
triggers.metadata.serverAdresse doit être https://thanos-querier.openshift-monitoring.svc.cluster.local:9092
triggers.metadata.authModes doivent être porteurs
triggers.metadata.namespace doit être réglé sur l’espace de noms de l’objet à l’échelle
triggers.authenticationRef doit pointer vers la ressource d’authentification de déclencheur spécifiée à l’étape précédente

3.4.2. Comprendre le déclencheur CPU

Les pods peuvent être mis à l’échelle en fonction des métriques CPU. Ce déclencheur utilise les métriques de cluster comme source pour les métriques.

Les mesures personnalisées autoscaler met à l’échelle les pods associés à un objet pour maintenir l’utilisation du CPU que vous spécifiez. L’autoscaler augmente ou diminue le nombre de répliques entre les nombres minimum et maximum pour maintenir l’utilisation spécifiée du CPU dans toutes les gousses. Le déclencheur de mémoire tient compte de l’utilisation de la mémoire de l’ensemble de la gousse. Lorsque la gousse a plusieurs conteneurs, le déclencheur de mémoire prend en compte l’utilisation totale de la mémoire de tous les conteneurs dans le pod.

Note

Ce déclencheur ne peut pas être utilisé avec la ressource personnalisée ScaledJob.
Lors de l’utilisation d’un déclencheur de mémoire pour mettre à l’échelle un objet, l’objet ne se met pas à l’échelle à 0, même si vous utilisez plusieurs déclencheurs.

Exemple d’objet mis à l’échelle avec une cible CPU

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
  name: cpu-scaledobject
  namespace: my-namespace
spec:
# ...
  triggers:
  - type: cpu 
    metricType: Utilization 
    metadata:
      value: '60' 
  minReplicaCount: 1

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
  name: cpu-scaledobject
  namespace: my-namespace
spec:
# ...
  triggers:
  - type: cpu


    metricType: Utilization


    metadata:
      value: '60'


  minReplicaCount: 1

Copy to Clipboard

Indique CPU comme type de déclencheur.

Indique le type de métrique à utiliser, soit l’utilisation ou la valeur moyenne.

Indique la valeur qui déclenche la mise à l’échelle. Doit être spécifié comme une valeur de chaîne citée.

Lors de l’utilisation, la valeur cible est la moyenne des métriques de ressources pour tous les pods pertinents, représentée en pourcentage de la valeur demandée de la ressource pour les pods.
Lors de l’utilisation de la valeur moyenne, la valeur cible est la moyenne des métriques de tous les pods pertinents.

Indique le nombre minimum de répliques lors de la mise à l’échelle. Dans le cas d’un déclencheur CPU, entrez une valeur de 1 ou plus, car le HPA ne peut pas atteindre zéro si vous utilisez uniquement des métriques CPU.

3.4.3. Comprendre le déclencheur de la mémoire

Les pods peuvent être mis à l’échelle en fonction des métriques de mémoire. Ce déclencheur utilise les métriques de cluster comme source pour les métriques.

Les mesures personnalisées autoscaler met à l’échelle les pods associés à un objet pour maintenir l’utilisation moyenne de la mémoire que vous spécifiez. L’autoscaler augmente et diminue le nombre de répliques entre les nombres minimum et maximum pour maintenir l’utilisation de la mémoire spécifiée dans toutes les gousses. Le déclencheur de mémoire considère l’utilisation de la mémoire de la gousse entière. Lorsque la gousse a plusieurs conteneurs, l’utilisation de la mémoire est la somme de tous les conteneurs.

Note

Ce déclencheur ne peut pas être utilisé avec la ressource personnalisée ScaledJob.
Lors de l’utilisation d’un déclencheur de mémoire pour mettre à l’échelle un objet, l’objet ne se met pas à l’échelle à 0, même si vous utilisez plusieurs déclencheurs.

Exemple d’objet mis à l’échelle avec une cible mémoire

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
  name: memory-scaledobject
  namespace: my-namespace
spec:
# ...
  triggers:
  - type: memory 
    metricType: Utilization 
    metadata:
      value: '60' 
      containerName: api

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
  name: memory-scaledobject
  namespace: my-namespace
spec:
# ...
  triggers:
  - type: memory


    metricType: Utilization


    metadata:
      value: '60'


      containerName: api

Copy to Clipboard

Indique la mémoire comme type de déclenchement.

Indique le type de métrique à utiliser, soit l’utilisation ou la valeur moyenne.

Indique la valeur qui déclenche la mise à l’échelle. Doit être spécifié comme une valeur de chaîne citée.

Lors de l’utilisation, la valeur cible est la moyenne des métriques de ressources pour tous les pods pertinents, représentée en pourcentage de la valeur demandée de la ressource pour les pods.
Lors de l’utilisation de la valeur moyenne, la valeur cible est la moyenne des métriques de tous les pods pertinents.

Facultatif: Spécifie un conteneur individuel à l’échelle, en fonction de l’utilisation de la mémoire seulement de ce conteneur, plutôt que de l’ensemble de la gousse. Dans cet exemple, seul le conteneur nommé api doit être mis à l’échelle.

3.4.4. Comprendre le déclencheur Kafka

Les pods peuvent être mis à l’échelle en fonction d’un sujet Apache Kafka ou d’autres services prenant en charge le protocole Kafka. L’échelle automatique des métriques personnalisées ne dépasse pas le nombre de partitions Kafka, à moins que vous n’ayez défini le paramètre allowIdleConsumers sur true dans l’objet mis à l’échelle ou le travail mis à l’échelle.

Note

Lorsque le nombre de groupes de consommateurs dépasse le nombre de partitions dans un sujet, les groupes de consommateurs supplémentaires restent inactifs. Afin d’éviter cela, le nombre de répliques par défaut ne dépasse pas:

Le nombre de partitions sur un sujet, si un sujet est spécifié
Le nombre de partitions de tous les sujets du groupe de consommateurs, si aucun sujet n’est spécifié
Le maxReplicaCount spécifié dans l’objet mis à l’échelle ou le travail mis à l’échelle CR

Le paramètre allowIdleConsumers permet de désactiver ces comportements par défaut.

Exemple d’objet mis à l’échelle avec une cible Kafka

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
  name: kafka-scaledobject
  namespace: my-namespace
spec:
# ...
  triggers:
  - type: kafka 
    metadata:
      topic: my-topic 
      bootstrapServers: my-cluster-kafka-bootstrap.openshift-operators.svc:9092 
      consumerGroup: my-group 
      lagThreshold: '10' 
      activationLagThreshold: '5' 
      offsetResetPolicy: latest 
      allowIdleConsumers: true 
      scaleToZeroOnInvalidOffset: false 
      excludePersistentLag: false 
      version: '1.0.0' 
      partitionLimitation: '1,2,10-20,31' 
      tls: enable

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
  name: kafka-scaledobject
  namespace: my-namespace
spec:
# ...
  triggers:
  - type: kafka


    metadata:
      topic: my-topic


      bootstrapServers: my-cluster-kafka-bootstrap.openshift-operators.svc:9092


      consumerGroup: my-group


      lagThreshold: '10'


      activationLagThreshold: '5'


      offsetResetPolicy: latest


      allowIdleConsumers: true


      scaleToZeroOnInvalidOffset: false


      excludePersistentLag: false


      version: '1.0.0'


      partitionLimitation: '1,2,10-20,31'


      tls: enable

Copy to Clipboard

Indique Kafka comme type de déclencheur.

Indique le nom du sujet Kafka sur lequel Kafka traite le décalage.

Indique une liste séparée par virgule des courtiers Kafka auxquels se connecter.