Installer le gestionnaire de tâches Synthetics

Pour afficher les versions, les dépendances, les valeurs par défaut du nombre de pods d'exécution démarrés avec chaque gestionnaire de tâches Synthetics et plus encore, veuillez consulter Afficher l'aide et les exemples ci-dessous.

1. Localisez la clé privée de votre site.

2. Assurez-vous d'avoir activé la dépendance Docker pour le sandboxing et installé le gestionnaire de tâches Synthetics sur votre système.

3. Exécutez le script approprié pour votre système. Adaptez la valeur par défaut commune /var/run/docker.sock dans les exemples suivants pour qu'elle corresponde à votre système.

   • Linux/macOS :

     bash

     Copier

     $
     docker run \
     >
         --name YOUR_CONTAINER_NAME \
     >
         -e "PRIVATE_LOCATION_KEY=YOUR_PRIVATE_LOCATION_KEY" \
     >
         -v /var/run/docker.sock:/var/run/docker.sock:rw \
     >
         -d \
     >
         --restart unless-stopped \
     >
         newrelic/synthetics-job-manager:latest

   • Windows:

     bash

     Copier

     $
     docker run ^
     $
         --name YOUR_CONTAINER_NAME ^
     $
         -e "PRIVATE_LOCATION_KEY=YOUR_PRIVATE_LOCATION_KEY" ^
     $
         -v /var/run/docker.sock:/var/run/docker.sock:rw ^
     $
         -d ^
     $
         --restart unless-stopped ^
     $
         newrelic/synthetics-job-manager:latest

   Consultez les logs de votre conteneur minion :

   bash

   Copier

   $
   docker logs --follow YOUR_CONTAINER_NAME

1. Localisez la clé privée de votre site.

2. Assurez-vous d'avoir activé la dépendance Podman pour le sandboxing et installé le gestionnaire de tâches Synthetics sur votre système.

3. Exécutez le script ci-dessous pour votre système.

   Pour créer un pod sous Linux et ajouter l’adresse IP de la machine hôte :

   podman pod create --network slirp4netns --name YOUR_POD_NAME --add-host=podman.service:HOST_IP_ADDRESS

   Copier

   Pour démarrer le gestionnaire de tâches :

   podman run \
   --name YOUR_CONTAINER_NAME \
   --pod YOUR_POD_NAME \
   -e "PRIVATE_LOCATION_KEY=YOUR_PRIVATE_LOCATION_KEY" \
   -e "CONTAINER_ENGINE=PODMAN" \
   -e "PODMAN_API_SERVICE_PORT=YOUR_PODMAN_API_SERVICE_PORT" \
   -e "PODMAN_POD_NAME=YOUR_POD_NAME" \
   -d \
   --restart unless-stopped \
   newrelic/synthetics-job-manager:latest

   Copier

   Pour afficher les logs de votre conteneur minion :

   podman logs --follow YOUR_CONTAINER_NAME

   Copier

1. Localisez la clé privée de votre site.

2. Configurez l'espace de nommage pour le gestionnaire de tâches Synthetics dans votre cluster Kubernetes:

   bash

   Copier

   $
   kubectl create namespace YOUR_NAMESPACE

3. Copiez les cartes Helm du référentiel Helm de New Relic.

   • Si vous copiez les graphiques pour la première fois :

     bash

     Copier

     $
     helm repo add YOUR_REPO_NAME https://helm-charts.newrelic.com

   • Si vous avez précédemment copié les cartes Helm du référentiel Helm de New Relic, récupérez la dernière version :

     bash

     Copier

     $
     helm repo update

4. Installez le gestionnaire de tâches Synthetics avec la commande Helm suivante :

   • Pour une nouvelle installation du gestionnaire de tâches Synthetics :

     helm install YOUR_JOB_MANAGER_NAME YOUR_REPO_NAME/synthetics-job-manager -n YOUR_NAMESPACE --set synthetics.privateLocationKey=YOUR_PRIVATE_LOCATION_KEY

     Copier

   • Pour mettre à jour une installation existante du gestionnaire de tâches Synthetics :

     bash

     Copier

     $
     helm upgrade YOUR_JOB_MANAGER_NAME YOUR_REPO_NAME/synthetics-job-manager -n YOUR_NAMESPACE --set synthetics.privateLocationKey=YOUR_PRIVATE_LOCATION_KEY

5. Vérifiez si le pod du gestionnaire de tâches Synthetics est opérationnel :

   bash

   Copier

   $
   kubectl get -n YOUR_NAMESPACE pods

   Une fois que l'attribut status de chaque pod est affiché comme running, votre gestionnaire de tâches Synthetics est opérationnel et prêt à exécuter le moniteur attribué à votre site privé.

Vous pouvez arrêter un conteneur Docker soit par le nom du conteneur, soit par l'ID du conteneur.

• Arrêt du nom du conteneur pour Linux, macOS et Windows :

  bash

  Copier

  $
  docker stop YOUR_CONTAINER_NAME
  $
  docker rm YOUR_CONTAINER_NAME

• Arrêt de l'ID de conteneur pour Linux/macOS :

  Dans les exemples, le conteneur est arrêté et retiré. Pour arrêter uniquement le conteneur, omettez docker rm $CONTAINER_ID.

  bash

  Copier

  $
  CONTAINER_ID=$(docker ps -aqf name=YOUR_CONTAINER_NAME)
  $
  docker stop $CONTAINER_ID
  $
  docker rm $CONTAINER_ID

• Arrêt de l'ID de conteneur pour Windows :

  Dans les exemples, le conteneur est arrêté et retiré. Pour arrêter uniquement le conteneur, omettez docker rm $CONTAINER_ID.

  bash

  Copier

  $
  FOR /F "tokens=*" %%CID IN ('docker ps -aqf name=YOUR_CONTAINER_NAME') do (SET CONTAINER_ID=%%CID)
  $
  docker stop %CONTAINER_ID%
  $
  docker rm %CONTAINER_ID%

Vous pouvez arrêter un conteneur Podman soit par le nom du conteneur, soit par l'ID du conteneur.

• Arrêt du nom du conteneur pour Linux :

  podman stop YOUR_CONTAINER_NAME
  podman rm YOUR_CONTAINER_NAME

  Copier

• Arrêt de l'ID du conteneur pour Linux :

  Dans les exemples, le conteneur est arrêté et retiré. Pour arrêter uniquement le conteneur, omettez podman rm $CONTAINER_ID.

  CONTAINER_ID=$(podman ps -aqf name=YOUR_CONTAINER_NAME)
  podman stop $CONTAINER_ID
  podman rm $CONTAINER_ID

  Copier

1. Récupérez le JOB_MANAGER_POD_INSTALLATION_NAME du pod du gestionnaire de tâches Synthetics que vous souhaitez supprimer :

   bash

   Copier

   $
   helm list -n YOUR_NAMESPACE

2. Supprimer le pod minion :

   bash

   Copier

   $
   helm uninstall -n YOUR_NAMESPACE JOB_MANAGER_POD_INSTALLATION_NAME

3. Supprimez l'espace de nommage mis en place pour le gestionnaire de jobs Synthetics dans votre cluster Kubernetes:

   bash

   Copier

   $
   kubectl delete namespace YOUR_NAMESPACE

Le gestionnaire de tâches Synthetics s'exécute dans Docker et est capable d'exploiter Docker comme technologie de sandboxing. Cela garantit une isolation complète de l’exécution du moniteur, ce qui améliore la sécurité, la fiabilité et la répétabilité. Chaque fois qu'un moniteur de script ou de navigateur est exécuté, le gestionnaire de tâches Synthetics crée un tout nouveau conteneur Docker pour l'exécuter à l'aide de l'environnement d'exécution correspondant.

Le conteneur du gestionnaire de tâches Synthetics doit être configuré pour communiquer avec le moteur Docker afin de générer un conteneur d'exécution supplémentaire. Chaque conteneur généré est ensuite dédié à l'exécution d'une vérification associée au moniteur Synthétique exécuté sur le site privé auquel le conteneur du gestionnaire de tâches Synthetics est associé.

Il existe une dépendance cruciale au lancement. Pour activer le sandboxing, assurez-vous que :

