Catégorie Guide de démarrage - Constellation

Déployez Constellation

Sebastien Warin — Fri, 25 Nov 2016 09:33:33 +0000

Ça y est, on y arrive… C’est l’heure de démarrer votre première expérience Constellation mais avant de commencer, vous devez obligatoirement avoir créé un compte pour pouvoir déployer Constellation.

Si pour vous Constellation est encore nouveau je vous recommande vivement la lecture de ces deux articles :

Vous découvrirez ce qu’est (et ce que n’est pas) Constellation et ce qu’elle vous apportera. Vous découvrirez également les notions/concepts de base : les sentinelles, les packages, les MessageCallbacks ou encore les StateObjects.

En parlant de concepts, il important de bien les comprendre :

Ca va ? Vous en savez suffisamment ? Prêt pour le grand bain ?

N’oubliez pas de créer un compte avant de pouvoir déployer votre serveur Constellation, la Console, ajouter des sentinelles, installer le SDK et gérer les mises à jour grâce au Web Platform Installer.

Sous Windows téléchargez et lancez l’exécutable ci-dessous :

Constellation Web Platform Installer » Article
Constellation-Web-Platform-Installer-1.9.735.exe
Version: 1.9.735

1.2 MiB
2136 Downloads
Détails

Voir le tutoriel d’installation en détail

Sous Linux lancez la commande suivante :

wget -O install.sh https://developer.myconstellation.io/download/installers/install-linux.sh && chmod +x install.sh && ./install.sh

Et ensuite ?

Prêt pour développer avec Constellation ?

Créez votre premier package Constellation en C#
Créez des packages UI en Winform ou WPF
Connectez vos pages Web à Constellation
Créez votre premier package Constellation en Python
Connectez un Arduino ou un ESP8266 à Constellation
Suivez également les tutoriels avec des projets prêts à l’emploi

Pas envie de lire ? Visionnez les webcasts de découverte :

Besoin d’aide ?

N’hésitez pas à poser vos questions ici
Ou discuter de vos projets, de vos idées sur les forums
C’est privé ? Contactez-nous

The post Déployez Constellation appeared first on Constellation.

Installer la plateforme Constellation 1.8

Sebastien Warin — Sun, 13 Mar 2016 18:22:53 +0000

Après avoir introduit Constellation, découvrons comment installer la plateforme sur vos ordinateurs ou serveurs.

Prérequis

La plateforme Constellation se compose :

d’un serveur qui héberge et expose la Constellation en HTTP/s (un serveur = une Constellation)
de sentinelles (UI ou Service) à installer sur vos différentes machines (tout système Windows ou Linux)
d’une Console d’administration : application Web de pilotage de votre Constellation

Vous pouvez installer le serveur Constellation sur une machine Windows ou Linux, que ce soit un laptop, un desktop, un NUC, un SoC, un serveur local ou dans le Cloud.

Dans la rubrique Constellation Server vous retrouverez plusieurs articles sur les différentes installations possibles (système Linux, Raspberry, cloud Azure ou Amazon, etc…).

Pour démarrer, nous allons déployer dans ce guide une Constellation complète (serveur, sentinelle, console et le SDK) sur une machine Windows.

Vous avez donc besoin pour suivre ce guide :

d’un ordinateur ou serveur sous Windows (Windows 7/8/10 ou Windows Server)
Pour installer le SDK : Visual Studio 2015, 2017 ou 2019

Si vous ne disposez pas de licence de Visual Studio, vous pouvez installer la version “Community”, une version gratuite de Visual Studio compatible avec le SDK Constellation : https://www.visualstudio.com/fr-fr/products/visual-studio-community-vs.aspx

Télécharger la plateforme Constellation

Sur la page de téléchargement vous trouverez plusieurs programmes d’installation pour chaque composant Constellation :

Le serveur
Les sentinelles (UI ou Service)
La console
Le SDK Visual Studio

Mais pour gagner en productivité, vous avez à votre disposition le “Web Platform Installer” (WPI), un programme d’installation tout-en-un qui télécharge automatiquement et configure les composants que vous souhaitez installer.

Commencez donc par télécharger le programme “Constellation Web Platform Installer” pour Windows :

Constellation Web Platform Installer
Constellation-Web-Platform-Installer-1.9.735.exe
Version: 1.9.735

1.2 MiB
2136 Downloads
Détails

Installer la plateforme

Etape 1 : lancement de l’installation

Lancez le programme “Constellation Web Platform Installer.exe”

Etape 2 : identification

Vous devez dans cette étape renseigner votre compte myConstellation.io afin de pouvoir télécharger les composants Constellation et accéder à vos licences :

Etape 3 : acceptez la licence d’utilisation

Vous retrouverez le détail des licences Constellation sur cette page. Pour résumer, Constellation est gratuit pour un usage personnel ou éducatif sans aucun but lucratif et soumis à l’acquisition d’une licence pour un usage professionnel ou entreprise.

Etape 4 : choix du canal de distribution

Vous devez sélectionner le canal de distribution à utiliser : Stable ou Pre-release (versions Beta) :

Etape 5 : répertoire d’installation

Vous devez choisir le répertoire d’installation racine de la plateforme Constellation :

Etape 6 : sélectionnez les composants Constellation à installer

Vous pouvez sélectionner ici les composants à installer ou utiliser les profils prédéfinis :

Full server installation : installation typique pour un serveur (le serveur, la sentinelle en version service et la console Constellation)
Full developer installation : installation typique pour un poste de développement (le serveur, la sentinelle UI, la console et le SDK Visual Studio)
Custom installation : sélectionnez à la carte les composants que vous souhaitez installer

Notez que le WPI vous indiquera la dernière version de chaque composant à installer et est capable de déployer les mises à jour pour chacun de ces composants si une nouvelle version plus récente est disponible.

Notez également que si Visual Studio n’est pas installé, le composant SDK sera grisé avec la mention “Not applicable”.

Dans ce guide, sélectionnons le profil “Développeur” :

Etape 7 : configuration du serveur Constellation

Entrons désormais dans les étapes de configuration de chacun des composants à installer en commençant par le serveur Constellation.

Etape 7.1 : sélection de la licence

Premièrement, vous devez sélectionner une licence pour l’utilisation du serveur. Vous pouvez utiliser une licence que vous aurez préalablement téléchargée depuis le portail Constellation ou vous connecter directement sur le service de licence de Constellation depuis le WPI :

Vous obtiendrez l’ensemble des licences associées à votre compte avec la possibilité de créer des licences gratuites pour un usage personnel (plus d’information ici).

Dans notre cas créons une licence personnelle :

Etape 7.2 : choix du répertoire des packages

Dans cette étape vous devez définir le répertoire pour votre catalogue de packages de votre Constellation.

Par défaut, il s’agit du sous-dossier “Packages” de votre répertoire d’installation :

Etape 7.3 : choix du port d’écoute du serveur

Le serveur Constellation utilise le protocole HTTP pour exposer ses différents hubs et API. Pour cela vous avez besoin de choisir le port d’écoute et de l’ouvrir au niveau de votre firewall.

L’assistant peut déclarer le port que vous avez choisi dans le pare-feu de Windows. Si vous souhaitez ouvrir Constellation à l’extérieur de votre réseau local, à vous d’ouvrir le port sur votre routeur.

A noter que vous pouvez déclarer dans la configuration du serveur Constellation sur plusieurs ports HTTP et/ou HTTPS ou même définir un chemin HTTP personnalisé. Il est d’ailleurs conseillé d’activer le protocole HTTPS si vous souhaitez exposer votre serveur Constellation sur Internet. Vous retrouverez plusieurs articles sur la configuration avancée du serveur dans la rubrique Constellation Server.

Etape 7.4 : choix des clés d’accès

Pour se connecter à Constellation vous avez besoin de créer des clés d’accès (les “Access Keys”). Dans le cas d’une nouvelle installation, l’assistant vous proposera de créer deux clés :

Une clé “Standard” (accès de base) que vous utiliserez pour connecter vos sentinelles et packages
Une clé “Administrator” qui dispose des droits d’accès au hub de contrôle (pour le pilotage de la Constellation) et à l’API de Management (pour la configuration du serveur) :

Une clé d’accès est une chaîne de caractère. Il est conseillé de choisir des clés d’accès assez longues (> 16 caractères) et compliquées.

Pour simplifier leurs mémorisations et générations, Constellation propose d’utiliser un couple login/password pour créer des clés d’accès. Pour cela, on utilise le hash SHA1.

Exemple : pour le login “Admin” et le mot de passe “Password”, la clé d’accès sera “d882b8721a224d38ebb54559e6b54e5df3a1bc6d » (soit SHA1(“AdminPassword”)). Notez bien que la casse est importante !

Dans l’assistant d’installation, cliquez sur le bouton “Use Password” pour renseigner un couple login/password afin de générer les Access Keys :

Pour finir, vous pouvez ajouter le droit de débogage sur la clé “Administrator” en cochant la case correspondante. Cela nous permettra de tester des packages connectés à votre Constellation depuis Visual Studio.

Etape 8 : configuration de la Console Constellation

Comme la Console Constellation est déployée sur la même machine que le serveur Constellation, l’assistant vous propose héberger la console par le serveur Constellation lui-même.

Si vous désirez utiliser votre propre serveur Web pour exposer la Console (Apache, IIS ou autre) sélectionnez la deuxième option mais dans notre guide laissons le serveur Constellation héberger la console :

Vous pouvez ensuite fixer une clé d’accès en dur ou utiliser une page de login. De plus vous pouvez également restreindre l’accès à la console en local seulement.

Laissons les options par défaut (c’est à dire Console ouverte à tous avec une page de login) :

Etape 9 : configuration de la Sentinelle Constellation

Dans la sélection des composants nous avons indiqué vouloir installer la sentinelle UI. Vous arrivez donc à cette étape de configuration.

Comme la sentinelle est installée sur la même machine sur le serveur, vous pouvez l’inclure automatiquement dans votre Constellation ou bien l’inclure dans une autre Constellation en sélectionnant la deuxième option.

Dans notre cas, laissons la première option sélectionnée pour ajouter notre sentinelle UI à notre Constellation en cours d”installation :

Etape 10 : Installation

La configuration des composants est désormais terminée. Vous retrouverez tout le détail sur l’écran de confirmation :

En cliquant sur le bouton “Install”, le Web Platform Installer va télécharger les dernières versions de composants Constellation à installer :

Puis il déroulera l’installation et la configuration de chacun de ces composants :

A la fin de l’installation, l’assistant vous proposera de lancer la Console et la Sentinelle UI (car ces deux composants ont été installés) :

Etape 11 : Validation de l’installation

En fermant le programme d’installation, la sentinelle UI va être lancée :

En double-cliquant sur l’icone vous pourrez visualiser les logs de cette sentinelle qui doit être correctement connectée au serveur :

Vous aurez également la Console Constellation qui se lancera dans votre navigateur Internet par défaut :

Utilisez le Login/Password de la clé d’accès “Administrator” pour vous connecter. Sur la page “Sentinels” vous devriez voir votre sentinelle UI locale connectée :

Bravo vous avez déployé votre première Constellation avec succès !

Optionnellement : ajouter ou mettre à jour un composant

Vous pouvez à tout moment relancer le “Web Platform Installer” (WPI) pour ajouter ou mettre à jour des composants Constellation.

Ainsi quand des mises à jour Constellation sont disponibles, vous avez juste à relancer le WPI et vous laissez guider par l’assistant.

Dans notre exemple, relançons le WPI. Comme nous le montre l’écran ci-dessous, tous les composants sont bien à jour mais vous pouvez encore ajouter la “Sentinel Service” sur cette machine :

Vous entrez alors dans la configuration de la sentinelle avec la possibilité d’ajouter cette nouvelle sentinelle à votre Constellation locale (car précédemment installée) ou de l’ajouter à une autre Constellation.

Next steps

Ajoutez des sentinelles dans votre Constellation
Téléchargez et déployez des packages sur vos sentinelles
Exposer votre serveur Constellation derrière avec reverse proxy IIS ou Nginx et ajouter le support du HTTPS/SSL

Vous souhaitez installer le serveur et sa console sur un système Linux ?

Installer Constellation sur Linux

Prêt pour développer avec Constellation ?

The post Installer la plateforme Constellation 1.8 appeared first on Constellation.

Ajouter des sentinelles dans votre Constellation

Sebastien Warin — Wed, 30 Mar 2016 15:26:53 +0000

Les sentinelles sont des agents exécutés sur des systèmes Windows ou Linux qui, connectés à votre Constellation, permettent de déployer des packages Constellation.

En suivant le guide d’installation vous avez pu installer une sentinelle Service ou UI sur la même machine que le serveur Constellation.

Voyons maintenant comment installer des sentinelles sur vos autres machines (laptops, desktop, serveurs, Raspberry, etc..).

Prérequis

Il existe deux types de sentinelle :

La “Sentinel Service” : il s’agit d’un service compatible Windows et Linux qui tourne en arrière plan et permet de déployer des packages Constellation sans interface graphique.
La “Sentinel UI” : il s’agit d’une application Windows s’exécutant au sein d’une session Windows et permettant de déployer des packages Constellation avec interface graphique (dit Package UI) ou encore des packages ayant besoin d’interagir avec la session de l’utilisateur.

Les prérequis pour installer une sentinelle sont :

Un système Windows avec le .NET Framework 4.0 installé (soit au minimum un Windows XP SP3 ou un Windows 2003 SP2)
Un système Linux avec Mono 3.10 au minimum

Note : la sentinelle UI n’est disponible que pour Windows.

Installation d’une sentinelle sur un système Windows

Les installeurs pour la sentinelle Service et UI sont similaires, la procédure d’installation est donc identique.

Note : vous pouvez installer sur la même machine une sentinelle UI et une sentinelle Service.

Pour cela, vous pouvez soit télécharger le programme d’installation spécifique à la Sentinelle UI et/ou Service ou, pour faire plus simple, utiliser le “Web Platform Installer” pour installer et mettre à jour les dernières versions des composants Constellation.

Etape 1 : lancez le “Web Platform Installer

Constellation Web Platform Installer » Article
Constellation-Web-Platform-Installer-1.9.735.exe
Version: 1.9.735

1.2 MiB
2136 Downloads
Détails

Etape 2 : sélection des composants

Commencez par vous identifier avec votre compte Constellation et acceptez la licence d’utilisation avant de pouvoir sélectionner les composants à installer :

Dans le cas ci-dessus, nous avons déjà installé la dernière version du SDK Constellation comme vous pouvez le constater !

Dans ce guide nous allons installer les deux sentinelles (UI et Service) que nous connecterons à notre Constellation précédemment installée sur une autre machine.

Etape 3 : type d’installation des sentinelles

Vous avez ensuite le choix entre :

Installer la sentinelle et l’enregistrer dans votre Constellation en utilisant l’API de Management (il vous faudra connaitre une AccessKey qui a les droits de management pour procéder à l’enregistrement).
Installer la sentinelle seulement

Bien entendu pour automatiser le processus, choisissons la première option :

Notez que si vous souhaitez ajouter une sentinelle sur un système sur lequel un serveur Constellation est installé, l’assistant vous proposera d’installer et d’enregistrer automatiquement votre sentinelle sur le serveur local.

Etape 4 : sélection du serveur Constellation à joindre

Vous devez indiquer l’URI de votre serveur Constellation ainsi que la clé d’accès avec les droits d’administration pour enregistrer vos sentinelles.

Dans cet exemple le serveur Constellation est accessible sur l’URL “http://pc-seb.ajsinfo.loc:8088/” avec le couple “admin/password” (cliquez sur le bouton “Use Password” pour générer l’AccessKey à partir de ce couple) :

Etape 5 : choix de la clé d’accès pour la sentinelle

Vous aurez ensuite à choisir parmi les clé d’accès configurées sur votre serveur, laquelle doit être utilisée pour la connexion de vos sentinelles :

Etape 6 : installation

Il ne vous reste plus qu’à confirmer l’installation :

L’installeur téléchargera et installera les composants puis réalisera l’enregistrement vos deux nouvelles sentinelles sur votre serveur Constellation avant de lancer le service (pour la Sentinel Service) ou l’application (pour la Sentinel UI).

Depuis la Console Constellation, nous pouvons observer nos deux nouvelles sentinelles (PO-SWARIN et PO-SWARIN_UI) fraichement connectées :

Installation d’une sentinelle sur un système Linux

Sur un système Linux utilisez le “Web Platform Installer” pour automatiser le processus d’installation et de configuration.

Le WPI se chargera d’installer tous les prérequis (Mono, Python, PIP, etc..) et les dernières versions des composants Constellation.

Etape 1 : lancez le “Web Platform Installer

Pour lancer le WPI entrez la commande suivante :

wget -O install.sh https://developer.myconstellation.io/download/installers/install-linux.sh && chmod +x install.sh && ./install.sh

Le programme d’installation doit être lancé en “root” pour cela, le script se relancera automatiquement en “sudo” si la commande est présente. Autrement il tentera de se relancer automatiquement en “su root”. Si cette commande n’existe pas non plus, il affichera un message d’erreur. Vous aurez alors besoin de relancer manuellement le script “install.sh” en root.

Avec “sudo” ou “su root”, vous aurez dans certain cas besoin de fournir votre mot de passe “root” pour pouvoir autoriser le script d’installation à se lancer :

Le script va vérifier les prérequis à savoir :

Python (2.7 ou 3.x)
Python-dev
Mono 3.10 sur un ARMv6 ou autrement Mono 3.12 minimum
Supervisor

Sur un système Debian ou dérivé, le programme d’installation vous proposera d’installer automatiquement les prérequis si besoin.

Etape 2 : sélection des composants

Une fois les prérequis validés, vous pourrez choisir les composants Constellation à installer :

Dans ce guide, sélectionnons le composant “Sentinel”. Vous commencerez par accepter la licence d’utilisation :

Puis vous devrez renseigner vos identifiants de votre compte myConstellation.io :

Définissez ensuite le répertoire d’installation de la sentinelle sur votre système :

Etape 3 : sélection du serveur Constellation à rejoindre

Renseignez maintenant l’URI de votre serveur Constellation sur laquelle votre sentinelle doit se connecter :

Etape 4 : type d’installation de la sentinelle

Comme pour l’installation d’une sentinelle sous Windows, indiquez si vous souhaitez également procéder à son enregistrement :

Au quel cas il faudra spécifier un compte avec les droits de management pour pouvoir joindre la sentinelle dans votre Constellation :

Etape 5 : choix de la clé d’accès pour la sentinelle

Vous pourrez ensuite choisir parmi les clé d’accès configurées sur votre serveur, laquelle doit être utilisée par votre sentinelle :

Etape 6 : prérequis pour les packages Python

Enfin si vous comptez déployer des packages Constellation Python vous devez installer le runtime Python ainsi que différentes librairies (plus d’informations).

Le WPI vous proposera d’installer ces prérequis pour vous de manière automatique :

Etape 7 : installation et démarrage

Le WPI procèdera à l’installation et à la configuration de la sentinelle et des prérequis.

A la fin de ce processus, la sentinelle sera automatiquement démarrée :

En retournant sur la Console de notre Constellation, on pourra constater qu’une nouvelle sentinelle ici nommée “rpi2” s’est bien connectée dans notre Constellation :

Votre sentinelle Linux est prête, vous pouvez maintenant y déployer des packages ou développer vos propres packages en C# ou en Python.

The post Ajouter des sentinelles dans votre Constellation appeared first on Constellation.

Télécharger et déployer des packages sur vos sentinelles

Sebastien Warin — Tue, 15 Mar 2016 10:58:25 +0000

Télécharger et déployer des packages depuis la Console Constellation

Sur la Console Constellation, rendez-vous sur la page “Package Repository”, le catalogue des packages de votre Constellation. C’est là que vous pourrez gérer votre catalogue de package.

Pour ajouter des packages dans votre catalogue, vous pouvez soit les uploader manuellement ou soit les télécharger directement depuis la catalogue de package gratuit Constellation en cliquant sur le bouton “Online Package Repository” :

Vous pourrez alors choisir sur le catalogue en ligne les packages à télécharger dans votre catalogue local.

Par exemple, ajoutons le package “NetworkTools” en cliquant sur le bouton “Deploy” :

Le téléchargement débutera alors :

Une fois le package télécharger un assistant de déploiement s’affichera vous invitant à sélectionner la sentinelle sur laquelle déployer votre package :

Dans mon cas je choisis de déployer ce package sur la sentinelle “PO-SWARIN”.

Vous pouvez ensuite sélectionner les options de déploiement, pour démarrer laissez les paramètres par défaut :

Ensuite chaque package peut déclarer des settings. Ici le package “NetworkTools” ne déclare qu’un setting pour le monitoring. Vous pouvez éditer le JSON pour définir les ressources à monitorer :

En cliquant sur le bouton “Deploy”, Constellation va automatiquement déployer ce package sur la sentinelle de votre choix. Sur la page “Packages” vous retrouverez vos packages démarrés. Vous pourrez suivre l’état et l’uptime de chaque package, sa consommation CPU et RAM, etc… Vous pouvez également arrêter, redémarrer ou mettre à jour vos packages sur n’importe quelle sentinelles grâce à cette page :

Sur la page “Console log” vous pourrez suivre en temps réel les logs produit par l’ensemble des packages de votre Constellation :

Sur le StateObject Explorer vous pourrez consulter les StateObjects publiés par chaque package. Ici le package “NetworkTools” publie un StateObject pour chaque ressource qu’il monitore (décrit dans ses settings) :

Vous pouvez cliquer sur le bouton “View” pour afficher le détail de chaque StateObject et le suivre en temps réel :

Sur le MessageCallback Explorer, vous pouvez consulter toutes les méthodes que vos packages exposent. Un formulaire permet même de tester les MC depuis la Console :

Notez qu’à tout moment vous pouvez vous rendre dans votre Package Repository et cliquez sur le bouton “Deploy package” dans le menu “Action” du package que vous souhaitez à nouveau déployer :

Quelques packages pour démarrer

BatteryChecker : permet de publier un StateObject sur l’état de votre batterie (pour les PC portables ou onduleurs)
DayInfo : information sur l’heure du levé et couché du soleil et la fete du jour
HWMonitor : permet de publier des StateObjects sur les compteurs “Hardware” de votre machines (CPU, RAM, réseau, disques durs, etc…)
WindowsControl : exposer des MessageCallbacks pour contrôler l’état d’une machine Windows (Reboot, Shutdown, Sleep, Lock, …)
ForecastIO : service de météo
FreeboxTV : pour les possesseurs de Freebox
Hue : pilotage des lampes Hue
Nest : pilotage des thermostats et détecteur de fumée Nest
NetAtmo : intégration des capteurs NetAtmo dans Constellation
PushBullet : envoi de notification sur smartphone, tablette et PC
Rfxcom : intégration des capteur RF
Vera : intégration de la box domotique Vera
Wemo : intégration des prises connectée Wemo
Xbmc : intégration des media-centers Kodi

Rendez-vous dans la rubrique packages.

Autres moyens

Uploader des packages manuellement

Vous pouvez par exemple télécharger des packages manuellement depuis le catalogue officiel ou tout autre source.

Depuis la Console, rendez-vous sur la page “Package Repository” et cliquez sur le bouton “Upload” :

Vous pouvez alors glisser-déplacer les package Constellation (fichiers ZIP) dans le rectangle ou cliquer dessus pour ouvrir la fenêtre de sélection du fichier :

Déposons les différents packages téléchargés dans le rectangle afin de les uploader dans votre catalogue :

Et voilà les packages sont disponibles dans le Package Repository de votre Constellation :

Uploader des packages depuis Visual Studio

Vous pouvez publier un package Constellation directement depuis Visual Studio :

Le package publié est celui marqué comme “Projet de démarrage” dans le cas où vous avez plusieurs projet dans votre solution. Autrement cliquez-droit sur le projet que vous souhaitez publier et cliquer sur “Publish Constellation package” dans le menu “Constellation” :

Vous pourrez ensuite publier votre package en local ou directement sur un serveur Constellation.

Pour plus d’information, consultez cet article.

Déployer manuellement des packages sur vos sentinelles

La définition des déploiements, c’est à dire “quel package sur quelle sentinelle” es t décrite dans le fichier de configuration de la Constellation.

Vous pouvez éditer ce fichier manuellement sur votre serveur Constellation avec notre éditeur de texte préféré, depuis Visual Studio ou directement depuis la Console Constellation :

Par exemple déployons les 5 packages ci-dessous sur la sentinelle nommée “PO-SEB” :

En cliquant sur le bouton “Save & Deploy”, vous allez enregistrer la configuration sur le serveur et déployer cette configuration dans votre Constellation.

Pour plus d’information sur le schéma XML de la configuration Constellation consultez cet article.

The post Télécharger et déployer des packages sur vos sentinelles appeared first on Constellation.

Créez votre premier package Constellation en C#

Sebastien Warin — Wed, 16 Mar 2016 10:00:22 +0000

Dans cet article nous allons découvrir comment créer et déployer votre premier package Constellation en C# avec Visual Studio.

Prérequis

Un accès “Administrator” à une Constellation (Management API & Developper access)
Le SDK Constellation installé

Nous vous conseillons de suivre le guide de démarrage ici avant de démarrer.

Créez le package dans Visual Studio

Lancez Visual Studio
Créez un nouveau projet de type “Constellation Package Console” (dans la catégorie Constellation) :

Démarrez le package en mode debug en cliquant sur le bouton “Start” ou en pressant la touche “F5” :

Au démarrage, votre package affichera une sorte de ”Hello World” :

Vous constaterez que :

La méthode “OnStart” est la méthode invoquée au démarrage de votre package
PackageHost.WriteInfo est une méthode pour écrire des logs de type “info”
PackageHost.IsRunning = true (votre package est bien en cours)
PackageHost.IsConnected = false (votre package n’est pas connecté à Constellation, car nous l’avons lancé en local)

Fonctionnement de base

Un package est une application !

Il faut impérativement appeler la méthode “PackageHost.Start” au démarrage de l’application, c’est à dire dans la méthode “Main” autrement, ce n’est pas un package Constellation mais une simple application !

Lorsque vous appelez la méthode “PackageHost.Start” vous devez impérativement transférer les arguments (args) et indiquer la classe de votre package qui est dans notre exemple “Program”.

static void Main(string[] args)
{
    PackageHost.Start(args);
}

La classe d’un package doit être une classe qui implémente l’interface “IPackage”. Cette interface définie trois méthodes :

OnStart qui sera invoqué lorsque le package a démarré
OnPreShutdown : invoqué lorsque le package va s’arrêter (à ce stade votre package est toujours connecté à Constellation, vous pouvez encore pusher des StateObjects, envoyer des messages, écrire des logs sur le hub, etc..)
OnShutdown : invoqué après le OnPreShutdown et après avoir fermé les connexions.

Pour vous éviter de devoir implémenter ces trois méthodes, votre classe peut hériter de la classe “PackageBase”. Cette classe abstraite implémente l’interface IPackage dans des méthodes virtuelles vides.

Libre à vous d’implémenter les méthodes que vous souhaitez !

Dans le template de projet créé ci-dessus, la classe “Program” hérite de “PackageBase” et redéfinie la méthode “OnStart” pour écrire un message de type “info” (PackageHost.WriteInfo) lorsque le package a démarré.

Ecrire des logs

Pour écrire des logs depuis un package Constellation vous disposez des méthodes :

PackageHost.WriteDebug
PackageHost.WriteInfo
PackageHost.WriteWarn
PackageHost.WriteError

Chacune de ces méthodes écrivent un message qui peut être formaté avec des arguments à la manière d’un “string.Format” :

PackageHost.WriteInfo("Je suis le package nommé {0} version {1}", PackageHost.PackageName, PackageHost.PackageVersion);

Attention : bien respecter les index dans le format de votre message sous peine d’avoir une erreur.

Note : la méthode WriteDebug écrit seulement dans la console (mode debug local). Les logs de type “Debug” ne sont jamais envoyés dans la Constellation.

Accéder aux settings

Chaque package peut définir des paramètres de configuration définis au niveau du serveur Constellation. Cela vous permet de changer ces paramètres directement depuis la Constellation qui se chargera de redescendre ces paramètres sur vos packages.

Il y a deux types de settings :

Les “Setting Value” : très simple il s’agit d’un couple clé/value à l’instant des d’une application .NET
Les “Setting Content” : au lieu de définir la valeur d’un paramètre dans un attribut XML, on peut la définir dans un élément XML enfant permettant d’avoir des settings qui renferme du XML ou JSON

Voici par exemple des “SettingValues” déclarés dans notre configuration :

Ces trois settings définissent la valeur dans l’attribut “value” (= SettingValue).

Pour récupérer la valeur du paramètre “MyStringSetting” dans votre code, utilisez la méthode “GetSettingValue” :

PackageHost.WriteInfo("My String = {0}", PackageHost.GetSettingValue("MyStringSetting"));

La méthode “GetSettingValue” renvoie la valeur d’un setting de type “string” mais vous pouvez également caster la valeur depuis cette méthode en utilisant sa forme générique :

int myIntSetting = PackageHost.GetSettingValue("MyIntSetting");
bool myBoolSetting = PackageHost.GetSettingValue("MyBoolSetting");

Si par contre vous avez un modèle de configuration plus compliqué qu’une série de clé/valeur vous pouvez utiliser les “Setting Contents” pour définir du XML ou JSON comme valeur de setting.

Par exemple la configuration de votre package peut définir deux autres settings, contenant du XML ou JSON de cette façon :


  
    
      Tove
      Jani
      Reminder
      Don't forget me this weekend!

Plusieurs méthodes pour récupérer ces settings :

GetSettingValue : vous pouvez toujours récupérer le contenu brute de votre setting sous forme d’un string
GetSettingAsJsonObject : dé-sérialise le contenu JSON de votre setting et vous retourne un objet dynamique
GetSettingAsJsonObject : dé-sérialise le contenu JSON de votre setting et le convertie dans un objet de votre type (T)
GetSettingAsXmlDocument : dé-sérialise le contenu XML de votre setting et vous retourne un XmlDocument
GetSettingAsConfigurationSection : dé-sérialise le contenu XML de votre setting sous forme d’un ConfigurationSection .NET

Par exemple, pour manipuler le setting XML on pourrait écrire :

var xml = PackageHost.GetSettingAsXmlDocument("MyXmlDocument");
PackageHost.WriteInfo("My XmlDocument Attribute = {0} , first node value = {1}", xml.ChildNodes[0].Attributes["date"].Value, xml.ChildNodes[0].FirstChild.InnerText);

Autre exemple avec le setting JSON :

dynamic json = PackageHost.GetSettingAsJsonObject("MyJsonObject");
PackageHost.WriteInfo("My JsonObject String={0}, Int={1}, Boolean={2}", json.String, json.Number, json.Boolean);

Les settings d’un package sont déclarés au niveau du serveur dans la déclaration du package et/ou dans le fichier App.config.

Tous les settings doivent être déclarés dans le manifeste du package (fichier PackageInfo.xml).

Retrouvez plus d’information sur les settings dans cet article.

Publier des StateObjects

Pour publier (Push) un StateObject dans Constellation vous devez invoquer la méthode “PackageHost.PushStateObject” en précisant obligatoirement le nom du StateObject et sa valeur.

Par exemple, vous pouvez publié n’importe quel type de base :

PackageHost.PushStateObject("MyString", "OK");
PackageHost.PushStateObject("MyNumber", 123);
PackageHost.PushStateObject("MyDecimal", 123.12);
PackageHost.PushStateObject("MyBoolean", true);

Pouvez également publié des objets anonymes :

PackageHost.PushStateObject("AnonymousObject", new { String = "test", Number = 123 });

Ou encore avec des types plus complexes :

PackageHost.PushStateObject("MyObject",  new MyCustomObject() { String = "test", Number = 123 });

Vous avez également la possibilité de définir des paramètres optionnels comme les métadonnées de votre StateObject ou sa durée de vie.

Par exemple, le StateObject “ShortLife” a une durée de vie de 20 secondes après sa publication. Au delà il sera marqué comme expiré.

PackageHost.PushStateObject("ShortLife", "Expire in 20 secs !!!", lifetime: 20);

Ici, on publie un StateObject “Salon” en lui associé les metadatas “Id” et “Zone”.

PackageHost.PushStateObject("Salon", monObjetZoneSalon, metadatas: new Dictionary { { "Id", 42 }, { "Zone", "Salon" } });

Sur les objets personnalisés il est recommande de décorer les classes de l’attribut [StateObject] si vous avez possibilité de modifier le code de la classe. Autrement, sur votre classe IPackage, ajoutez l’attribut [StateObjectKnownTypes] en définissant tous les types de StateObjects que vous serez amener à publier. Cela permet de décrire ces types dans la Constellation pour l’auto-description (utilisez entre autre par les générateurs de code).

Pour plus d’information sur les StateObjects dans l’API .NET cliquez ici.

Tester son package dans sa Constellation

Pour tester nous allons créer un package qui push à intervalle régulier un StateObject.

Le code de notre Package sera :

public class Program : PackageBase
{
    static void Main(string[] args)
    {
        PackageHost.Start(args);
    }

    public override void OnStart()
    {
        PackageHost.WriteInfo("Package starting - IsRunning: {0} - IsConnected: {1}", PackageHost.IsRunning, PackageHost.IsConnected);
        PackageHost.WriteInfo("Je suis le package nommé {0} version {1}", PackageHost.PackageName, PackageHost.PackageVersion);

        while (PackageHost.IsRunning)
        {
            PackageHost.WriteInfo("Je push un long !");
            PackageHost.PushStateObject("DemoLong", DateTime.Now.Ticks);

            Thread.Sleep(PackageHost.GetSettingValue("Interval"));
        }
    }
}

Notre application console démarre bien le package au démarrage (Main) où le package est notre classe Program qui hérite de PackageBase (donc c’est un IPackage).

Au démarrage on écrit deux logs de type information qui indique notamment le nom du package, sa version, si il est démarré (IsRunning) et si il est connecté (IsConnected).

Ensuite on crée une boucle qui tournera tant que le package est démarré. A chaque itération on écrit un log, publie un StateObject avant de mettre le thread en pause avant la prochaine itération.

Le temps de pause est un setting de type “Int” que l’on a nommé “Interval”.

L’utilisateur pourra le configurer dans la configuration du package sur le serveur, mais pour être sûr d’avoir une valeur par défaut nous allons déclarer ce setting ainsi que sa valeur par default dans son manifest.

Editez le fichier PackageInfo.xml pour ajouter :

Ainsi même si le setting n’est pas déclaré sur le serveur ni dans le App.config local, cette valeur sera par défaut égale à 5 secondes.

Vous pouvez démarrer le projet en mode debug (“F5” ou bouton “Start”) mais bien entendu il ne sera pas connecté à Constellation.

Pour débugger dans Constellation, vous trouverez une icone dans la toolbar (en en pressant Ctrl+Alt+F8) :

Vous pouvez également cliquez droit sur votre projet et dans le menu Constellation sélectionnez “Debug On Constellation” :

Si vous n’avez pas encore configuré la Constellation utilisée pour le débogage, vous devriez voir une alerte vous invitant à configurer vos accès :

Cette fois ci, votre package tourne bien en étant connecté à votre Constellation :

Lancez maintenant votre Console Constellation, vous verrez en temps réel les logs de votre package.

Sur le StateObject Explorer, vous verrez également le StateObject “DemoLong” publié par le package “MonPremierPackage”.

Notez que la sentinelle qui héberge le package est une sentinelle virtuelle nommée “Developer”.

Vous pouvez cliquer sur “View” pour voir toutes les informations à propos de ce StateObject.

Pour finir, cliquez sur “Subscribe” pour vous abonner aux mises à jour.

Publier son package dans Constellation

Nous voulons maintenant publier ce package et le déployer sur une des sentinelles de notre Constellation.

Toujours dans la toolbar “Constellation”, cliquez sur “Publish Constellation package” :

Ou depuis le menu contextuel de votre projet, sélectionnez “Publish Constellation package” :

Vous pouvez soit le publier en local puis l’uploader manuellement via la Console par exemple, soit le publier directement dans votre Constellation.

Pour cela, sélectionnez “Upload on Constellation Server”.

Sélectionnez ensuite l’adresse de votre Constellation et cliquez sur “Publish”.

Un message vous informera de la réussite de la publication. Dans le panneau “Ouput” de Visual Studio vous retrouvez également le détail de la publication :

Depuis la Console, sur la page “Package Repository” vous pourrez apercevoir votre package fraichement publié :

Pour le déployer, vous devez éditer la configuration de votre Constellation pour ajouter le package à une (ou plusieurs) sentinelle. Vous pouvez également redéfinir le setting “Interval” que nous exploitations dans notre package (bien que nous avons défini une valeur par défaut).

Vous pouvez éditer la configuration du serveur Constellation directement depuis Visual Studio en cloquant sur “Edit Constellation Server configuration” (depuis la toolbar ou via le menu contextuel).

La configuration sera automatiquement téléchargée du serveur et ouverte dans Visual Studio :

L’avantage est de pouvoir profiter de la validation du schéma XML et de l’IntelliSense de Visual Studio :

Dès que vous enregistrerez votre configuration, Visual Studio détectera les modifications et vous proposera d’uploader et de recharger la nouvelle configuration sur votre serveur Constellation :

Vous pouvez aussi éditer la configuration de votre Constellation depuis la Console. Après avoir ajouter votre package, cliquez sur “Save & Deploy” (pour informer les sentinelles des nouveaux packages) :

Vous pourrez alors voir dans les logs que le package est automatiquement téléchargé et déployé sur sa sentinelle et commence à pusher des StateObject toutes les 2 secondes comme nous l’avons indiqué dans sa configuration :

Sur la page “Packages” vous pouvez maintenant contrôler votre package, l’arrêter, le redémarrer ou le recharger (= déploiement d’une nouvelle version).

Next steps

Les bases des packages .NET
Les Settings : paramètres de configuration de vos packages
Publier des StateObjects
Exposer vos méthodes dans Constellation grâce aux MessageCallbacks
Envoyer des messages & Invoquer des méthodes
Consommer des StateObjects
Accéder au hub de contrôle depuis un package C# avec le ControlManager
Créer des Packages UI en Winform ou WPF

The post Créez votre premier package Constellation en C# appeared first on Constellation.

Connectez vos pages Web à Constellation

Sebastien Warin — Wed, 06 Jul 2016 14:22:29 +0000

Introduction

Il existe actuellement deux librairies Constellation JavaScript :

Constellation for Javascript
Constellation for AngularJS

La première est basée sur jQuery, la deuxième est une surcouche de la 1ère encapsulée dans un module AngularJS.

Vous retrouverez ces deux librairies depuis le gestionnaire de package Nuget intégré à Visual Studio :

Chacune de ces deux librairies propose deux types de client :

Consumer
Controller

Le client “Consumer” permet de se connecter à Constellation en tant que “consommateur” pour pouvoir interroger des StateObjects et envoyer/recevoir des messages.

Le client “Controller” permet lui de se connecter à Constellation en tant que « contrôleur » pour récupérer par exemple en temps réel les logs produits par vos packages, arrêter/démarrer les packages, surveiller la consommation de ressources de chacun d’entre eux, etc.

Dans ce guide nous allons utiliser le client « Consumer » afficher en temps réel le StateObject produit par le package HWMonitor représentant la consommation de votre CPU dans une page Web.

Pour cela vous devez avoir déployé le package “HWMonitor” sur au moins une de vos sentinelles (Windows).

Etape 1 : ajouter la librairie Constellation

En utilisant le CDN

Les librairies JavaScripts sont accessibles sur : http://cdn.myconstellation.io/js/ (en HTTP ou HTTPS).

De ce fait, vous pouvez créer une simple pages HTML et ajoutez dans l’entête les balises suivantes :

Si vous souhaitez connecter votre page à Constellation en utilisant le framework AngularJS :

Par Nuget en utilisant Visual Studio

Créez une application Web vide dans Visual Studio et ouvrez le gestionnaire de package NuGet.

En sélectionnant la source “Constellation”, installez le package Nuget “Constellation.Javascript” :

Une fois installée vous obtiendrez dans le dossier “Scripts” de votre projet Web les librairies jQuery, SignalR et Constellation :

Créez ensuite une page Web (HTML ou ASPX) et dans l’entête de votre code HTML référencez les scripts (à adapter en fonction des n° de version des librairies contenues dans les packages Nuget) :

Etape 2 : Initialiser le client

Tout d’abord il faut déterminer la clé d’accès qui sera utilisée par votre page. Ici, depuis la Console Constellation, nous créons un credential “DemoWeb” avec la clé d’accès “123456789” :

Dans notre page HTML, créons un client “Consumer” en spécifiant l’URI de notre Constellation, la clé d’accès utilisée pour se connecter et le “friendly name” de votre client :

var constellation = $.signalR.createConstellationConsumer("http://localhost:8088", "123456789", "Test API JS");

Etape 3 : Etablir la connexion à Constellation

Ajoutons un handler sur le changement d’état de la connection pour afficher le message “Je suis connecté” dans la console de votre navigateur :

constellation.connection.stateChanged(function (change) {
    if (change.newState === $.signalR.connectionState.connected) {
        console.log("Je suis connecté");
    }
});

Pour finir lançons la connexion en invoquant la méthode Start :

constellation.connection.start();

Testons la page dans Chrome par exemple :

Etape 4 : Afficher le contenu d’un StateObject en temps réel

Dans notre cas nous voulons afficher en temps réel la consommation CPU de notre sentinelle.

Ce StateObject se nomme “/intelcpu/0/load/0” et est produit par le package “HWMonitor” que vous aurez pris le soin de déployer sur une de vos sentinelles (ici ma sentinelle se nomme “PO-SWARIN”) :

On peut donc enregistrer un “StateObjectLink” avec la méthode “registerStateObjectLink” en demandant un filtre sur la sentinelle nommée “MON-PC”, le package “HWMonitor” et le nom “/intelcpu/load/0” (le dernier argument de cette méthode correspond au type du StateObject, ici ”*” indique qu’il n’y a pas de filtre sur le type) et en indiquant la fonction à invoquer à chaque mise à jour du et des StateObjects liés, ici mettre à jour un de la page.

Vous devez impérativement faire cet enregistrement lorsque vous êtes connecté, c’est à dire lorsque le handler “stateChanged” est invoqué avec l’état “Connected”.

Le code final sera donc :

constellation.connection.stateChanged(function (change) {
    if (change.newState === $.signalR.connectionState.connected) {
        console.log("Je suis connecté");
        constellation.client.registerStateObjectLink("MON-PC", "HWMonitor", "/intelcpu/0/load/0", "*", function (so) {
            console.log(so);
            $("#cpu").text(so.Value.Value);
        });
    }
});

Dès que le StateObject est réceptionné par notre page nous affectons la propriété “Value” de la valeur du StateObject comme contenu du span “cpu” de la page. De ce fait, ajoutons un “span” nommé “cpu” dans le corps de notre page :

Ainsi vous aurez en temps réel votre CPU dans une page HTML grâce à l’exploitation du StateObject ici produit par le package HWMonitor :

Vous remarquerez que dans le handler ci-dessus nous loguons également l’objet “stateobject” réceptionné par notre page.

Cet objet contient les différentes propriétés du StateObject : la sentinelle et le package qui ont produit ce StateObject, le nom du StateObject, son type, sa durée de vue (ici “lifetime=0” donc n’expire jamais), la date de mise à jour du StateObject, ses métadonnées et surtout sa valeur (propriété “Value”).

Ici la valeur de ce StateObject produit par le package “HWMonitor” est un objet complexe (entouré en vert) qui contient différentes propriétés :

Pour la suite je vous recommande vivement l’utilisation du framework AngularJS permettant de développer des pages plus facilement.

Next step

The post Connectez vos pages Web à Constellation appeared first on Constellation.

Créez votre premier package Constellation en Python

Sebastien Warin — Fri, 01 Apr 2016 08:28:19 +0000

Vous pouvez développer des packages Constellation avec le langage Python. Sur vos sentinelles Windows comme sur vos sentinelles Linux vous pourrez profiter des différentes libraires et de l’écosystème Python connectés dans Constellation.

Découvrons dans cet article comment créer et déployer votre premier package Constellation en Python.

Prérequis

Tout d’abord, que vous soyez sur Windows ou Linux, il vous faudra un interpréteur Python 2 ou Python 3 et une ou deux libraires indispensables pour Constellation.

Notez que ces prérequis sont automatiquement installés sur Linux avec le Web Platform Installer.

Installer Python sur Windows

Téléchargez Python pour Windows (en version 2.x ou 3.x) puis lancez l’installation en choisissant une installation pour tous les utilisateurs :

Sélectionnez le composant “PIP” ( le gestionnaire de package Python) et ajoutez “Python.exe” dans les “Paths” Windows :

Une fois l’installation terminée, lancez une invite de commande (cmd.exe) et assurez-vous que la commande “python” fonctionne :

Toujours dans une invite de commande Windows, installez via PIP les librairies “pyzmq” (et “enum34” si vous êtes en Python 2.x) grâce aux commandes suivantes :

pip install pyzmq
pip install enum34

Si vous êtes sur Python 3.x, vous n’avez pas besoin du module “enum34”, seulement “pyzmq”.

Et voilà, votre environnement Windows est prêt !

Installer Python sur Linux

Sur un système Debian ou similaire (Raspbian, Ubuntu, etc …), vous n’avez qu’à installer (et enregistrer dans votre Constellation) une sentinelle Constellation.

Le Web Platform Installer vous proposera d’installer tous les prérequis nécessaires à savoir Python et les librairies “pyZmq” et “enum34” (si Python 2.x) via PIP.

Autrement, pour installer manuellement ces prérequis, vous pouvez utiliser les mêmes commandes que sur Windows :

sudo easy_install pip
sudo pip install pyzmq
sudo pip install enum34

Encore une fois, la libraire “enum34” est seulement requise sur Python 2.x.

Enfin si vous utilisez un Raspberry Pi, vous pouvez également consulter cet article en particulier.

Et voilà, votre environnement Linux est prêt !

Développer un package Python en ligne de commande

Vous pouvez soit utiliser le SDK Constellation basé sur Visual Studio pour créer, tester et déployer des packages Constellation (.NET ou Python) ou bien, utiliser l’outil en ligne de commande nommé « Constellation Package Tools CLI ».

Le développement sous Visual Studio est abordé ci-dessous. Pour l’outil en ligne de commande, rendez-vous sur la page : Créer, tester et déployer des packages Python en ligne de commande

Développer un package Python avec Visual Studio

Après avoir installé les prérequis et le SDK Constellation, lancez Visual Studio et créez un nouveau package Constellation de type “Python” :

Une fois créé le projet Visual Studio a la structure suivante :

Vous retrouverez une structure classique pour un package Constellation :

App.config : le fichier de configuration local pour définir les valeurs locales de vos settings (lire ici) ainsi que les scripts Python à démarrer
PackageInfo.xml : le manifeste de votre package
packages.config : le fichier des packages Nuget de votre projet (réservé à Nuget)
Program.cs : le point d’entrée (C#) de votre package qui se chargera de lancer le “Python Proxy” (le pont entre vos scripts Python et Constellation)
Le répertoire “Scripts” (qui contient vos scripts Python)
- Constellation.py : le proxy Python Constellation (la librairie Python) : ne pas modifier !
- Demo.py : un script Python d’exemple

Configurer les scripts à démarrer

Vous pouvez ajouter autant de scripts Python dans le dossier “Scripts” comme vous le souhaitez. Pour cela, cliquez-droit sur ce répertoire et sélectionnez « Ajouter un nouvel élément ».

Dans la catégorie « Constellation » sélectionnez « Constellation Python Script » :

Chaque script sera démarré dans un processus dédié et connecté à Constellation.

Attention : si vous rajoutez des scripts Python dans ce dossier, il faut obligatoirement les inclure dans le package en sélectionnant “Copy if newer” pour la propriété “Copy to Output directory”. Cette propriété est automatiquement définie à cette valeur si vous avez créé votre fichier Python en sélectionnant l’élément « Constellation Python Script » comme expliqué ci-dessus.

Dans le fichier « App.config » vous devez déclarer les fichiers Python à démarrer. Les scripts Python créé en sélectionnant l’élément « Constellation Python Script » sont automatiquement ajoutés dans ce fichier lors de la création. Si vous renommez ou supprimer vos scripts, n’oubliez pas de mettre à jour ce fichier.

Auteur:	MyConstellation.io
Plateformes:	Windows
Catégorie:	Web Platform Installers
Licence:	Constellation License Agreement
Date:	juin 15, 2020

Auteur:	MyConstellation.io
Plateformes:	Windows
Catégorie:	Web Platform Installers
Licence:	Constellation License Agreement
Date:	juin 15, 2020

Auteur:	MyConstellation.io
Plateformes:	Windows
Catégorie:	Web Platform Installers
Licence:	Constellation License Agreement
Date:	juin 15, 2020