Démarrer avec OIBus

OIBus & collecte de données

Code source

Le code source d’OIBus est disponible avec une licence Open Source sur notre repository public GitHub. Ci-dessous les liens pour y accéder, le suivre ou nous soutenir dans cette démarche.

Watch Star Fork Sponsor

Système Minimal

Pour fonctionner, OIBus doit être installé sur un environnement avec les caractéristiques minimales suivantes :

  • Windows Server version ≥ 10 et 64 bits
  • RAM : 4Go minimum (OIBus peut nécessiter plus de mémoire vive en fonction du nombre d’applications Sud configurées)
  • Espace disque : 200 Mo pour l’application plus l’espace nécessaire pour stocker les données en cache et les logs (à déterminer en fonction du volume de données traité et de la configuration du cache et des logs)
  • Droits d’administrateur sur l’environnement pour installer le plugin et l’enregistrer en tant que service
  • S’assurer que le système sur lequel est installé OIBus soit synchronisé sur un serveur de temps (NTP)
  • Un navigateur web moderne (IE non supporté) pour accéder à l’interface d’OIBus. Le navigateur peut être sur la machine d’installation ou bien sur une autre à condition d’avoir configuré les accès nécessaires.

Télécharger l’exécutable

Installer OIBus

Installer OIBus comme service

  1. Télécharger la dernière version d’OIBus.
  2. Créer un répertoire OIBus avec l’ensemble des fichiers de l’archive .zip. Par exemple C:\Program Files\OIBus
  3. Créer un répertoire pour les données d’OIBus (le cache, la configuration, les logs…). Par exemple C:\OIBus. Il est conseillé de mettre ce dossier sur un espace dédié suffisamment grand par rapport à la quantité de données qui y circulera.
  4. Ouvrir la console en tant qu’administrateur.
  5. Se positionner dans le répertoire où se trouve l’exécutable oibus.exe cd "c:\Program Files\OIBus".
  6. Exécuter la commande : install.bat "C:\OIBus\oibus.json" où le chemin du fichier oibus.json est à adapter par rapport au chemin du répertoire de données. Vérifier que le fichier de configuration (oibus.json) a bien été créé dans le répertoire spécifié.
  7. Vérifier qu’OIBus a bien été lancé en tant que service Windows. Ouvrir la fenêtre des services Windows et vérifier la présence du service OIBus. Si besoin le démarrer.

Supprimer le service

  • Se positionner dans le répertoire où se trouve l’exécutable oibus.exe
  • Exécuter la commande : uninstall.bat

Pour exécuter OIBus dans la console (troubleshooting)

Ce mode d’exécution permet de faciliter le debuggage en cas de dysfonctionnement du service

  • Arrêter le service (gestionnaire des services Windows)
  • Ouvrir la console avec les droits administrateurs
  • Se positionner dans le répertoire où se trouve l’exécutable oibus.exe cd "c:\Program Files\OIBus"
  • Exécuter la commande : go.bat

La console affichera des informations sur l’exécution d’OIBus, en particulier les logs d’erreurs. En cas de problème, récupérer les logs et nous les transmettre pour faciliter l’investigation.


Mise à jour d’OIBus

La procédure de mise à jour d’OIBus nécessite d’avoir les droits administrateur.

  • Télécharger la dernière version d’OIBus.
  • Extraire l’archive zip.
  • Ouvrir la fenêtre des services Windows et arrêter le service OIBus.
  • Copier l’ensemble des fichiers vers le répertoire où se trouve oibus.exe et remplacer les anciens fichiers.
  • Relancer le service OIBus.

Si vous utilisez le même répertoire que l’exécutable pour les fichiers de configuration, les fichiers du cache et les fichiers temporaires, veillez à ne pas les effacer.

Configurer OIBus

Sur la machine sur laquelle OIBus est installé, ouvrir un navigateur (de préférence dernière version de Chrome). Puis aller sur l’adresse localhost:2223 pour accéder à l’interface d’OIBus.

Aide intégrée

Pour plus de détails sur la configuration, l’aide d’OIBus est directement disponible dans l’interface.

Changer le mot de passe Administrateur

Par défaut, l’utilisateur est admin et le mot de passe pass.

Pour des raisons de sécurité il est nécessaire de limiter l’accès à l’administration. La première chose à faire est de modifier le mot de passe par défaut dans la section « Engine ».

Valider les changements de configuration

Chaque fois que vous modifiez un élément de la configuration, ces modifications ne sont pas immédiatement appliquées. Pour appliquer les modifications, vous devez passer par l’étape d’activation de votre nouvelle configuration. Pour cela, cliquez sur le menu « Activation », puis vérifiez vos modifications, et si elles sont correctes, cliquez sur le bouton « Activate ».

Ensuite il vous sera demandé de redémarrer le serveur OIBus. Cliquez sur « Confirm ».

Vérifier le statut d’OIBus

Vous pouvez avoir de nombreuses informations sur le fonctionnement d’OIBus en allant sur la page « Home » via l’icone OIBus. Sur cet écran vous aurez une synthèse du fonctionnement d’OIBus. En haut, vous avez le statut des trois couches qui constituent OIBus

  • North : connexions aux différentes applications auxquelles OIBus transmet des données;
  • Engine : statut du moteur d’exécution d’OIBus qui gère le regroupement des données, le tampon de données ainsi que l’orchestration des requêtes;
  • South : connexions aux différentes sources de données auxquelles OIBus est connecté.

Vous pouvez aussi accéder au détail des traces avec le menu « Logs ».

Configuration des connexions Sud (South)

Vous pouvez accéder et gérer les connexions sud via le menu « South ». Vous pouvez accéder directement à la configuration de chaque source de données ou en ajouter une à la liste en fonction de vos besoins.

Configuration des connexions Nord (North)

Vous pouvez accéder et gérer les connexions sud via le menu « North ». Vous pouvez accéder directement à la configuration de chaque application ou en ajouter une à la liste en fonction de vos besoins.

OIBus Security

Il est important de considérer quelques points concernant la sécurité de l’installation. OIBus est généralement installé sur une machine dédiée (qui peut être une machine virtuelle) située sur le site du client. Le comportement OIBus est entièrement géré par le fichier de configuration OIBus (oibus.json par défaut).

Il est important de considérer plusieurs aspects pour protéger OIBus :

  • Accès à la machine
  • Accès à l’interface d’administration OIBus
  • Protection des mots de passe, des clés secrètes, etc.

Accès à la machine OIBus

Bien évidemment, l’accès local ou à distance (en utilisant RDP ou le partage de disque par exemple) à la machine où OIBus est installé est un risque à considérer. En effet, un utilisateur local pourrait supprimer des fichiers OIBus ou modifier directement le fichier de configuration.

Il est important de limiter l’accès à la machine OIBus afin que personne ne puisse y accéder à l’exception de l’administrateur OIBus.

Accès à l’interface d’administration OIBus

L’interface d’administration OIBus est une interface Web qui peut être lancée localement ou à partir de n’importe quel PC distant avec un navigateur Web. Nous vous recommandons d’utiliser l’interface en utilisant l’URL localhost:2223.

interface administration oibus

Pour l’utiliser à partir d’un PC distant, vous devez configurer la section « Filters » de l’engine OIBus. L’accès à l’interface d’administration nécessite également un utilisateur / mot de passe.

Le nom d’utilisateur par défaut est admin

Le mot de passe par défaut est pass

Le mot de passe doit être modifié par l’utilisateur lors du premier lancement.

Mot de passe oublié :

L’administrateur disposant d’un accès au fichier de configuration OIBus peut utiliser un éditeur de texte pour supprimer la ligne « password » de la section « Engine » du fichier de configuration OIBus. Le mot de passe sera alors restauré à sa valeur par défaut (« pass »).

OIBus utilise la méthode d’authentification de base en plus du protocole HTTP pris en charge par la plupart des navigateurs Web. Cette méthode n’assure aucune protection de confidentialité pour les informations d’identification transmises envoyées dans l’en-tête pour chaque requête HTTP. Les « filters » du moteur d’OIBus peuvent atténuer ce risque en limitant les adresses IP autorisées, mais ce n’est pas une protection garantie à 100% car usurper l’identité d’un autre système informatique avec une fausse adresse IP n’est pas difficile pour les pirates.

Par conséquent, l’accès à distance à l’interface d’administration OIBus doit être limité à l’intérieur du LAN du client et ne doit pas être accessible sur Internet.

Protection des mots de passe, des clés secrètes, etc.

OIBus a besoin d’accéder à de multiples sources d’informations (Historiens, DCS, LIMS, MES, Bases de données, etc …). Beaucoup de ces sources nécessitent une paire nom d’utilisateur / mot de passe ou une clé secrète pour accéder à ces systèmes.

Ces informations sont également stockées dans le fichier de configuration OIBus mais elles sont toutes chiffrées. Cela ajoute un niveau de protection évitant à quiconque de lire ces informations en clair.

Ce chiffrement utilise des clés publiques / privées stockées dans le dossier de cache OIBus. Ces clés sont créées automatiquement à chaque démarrage si elles n’existent pas encore.

Si ces clés sont supprimées, il sera impossible pour OIBus de déchiffrer les mots de passe ou les clés secrètes. Une nouvelle paire de clé sera générée au redémarrage d’OIBus. Dans ce cas, il sera nécessaire d’utiliser l’interface d’administration et de ressaisir tous les mots de passe.