• Votre socket Docker UNIX inscriptible est monté sur la variable d'environnement /var/run/docker.sock ou DOCKER_HOST . Pour plus d'informations, consultez Docker l'option de socket daemon.

  Prudence

  Le nombre de cœurs sur l'hôte détermine le nombre de conteneurs d'exécution que le gestionnaire de tâches Synthetics peut exécuter simultanément sur l'hôte. Étant donné que les besoins en mémoire sont adaptés au nombre attendu de conteneurs d'exécution, nous recommandons not running multiple synthetics job managers on the same host pour éviter les conflits de ressources.

  Pour plus d'informations sur le sandboxing et l'exécution en tant qu'utilisateur root ou non root, consultez Sécurité, sandboxing et exécution en tant qu'utilisateur non root.

Le gestionnaire de tâches Synthetics s'exécute dans Podman et est capable d'exploiter Podman comme technologie de sandboxing. Cela garantit une isolation complète de l’exécution du moniteur, ce qui améliore la sécurité, la fiabilité et la répétabilité. Chaque fois qu'un moniteur de script ou de navigateur est exécuté, le gestionnaire de tâches Synthetics crée un tout nouveau conteneur Podman pour l'exécuter à l'aide de l'environnement d'exécution correspondant.

Le conteneur du gestionnaire de tâches Synthetics doit être configuré pour communiquer avec le moteur Podman afin de générer un conteneur d'exécution supplémentaire. Chaque conteneur généré est ensuite dédié à l'exécution d'une vérification associée au moniteur Synthétique exécuté sur le site privé auquel le conteneur du gestionnaire de tâches Synthetics est associé.

Il existe une dépendance cruciale au lancement. Pour activer le sandboxing, assurez-vous que vous disposez des éléments suivants :

1. Installez Podman 5.0.0-ce ou supérieur.

2. Activation de l'exécution sans racine :

   • Configurez Podman pour exécuter conteneur sans nécessiter de privilèges root.

     mkdir -p ~/.config/containers
     touch ~/.config/containers/containers.conf
     vi ~/.config/containers/containers.conf

     Copier
   • Modifiez le fichier containers.conf pour configurer Podman afin qu'il utilise crun et systemd:

     [engine]
     runtime = "crun"
     cgroup_manager = "systemd"

     Copier

3. Activation des cgroups v2 (RHEL uniquement) :

   • Modifiez le GRUB pour activer les cgroups v2, cela garantit la compatibilité avec les runtimes de conteneurs modernes dans RHEL.

     sudo sed -i 's/GRUB_CMDLINE_LINUX="/&systemd.unified_cgroup_hierarchy=1 /' /etc/default/grub
     sudo grub2-mkconfig -o /boot/grub2/grub.cfg
     sudo reboot

     Copier

4. Activation de la délégation à l'échelle du système pour autoriser la délégation cgroups pour les services Podman.

   sudo mkdir -p /etc/systemd/system/user@.service.d/
   echo -e "[Service]\nDelegate=yes" | sudo tee /etc/systemd/system/user@.service.d/delegate.conf > /dev/null

   Copier

5. Configurer le service systemd au niveau utilisateur :

   • Créez des répertoires pour les services systemd au niveau utilisateur.

     mkdir -p ~/.config/systemd/user/podman.service.d

     Copier
   • Ajoutez une configuration déléguée au service systemd au niveau utilisateur.

     echo -e "[Service]\nDelegate=yes" > ~/.config/systemd/user/podman.service.d/override.conf

     Copier

6. Activé et démarré le socket Podman.

   systemctl --user enable podman.socket
   systemctl --user start podman.socket
   systemctl --user status podman.socket

   Copier

7. Création et configuration du service API Podman :

   • Créez un service API Podman et configurez Podman pour fournir un accès API HTTP.

     mkdir -p ~/.config/systemd/user
     touch ~/.config/systemd/user/podman-api.service
     vi ~/.config/systemd/user/podman-api.service

     Copier

   • Définissez le service pour exposer l’API de Podman sur le port 8000.

     [Unit]
     Description=Podman API Service
     After=default.target
     
     [Service]
     Type=simple
     ExecStart=/usr/bin/podman system service -t 0 tcp:0.0.0.0:8000
     Restart=on-failure
     
     [Install]
     WantedBy=default.target

     Copier

