NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Building and Installing using Jenkins

  1. A new release will be tagged in the github project https://github.com/ncievs/nci-protege5.git
  2. Navigate to Jenkins at https://evs-jenkins.nci.nih.gov/jenkins/job/_default/job/_lower/job/_Protege/
  3. Choose protege_build > Build with Parameters and select the appropriate tag in the BRANCH_OR_TAG selection box and click Build
  4. Review the Console Output for any errors
  5. For Dev, choose protege_deploy_dev > Build with Parameters. You should be presented with the same tag. Click Build
  6. Review the Console Output for any errors
  7. Check the protege dev server and see that the /local/content/protege/protege-server and protege-desktop have been updated
  8. Confirm the service has started by checking /local/content/protege/logs/protserv-console.txt for "Admin server has started at port 9091"

Manual Build

Building a new Protege version on Dev using Ant

  1. A new release will be tagged in the github project https://github.com/ncievs/nci-protegeprotege5.git
  2. Clone the new release into your local build directory.a new directory in /local/project.  "git clone https://github.com/ncievs/nci-protege5.git nci-protege-V<tag>"
  3. The clone will create a directory "nci-protege5".   Enter into the scripts subdirectory "cd nci-protege-protege5V<tag>/scripts/"
  4. Run the build script, passing in the version number "./build.sh versionTag <tag> ncievs >> build.log".
  5. Review the output for errors or build failures: "cat build.log | grep FAILURE"
  6. Check the structure of the build.  The following folders and files should be present under <build-location>/nci-protege5/scripts/nci-protege5
    • binaryowl
    • explanation-workbench
    • metaproject
    • nci-protege_<date>.tar.gz
    • nci-protege_<date>.zip
    • owlapi
    • pellet
    • protege
    • protege-clientprotege-server
    • run-protege.sh
    • run-server.sh

Installing the server build

  1. Navigate to the running instance of protege, likely in on Dev this is /local/content/protege/scripts/Shutdown the explanation server:  “./pellet server --config /local/content/protege/protegedata/configdata/server.properties stop"
  2. Shutdown the protege server: "./shutdown.sh" 
  3. Archive the previous version of the services, which are these 3 directories:explanationserver2 directories in /local/content/protege:
    • protegeserver
    • protegedesktop
  4. Copy the new protegeserver into the service directory "cp -r <build-location>/nci-protege5/scripts/nci-protege5/protege-server/target/server-distribution/server /local/content/protege/protegeserver"
  5. Copy the new protegedesktop into the empty desktop directory "cp -r 

    <build-location>/nci-protege5/scripts/nci-protege5/protege/protege-desktop/target/protege-5.1.1<version>-SNAPSHOT-platform-independent/Protege-5.1.1<version>-SNAPSHOT /local/content/protege/protegedesktop"Create a new explanationserver directory "mkdir explanationserver"

  6. Untar the explanationserver tarball to the server folder 
    • Unpack "tar -xf <build-location>/nci-protege5/scripts/nci-protege5/pellet/distribution/target/*.gz /local/content/protege/pellet-2.4.0-SNAPSHOT" 
    • rename "mv pellet-2.4.0-SNAPSHOT explanationserver"
  7. Remove previously compiled reasonings from the protegedata/pelletdata folder "rm -rf /local/content/protege/protegedata/pelletdata/*"
  8. From the /local/content/protege/scripts directory start the protege server: "./run-background.sh".  The server should start almost immediately
  9. Confirm the service has started by checking /local/content/protege/logs/protserv-console.txt for "Admin server has started at port 9091"
  10. Start the explanation server “./pellet server --config /local/content/protege/protegedata/configdata/server.properties start".  The service can take half an hour or more to start.
  11. Confirm the service has started by checking /local/content/protege/logs/pellet-console.txt for "Listening at: https://<server>.nci.nih.gov:18080"


Shutdown/Startup of Services

There are two services supporting Protege - the main protege server and the explanation server.  The main server should be shutdown before the explanation server.  When starting, the explanation server should be started before the protege server.

Shutdown

  1. Navigate to /local/content/protege/scripts/
  2. To shutdown the protegeserver: "./shutdown.sh" 
  3. To shutdown the explanation server:  “./pellet server --config /local/content/protege/protegedata/configdata/server.properties stop"

Startup

  1. Navigate to /local/content/protege/scripts/
  2. To startup protege server: "./run-background.sh"
  3. Do "tail ../logs/protserv-console.txt" to check that the protege server is running.
  4. Server is started when you see "Admin server has started at port 9091"
  5. To startup explanation server: “./pellet server --config /local/content/protege/protegedata/configdata/server.properties start"
  6. Do "tail ../logs/pellet-console.txt" to check that the explanation server is running.
  7. Explanation server is started when you see "Listening at: https://<server>.nci.nih.gov:18080"