Jinstall-3.3.1

Mis à jour par Xavier Masia · le 07/12/2023 à 09:59 · Version 1.34
Déposé par · le 21/12/2020 à 16:56
Archive ZIP (430,38 Mo)

Jinstall is an automatic procedure installing the application components of JPlatform:

  • jplatform : the JPlatform application
  • httpd : the Apache HTTPD front-end
  • postgres_jplatform : the PostgreSQL database dedicated to JPlatform
  • jodconverter : the JODConverter server
  • horizon : the Horizon messaging system

This procedure is based on RedHat Ansible, a tool that automates configuration management and application deployment.

Prerequisites

Operating systems

Distributions supported by the scripts.

  • Debian : 10, 11
  • Ubuntu : 20.04, 22.04
  • Red Hat Enterprise Linux : 8, 9
  • Rocky Linux : 8, 9

Jinstall Win is the automatic installation procedure dedicated to Microsoft Windows systems.

Utilities

The package(s) to install via the package manager

  • python3: version 3.5 or higher

Access

  • SSH
  • user account with sudo privileges
  • Internet (package manager)

Installation procedure

In the case of an installation on several instances (front-end, application, services), the entire installation procedure is to be performed on 1 instance only.

Remote authentication

This step is only necessary if you are installing on several instances.

To facilitate and automate the remote authentication, we will generate private/public keys for each remote machine.

(If ever done) Generate a private/public key :

ssh-keygen

Then authenticate to create an SSH key with the remote machine (repeat for each remote instance) :

ssh-copy-id -p 22 ssh_user@server.example.com

You can test the authentication :

ssh ssh_user@ssh_user@server.example.com python3 --version

The expectation is no password prompt.

Get the installation scripts

Télécharger l'archive de Jinstall depuis Community.

Download the Jinstall archive from Community.

Extract the archive in a dedicated directory :

mkdir ~/Jinstall
unzip Jinstall-X.Y.Z.zip -d ~/Jinstall

Restrict access rights to the owner of the directory :

chmod 700 ~/Jinstall

Move into the directory:

cd ~/Jinstall

Install dependencies

Python packages for installation will be installed via PyPI in a virtual environment (can be removed at the end of the installation).

On Debian & Ubuntu, install these components :

sudo apt install python3-pip python3-venv -y

Create a virtual environment :

python3 -m venv venv_jinstall

Place yourself in the environment :

source venv_jinstall/bin/activate

The appearance of the terminal has been changed accordingly.

Update pip :

python3 -m pip install --upgrade pip

Install dependencies :

python3 -m pip install -r requirements.txt

Identify the components to be deployed

Adapt the installation variables

You can customize the installation architecture (directory, memory, URL, ...).

Put in the files directory your WAR to deploy and your SSL certificates, to have a HTTPS URL.

Edit the files associated to the different components you want to deploy:

  • group_vars/all.yml : common / general file
  • group_vars/horizon.yml : Horizon messaging
  • group_vars/httpd.yml : Apache frontend
  • group_vars/jplatform.yml : JPlatform application
  • group_vars/jodconverter.yml : document conversion server
  • group_vars/postgres_jplatform.yml : PostgreSQL database for JPlatform

Declare the remote servers

Identify the FQDN (or IP) of the remote servers where to perform the installation.

Installation architecture:

  • on 1 node: edit the inventory_local.yml file
  • on several nodes (e.g. application VM and service): edit the inventory_remote.yml file.

Then rename this file to inventory.yml.

Test the configuration

Let's check that the accesses are well established.

Run the ping test command:

ansible all -i inventory.yml -m ping

The expected result is a ok received successfully for each remote server.

Deployment of applications

Install software components. You will be prompted for the elevation of privileges password (sudo):

ansible-playbook -i inventory.yml playbooks/install.yml -K

The installation must end without failed operations. Example:

PLAY RECAP ****************************************************************************************************
example.com: ok=123 changed=78 unreachable=0 failed=0 skipped=34 rescued=0 ignored=0

After installation

Exit the virtual environment:

deactivate

The appearance of the terminal returns to normal.

Remove the virtual environment:

rm -rf venv_jinstall

Also remove the Jinstall directory:

cd ~
rm -rf ~/Jinstall

Tips & Tricks

Installed services

After installation here are the available services.

Software Service Status after installation Information
Apache HTTPD [apache2 | httpd] started systemctl status [apache2 | httpd]
Tomcat JPlatform jplatform not started systemctl status jplatform
Tomcat JOD jodconverter not started systemctl status jodconverter
LibreOffice libreoffice not started systemctl status libreoffice
PostgreSQL postgresql started systemctl status postgresql

The Apache HTTPD service name is apache2 for Debian & Ubuntu and httpd for RedHat & RockyLinux.

Handy commands

Commands to run on remote servers.

Start services (not yet started):

sudo systemctl start jplatform jodconverter libreoffice

View the JPlatform logs:

sudo -u jplatform tail -f /opt/jalios/app/tomcat/jplatform/webapps/ROOT/WEB-INF/data/logs/jcms.log

Install on multiple environments

See How to build your inventory

Links

Télécharger

3 votes :

19 commentaires

Jean-Charles FELICITE
le 09/11/2021 à 17:03
#1

Bonjour, 
Ce script permet-il des installations également du DEBIAN 11 ou seulement DEBIAN 10?
JC

Loïc Lesport

1 vote :

le 09/11/2021 à 17:35
#2

Bonjour,

Non cette version n'est pas compatible avec une Debian 11.

Néanmoins, une nouvelle version est en cours de release la supportant et mettant à jour les composants applicatifs (Tomcat, Java JDK).

Cordialement.

Jean-Charles FELICITE

1 vote :

le 09/11/2021 à 18:15
#3

OK Merci pour cette réponse rapide ;-)

Jean-Charles FELICITE
le 21/03/2022 à 14:58
#4

Bonjour Loïc Lesport 

Je dois modifier le script ansible car la création d'utilisateur doit se faire avec les attributs suivants 

useradd -m -g groupeadmin -G allowssh,seelogs -d /home/username username

Hélas je ne connais pas Ansible, comment puis-je indiquer ces attributs spécifiques dans le script d'installation?

Merci

Jean-Charles FELICITE
le 21/03/2022 à 15:50
#5

Réponse à moi-même, j'ai fait ceci 

vi ~/Jinstall3/playbooks/roles/jalios.init/vars/RedHat.yml

J'ai rajouté les groupes en gras ci-dessous

groups_sudo: wheel,allowssh,seelogs,groupeadmin
package_xz: xz
package_cron: cronie

Cela vous parait-il correct?

Le reste est inchangé car déjà pris en compte.

Jean-Charles FELICITE
le 21/03/2022 à 16:59
#6

Re-réponse à moi-même : j'ai tout bon 😉

Loïc Lesport
le 21/03/2022 à 18:35
#7

Bonjour Jean-Charles FELICITE ,

Je comprends que vous avez besoin de rajouter de nouveaux groupes à l'utilisateur de devops qui est créé.

Une fois l'installation finie, le compte reste modifiable donc vous pourriez le faire via un usermod.
Ou alors au préalable, vous pouvez créer le compte et l'utiliser lors de l'installation (il ne sera pas recréé).

Sinon si vous souhaitez faire la modification lors de l'install, c'est bien une manière de le faire.

Jean-Charles FELICITE
le 06/04/2022 à 11:11
#8

Bonjour Loïc Lesport 

D'après votre documentation, le script permet une installation sur RedHat version 8, j'ai pu la tester cela fonctionne parfaitement.
Cependant ImageMagick ne s'installe pas car le package n'est plus disponible depuis RedHat8, il a été remplacé par GraphicsMagick

Il faudrait donc prévoir une modification du script Ansible sur ce point, est-ce prévu?
Si j'install GraphicsMagick sur un environnement JPlatform est-ce que le module de génération des aperçus pourra focntionner en remplaçant les lignes de commandes? 

Cordialement,

Jean-Charles FELICITE
le 03/05/2022 à 10:35
#9

Bonjour

Bon pas de réponse sur mon précédent commentaire. 

J'ai une demande, serait-il possbile de variabiliser le chemin de contexte de l'application svp, plutôt que de mettre {{ JALIOS_HOME }}/app/tomcat/jplatform/webapps/ROOT il serait interessant de pouvoir changer le contexte ROOT en autre chose.

Certains de nos clients ont soit plusieurs applis sur un serveur tomcat, soit souhaite avoir un contexte nominatif pour bien identifier par exemple la version de la webapp à la lecture du contexte monappli10SP5 ou monappli10SP2.

J'ai été obligé de modifier les fichiers suivants :
/home/asi/Jinstall3/playbooks/roles/jalios.jplatform.addons/templates/backup-full.sh
/home/asi/Jinstall3/playbooks/roles/jalios.jplatform.addons/templates/backup-light.sh
/home/asi/Jinstall3/playbooks/roles/jalios.jplatform.configure/tasks/main.yml
/home/asi/Jinstall3/playbooks/roles/jalios.jplatform.war/tasks/main.yml

alors qu'il aurait été plus simple de spécifier une variable comme contexte avec par défaut la valeur ROOT que l'on pourrait modifier si besoin.

Merci beaucoup ;-)

Jean-Charles FELICITE
le 11/05/2022 à 09:13
#10

Bonjour,

Un autre problème rencontré sur l'installation de 2 environnements différents

(Média en accès restreint)  

J'ai résolu le problème en modifiant le fichier Jinstall3/playbooks/roles/jalios.jplatform.httpd/tasks/mail.yml de la manière suivante :

- name: if enabled, copy ssl CERT in '{{ httpd_jplatform_ssl_cert_directory }}'
  copy:
    src: '{{ inventory_dir }}/files/{{ HTTPD_JPLATFORM_SSL_CERT_CRT }}'
    dest: '{{ httpd_jplatform_ssl_cert_directory }}/{{ HTTPD_JPLATFORM_SSL_CERT_CRT | basename }}'
    force: yes
  when: httpd_jplatform_ssl_cert_provided

- name: if enabled, copy ssl KEY in '{{ httpd_jplatform_ssl_key_directory }}'
  copy:
    src: '{{ inventory_dir }}/files/{{ HTTPD_JPLATFORM_SSL_CERT_KEY }}'
    dest: '{{ httpd_jplatform_ssl_key_directory }}/{{ HTTPD_JPLATFORM_SSL_CERT_KEY | basename }}'
    force: yes
  when: httpd_jplatform_ssl_cert_provided
Loïc Lesport

1 vote :

le 12/05/2022 à 16:55
#11

Bonjour Jean-Charles FELICITE ,

Une nouvelle version a été publiée intégrant ces améliorations, correctifs et des mises à jour des versions de certains composants dont Java et Tomcat.

J'ai bien compris votre retour sur la proposition de supporter différents contexts pour Tomcat. Je le note pour une prochaine version.

Merci pour vos retours.

Jean-Charles FELICITE
le 13/05/2022 à 09:16
#12

Bonjour Loïc Lesport 

Merci pour cette nouvelle mise à jour.

La problématique avec ImageMagick et RedHat 8 a été également corrigée?
Beaucoup d'installations se font sous RehHat 8 aujourd'hui et ImageMagick n'est plus supporté, cela stop l'installation.

Loïc Lesport

1 vote :

le 13/05/2022 à 11:27
#13

Bonjour Jean-Charles FELICITE ,

Nous sommes passés par l'activation d'EPEL (Extra Packages for Enterprise Linux) pour l'installation d'ImageMagick.

GraphicsMagick est un fork d'ImageMagick qui devrait fonctionner pareillement, mais n'a jamais été expérimentée par la R&D.

Jean-Charles FELICITE
le 13/05/2022 à 11:43
#14

OK c'est noté, merci

Jean-Charles FELICITE
le 17/05/2022 à 10:51
#15

Bonjour, 

Pour un client j'ai eu besoin de lui donner toutes les urls à ouvrir sur le serveur à installer, il ne souhaite pas que le serveur soit exposé sur internet, comme il y a quelques appels à des urls externes j'ai du lister toutes les urls du script pour qu'il les ouvre de manière explicite le temps de l'installation.
L'url suitante https://api.adoptopenjdk.net/v2/ ne fonctionne pas car cette version est dépréciée https://api.adoptopenjdk.net/ 

Petite question supplémentaire, à quoi sert lean_delivery.java? Je ne connais pas.

Loïc Lesport

1 vote :

le 17/05/2022 à 18:50
#16

Bonjour,

Nous avons rencontré les mêmes contraintes avec des serveurs qui n'avaient accès qu'aux repository, c'est pourquoi l'installation se veut orienter offline au maximum.

Actuellement, lean_delivery est le seul rôle que nous récupérons de la communauté Ansible Galaxy : https://galaxy.ansible.com/lean_delivery/java (https://github.com/lean-delivery/ansible-role-java)
Ce rôle est très utile car il permet d'installer Java de différentes façons : choix de la distrib, zone d'installation…

Néanmoins, en passant par les playbooks d'installation, ce rôle est très "sous-utilisé" car l'installation de Java et pareillement Tomcat, Glowroot, ... les fichiers d'installations sont déjà présents dans l'archive Jinstall. (cf répertoire playbooks/files et leur déclaration playbooks/group_vars/all.yml)

Jean-Charles FELICITE

1 vote :

le 18/05/2022 à 09:04
#17

Super, merci Loïc Lesport  pour le retour.

Jean-Charles FELICITE
le 16/08/2022 à 16:03
#18

Bonjour Loïc Lesport 

Sur une nouvelle install qui n'a pas accès à internet, j'ai un nouveau problème

TASK [jalios.init : APT update] **********************************************************************************************************************************************************************************************************
fatal: [10.11.6.201]: FAILED! => {"changed": false, "msg": "Failed to update apt cache: unknown reason"}

Le script n'est donc pas full offline et cela bloque l'installation.

Dans ce bout de script jalios.init, je vois également l'installation de plusieurs utilitaires zip, unzip, etc, comment sont installés ces utilitaires en offline? Ce n'est pas possible? 

Loïc Lesport
le 16/08/2022 à 17:39
#19

Bonjour Jean-Charles FELICITE ,

En effet, une installation fulll-offline n'est pas possible et non supportée par les scripts.

Comme précisé précédemment, il est nécessaire d'avoir accès aux repositories de la distribution pour télécharger des utilitaires d'installation (zip, unzip, ...) mais aussi les composants applicatifs (apache, postgresql, ...)