Aller au contenu principal

Kubernetes API

Contenu du pack​

Préambule​

Ce Pack vise à superviser à la fois la couche d'infrastructure (noeuds) et les services d'un cluster Kubernetes (deployments, daemonsets, etc). Le Pack Kubernetes API offre plusieurs façons d'organiser la supervision du cluster. Il en existe principalement trois :

Modèles​

Le connecteur de supervision Kubernetes API apporte 2 modèles d'hôte :

  • Cloud-Kubernetes-Api-custom
  • Cloud-Kubernetes-Kubectl-custom
  • Cloud-Kubernetes-Node-Api-custom
  • Cloud-Kubernetes-Node-Kubectl-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescriptionDécouverte
Cluster-EventsCloud-Kubernetes-Cluster-Events-Api-customContrôle le nombre d'événements survenant sur le cluster
CronJob-StatusCloud-Kubernetes-CronJob-Status-Api-customContrôle le statut des CronJobsX
Daemonset-StatusCloud-Kubernetes-Daemonset-Status-Api-customContrôle le statut des DaemonSetsX
Deployment-StatusCloud-Kubernetes-Deployment-Status-Api-customContrôle le statut des DeploymentsX
Node-StatusCloud-Kubernetes-Node-Status-Api-customContrôle le statut des Nodes
Node-StatusCloud-Kubernetes-Node-Status-Name-Api-customContrôle le statut d'un Node identifié par son nom (par exemple à l'issue de la règle de découverte associée)X
Node-UsageCloud-Kubernetes-Node-Usage-Api-customContrôle l'utilisation des noeuds
Node-UsageCloud-Kubernetes-Node-Usage-Name-Api-customContrôle l'utilisation d'un noeud identifié par son nom (par exemple à l'issue de la règle de découverte associée)X
PersistentVolume-StatusCloud-Kubernetes-PersistentVolume-Status-Api-customContrôle le statut des PersistentVolumesX
Pod-StatusCloud-Kubernetes-Pod-Status-Api-customContrôle le statut des pods et des containersX
ReplicaSet-StatusCloud-Kubernetes-ReplicaSet-Status-Api-customContrôle le statut des ReplicaSetsX
ReplicationController-StatusCloud-Kubernetes-ReplicationController-Status-Api-customContrôle le statut des ReplicationControllersX
StatefulSet-StatusCloud-Kubernetes-StatefulSet-Status-Api-customContrôle le statut des StatefulSetsX

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Cloud-Kubernetes-Api-custom est utilisé.

Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.

Règles de découverte​

Découverte d'hôtes​

Nom de la règleDescription
Kubernetes Nodes (RestAPI)Découvrez les noeuds Kubernetes en interrogeant l'API Rest Kubernetes
Kubernetes Nodes (Kubectl)Découvrez les noeuds Kubernetes en interrogeant le cluster Kubernetes avec kubectl

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique d'hôtes.

Découverte de services​

Nom de la règleDescription
Cloud-Kubernetes-Api-CronJobs-StatusDécouvrez les CronJobs Kubernetes pour superviser leur statut
Cloud-Kubernetes-Api-Daemonsets-StatusDécouvrez les DaemonSets Kubernetes pour superviser leur statut
Cloud-Kubernetes-Api-Deployments-StatusDécouvrez les Deployments Kubernetes pour superviser leur statut
Cloud-Kubernetes-Api-Nodes-StatusDécouvrez les Nodes Kubernetes pour superviser leur statut
Cloud-Kubernetes-Api-Nodes-UsageDécouvrez les Nodes Kubernetes pour superviser leur utilisation
Cloud-Kubernetes-Api-PersistentVolumes-StatusDécouvrez les PersistentVolumes Kubernetes pour superviser leur statut
Cloud-Kubernetes-Api-Pods-StatusDécouvrez les Pods Kubernetes pour superviser leur statut
Cloud-Kubernetes-Api-ReplicaSets-StatusDécouvrez les ReplicaSets Kubernetes pour superviser leur statut
Cloud-Kubernetes-Api-ReplicationControllers-StatusDécouvrez les ReplicationControllers Kubernetes pour superviser leur statut
Cloud-Kubernetes-Api-StatefulSets-StatusDécouvrez les StatefulSets Kubernetes pour superviser leur statut

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

Métriques & statuts collectés​

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

MétriqueUnité
events.type.warning.countcount
events.type.normal.countcount
events#statusN/A

Informations complémentaires sur les métriques et services​

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

Cet indicateur permet de superviser le nombre d'événements se produisant sur le cluster. Si la commande kubectl get events a pour sortie :

NAMESPACE   LAST SEEN   TYPE      REASON      OBJECT           MESSAGE
graphite    26m         Warning   Unhealthy   pod/graphite-0   Liveness probe failed: Get "http://10.244.2.10:8080/": context deadline exceeded (Client.Timeout exceeded while awaiting headers)

Alors la sortie résultante dans Centreon pourrait ressembler à :

Event 'Warning' for object 'Pod/graphite-0' with message 'Liveness probe failed: Get "http://10.244.2.10:8080/": context deadline exceeded (Client.Timeout exceeded while awaiting headers)', Count: 1, First seen: 26m 21s ago (2021-03-11T12:26:23Z), Last seen: 26m 21s ago (2021-03-11T12:26:23Z)

Prérequis​

Comme mentionné dans l'introduction, deux modes de communication sont disponibles:

  • l'API Rest exposée par le cluster Kubernetes,
  • l'outil CLI kubectl pour communiquer avec le control plane du cluster.

Pour de meilleures performances, nous vous recommandons d'utiliser l'API Rest.

Créer un compte de service​

Les deux versions doivent utiliser un compte de service avec des droits suffisants pour accéder à l'API Kubernetes.

Créez un compte de service dédié centreon-service-account dans l'espace de noms kube-system pour accéder à l'API:

kubectl create serviceaccount centreon-service-account --namespace kube-system

Créez un rôle de cluster api-access avec les privilèges nécessaires pour le plugin et liez-le au compte de service nouvellement créé :

cat <<EOF | kubectl create -f -
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: api-access
rules:
  - apiGroups:
      - ""
      - apps
      - batch
    resources:
      - cronjobs
      - daemonsets
      - deployments
      - events
      - namespaces
      - nodes
      - persistentvolumes
      - pods
      - replicasets
      - replicationcontrollers
      - statefulsets
    verbs:
      - get
      - list
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: api-access
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: api-access
subjects:
- kind: ServiceAccount
  name: centreon-service-account
  namespace: kube-system
EOF

Se référer à la documentation officielle pour la création de compte de service ou pour des informations sur le concept de secret.

Utilisation de l'API Rest​

Si vous avez choisi de communiquer avec l'API Rest de votre plateforme Kubernetes, les conditions préalables suivantes doivent être remplies :

  • Exposez l'API avec TLS,
  • Récupérez le jeton du compte de service.
Exposez l'API​

Comme l'API utilise HTTPS, vous aurez besoin d'un certificat.

Vous pouvez créer un couple clé / certificat signé automatiquement avec la commande suivante :

openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/ssl/private/kubernetesapi.key -out /etc/ssl/certs/kubernetesapi.crt

Puis chargez-le en tant que api-certificate dans le cluster, à partir du noeud maître :

kubectl create secret tls api-certificate --key /etc/ssl/private/kubernetesapi.key --cert /etc/ssl/certs/kubernetesapi.crt

L'entrée peut maintenant être créée :

cat <<EOF | kubectl create -f -
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: kubernetesapi-ingress
  namespace: default
  annotations:
    kubernetes.io/ingress.class: "nginx"
    nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
spec:
  tls:
    - hosts:
      - kubernetesapi.local.domain
      secretName: api-certificate
  rules:
  - host: kubernetesapi.local.domain
    http:
      paths:
      - path: /
        pathType: ImplementationSpecific
        backend:
          service:
            name: kubernetes
            port:
              number: 443
EOF

Adaptez les entrées host à vos besoins.

Se référer à la documentation officielle pour la gestion des ingress.

Récupérer le jeton du compte de service​

Récupérez le secret du compte de service précédemment créé :

kubectl get serviceaccount centreon-service-account --namespace kube-system --output jsonpath='{.secrets[].name}'

Récupérez ensuite le jeton du secret du compte de service :

kubectl get secrets centreon-service-account-token-xqw7m --namespace kube-system --output jsonpath='{.data.token}' | base64 --decode

Ce jeton sera utilisé ultérieurement pour la configuration de l'hôte Centreon.

Utilisation de kubectl​

Si vous avez choisi de communiquer avec le control plane du cluster avec kubectl, les conditions préalables suivantes doivent être remplies:

  • Installez l'outil kubectl,
  • Créez une configuration kubectl.

Ces actions sont nécessaires sur tous les Pollers qui effectueront la supervision de Kubernetes.

Installer kubectl​

Téléchargez la dernière version avec la commande suivante :

curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"

Assurez-vous de télécharger une version avec une différence d'au maximum une version mineure de votre cluster. Pour télécharger une version spécifique, changez le contenu de la commande curl incluse dans la commande ci-dessus, permettant de récupérer le numéro de version. Par exemple pour télécharger la version 1.20.0 voici la commande : curl -LO "https://dl.k8s.io/release/v1.20.0/bin/linux/amd64/kubectl"

Installez l'outil dans le répertoire des binaires :

sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl

Référez vous à la documentation officielle pour plus de détails.

Créer une configuration kubectl​

Pour accéder au cluster, kubectl a besoin d'un fichier de configuration contenant toutes les informations nécessaires.

Voici un exemple de création de fichier de configuration basé sur un compte de service (créé au chapitre précédent).

Vous devrez remplir les informations suivantes et exécuter les commandes sur le noeud maître:

ip=<master node ip>
port=<api port>
account=centreon-service-account
namespace=kube-system
clustername=my-kube-cluster
context=my-kube-cluster
secret=$(kubectl get serviceaccount $account --namespace $namespace --output jsonpath='{.secrets[].name}')
ca=$(kubectl get secret $secret --namespace $namespace --output jsonpath='{.data.ca\.crt}')
token=$(kubectl get secret $secret --namespace $namespace --output jsonpath='{.data.token}' | base64 --decode)

Le nom du compte et l'espace de noms doivent correspondre au compte créé précédemment. Toutes les autres informations doivent être adaptées.

Exécutez ensuite cette commande pour générer le fichier de configuration :

cat <<EOF >> config
apiVersion: v1
kind: Config
clusters:
- name: ${clustername}
  cluster:
    certificate-authority-data: ${ca}
    server: https://${ip}:${port}
contexts:
- name: ${context}
  context:
    cluster: ${clustername}
    namespace: ${namespace}
    user: ${account}
current-context: ${context}
users:
- name: ${account}
  user: ${token}
EOF

Cela créera un fichier config. Ce fichier doit être copié dans le répertoire racine de l'utilisateur de l'Engine du Poller, généralement dans un répertoire .kube (c'est-à-dire /var/lib/centreon-engine/.kube/config).

Ce chemin sera utilisé ultérieurement dans la configuration de l'hôte Centreon.

Vous devez également copier la configuration dans le répertoire de l'utilisateur Gorgone si vous utilisez Host Discovery.

Référez vous à la documentation officielle pour plus de détails.

Installer le connecteur de supervision​

Pack​

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Gestionnaire de connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
dnf install centreon-pack-cloud-kubernetes-api
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Kubernetes API depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

dnf install centreon-plugin-Cloud-Kubernetes-Api

Utiliser le connecteur de supervision​

Utiliser un modèle d'hôte issu du connecteur​

  1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
  3. Appliquez le modèle d'hôte Cloud-Kubernetes-Api-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
  4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires, notamment la macro permettant de définir le custom mode, c'est-à-dire la méthode de connexion à la ressource.
MacroDescriptionValeur par défautObligatoire
KUBERNETESAPIHOSTNAMEHostname or address of the Kubernetes API serviceX
KUBERNETESAPITOKENToken retrieved from service accountX
KUBERNETESAPIPROTOSpecify https if neededhttps
KUBERNETESAPIPORTAPI port443
KUBERNETESAPICUSTOMMODEWhen a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this optionapi
KUBERNETESAPINAMESPACESet namespace to get informations
KUBERNETESNODENAMEFilter StatefulSet name (can be a regexp)
PROXYURLProxy URL if any
TIMEOUTSet timeout in seconds10
EXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Pour la découverte d'hôte : définissez le jeton récupéré plus tôt à partir du compte de service,

Utiliser un modèle de service issu du connecteur​

  1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
  2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.
MacroDescriptionValeur par défautObligatoire
FILTERTYPEFilter event type (can be a regexp).*
FILTERNAMESPACEFilter namespace (can be a regexp).*
WARNINGSTATUSDefine the conditions to match for the status to be WARNING (default: '%{type} =~ /warning/i') Can use special variables like: %{name}, %{namespace}, %{type}, %{object}, %{message}, %{count}, %{first_seen}, %{last_seen}%{type} =~ /warning/i
CRITICALSTATUSDefine the conditions to match for the status to be CRITICAL (default: '%{type} =~ /error/i'). Can use special variables like: %{name}, %{namespace}, %{type}, %{object}, %{message}, %{count}, %{first_seen}, %{last_seen}%{type} =~ /error/i
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.--verbose
  1. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine). Vous pouvez tester que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_kubernetes_api.pl \
    --plugin=cloud::kubernetes::plugin \
    --mode=statefulset-status \
    --custommode='api' \
    --hostname= \
    --port='443' \
    --proto='https' \
    --token='' \
    --config-file='' \
    --proxyurl='' \
    --namespace='' \
    --timeout='10'  \
    --filter-name='.*' \
    --filter-namespace='.*' \
    --warning-status='%{up_to_date} < %{desired}' \
    --critical-status='%{ready} < %{desired}' \
    --verbose

La commande devrait retourner un message de sortie similaire à :

OK: All StatefulSets status are ok |

Diagnostic des erreurs communes​

Voici quelques erreurs courantes et leur description. Vous devrez souvent utiliser l'option --debug pour obtenir l'erreur exacte.

ErreurDescription
UNKNOWN: Cannot decode json response: Can't connect to <hostname>:<port> (certificate verify failed)This error may appear if the TLS certificate is self-signed. Use the option --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE" to omit the certificate validity.
UNKNOWN: API return error code '401' (add --debug option for detailed message)If adding --debug option, API response message says Unauthorized. It generally means that the provided token is not valid.
UNKNOWN: API return error code '403' (add --debug option for detailed message)If adding --debug option, API response message says nodes is forbidden: User "system:serviceaccount:<namespace>:<account>" cannot list resource "nodes" in API group "" at the cluster scope. It means that the cluster role RBAC bound to the service account does not have the necessary privileges
UNKNOWN: CLI return error code '1' (add --debug option for detailed message)If adding --debug option, CLI response message says error: stat ~/.kube/config:: no such file or directory. The provided configuration file cannot be found.
UNKNOWN: CLI return error code '1' (add --debug option for detailed message)If adding --debug option, CLI response message says error: error loading config file "/root/.kube/config": open /root/.kube/config: permission denied. The provided configuration file cannot be read by current user.
UNKNOWN: CLI return error code '1' (add --debug option for detailed message)If adding --debug option, CLI response message says error: error loading config file "/root/.kube/config": v1.Config.AuthInfos: []v1.NamedAuthInfo: v1.NamedAuthInfo.AuthInfo: v1.AuthInfo.ClientKeyData: decode base64: illegal base64.... The provided configuration file is not valid.
UNKNOWN: CLI return error code '1' (add --debug option for detailed message)If adding --debug option, CLI response message says The connection to the server <hostname>:<port> was refused - did you specify the right host or port?. The provided configuration file is not valid.

Pour plus d'informations, rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.

Modes disponibles​

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins/centreon_kubernetes_api.pl \
    --plugin=cloud::kubernetes::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
cluster-events [code]Cloud-Kubernetes-Cluster-Events-Api-custom
cronjob-status [code]Cloud-Kubernetes-CronJob-Status-Api-custom
daemonset-status [code]Cloud-Kubernetes-Daemonset-Status-Api-custom
deployment-status [code]Cloud-Kubernetes-Deployment-Status-Api-custom
discovery [code]Used for host discovery
list-cronjobs [code]Used for service discovery
list-daemonsets [code]Used for service discovery
list-deployments [code]Used for service discovery
list-ingresses [code]Not used in this Monitoring Connector
list-namespaces [code]Not used in this Monitoring Connector
list-nodes [code]Used for service discovery
list-persistentvolumes [code]Used for service discovery
list-pods [code]Used for service discovery
list-replicasets [code]Used for service discovery
list-replicationcontrollers [code]Used for service discovery
list-services [code]Not used in this Monitoring Connector
list-statefulsets [code]Used for service discovery
node-status [code]Cloud-Kubernetes-Node-Status-Api-custom
Cloud-Kubernetes-Node-Status-Name-Api-custom
node-usage [code]Cloud-Kubernetes-Node-Usage-Api-custom
Cloud-Kubernetes-Node-Usage-Name-Api-custom
persistentvolume-status [code]Cloud-Kubernetes-PersistentVolume-Status-Api-custom
pod-status [code]Cloud-Kubernetes-Pod-Status-Api-custom
replicaset-status [code]Cloud-Kubernetes-ReplicaSet-Status-Api-custom
replicationcontroller-status [code]Cloud-Kubernetes-ReplicationController-Status-Api-custom
statefulset-status [code]Cloud-Kubernetes-StatefulSet-Status-Api-custom

Custom modes disponibles​

Ce connecteur offre plusieurs méthodes pour se connecter à la ressource (CLI, bibliothèque, etc.), appelées custom modes. Tous les custom modes disponibles peuvent être affichés en ajoutant le paramètre --list-custommode à la commande :

/usr/lib/centreon/plugins/centreon_kubernetes_api.pl \
    --plugin=cloud::kubernetes::plugin \
    --list-custommode

Le plugin apporte les custom modes suivants :

  • api
  • kubectl

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

OptionDescription
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--custommodeWhen a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option.
--list-custommodeList all available custom modes.
--multipleMultiple custom mode objects. This may be required by some specific modes (advanced).
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()'
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdataRewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'. Kubernetes CLI (kubectl)
--namespaceSet namespace to get informations.
--timeoutSet timeout in seconds (default: 10).
--proxyurlProxy URL if any

Options des custom modes​

Les options spécifiques aux custom modes sont listées ci-dessous :

OptionDescription
--hostnameKubernetes API hostname.
--portAPI port (default: 443)
--protoSpecify https if needed (default: 'https')
--timeoutSet HTTP timeout
--limitNumber of responses to return for each list calls. See https://kubernetes.io/docs/reference/kubernetes-api/common-param eters/common-parameters/#limit
--namespaceSet namespace to get information.
--legacy-api-betaIf this option is set the legacy API path are set for this API calls: kubernetes_list_cronjobs will use this path: /apis/batch/v1beta1/namespaces/ and kubernetes_list_ingresses will use this path: /apis/extensions/v1beta1/namespaces/ . This ways are no longer served since K8S 1.22 see https://kubernetes.io/docs/reference/using-api/deprecation-guide/#ingress-v122
--http-peer-addrSet the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurlProxy URL. Example: http://my.proxy:3128
--proxypacProxy pac file (can be a URL or a local file).
--insecureAccept insecure SSL connections.
--http-backendPerl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--ssl-optSet SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE").
--curl-optSet CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ).

Options des modes​

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

OptionDescription
--config-fileKubernetes configuration file path (default: '~/.kube/config'). (example: --config-file='/root/.kube/config').
--contextContext to use in configuration file.
--sudoUse 'sudo' to execute the command.
--commandCommand to get information (default: 'kubectl'). Can be changed if you have output in a file.
--command-pathCommand path (default: none).
--command-optionsCommand options (default: none).
--filter-typeFilter event type (can be a regexp).
--filter-namespaceFilter namespace (can be a regexp).
--warning-statusDefine the conditions to match for the status to be WARNING (default: '%{type} =~ /warning/i') Can use special variables like: %{name}, %{namespace}, %{type}, %{object}, %{message}, %{count}, %{first_seen}, %{last_seen}.
--critical-statusDefine the conditions to match for the status to be CRITICAL (default: '%{type} =~ /error/i'). Can use special variables like: %{name}, %{namespace}, %{type}, %{object}, %{message}, %{count}, %{first_seen}, %{last_seen}.

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins/centreon_kubernetes_api.pl \
    --plugin=cloud::kubernetes::plugin \
    --mode=statefulset-status \
    --custommode='api' \
    --help