Aller au contenu

Guide de migration vers Canopsis 4.2.0

Ce guide donne des instructions vous permettant de mettre à jour un Canopsis 4.1.0 ou 4.1.1 vers la version 4.2.0.

Note

18/05/2021 : Mise à jour des scripts de migrations.

Prérequis

L'ensemble de cette procédure doit être lu avant son exécution.

Cette procédure ne doit être suivie que dans le cadre d'une mise à jour. Elle n'est pas utile dans le cadre d'une nouvelle installation.

Vous devez avoir suivi les notes de version et appliqué tous les guides de mise à jour de toutes les versions comprises entre votre version actuelle de Canopsis et Canopsis 4.2.0.

Fin de la production de paquets pour Debian 9

Comme annoncé depuis plusieurs mois, Canopsis ne produit et n'héberge désormais plus aucun paquet pour Debian 9 (« stretch »).

Les deux seules méthodes d'installation officiellement prises en charge (sauf disposition particulière) sont donc :

  • les paquets RPM pour CentOS 7 ;
  • les conteneurs Docker au travers de Docker Compose.

Note auprès des utilisateurs de Dockerhub

Canopsis 4.3.0 migrera ses images Docker de Dockerhub vers le nouveau registre registry.canopsis.net.

Si vous bénéficiez de Canopsis Pro, et que vous utilisez Canopsis au travers des images Docker, vous avez dû recevoir une communication vous invitant à nous transmettre une adresse e-mail à utiliser afin de mettre en place ce nouvel accès. Si ce n'est pas le cas, veuillez vous rapprocher de votre contact habituel chez Capensis.

Les détails de cette migration seront publiés lors de la sortie de Canopsis 4.3.0. Canopsis reste encore disponible sur Dockerhub sans changement particulier pour le moment.

Suppression du moteur engine-stat

Le moteur engine-stat, désactivé et déprécié depuis Canopsis 3.31.0, a été complètement supprimé.

Procédure de mise à jour

Déclenchement des webhooks par le moteur engine-action (Pro)

À partir de Canopsis 4.2.0, les webhooks (disponibles uniquement dans l'édition Pro) sont déclenchés par le moteur engine-action.

Configurez l'unité systemd canopsis-engine-go@engine-action.service afin qu'elle comporte dorénavant l'option -withWebhook :

mkdir -p /etc/systemd/system/canopsis-engine-go@engine-action.service.d
cat > /etc/systemd/system/canopsis-engine-go@engine-action.service.d/action.conf << EOF
[Service]
ExecStart=
ExecStart=/usr/bin/env /opt/canopsis/bin/%i -withWebhook
EOF
systemctl daemon-reload

Dans votre fichier docker-compose.yml, modifiez la ligne d'exécution du conteneur engine-action afin qu'elle contienne l'option -withWebhook :

command: /engine-action -withWebhook

Notez que le moteur engine-webhook est cependant toujours nécessaire et ne doit donc pas être désactivé.

Migration des actions, webhooks et idlerules existants

Toutes vos configurations d'actions, webhooks ou idle rules doivent être migrées à l'aide de scripts, afin d'être fonctionnels avec les nouveaux scénarios de Canopsis 4.2.

Sur une machine disposant d'un accès à git.canopsis.net ainsi que d'un client MongoDB, exécutez les scripts suivants, en adaptant les identifiants MongoDB ci-dessous si nécessaire :

for file in 000_migrate_actions.js 001_migrate_webhook.js 002_migrate_idlerules.js ; do
    curl -O -L "https://git.canopsis.net/canopsis/go-engines/-/raw/release-4.2/database/migrations/engineactionv2/$file"
    mongo -u cpsmongo -p canopsis canopsis < "$file"
done

Notez au passage que les nouveaux scénarios ne disposent plus d'event patterns. Si vous aviez écrit des règles d'actions ou de webhooks comportant des event patterns, vous devez les transposer vers des alarm patterns ou des entity patterns, selon votre cas d'utilisation.

Ajout d'une nouvelle option de configuration pour la remédiation (Pro)

Si vous utilisez la fonctionnalité de remédiation, une nouvelle option a été ajoutée au fichier canopsis.toml :

[Canopsis.remediation]
JobExecutorFetchTimeoutSeconds = 30

Vérifiez que vous disposez bien de cette option, et ajustez-la si nécessaire.

Synchronisation du fichier de configuration canopsis.toml

Vérifiez que votre fichier canopsis.toml soit bien à jour par rapport au fichier de référence, notamment dans le cas où vous auriez apporté des modifications locales à ce fichier :

Fin de la mise à jour

Une fois ces changements apportés, suivez la procédure standard de mise à jour de Canopsis.


Dernière mise à jour: 2021-05-18