Difference between revisions of "Category:NCBO Virtual Appliance"

From NCBO Wiki
Jump to: navigation, search
(made more OntoPortal, removed v1.0 reference to bottom)
(added Migrated category)
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== ONTOPORTAL VIRTUAL APPLIANCE v2.5 IS NOW AVAILABLE ==
+
[[Category:NCBO Virtual Appliance]]
 +
[[Category:Migrated to GitHub]]
  
The OntoPortal Virtual Appliance is the (rebranded) update of the BioPortal Virtual Appliance originally developed by the National Center for Biomedical Ontologies (NCBO). Our current Virtual Appliance software is based on NCBO's v4.x software infrastructure, including the use of an RDF triplestore as the primary data storage mechanism. Please read below as much of the Appliance workflow has changed.
+
'''''Most of this content has been moved!''''' Please find the new content for the 3.0 version of the Virtual Appliance at our new '''[https://ontoportal.github.io/administration/ OntoPortal Virtual Appliance Administration pages]'''.  
  
== Virtual Appliance Basics ==
+
== OntoPortal Virtual Appliance Version 3.0 is here! ==
  
The OntoPortal Virtual Appliance is a copy of the BioPortal software that you can run on your own Linux system. You have to install it following the instructions below, and upload your own ontologies (and/or copies of ours, if they are public).
+
We are pleased to softly announce our soft release of the OntoPortal Virtual Appliance version 3.0 (3.0.1, to be precise).
  
The OntoPortal Virtual Appliance image contains a pre-installed, pre-configured version of commonly-used open source software running on a Linux operating system.  
+
This release includes lots of new capabilities, one of which involves licensing. The good news is that you can download and get started with your Virtual Appliance right away—no need to wait for us to give you access to the right page.  
  
It is available as a VMWare Virtual Appliance OVF, as well as an Amazon Web Service AMI, and can be obtained by contacting us following the instructions under '''Getting Started''' below.
+
In order to do this, we had to implement licensing for BioPortal. Most users will find it trivial to obtain a free license, but for commercial users we are evaluating whether license fees could make BioPortal more sustainable.  
  
The following software is included on the image as of v2.4:
+
To learn more about the new OntoPortal Virtual Appliance release, visit our [https://ontoportal.github.io/administration/steps/getting_started/ Getting Started] page.
* Ontologies API (REST service)
+
You may also want to visit our [https://ontoportal.github.io/administration/ OntoPortal Administration Guide],
* Annotator
+
including the [https://ontoportal.github.io/administration/general/ General Introduction], [https://ontoportal.github.io/administration/general/licensing/ Licensing], and [https://ontoportal.github.io/administration/steps/ Installation] sections.
* Recommender
+
* OntoPortal Web User Interface (including UIs for ontology browse, Annotator and Recommender, ontology tree visualization, graph visualization with BioMixer, and widgets)
+
* API services
+
  
Please see below for how-to documentation for managing the software and running data population for Annotator and Recommender.
+
== Virtual Appliance Administration Documentation: Moved to GitHub ==
  
You may also want to visit the [[Virtual Appliance FAQ]] for additional information on the Virtual Appliance, as well as the other pages in this category (bottom of the page).
+
Our Administration documentation for the OntoPortal Virtual Appliance has been moved to the GitHub pages document at https://ontoportal.github.io/administration/.
  
== Getting Started ==
+
== Archival ==
=== VMWare Virtual Appliance ===
+
  
To obtain the VMWare Virtual Appliance, contact [mailto:support@bioontology.org OntoPortal Support] to initiate your request. You'll then be asked privately for your BioPortal account username, project goals, and reason for preferring the local installation.
+
=== OntoPortal Virtual Appliance v2.5 archive is available ===
* If you don't have a BioPortal account, you can create one at: http://bit.ly/bioportal-account.
+
* If your email doesn't include your organization or other means of identifying you, we will ask for that as well.
+
* The overall transaction can take a few working days, depending on resource availability.
+
  
The download is provided as a zip archive containing several files. One of these is an Open Virtualization Format (OVF) file that may need to be [http://www.bioontology.org/wiki/index.php/Virtual_Appliance_FAQ#How_can_I_use_the_OVF_image_with_my_virtualization_software.3F_.28VMWare.2C_VirtualBox.2C_KVM.2C_Xen.2C_etc.29 converted to work in your virtualization environment].
+
For previous registered users of the v2.5 OntoPortal Virtual Appliance, we maintain an archival copy of this software on our site. While we do not actively support this version because its libraries are outdated, we still make it available to those users who were previously authorized to use it. All new users of the Virtual Appliance should use Version 3 or later of the Appliance.
  
* You can supply the hostname (machine name) for the virtual machine during the deployment process. Documentation will refer to this hostname as 'example'.
+
The OntoPortal Virtual Appliance is the (rebranded) update of the BioPortal Virtual Appliance originally developed by the National Center for Biomedical Ontologies (NCBO). Our current Virtual Appliance software is based on BioPortal's v5.x software infrastructure, including the use of an RDF triplestore as the primary data storage mechanism.
* '''Change default passwords'''
+
** Operating System
+
*** Username: <code>root</code>
+
*** Password: password is prompted on the first boot
+
** OntoPortal Admin User
+
*** Username: <code>admin</code>
+
*** Password: <code>changeme</code>
+
  
=== Amazon AWS AMI ===
+
=== Even older archive ===
For users who want to run their OntoPortal instance on Amazon Web Services, an Amazon Machine Instance (AMI) is available on the [https://aws.amazon.com/marketplace/seller-profile/ref=dtl_pcp_sold_by?ie=UTF8&id=76948a46-8f8a-4a68-9a5c-3e3ff6b82d10 BioOntology AWS Market Place].  Please contact [mailto:support@bioontology.org OntoPortal Support] for more information.
+
 
+
Once the instance is running, enter the public DNS provided by Amazon into your browser to access BioPortal web interface.  The default application administrator is 'admin' and the initial password is the Instance ID.  You can also SSH to the machine using the username 'ec2-user' and your Amazon private key.
+
 
+
=== General Instruction ===
+
Virtual Appliance Web UI can be accessed at http://{ip_address_of_appliance}.  You can get IP address of the Appliance by using the following command in the terminal 'ip addr show eth0'
+
* Add an ontology using the OntoPortal Admin User here: http://{ip_address_of_appliance}/ontologies/new
+
** The ncbo_cron project is configured to automatically process new ontologies every 5 minutes (see [http://www.bioontology.org/wiki/index.php/Virtual_Appliance_FAQ#When_are_new_ontologies_parsed.3F documentation for enabling the scheduler]). This processing includes:
+
*** Parsing any new, unparsed ontologies
+
*** Calculating a set of metrics for these ontologies
+
*** Indexing these ontologies for use with search
+
*** Processing the ontology for use with the annotator
+
* REST services are available at the following location:
+
** http://{ip_address_of_appliance}:8080
+
** http://{ip_address_of_appliance}:8080/documentation
+
 
+
== System Requirements ==
+
The following requirements are for the resources that you devote to your Appliance instance, not for the machine running your host environment. For example, if you are using a system with 4GB of RAM, then you will need to devote all of that RAM to your guest Appliance.
+
 
+
'''Note: these requirements are for basic usage'''. System requirements will vary greatly depending on the size of the ontologies you work with, the number of ontologies in the system, and the number of concurrent requests that the system needs to respond to. It can also vary depending on how the ontologies are used. For example, the search index can be RAM-intensive but parsing ontologies can be CPU-intensive. You will need to experiment with your Appliance resource settings to find what works for your scenario.
+
 
+
* Minimum
+
** 2 CPU (2 GHz)
+
** 4GB RAM
+
** Hard disk space: 20GB
+
 
+
* Recommended for heavier usage
+
** 4 CPU (3 GHz)
+
** 8GB RAM  (or more depending on the size/number of ontologies)
+
** Hard disk space: 20GB (or more depending on number/size of ontologies)
+
 
+
== Image Format and Operating System Details ==
+
The OntoPortal Virtual Appliance image was created using the [http://www.vmware.com/appliances/getting-started/learn/ovf.html Open Virtualization Format], which should allow the machine to be used in a variety of environments.
+
 
+
The operating system is CentOS 6.9 64-bit running:
+
*Tomcat 6.0.26
+
*Solr 6.6
+
*Java 8
+
*MySQL 5.1.x
+
*Rails 4.2.x
+
*Ruby 2.3.6
+
*memcached
+
*redis 2.3.11
+
*nginx 1.12.1
+
*4store
+
*Passenger/Apache
+
 
+
 
+
The following applications use these services/runtime environments:
+
* Sinatra, Ruby, 4store, redis
+
** Ontologies API
+
** Annotator
+
** Recommender
+
* Rails, Ruby, memcached, mysql
+
** BioPortal Web User Interface (including ontology visualization, Flex widgets, biomixer, Annotator)
+
* Tomcat, Solr
+
** Search index
+
 
+
== Basic System Administration ==
+
* Most of our administration scripts and build environment assume that you will be running as the root user.
+
* We assume familiarity with basic CentOS Linux administration
+
* 2 text editors are originally installed: nano and vim
+
* All services required for OntoPortal Stack are automatically started on boot.  For troubleshooting purposes you can manually stop/start services:
+
** <code>bprestart</code>: manually restart services required for Ontoportal Stack. 
+
** <code>bpstart</code>: manually start services. 
+
** <code>bpstop</code>: manually stop services
+
* Start individual services:
+
** <code>/sbin/service httpd start</code>
+
** <code>/sbin/service memcached start</code>
+
** <code>/sbin/service tomcat6 start</code>
+
** <code>/sbin/service mgrep start</code>
+
** <code>/sbin/service 4s-httpd-ontologies_api start</code>
+
** <code>/sbin/service unicorn start</code>
+
* Stop individual services:
+
** <code>/sbin/service httpd stop</code>
+
** <code>/sbin/service memcached stop</code>
+
** <code>/sbin/service tomcat6 stop</code>
+
** <code>/sbin/service mgrep stop</code>
+
** <code>/sbin/service 4s-httpd-ontologies_api stop</code>
+
** <code>/sbin/service unicorn stop</code>
+
 
+
== License ==
+
 
+
The Virtual Appliance software is released with the 2-clause BSD license. Source code is included on the Virtual Appliance.
+
 
+
== Archival ==
+
  
 
For documentation of previous (v1.0) Virtual Appliances, please see our [http://www.bioontology.org/wiki/index.php?title=Category:NCBO_Virtual_Appliance&oldid=12610 archive].
 
For documentation of previous (v1.0) Virtual Appliances, please see our [http://www.bioontology.org/wiki/index.php?title=Category:NCBO_Virtual_Appliance&oldid=12610 archive].

Latest revision as of 18:23, 12 June 2020


Most of this content has been moved! Please find the new content for the 3.0 version of the Virtual Appliance at our new OntoPortal Virtual Appliance Administration pages.

Contents

[edit] OntoPortal Virtual Appliance Version 3.0 is here!

We are pleased to softly announce our soft release of the OntoPortal Virtual Appliance version 3.0 (3.0.1, to be precise).

This release includes lots of new capabilities, one of which involves licensing. The good news is that you can download and get started with your Virtual Appliance right away—no need to wait for us to give you access to the right page.

In order to do this, we had to implement licensing for BioPortal. Most users will find it trivial to obtain a free license, but for commercial users we are evaluating whether license fees could make BioPortal more sustainable.

To learn more about the new OntoPortal Virtual Appliance release, visit our Getting Started page. You may also want to visit our OntoPortal Administration Guide, including the General Introduction, Licensing, and Installation sections.

[edit] Virtual Appliance Administration Documentation: Moved to GitHub

Our Administration documentation for the OntoPortal Virtual Appliance has been moved to the GitHub pages document at https://ontoportal.github.io/administration/.

[edit] Archival

[edit] OntoPortal Virtual Appliance v2.5 archive is available

For previous registered users of the v2.5 OntoPortal Virtual Appliance, we maintain an archival copy of this software on our site. While we do not actively support this version because its libraries are outdated, we still make it available to those users who were previously authorized to use it. All new users of the Virtual Appliance should use Version 3 or later of the Appliance.

The OntoPortal Virtual Appliance is the (rebranded) update of the BioPortal Virtual Appliance originally developed by the National Center for Biomedical Ontologies (NCBO). Our current Virtual Appliance software is based on BioPortal's v5.x software infrastructure, including the use of an RDF triplestore as the primary data storage mechanism.

[edit] Even older archive

For documentation of previous (v1.0) Virtual Appliances, please see our archive.

Subcategories

This category has only the following subcategory.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox