Commit aae10db9 authored by Lucas Seguinot's avatar Lucas Seguinot

Merge branch 'doc/3.10-release-notes' into 'develop'

Canopsis 3.10.0 release notes

See merge request !672
parents 185ac3db 3aef7e56
Pipeline #4525 passed with stage
in 1 minute and 45 seconds
......@@ -2,9 +2,12 @@
## Fonctionnement général de Canopsis
Voici le schéma du fonctionnement général de Canopsis.
Voici le schéma du fonctionnement général de Canopsis.
Vous y trouvez les principales briques logicielles de l'hyperviseur ainsi que les moteurs faisant fonctionner Canopsis.
Certains moteurs sont des moteurs propriétaires non disponibles dans la version communautaire de Canopsis.
!!! note
Certains moteurs sont des moteurs propriétaires non disponibles dans la version communautaire de Canopsis.
![img1](img/schema.png)
......@@ -12,11 +15,11 @@ Certains moteurs sont des moteurs propriétaires non disponibles dans la version
![img2](img/Cano_macro_resume.png)
**Documentation des différentes parties :**
## Documentation des différentes parties
[Documentation connecteurs](../../guide-connecteurs/index.md)
[Documentation moteurs](../moteurs/index.md)
[Documentation base de données](../troubleshooting/bdd-requetes-de-base.md)
[Documentation Web UI](../../guide-utilisation/interface/index.md)
* [Documentation connecteurs](../../guide-connecteurs/index.md)
* [Documentation moteurs](../moteurs/index.md)
* [Documentation base de données](../troubleshooting/bdd-requetes-de-base.md)
* [Documentation Web UI](../../guide-utilisation/interface/index.md)
Plus de détails sur l'enchaînement des moteurs [disponible ici](../moteurs/schema-enchainement-moteurs.md)
Plus de détails sur [l'enchaînement des moteurs](../moteurs/schema-enchainement-moteurs.md).
......@@ -4,11 +4,23 @@ Ce guide vous accompagne dans vos tâches d'administration de Canopsis.
## Sommaire
* [Architecture interne](architecture-interne/index.md)
* [Installation](installation/index.md)
* [Mise à jour](mise-a-jour/index.md)
* [Quelques interconnexions](exemples-interconnexions/index.md)
### Architecture
* [Architecture interne de Canopsis](architecture-interne/index.md)
### Installation et mise à jour
* [Installation de Canopsis](installation/index.md) : installation par paquets (Debian, CentOS) ou avec Docker
* [Mise à jour de Canopsis](mise-a-jour/index.md)
* [Première utilisation de Canopsis](exemples-interconnexions/index.md)
### Composants disponibles dans Canopsis
* [Liste des différents connecteurs](../guide-connecteurs/)
* [Liste des différents moteurs](moteurs/index.md)
### Administration quotidienne
* [Gestion des services](gestion-services/index.md)
* [Moteurs](moteurs/index.md)
* [Administration avancée](administration-avancee/index.md)
* [Administration avancée de Canopsis](administration-avancee/index.md)
* [Troubleshooting](troubleshooting/index.md)
# Sommaire
# Installation de Canopsis
## Pré-requis
## Installation
- [Installation avec un paquets Deb/Rpm](installation-paquets.md)
- [Installation avec un conteneurs Docker](installation-conteneurs.md)
* [Pré-requis réseau et de sécurité](pre-requis-parefeu-et-selinux.md)
## Sécurité
## Méthodes d'installation de Canopsis
- [Configuration des ports réseaux à partir de la matrice des flux](pre-requis-parefeu-et-selinux.md)
* [Installation avec un paquet Debian ou CentOS](installation-paquets.md)
* [Installation avec Docker](installation-conteneurs.md)
## Premier login
## Première connexion à Canopsis
- [Crédentials](premiere-connexion.md)
* [Accès et identifiants Canopsis par défaut](premiere-connexion.md)
# Installation Conteneur
# Installation de Canopsis avec Docker
## Pré-requis
### Version de Docker
Canopsis nécessite [l'installation de Docker CE](https://docs.docker.com/install/#supported-platforms), version 18.06 minimum. Veuillez utiliser les dépôts officiels de Docker CE, et non pas ceux hébergés par votre distribution.
Une fois Docker CE installé, vous devez ensuite [installer Docker compose](https://docs.docker.com/compose/install/#install-compose).
### Ports
Il faut vérifier les ports utilisés par `docker-compose.yml`.
Veuillez effectuer les adaptations nécessaires si certains ports sont déjà en utilisation sur le noeud d'installation.
Veuillez effectuer les adaptations nécessaires si certains ports sont déjà en utilisation sur le nœud d'installation.
## Installation
......@@ -13,7 +20,6 @@ Veuillez effectuer les adaptations nécessaires si certains ports sont déjà en
- Actuellement, les conteneurs sont gérés dans le Docker Hub officiel : `https://hub.docker.com/u/canopsis/`
- Dans ce dépôt, un fichier `docker-compose.yml` est présent. Il va servir à la création de votre Canopsis en version Dockerisée.
- Rappel : [Installation de Docker compose](https://docs.docker.com/compose/install/#install-compose)
- Troubleshooting : Si vous rencontrez une erreur de ce type lors d'un `docker-compose up -d` ou un `docker-compose --version`
```bash
......
# Installation de Canopsis par les paquets système
# Installation de Canopsis avec un paquet Debian ou CentOS
Cette procédure décrit l'installation de l'édition open-source de Canopsis en mono-instance.
L'ensemble des procédures décrites doivent être réalisées avec l'utilisateur `root`.
## Pré-requis
Canopsis doit être installé sur l'un des environnements Linux suivants :
Canopsis peut être installé sur l'un des environnements Linux suivants (architecture x86-64) :
* CentOS 7 ;
* Debian 8 (« *jessie* ») ;
* ou Debian 9 (« *stretch* »).
## Installation
## Installation des paquets
### Sur Debian 8 et Debian 9
### Sur Debian
La procédure est identique pour Debian 8 et Debian 9.
Application des dernières mises à jour de votre système :
```sh
apt update
apt upgrade
```
Ajout du dépôt Canopsis (qui permettra aussi de récupérer les mises à jour) :
```sh
apt install apt-transport-https lsb-release
echo "deb [trusted=yes] https://repositories.canopsis.net/pulp/deb/debian$(cat /etc/debian_version | cut -d'.' -f 1)-canopsis/ stable main" \
> /etc/apt/sources.list.d/canopsis.list
apt update
apt install canopsis-core
```
Pour déployer une configuration **mono-instance :**
Installation de l'édition open-source de Canopsis :
```sh
canoctl deploy
apt update
apt install canopsis-core
```
### Sur CentOS 7
!!! note
Les versions de CentOS inférieures à CentOS 7 ne sont **pas** prises en charge.
Activation d'EPEL et application des dernières mises à jour de votre système :
```sh
yum install yum-utils epel-release
yum update
```
Ajout du dépôt Canopsis (qui permettra aussi de récupérer les mises à jour) :
```sh
echo "[canopsis]
name = canopsis
baseurl=https://repositories.canopsis.net/pulp/repos/centos7-canopsis/
gpgcheck=0
enabled=1" > /etc/yum.repos.d/canopsis.repo
```
Installation de l'édition open-source de Canopsis :
```sh
yum install canopsis-core
```
Pour déployer une configuration **mono-instance :**
## Mise en service
!!! attention
La commande suivante ne doit être exécutée que lors de votre **première** installation de Canopsis, sans quoi certains éléments de configuration seront totalement réinitialisés.
Pour procéder à une mise jour de Canopsis, voir [la documentation de mise à jour](../../mise-a-jour/).
Une fois le paquet installé, vous pouvez déployer une configuration **mono-instance** à l'aide de la commande suivante :
```sh
canoctl deploy
```
# SeLinux & Firewall
# Pré-requis réseau et de sécurité pour l'installation de Canopsis
## Selinux
## Désactivation de SELinux
Il est nécessaire de désactiver SeLinux pour installer correctement Canopsis.
Dans tous les cas la commande `canoctl deploy` s'en charge automatiquement.
Vous retrouverez cette commande lors de [l'installation par paquets](installation-paquets.md) ou de [l'installation via conteneurs](installation-conteneurs.md).
Les environnements SELinux ne sont pas pris en charge par Canopsis. Il est donc nécessaire de désactiver SELinux s'il est présent sur votre environnement.
## Firewall
La commande `canoctl deploy` s'en charge automatiquement lors de votre premier déploiement de Canopsis.
Au niveau du Firewall, certains ports devront être ouverts. Voici une matrice des flux de Canopsis V3 qui répertorie les différents ports utilisés.
Pour plus de détail, [rendez-vous ici](../administration-avancee/configuration-parefeu-et-selinux.md)
Plus de détails dans [la documentation des différentes méthodes d'installation](index.md).
![CanoV3Flux](img/matrice-flux-canopsis.png)
## Pré-requis pare-feu (flux réseau)
Dans le cas où votre environnement nécessite l'ouverture explicite de ports sur un pare-feu, la matrice suivante vous permet de connaître les différents ports réseaux utilisés par une installation de Canopsis 3.
![Matrice des flux Canopsis 3](img/matrice-flux-canopsis.png)
Pour plus de détails, consultez [le guide avancé de sécurité](../administration-avancee/configuration-parefeu-et-selinux.md).
# Première connexion, identifiants par défaut
# Accès et identifiants Canopsis par défaut
## Interface web Canopsis
Après une installation de Canopsis, ses différents composants utiliseront les adresses et identifiants par défaut suivants.
Par défaut, l'interface web de Canopsis est disponible sur : http://localhost:8082/
## Accès à Canopsis
### Interface web Canopsis
Par défaut, l'interface web de Canopsis est disponible sur : [http://localhost:8082/](http://localhost:8082/).
Si elle n'est pas activée par défaut, la nouvelle interface « UIv3 » peut être chargée explicitement à l'adresse [http://localhost:8082/en/static/canopsis-next/dist/index.html#](http://localhost:8082/en/static/canopsis-next/dist/index.html#).
Identifiants par défaut : `root` / `root`.
## Interface web RabbitMQ
Parcourez ensuite [le guide d'utilisation](../../../guide-utilisation/) pour en apprendre davantage sur l'interface web de Canopsis.
## Accès aux composants internes de Canopsis
### Interface web RabbitMQ
Par défaut, l'interface web d'administration de RabbitMQ est disponible sur : http://localhost:15672/
Par défaut, l'interface web d'administration de RabbitMQ est disponible sur : [http://localhost:15672/](http://localhost:15672/).
Identifiants par défaut : `cpsrabbit` / `canopsis`.
## Bus AMQP RabbitMQ
### Bus AMQP RabbitMQ
Le bus AMQP RabbitMQ par défaut est : `amqp://cpsrabbit@canopsis:localhost:5672/canopsis`.
## MongoDB
### MongoDB
En ligne de commande, la base de données MongoDB est accessible avec la commande `mongo localhost`.
Identifiants par défaut : `cpsmongo` / `canopsis`.
## InfluxDB
### InfluxDB
En ligne de commande, la base de métriques InfluxDB est accessible avec la commande `influx -username cpsinflux -password canopsis -database canopsis`.
......
......@@ -18,9 +18,52 @@ Pour une mise à jour vers une version `X.Y.Z` de Canopsis :
## Procédure standard de mise à jour
!!! note
Cette procédure ne décrit que la mise à jour d'une instance **mono-nœud** de Canopsis.
Cette procédure s'applique aux mises à jour intermédiaires (3.4.0 vers 3.5.0) et aux mises à jour de correctifs (3.5.0 vers 3.5.1).
> **TODO :** cette procédure est en cours de rédaction.
Vous devez **impérativement** lire chacune des [notes de version](../../notes-de-version/index.md) vous séparant de votre version précédente à votre version cible, avant de procéder à une mise à jour.
### Mise à jour en installation par paquets
Puisque la [procédure d'installation](../installation/index.md) ajoute un dépôt Canopsis dans votre gestionnaire de paquets, il suffit de lancer une mise à jour pour bénéficier d'un paquet à jour.
**Cette mise à jour causera une interruption de service.**
Sur un environnement Debian :
```sh
apt update
apt upgrade
```
Sur un environnement CentOS :
```sh
yum update
```
!!! attention
La procédure suivante réinitialise les identifiants `root` de la base utilisateur, interne à Canopsis, ainsi que sa authkey associée ([Bug #1431](https://git.canopsis.net/canopsis/canopsis/issues/1431)).
Il faut ensuite lancer le script `canopsinit` (en tant qu'utilisateur Unix `canopsis`) pour appliquer les éventuelles procédures automatisées de mise à jour :
```sh
su - canopsis
(canopsis) canopsinit
```
Puis, redémarrer l'ensemble des moteurs Canopsis :
```sh
/opt/canopsis/bin/canopsis-systemd restart
```
Appliquer toute éventuelle procédure supplémentaire décrite dans les [notes de version](../../notes-de-version/index.md) qui vous concernent.
Vous pouvez alors vous connecter à nouveau sur l'interface Canopsis pour valider que tout fonctionne correctement.
### Mise à jour en environnement Docker
!!! todo
Cette procédure est en cours de rédaction.
## Guides de migration
......@@ -33,3 +76,4 @@ Celles-ci sont décrites dans les documents suivants, branche par branche :
* [3.7.0](../../notes-de-version/3.7.0.md)
* [3.8.0](../../notes-de-version/3.8.0.md)
* [3.9.0](../../notes-de-version/3.9.0.md)
* [3.10.0](../../notes-de-version/3.10.0.md)
# Présentation
# Connecteurs Canopsis
Voici le listing des connecteurs qui peuvent fournir des évènements entrants à Canopsis.
Voici la liste des connecteurs qui peuvent fournir des évènements entrants à Canopsis.
# Sommaire
......
# Présentation
# Présentation de l'interface web de Canopsis
## Les vues
......
......@@ -15,6 +15,7 @@ Cette plateforme regroupe toutes les informations permettant de mettre en place,
Liste des changements et procédures particulières à suivre pour la mise à jour vers une nouvelle branche de Canopsis.
* [3.10.0](notes-de-version/3.10.0.md)
* [3.9.0](notes-de-version/3.9.0.md)
* [3.8.0](notes-de-version/3.8.0.md)
* [3.7.0](notes-de-version/3.7.0.md)
......
# Notes de version Canopsis 3.10.0
Canopsis 3.10.0 a été publié le 8 février 2019.
!!! attention
Cette version de Canopsis désactive temporairement la prise en charge de LDAP en raison d'une régression dans le build de la bibliothèque externe `python-ldap` ([bug #1451](https://git.canopsis.net/canopsis/canopsis/issues/1451)).
Si vous êtes dépendant de la fonctionnalité LDAP, **n'effectuez pas cette mise à jour vers Canopsis 3.10.0**. Ce problème sera résolu dans la prochaine version de Canopsis.
## Procédure de mise à jour
Suivre la [procédure standard de mise à jour de Canopsis](../guide-administration/mise-a-jour/index.md).
Il n'y a aucune action supplémentaire à réaliser pour mettre Canopsis à jour d'une version 3.9 à une version 3.10.
## Changements entre Canopsis 3.9.0 et 3.10.0
Voir le [ChangeLog complet](https://git.canopsis.net/canopsis/canopsis/blob/develop/CHANGELOG.md) pour plus de détails techniques.
* **Documentation :**
* Mise à jour de [la documentation du connecteur Centreon](https://doc.canopsis.net/guide-connecteurs/Supervision/Centreon/), qui [devient maintenant open-source](https://git.canopsis.net/canopsis-connectors/connector-centreon-engine) ([#1435](https://git.canopsis.net/canopsis/canopsis/issues/1435))
* Mise à jour de la documentation du widget Météo de services, concernant les nouvelles fonctionnalités qui y ont été apportées ([#1421](https://git.canopsis.net/canopsis/canopsis/issues/1421))
* Mise à jour de la documentation des variables disponibles dans les templates de l'interface, de la documentation de customisation du nom de l'entité, et de la documentation des modales d'aide sur les variables disponibles ([#1420](https://git.canopsis.net/canopsis/canopsis/issues/1420))
* Meilleure documentation de l'intégration LDAP disponible dans Canopsis ([#1036](https://git.canopsis.net/canopsis/canopsis/issues/1036))
* Correction de l'intitulé de certains champs documentés dans l'API pbehavior ([#1429](https://git.canopsis.net/canopsis/canopsis/issues/1429))
* Meilleure documentation de [l'installation](../../guide-administration/installation/installation-paquets/) et de [la mise à jour](../../guide-administration/mise-a-jour/) d'une installation par paquets de Canopsis
* Documentation des pré-requis lors de [l'installation Docker](../../guide-administration/installation/installation-conteneurs/) ([#1384](https://git.canopsis.net/canopsis/canopsis/issues/1384))
* Améliorations diverses dans la présentation du guide d'administration
* **Images Docker / paquets :**
* Ajout de l'image `engine-axe-cat` pour l'installation CAT en environnement Docker
* Correction d'erreurs possibles lors d'import de MIB dans l'interface SNMP (Canopsis CAT uniquement), qui ne fonctionnait pas correctement sur les environnements Debian et Docker, en raison d'une dépendance manquante à `snmp-mibs-downloader` ([#1388](https://git.canopsis.net/canopsis/canopsis/issues/1388))
* Correction de `push_docker_images`, servant à publier les images des moteurs Go ([#1414](https://git.canopsis.net/canopsis/canopsis/issues/1414))
* **Moteurs :**
* **Moteurs ancienne génération (Python) :**
* pbehavior : ajout du support des dates d'exclusions dans les pbehaviors
* **Moteurs nouvelle génération (Go) :**
* Ajout du plugin de webhooks ([#69](https://git.canopsis.net/canopsis/go-revolution/issues/69))
* statsng / webhooks : correction du moteur `che`, afin que les évènements générés lors de l'ack d'une alarme soient bien enrichis avec l'entité ([#74](https://git.canopsis.net/canopsis/go-revolution/issues/74))
* **UI :**
* Mise à jour vers [VueJS 2.5.21](https://github.com/vuejs/vue/releases/tag/v2.5.21)
* Quelques correctifs du composant VueX utilisé en interne, apportant quelques petites améliorations de performance ([#1409](https://git.canopsis.net/canopsis/canopsis/issues/1409))
* **Gestion des vues :**
* Ajout de la fonctionnalité de duplication d'onglet ([#1392](https://git.canopsis.net/canopsis/canopsis/issues/1392))
* Ajout d'onglets dans les vues installées par défaut ([!671](https://git.canopsis.net/canopsis/canopsis/merge_requests/671))
* Correction du message de suppression des vues, qui s'affichait sous sa forme JSON brute ([#1443](https://git.canopsis.net/canopsis/canopsis/issues/1443))
* Correction de la duplication des vues ([#1446](https://git.canopsis.net/canopsis/canopsis/issues/1446))
* Amélioration des liens vers les vues sur le menu latéral
* **Bac à alarmes :**
* Ajout d'une zone de saisie de commentaire (optionnelle) lors de la pose d'un comportement périodique ([#1427](https://git.canopsis.net/canopsis/canopsis/issues/1427))
* Correction de l'éditeur de filtre avancé, afin de pouvoir changer manuellement le type voulu sur la comparaison d'une variable ([#1447](https://git.canopsis.net/canopsis/canopsis/issues/1447))
* **Météo des services :**
* Ajout d'un rafraîchissement de la météo après la modification d'un filtre sur la météo ([#1393](https://git.canopsis.net/canopsis/canopsis/issues/1393))
* Ajout d'icônes pour les actions effectuées sur les entités ([#1402](https://git.canopsis.net/canopsis/canopsis/issues/1402))
* Correction du clignotement et des icônes affichés
* Diverses améliorations visuelles ([#1396](https://git.canopsis.net/canopsis/canopsis/issues/1396))
* **Profil utilisateur :**
* Amélioration du style du menu du profil utilisateur
* Correction de la position du menu du profil utilisateur, qui pouvait apparaître tronqué sur la droite ([#1428](https://git.canopsis.net/canopsis/canopsis/issues/1428))
......@@ -8,6 +8,9 @@ Suivre la [procédure standard de mise à jour de Canopsis](../guide-administrat
Il n'y a aucune action supplémentaire à réaliser pour mettre Canopsis à jour d'une version 3.7 à une version 3.8.
!!! attention
Les traitements périodiques (*pbehaviors*) gèrent maintenant le changement heure d'été / heure d'hiver d'une façon différente. Voir plus bas.
## Changements entre Canopsis 3.7.0 et 3.8.0
Voir le [ChangeLog complet](https://git.canopsis.net/canopsis/canopsis/blob/develop/CHANGELOG.md) pour plus de détails techniques.
......@@ -18,7 +21,7 @@ Voir le [ChangeLog complet](https://git.canopsis.net/canopsis/canopsis/blob/deve
* **Go :**
* Refonte du moteur heartbeat et de ses API
* **Python :**
* Correction de la gestion des timezones pour les pbehaviors
* Correction de la gestion des timezones pour les pbehaviors, qui se lanceront maintenant toujours à l'heure qui a été demandée, que le serveur soit en heure d'été ou en heure d'hiver (dans les précédentes versions, un pbehavior resté « bloqué » dans l'heure d'été (ou d'hiver) où il a été créé, et se retrouvait décalé lors du changement d'heure)
* Ajout du support des acquittements dans l'alarm-filter
* **UI :**
* Ajout du CRUD Pbehaviors
......
......@@ -12,21 +12,6 @@ désormais l'alarme complète. Les templates utilisant cette variable doivent
être modifiés. Par exemple, pour afficher l'état de l'alarme il faut maintenant
utiliser `alarm.v.state.val` au lieu de `alarm.state.val`.
Les nouveaux droits du contexte doivent être ajoutés manuellement. Il faut
créer les droits suivants depuis la page *Droits*, en cliquant sur le bouton en
bas à droite puis sur *Créer un droit* :
- `crudcontext_createEntity`
- `crudcontext_edit`
- `crudcontext_duplicate`
- `crudcontext_delete`
- `crudcontext_pbehavior`
- `crudcontext_listPbehavior`
- `crudcontext_listFilters`
- `crudcontext_editFilter`
- `crudcontext_addFilter`
## Changements entre Canopsis 3.8.0 et 3.9.0
Voir le [ChangeLog complet](https://git.canopsis.net/canopsis/canopsis/blob/develop/CHANGELOG.md) pour plus de détails techniques.
......@@ -40,12 +25,12 @@ Voir le [ChangeLog complet](https://git.canopsis.net/canopsis/canopsis/blob/deve
* Ajout d'un système de plugins de post-traitement au moteur axe
* Définitions de triggers dans le moteur axe
* **Python :**
* Correction de l'API healthcheck quand criticals n'est pas défini
* Correction de l'API healthcheck quand `criticals` n'est pas défini
* Correction de la gestion des pbehaviors dont la rrule génère des dates invalides
* **UI :**
* Ajout de bouton d'aides sur les widgets Bac à alarmes, Contexte, et Météo de services
* Ajout de boutons d'aide sur les widgets Bac à alarmes, Contexte, et Météo de services
* Ajout de la fonctionnalité de réorganisation des onglets
* Ajout d'un boutton de refraîchissement de la page sur les vues d'administration et d'exploitation
* Ajout d'un bouton de rafraîchissement de la page sur les vues d'administration et d'exploitation
* Améliorations du style de la barre latérale gauche
* Harmonisation des variables disponibles pour la création des templates (Info popup, More infos, Template Météo de services)
* **Bac à alarmes :**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment