Vanilla : Virtual Box Installation Guide for Virtual Box appliance Guide d'installation de l'application VirtualBox Vanilla Charles Martin et Patrick Beaucamp BPM Conseil Contact : charles.martin@bpm-conseil.com, patrick.beaucamp@bpm-conseil.com December 2012 (Décembre 2012) Document : BPM_Vanilla_Installation_v4.2.odt Version 4.2 BETA 1
Index Introduction...3 Pre-requisites (Pré-requis)...4 About this documentation (Apropos de la documentation)...4 Restore the appliance (Restauration de l'application)...5 Virtual Box...5 Network configuration (Configuration réseau)...6 Get the IP (Récupération de l'ip)...7 Configuration of Vanilla (Configuration de Vanilla)...10 Start Vanilla (Démarrage de Vanilla)...12 Manipulations...12 Configuration...13 Acces Vanilla platform (Accéder à Vanilla)...15 Url acces and connection (Url d'accès et connexion)...15 Run the samples (Consultation des exemples)...17 Shutdown (Eteindre l'application)...19 2
Introduction Vanilla VirtualBox appliance is a packaged version of the Vanilla server application. The OS is Debian Squeeze and the database server used is MySQL. Ready to deploy, this appliance is configured for accessing the network by bridge and the default configuration IP for Vanilla is 192.168.1.122. Through this document, we will explain how to deploy the VirtualBox appliance in your network and acces the samples. Please note that the complete documentation about Vanilla configuration and installation is available and that you need to read it in order to achieve the Vanilla installation. Virtual Box downloads url : https://www.virtualbox.org/wiki/downloads L'applicatif Vanilla Virtual Box est une version packagée de l'application Vanilla Serveur. L'OS utilisé est Debian Squeeze et le serveur générique de base de données est MySQL. Prête à être déployée, l'application est configurée par défaut afin d'accéder au réseau par pont. Vanilla est par défaut configurée sur l'ip 192.168.1.122. A travers de document, nous expliquerons comment déployer l'application Vanilla VirtualBox sur votre réseau et accéder aux exemples. Veuillez noter que la documentation compléte expliquant la configuration et l'installation de Vanilla est disponible. Cette documentation doit être lue et comprise afin de compléter l'installation de la plate-forme Vanilla. Téléchargements Virtual Box : https://www.virtualbox.org/wiki/downloads 3
Pre-requisites (Pré-requis) Virtual Box background has to de deployed and ready to welcome new appliance. Your server must access a network in order to be able to create a bridge connection. Le socle Virtual Box doit être disponible et prêt à accueillir une nouvelle application. Votre serveur doit pouvoir accéder au réseau afin de créer une connexion par pont. About this documentation (Apropos de la documentation) This documentation is about Vanilla Virtual Box appliance version 4.2 BETA, released December 2012. This documentation describes installation, configuration and main use of the platform and puts aside minor bugs. Cette documentation porte sur l'application Vanilla Virtual Box version 4.2 BETA, publiée en Décembre 2012. Elle décrit les phases d'installation, de configuration et d'usage général de la plateforme Vanilla sous réserve de bugs mineurs. 4
Restore the appliance (Restauration de l'application) Virtual Box Start your Virtual Box background.(1) Import the Vanilla appliance ova file : File, Import Virtual appliance.(2) Select the.ova file and run the restore step.(3) Démarrez votre socle Virtual Box.(1) Importez l'application Vanilla : Fichier, Importer application virtuelle.(2) Sélectionnez le fichier.ova et démarrez la phase de restauration.(3) 5
Network configuration (Configuration réseau) Your Vanilla VirtualBox is now created. Click on it (1) and click on the 'Configuration' button.(2) Go to the 'Network' tab and choose the right interface for the connection (bellow 'Acces by bridge' field). Click on OK in order to validate.(3) Votre Virtual Box Vanilla est maintenant crée. Cliquer sur cette dernière (1) puis cliquer sur 'Configuration'.(2) Rendez-vous à l'onglet 'Réseau' puis choisissez la bonne interface pour la connexion (sous le champ 'Accès par pont'). Cliquez sur OK afin de valider la définition.(3) 6
Get the IP (Récupération de l'ip) Start the Virtual Box thanks to the 'Start' button.(1) A new window will appear.(2) Wait for the line 'login as :' to be printed.(3) Log in with : root as login and root as password. Wait for the line 'root@debian...' to be printed.(4) Enter 'ifconfig' in order to get the IP of your virtual box.(5) Démarrer votre virtual Box grâce au bouton 'Démarrer'.(1) Une nouvelle fenêtre apparaît.(2) Attendez l'inscription de la ligne 'login as :'.(3) Renseignez 'root' en tant que login et 'root' en tant que mot de passe. Attendez l'inscription de la ligne 'root@debian...'.(3) Entrez 'ifconfig' en tant que commande afin de récupérer l'ip attribué à votre virtual box.(4) 7
By default the network interface is configured to be running with the IP 192.168.1.122. We will see how to configure it in your own network configuration. Par défaut, la virtualbox est définie afin de récupérer l'ip 192.168.1.122. Nous allons décrire les étapes qui permettent de configurer votre IP sur votre propre réseau. 8
Configure your network interface thanks to the /etc/network/interfaces file. Enter : nano /etc/network/interfaces Then modify the file in order to point at your new IP address. Enter : rm -rf /etc/udev/rules.d/70-persistent-net.rules Enter : ifdown eth0 then, ifup eth0 Then restart your server (the virtualbox) Enter : ifconfig after the server restarted in order to check your new configuration. Configurer votre interface réseau grâce au fichier /etc/network/interfaces. Entrer : nano /etc/network/interfaces Puis modifier le fichier afin de faire pointer sur votre nouvel IP. Entrer : rm -rf /etc/udev/rules.d/70-persistent-net.rules Entrer : ifdown eth0 puis ifup eth0 Puis redémarrer votre serveur (la machine virtualbox) Entrer ifconfig après avoir redémarré votre serveur afin de vérifier votre nouvelle configuration. 9
Configuration of Vanilla (Configuration de Vanilla) We will configure the Vanilla server in order to deploy it in your network environnement. Edit the /vanilla/4.2/beta/vanilla-tomcat-mysql-4.2_beta/vanilla-conf/vanilla.properties file. Change the following items : #the VanillaRuntime Url bpm.vanilla.server.url=http://192.168.1.122:8080/vanillaruntime bpm.vanilla.server.root.login=system bpm.vanilla.server.root.password=system bpm.vanilla.server.local.protocole=http:// bpm.vanilla.server.local.ip=192.168.1.122 bpm.vanilla.server.local.port=8080 bpm.vanilla.server.local.context=/vanillaruntime into #the VanillaRuntime Url bpm.vanilla.server.url=http://your-ip:8080/vanillaruntime bpm.vanilla.server.root.login=system bpm.vanilla.server.root.password=system bpm.vanilla.server.local.protocole=http:// bpm.vanilla.server.local.ip=your-ip bpm.vanilla.server.local.port=8080 bpm.vanilla.server.local.context=/vanillaruntime and bpm.vanilla.webapps.url.faweb=http://192.168.1.122:8080/freeanalysisweb bpm.vanilla.webapps.url.fmloaderweb=http://192.168.1.122:8080/fmloaderweb bpm.vanilla.webapps.url.fwr=http://192.168.1.122:8080/freewebreport bpm.vanilla.webapps.url.fmuserweb=http://192.168.1.122:8080/fmuserweb bpm.vanilla.webapps.url.fdweb=http://192.168.1.122:8080/freedashboardweb into bpm.vanilla.webapps.url.faweb=http://your-ip:8080/freeanalysisweb bpm.vanilla.webapps.url.fmloaderweb=http://your-ip:8080/fmloaderweb bpm.vanilla.webapps.url.fwr=http://your-ip:8080/freewebreport bpm.vanilla.webapps.url.fmuserweb=http://your-ip:8080/fmuserweb bpm.vanilla.webapps.url.fdweb=http://your-ip:8080/freedashboardweb 10
Nous allons configurer le serveur Vanilla afin de le dépoyer dans votre environnement réseau. Editer le fichier /vanilla/4.2/beta/vanilla-tomcat-mysql-4.2_beta/vanilla-conf/vanilla.properties. Changer les éléments suivants : #the VanillaRuntime Url bpm.vanilla.server.url=http://192.168.1.122:8080/vanillaruntime bpm.vanilla.server.root.login=system bpm.vanilla.server.root.password=system bpm.vanilla.server.local.protocole=http:// bpm.vanilla.server.local.ip=192.168.1.122 bpm.vanilla.server.local.port=8080 bpm.vanilla.server.local.context=/vanillaruntime into #the VanillaRuntime Url bpm.vanilla.server.url=http://votre-ip:8080/vanillaruntime bpm.vanilla.server.root.login=system bpm.vanilla.server.root.password=system bpm.vanilla.server.local.protocole=http:// bpm.vanilla.server.local.ip= VOTRE-IP bpm.vanilla.server.local.port=8080 bpm.vanilla.server.local.context=/vanillaruntime and bpm.vanilla.webapps.url.faweb=http://192.168.1.122:8080/freeanalysisweb bpm.vanilla.webapps.url.fmloaderweb=http://192.168.1.122:8080/fmloaderweb bpm.vanilla.webapps.url.fwr=http://192.168.1.122:8080/freewebreport bpm.vanilla.webapps.url.fmuserweb=http://192.168.1.122:8080/fmuserweb bpm.vanilla.webapps.url.fdweb=http://192.168.1.122:8080/freedashboardweb into bpm.vanilla.webapps.url.faweb=http://votre-ip:8080/freeanalysisweb bpm.vanilla.webapps.url.fmloaderweb=http://votre-ip:8080/fmloaderweb bpm.vanilla.webapps.url.fwr=http://votre-ip:8080/freewebreport bpm.vanilla.webapps.url.fmuserweb=http://votre-ip:8080/fmuserweb bpm.vanilla.webapps.url.fdweb=http://votre-ip:8080/freedashboardweb 11
Start Vanilla (Démarrage de Vanilla) Manipulations Enter '/vanilla/4.2/beta/vanilla-tomcat-mysql-4.2_beta/' in order to go the Vanilla tomcat folder. (1) Enter './start-vanilla.sh start' in order to start Vanilla application.(2) Entrez '/vanilla/4.2/beta/vanilla-tomcat-mysql-4.2_beta/' afin de vous rendre dans le dossier du tomcat Vanilla.(1) Entrez './start-vanilla.sh start' afin de démarrer l'applicatif Vanilla.(2) 12
Configuration We will modify the default repository URL in order to match the new server ip. Nous allons modifier l'url par défaut du référentiel afin de la faire pointer sur l'ip du nouveau serveur. Repository The default repository given with the Vanilla plaform is : http://localhost:8080/birepository. Open the 'Repositories Administration' view of EnterpriseService. Modify the URL field of your repository (if necessary) and click on Update. 13
Référentiel Le référentiel par défaut fourni dans la plateforme Vanilla est : http://localhost:8080/birepository. Rendez-vous dans la vue 'Repositories Administration' du module EnterpriseServices. Modifiez ici le champ URL de votre référentiel (si nécessaire) puis cliquez sur Update. 14
Access Vanilla platform (Accéder à Vanilla) Url access and connection (Url d'accès et connexion) Once your server started, run a Web browser and enter : http://serverip:8080/vanilla The welcome page of the Vanilla platform will be opened.(1) Connect into Vanilla thanks to 'system/system' user login/password. Validate with OK on the groups and repositories selection page. The main page of the Vanilla Web Portal is opened.(2) Une fois votre serveur démarré, exécutez un navigateur Web et entrez : http://serverip:8080/vanilla La page d'accueil de la plate-forme Vanilla est ouverte.(1) Connectez vous à Vanilla grâce à 'system/system' comme login/mot de passe. Validez par OK la seconde fenêtre de sélection des groupes et référentiels. La page principale du portail Web Vanilla est ouverte.(2) 15
16
Run the samples (Consultation des exemples) The cubes, dashboards and reports in the repository can be ran thanks to a double-clic on it. Please read the 'WebPortal' documentation in order to get more information. Les cubes, tableaux de bord et rapports présents sur le référentiel peuvent être consultés grâce à un double-clic sur l'élément. Veuillez lire la documentation 'Portail Web Vanilla' pour plus d'informations. 17
18
Shutdown (Eteindre l'application) In order to shutdown Vanilla : Enter : ps aux grep java and get the processid associated. Enter : kill -9 processid In order to shutdown the virtualbox server, click on the red cross (top right) and select 'Send interruption signal'.(1) The server will shutdown. Afin de stopper la plate-forme Vanilla : Entrer : ps aux grep java and récupérer le processid associé. Enter : kill -9 processid Afin d'éteindre l'application, cliquez sur la croix rouge (haut droite) et sélectionnez 'Envoyer le signal d'extinction'.(1) Le serveur va s'éteindre. 19