ELisA - install and configure the logbook for your project

ELisA logbook is developed and maintained by the ATLAS TDAQ Controls & Configuration group. The logbook application was initially created for the ATLAS experiment operations followup, as a replacement of the elog logbook. The logbook consists of a web user interface, a REST API and a set of client libraries to access the REST API functionalities. These client libs are part of the ATLAS TDAQ sw release.

Get in contact

Alina Corso-Radu (University of California Irvine) alina.radu@cern.ch

Firstly, please get in contact with the developer if you are interested in using ELisA.

The logbook developer is providing the application SW, maintenance, and further updates. Support for configuration setup is provided as well.

The client is responsible for host installation, setup and maintenance.

The client email is added to the egroup: elisa-logbook-admins@cernNOSPAMPLEASE.ch to be informed about new RPMs available into the repository, current issues, or problems.

Requirements

Install a machine with linux CC7 as operating system. Add Apache or another web server.

Add Java-1.8 (at least)

Installation path

ELisA logbook is installed in /var/local/ and is running under 'logbook' user (created automatically by the RPM).

The log files are in /var/local/elisa/logs/

The application is installed on port 8090 by default. The port number can be changed via configuration.

Logbook URL: http://your.host:8090/elisa/

RPM installation

  • Add the TDAQ repository to your host (/etc/yum.repo.d/tdaq-elisa.repo)
[tdaq-elisa]
name=TDAQ ELisA logbook
baseurl=http://atlas-tdaq-sw.web.cern.ch/atlas-tdaq-sw/yum/tdaq/elisa
enabled=1
gpgcheck=0

You can choose if you want to update the RPM on your host as soon as a new version is available in the TDAQ repository or to lock the application to a given version.

  • Install the rpm using your preferred utility, for example yum install. The user 'logbook' and the directory path are created. All necessary files are installed. The service 'elisa' is started automatically.
  • Check and change, if needed, the path to your installed java (JAVA_HOME) in /var/local/elisa/elisa.conf
  • Check the configuration you want to use in /var/local/elisa/elisa.conf file. The default configuration (profile) is "test". This configuration is using an Oracle INTR database available at CERN.

Different profiles are available already for ORACLE and Atlas.MySQL.

test = ORACLE INTR test
prod = ORACLE ATONR ATLAS
atlr = ORACLE ATLR ATLAS
int8r = ORACLE INT8R test
pddp = ORACLE PDBR ProtoDUNE-DP
pdsp = ORACLE PDBR ProtoDUNE-SP
epdtdi = ORACLE DevDB11 test
epdtdi-gral = ORACLE PDBR EPDTDI
epdtdi-piquet = ORACLE PDBR EPDTDI
t2k = ORACLE PDBR test EPDTDI
mysql-local = MySQL local server (mariadb)
mysql-dbod = MySQL DBOnDemand ADC

Change line PROFILE="spring.profiles.active=test" if you choose another profile. Restart the service, in this case, using systemctl restart elisa. The restart usually takes a few sec.

  • If you need to overwrite properties of an existing profile:
- create subdir /var/local/elisa/config

- copy into /var/local/elisa/config the corresponding profile file which is named application-'profile'.properties from GIT here.

- modify parameter values. Do not modify the file name.

- restart elisa with systemctl start elisa

NB: your locally modified file elisa.conf will not be overwritten if the RPM is updated.

  • If none of the existing profiles is suitable for your configuration, please contact the developer.
  • Atlas.ELisA is accesible at URL: http://your.host:8090/elisa

Manual installation

Required files:

  • elisa.jar
  • src/main/webapp/WEB-INF/jsp/*.jsp
  • elisa.conf
  • elisa.service

Get jsp files, elisa.conf and elisa.service from git: https://gitlab.cern.ch/atlas-tdaq-software/elisamerge/

Download elisa.jar from http://vm-atlas-tdaq-cc-01.cern.ch:8585/repository/internal/atlas/tdaq/elisa/1.0.0/ (Contact the developer to check the last version or if you do not have access)

You need root access for the following steps.

- create user 'logbook'

useradd logbook
- create directory elisa in your installation area
cd /var/local/
mkdir elisa
cd elisa
- copy needed files in /var/local/elisa
cp -p /your/path/to/download/elisa.jar .
cp -pR /your/path/to/download/src .
cp -p /your/path/to/download/elisa.conf .
cp -p /your/path/to/download/elisa.service . 
- change ownership for all files to logbook
chown -R logbook:logbook *
- copy elisa.service file
cp elisa.service /etc/systemd/system/.
- change the path to your installed java, if needed, in elisa.conf

- check the configuration you need to use in elisa.conf. Check above for the available profiles

- change PROFILE="spring.profiles.active=test"

- start elisa service

systemctl start elisa

Authentication

Logbook operation is restricted to authenticated users only. Two authentication mechanisms are used by ELisA depending on the web application visibility: CERN Single-Sign-On (SSO) or authentication based on LDAP server.
  • CERN Single-Sign-On (SSO)
If the logbook will be accessed worldwide, CERN SSO is used for user's authentication. You should register your host (even external to CERN domain) with CERN SSO here: https://sso-management.web.cern.ch/. (NB: there is a new CERN SSO page here: https://application-portal.web.cern.ch/).

Add the following request headers to your Apache configuration

RequestHeader add X-Forwarded-login  %{ADFS_LOGIN}e
RequestHeader add X-Forwarded-fullname  %{ADFS_FULLNAME}e
RequestHeader add X-Forwarded-email  %{ADFS_EMAIL}e
Once this is done, you can authenticate to ELisA via SSO.

  • LDAP-based
If the logbook visibility is restricted to a domain/project only (for example the application is available inside ATLAS Point1 only, or on GPN only), then using an LDAP server for user authentication is possible as well. LDAP configuration is done via application.properties file. Get in contact with the developer.

Logbook configuration

ELisA is storing the logbook configuration and messages into a database. You have a choice between two database technologies: ORACLE and MySQL. Get in contact with the developer to get a minimal database configuration to start with.


Major updates:
-- AlinaCorso - June 2020

Responsible: Main.unknown
Last reviewed by: Never reviewed

Edit | Attach | Watch | Print version | History: r7 < r6 < r5 < r4 < r3 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r7 - 2020-06-05 - unknown
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    Atlas All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback