X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Fman_configuration.html;h=c345b9b60afab953253f8e46ce8b85ff4de7884f;hb=85f830bbd51a7277994bd4233141016304e210c9;hp=5122e088f04b5ec6a59776d995521c90211759af;hpb=b0423691d9a44eae86799ad242c4fea58f9acd8d;p=jabaws.git diff --git a/website/man_configuration.html b/website/man_configuration.html index 5122e08..c345b9b 100644 --- a/website/man_configuration.html +++ b/website/man_configuration.html @@ -15,11 +15,12 @@
+ +
Home @@ -32,12 +33,15 @@ Server
Configuration
CMD Client + Usage Statistics Accessing
JABAWS
+ JABAWS Development
Download Contact Us -Barton Group +Usage Statistics +Barton Group
@@ -57,12 +61,11 @@ with Mafft
  • Limiting the size of the job accepted by JABAWS Server
  • Using a different version of the alignment program with JABAWS
  • Load balancing
  • -
  • Reviewing JABAWS configuration via web browser
  • Testing JABA Web Services
  • JABAWS requests logging
  • JABAWS internal logging
  • -
  • Monitoring JABAWS
  • JABAWS War File Content
  • +
  • JABAWS Usage Statistics
  • JABAWS Configuration

    There are three parts of the system you can configure. The local @@ -127,8 +130,8 @@ environment variables have to be defined. They tell the cluster engine where to find DRMAA libraries. These variables should be defined when the web application server starts up, e.g.

    -

    SGE_ROOT=/gridware/sge
    - LD_LIBRARY_PATH=/gridware/sge/lib/lx24-amd64

    +

    SGE_ROOT=/gridware/sge
    + LD_LIBRARY_PATH=/gridware/sge/lib/lx24-amd64

    Finally, do not forget to configure executables for the cluster execution, they may be the same as for the local execution but may @@ -258,27 +261,6 @@ By default limits are set well in excess of what you may want to offer to the u

    JABAWS supplied with binaries and source code of the executables which version it supports. So normally you would not need to install your own executables. However, if you have a different version of an executable (e.g. an alignment program) which you prefer, you could use it as long as it supports all the functions JABAWS executable supported. This could be the case with more recent executable. If the options supported by your chosen executable is different when the standard JABAWS executable, than you need to edit ExecutableNameParamaters.xml  configuration file.

    Load balancing

    If your cluster is busy and have significant waiting times you can achieve a faster response by allowing the server machine to calculate small tasks and the reserve the cluster for bigger jobs. This works especially well if your server is a powerful machine with many CPUs. To do this you need to enable and configure both the cluster and the local engines. Once this is done decide on the maximum size of a task to be run on the server locally. Then, edit "# LocalEngineExecutionLimit #" preset in <ServiceName>Limits.xml file accordingly. JABAWS server then will balance the load according to the following rule: If the task size is smaller then the maximum task size for local engine, and the local engine has idle threads, then calculate task locally otherwise submit the task to the cluster.

    -

    Reviewing JABAWS configuration via web browser

    -

    Access to configuration files is prohibited to any unauthorized users by means of security constrain defined in web application descriptor file. There is a special user role called admin who can access these files. This comes handy if you would like to keep an eye on any of the task outputs stored in jobsout, or would like to view the configuration files. To access the configuration files add admin user into your application server. The way you do it depends on where you would like the user passwords to come from and your web application server. If you use Tomcat, then the simplest way is to use Tomcat Memory Realm which is linked to a plain text configuration file. To define the user in Tomcat server add an entry in conf/tomcat-user.xml file. <role rolename="admin"/>
    - <user username="admin" password="your password here " roles="admin"/>

    -

    Once this is done make sure the servlet that returns the web application directory listings is enabled. Look in the <tomcatroot>/conf/web.xml file for the following <param-name>listings</param-name>
    - <param-value>true</param-value>

    -

    The whole section that defines default listing servlet is below

    -

    <servlet>
    - <servlet-name>default</servlet-name>
    - <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
    - <init-param>
    - <param-name>debug</param-name>
    - <param-value>0</param-value>
    - </init-param>
    - <init-param>
    - <param-name>listings</param-name>
    - <param-value>true</param-value>
    - </init-param>
    - <load-on-startup>1</load-on-startup>
    - </servlet>
    -

    -

    These listings are read only by default.

    Testing JABA Web Services

    You can use a command line client (part of the client only package) to test your JABAWS installation as described here. If you downloaded a JABAWS @@ -336,9 +318,6 @@ class="hightlight">log4j.properties and uncomment section of

    If you would like to know who is using your services, you might want to enable Tomcat request logging.

    -

    Monitoring JABAWS

    -

    JABAWS stores cluster task ids for all tasks which were run on the cluster. Using cluster ids the detailed statistics can be extracted from cluster accounting system. Due to the fact that each cluster supported by JABAWS have different accounting system it was not possible to provide ready to use statistics.
    - For the local execution the starting and finishing time in nano seconds can be found in STARTED and FINISHED files respectively. In time we will provide the tools to extract execution time statistics, so keep the content of your working directory ready!

    JABAWS War File Content

    @@ -409,10 +388,9 @@ class="hightlight">log4j.properties and uncomment section of
    images referenced by html pages
    -

     

    -