Gatekeeper

Supported OS Linux

Integrationv0.0.1

Présentation

Ce check recueille des métriques à partir de Gatekeeper OPA.

Dashboard de vue d’ensemble de Gatekeeper

Configuration

Suivez les instructions ci-dessous pour installer et configurer ce check pour un Agent exécuté sur un cluster Kubernetes. Consultez également la documentation relative aux modèles d’intégration Autodiscovery pour découvrir comment appliquer ces instructions.

Installation

Agent v7.26.0/v6.26.0 ou ultérieur

Pour utiliser une intégration provenant du référentiel integrations-extra avec l’Agent Docker, nous vous recommandons de générer l’Agent avec l’intégration installée. Utilisez le Dockerfile suivant pour créer une version mise à jour de l’Agent comprenant l’intégration gatekeeper issue de integrations-extras :

FROM gcr.io/datadoghq/agent:latest
RUN agent integration install -r -t datadog-gatekeeper==<VERSION_INTÉGRATION>

Versions antérieures de l’Agent

Pour installer le check gatekeeper sur votre cluster Kubernetes :

  1. Installez le kit de développement.

  2. Clonez le dépôt integrations-extras :

    git clone https://github.com/DataDog/integrations-extras.git.
    
  3. Mettez à jour votre configuration ddev avec le chemin integrations-extras/ :

    ddev config set extras ./integrations-extras
    
  4. Pour générer le package gatekeeper, exécutez :

    ddev -e release build gatekeeper
    
  5. Téléchargez le manifeste de l’Agent pour installer l’Agent Datadog en tant que DaemonSet.

  6. Créez deux PersistentVolumeClaim, un pour le code des checks et l’autre pour la configuration.

  7. Ajoutez-les en tant que volumes au modèle de pod de l’Agent, puis utilisez-les pour vos checks et votre configuration :

         env:
           - name: DD_CONFD_PATH
             value: "/confd"
           - name: DD_ADDITIONAL_CHECKSD
             value: "/checksd"
       [...]
         volumeMounts:
           - name: agent-code-storage
             mountPath: /checksd
           - name: agent-conf-storage
             mountPath: /confd
       [...]
       volumes:
         - name: agent-code-storage
           persistentVolumeClaim:
             claimName: agent-code-claim
         - name: agent-conf-storage
           persistentVolumeClaim:
             claimName: agent-conf-claim
    
  8. Déployez l’Agent Datadog sur votre cluster Kubernetes :

    kubectl apply -f agent.yaml
    
  9. Copiez le fichier d’artefact de l’intégration (.whl) sur vos nœuds Kubernetes ou importez-le sur une URL publique.

  10. Exécutez la commande suivante pour installer le wheel de l’intégration à l’aide de l’Agent :

    kubectl exec ds/datadog -- agent integration install -w <PATH_OF_GATEKEEPER_ARTIFACT_>/<GATEKEEPER_ARTIFACT_NAME>.whl
    
  11. Exécutez les commandes suivantes pour copier les checks et la configuration sur les PVC correspondants :

    kubectl exec ds/datadog -- sh
    # cp -R /opt/datadog-agent/embedded/lib/python3.8/site-packages/datadog_checks/* /checksd
    # cp -R /etc/datadog-agent/conf.d/* /confd
    
  12. Redémarrez les pods de l’Agent Datadog.

Configuration

  1. Modifiez le fichier gatekeeper/conf.yaml dans le dossier /confd que vous avez ajouté au pod de l’Agent pour commencer à recueillir vos données de performance gatekeeper. Consultez le fichier d’exemple gatekeeper/conf.yaml pour découvrir toutes les options de configuration disponibles.

  2. Redémarrez l’Agent.

Validation

Lancez la sous-commande status de l’Agent et cherchez gatekeeper dans la section Checks.

Données collectées

Métriques

gatekeeper.audit.duration.seconds.sum
(count)
Latency of audit operation in seconds
Shown as second
gatekeeper.audit.duration.seconds.count
(count)
Latency of audit operation in seconds
Shown as second
gatekeeper.audit.last_run_time
(gauge)
Timestamp of last audit operation
gatekeeper.constraint_template_ingestion.duration.seconds.sum
(count)
Distribution of how long it took to ingest a constraint template in seconds
Shown as second
gatekeeper.constraint_template_ingestion.duration.seconds.count
(count)
Distribution of how long it took to ingest a constraint template in seconds
Shown as second
gatekeeper.constraint_template_ingestion.count
(count)
Total number of constraint template ingestion actions
gatekeeper.violations
(gauge)
Total number of violations per constraint
gatekeeper.constraints
(gauge)
Current number of known constraints
gatekeeper.constraint_templates
(gauge)
Number of observed constraint templates
gatekeeper.request.duration.seconds.sum
(count)
The response time in seconds
Shown as second
gatekeeper.request.duration.seconds.count
(count)
The response time in seconds
Shown as second
gatekeeper.request.count
(count)
Total number of requests that are routed to webhook
gatekeeper.sync
(gauge)
Total number of resources of each kind being cached
gatekeeper.sync.duration.seconds.sum
(count)
Latency of sync operation in seconds
Shown as second
gatekeeper.sync.duration.seconds.count
(count)
Latency of sync operation in seconds
Shown as second
gatekeeper.sync.last_run_time
(gauge)
Timestamp of last sync operation
gatekeeper.watch.intended
(gauge)
The total number of Group/Version/Kinds that the watch manager has instructions to watch
gatekeeper.watch.watched
(gauge)
The total number of Group/Version/Kinds currently watched by the watch manager

Événements

Gatekeeper n’inclut aucun événement.

Checks de service

gatekeeper.prometheus.health
Returns CRITICAL if the agent fails to connect to the Prometheus metrics endpoint, otherwise OK.
Statuses: ok, critical

gatekeeper.health
Returns CRITICAL if the agent fails to connect to the gatekeeper health endpoint, OK if it returns 200, WARNING otherwise.
Statuses: ok, warning, critical

Dépannage

Besoin d’aide ? Contactez l’assistance Datadog.