8. Activation et démarrage du service API Podman.

   systemctl --user daemon-reload
   systemctl --user enable podman-api.service
   systemctl --user start podman-api.service
   systemctl --user status podman-api.service

   Copier

   Prudence

   Le nombre de cœurs sur l'hôte détermine le nombre de conteneurs d'exécution que le gestionnaire de tâches Synthetics peut exécuter simultanément sur l'hôte. Étant donné que les besoins en mémoire sont adaptés au nombre attendu de conteneurs d'exécution, nous recommandons not running multiple synthetics job managers on the same host pour éviter les conflits de ressources.

Pour plus d'informations, consultez la documentation officielle de Docker sur la sécurité et les profils de sécurité AppArmor.

Si votre environnement nécessite que vous exécutiez le gestionnaire de tâches Synthetics en tant qu'utilisateur non root, suivez cette procédure. Dans l'exemple suivant, l'utilisateur non root est my_user.

1. Assurez-vous que my_user peut utiliser le moteur Docker sur l'hôte :

   Vérifiez que my_user appartient au groupe système "docker" . L'accès root limité au docker.sock est toujours nécessaire pour créer des réseaux de ponts.

   OU

   Activez l’ option de socket TCP Docker et transmettez la variable d’environnement DOCKER_HOST au gestionnaire de tâches Synthetics.

2. Vérifiez que my_user dispose des autorisations de lecture/écriture sur tous les répertoires et volumes transmis au gestionnaire de tâches Synthetics. Pour définir ces autorisations, utilisez la commande chmod .

3. Obtenez le uid de my_user à utiliser dans la commande d'exécution : id -u my_user.

   Une fois ces conditions remplies, utilisez l'option "-u <uid>:<gid>" lors du lancement du gestionnaire de tâches Synthetics :

   bash

   Copier

   $
   docker run ... -u 1002 ...

   OU

   bash

   Copier

   $
   docker run ... -u 1002 -e DOCKER_HOST=http://localhost:2375 ...

Utilisez ces options selon le cas :

• Pour suivre les logs Docker ou Podman et vérifier l'état de votre moniteur, consultez Maintenance et monitoring du gestionnaire de tâches Synthetics.

• Pour un gestionnaire de tâches Synthetics dans l'environnement du système d'orchestration de conteneurs Kubernetes , les commandes Helm show suivantes peuvent être utilisées pour afficher respectivement chart.yaml et values.yaml:

  bash

  Copier

  $
  helm show chart YOUR_REPO_NAME/synthetics-job-manager

  bash

  Copier

  $
  helm show values YOUR_REPO_NAME/synthetics-job-manager

Certains de nos logiciels open source sont répertoriés sous plusieurs licences logicielles, et dans ce cas, nous avons répertorié la licence que nous avons choisi d'utiliser. Nos informations de licence sont également disponibles dans notre documentation de licences.

Pour Docker et Kubernetes, le gestionnaire de tâches Synthetics et son conteneur d'exécution hériteront des paramètres réseau de l'hôte. Pour un exemple de ceci sur un environnement système de conteneur Docker , consultez le site Docker .

Un réseau de pont est créé pour la communication entre le gestionnaire de tâches Synthetics et le conteneur d'exécution. Cela signifie que les options de commande réseau telles que --network et --dns transmises au conteneur du gestionnaire de tâches Synthetics au lancement (comme via les commandes d'exécution Docker sur un environnement système de conteneur Docker ) ne sont pas héritées ou utilisées par le conteneur d'exécution.

Lorsque ces réseaux sont créés, ils proviennent du pool d’adresses IP par défaut configuré pour le daemon. Pour un exemple de ceci sur un environnement système de conteneur Docker , consultez le site Docker.

Dans le cas de Podman, nous n'utilisons pas de réseau pont pour la communication entre le gestionnaire de tâches Synthetics et le conteneur d'exécution, mais nous utilisons plutôt un pod Podman. Tous les conteneurs d'un pod Podman partagent le même espace de nommage réseau. Cela signifie qu'ils partagent la même adresse IP au sein de ce pod. Dans ce cas, bien que les conteneurs partagent la même IP, leurs services sont exposés sur des ports différents.

Une seule image Docker du gestionnaire de tâches Synthetics sert l'environnement du système d'orchestration de conteneurs Docker, Podman et Kubernetes . L'image Docker est hébergée sur Docker Hub. Pour vous assurer que votre image Docker est à jour, consultez le référentiel Docker Hub newrelic/synthetics-job-manager.