Skip to content

site_plugins.md

Latest commit

 

History

History
80 lines (46 loc) · 3.41 KB

site_plugins.md

File metadata and controls

80 lines (46 loc) · 3.41 KB

Site Plugins

The customization of FragMAXapp for deployment to different facilities is achieved via the site-plugins architecture.

Architecture

A site-plugin is an python package which provides a SitePlugin class. The application will consult an instance of the class, when site specific functionality is required.

The provided SitePlugin class must implement all fields and methods defined in fragview.sites.plugin.SitePlugin class. The application will access class's fields and methods to fetch site specific information and invoke site specific behaviour.

Some of the SitePlugin's methods must return objects that implement other classes from the fragview.sites.plugin package.

For example the SitePlugin.get_hpc_runner() method must return an object that implements all methods of the fragview.sites.plugin.SitePlugin.HPC class. This HPC runner object will be used for running compute heavy jobs, in the site specific way.

For full details of all classes that must be implemented, see the fragview.sites.plugin documentation.

Site Plugin Configuration

The site-plugin that will be used by the application is configured by creating local_site.py file in the root of the application. This file must define SITE variable, which is a string representation of the site-plugin to load. For example, following file configures to use MAXIV site-plugin:

SITE = "MAXIV"

The 'deploy/local_site.py-maxiv' file in this repository, is an example on how to select "MAXIV" site-plugin.

Currently supported sites are "MAXIV" and "HZB".

Loading of Site Plugins

The canonical name of the site-plugin that will be used by the application is read from local_site.SITE variable. See the above on how to configure that variable.

The canonical name is then converted to lower cases and expanded to a full python package name by prepending the "fragview.sites." string. The full package name then used to instantiate the SitePlugin class from that package.

For example, if SITE is set to "MAXIV", the application will load the fragview.sites.maxiv python package. From the loaded fragview.sites.maxiv package the SitePlugin class will be instantiated.

Available Site Plugins

Currently the FragMAX app have implementation of two site-plugins, for "MAXIV" and "HZB" sites.

MAX IV Site Plugin

The MAXIV site plugin is used for deployment at MAX IV Laboratory.

Authentication

The MAXIV plugin uses DUO/ISPyB credentials for authentication. Authentication with DUO/ISPyB credentials is implemented by fragview.auth.ISPyBBackend authentication back-end. The ISPyBBackend will use ISPyB REST API to check the login credentials. See the fragview.auth.ISPyBBackend module's documentation for details on how to confgure ISPyB authentication.

HZB Site Plugin

The HZB site plugin is used for deplyment at Helmholtz-Zentrum Berlin facility.

Authentication

The HZB plugin uses stand-alone FragMAX user accounts, implemented by fragview.auth.LocalBackend authentication back-end. The LocalBackend stores user names and password in the application's django database.

To manage the local accounts use the manage.py commands.

User can be added with manage.py add command:

./manage.py adduser <user_name>

The command will prompt for the password.

To change an existing user's password use manage.py changepassword command:

./manage.py changepassword <user_name>

The command will prompt for the new password.