Difference between revisions of "GOCDB/Regional Module Technical Documentation"

From EGIWiki
Jump to: navigation, search
Line 19: Line 19:
  
 
<br>  
 
<br>  
 
 
<!---
 
<!---
 +
<br>
  
 
== Deployment  ==
 
== Deployment  ==
Line 30: Line 30:
 
==== Database  ====
 
==== Database  ====
  
*'''Mysql/Oracle/Sqlite'''
+
Version 5 of GocDB utilizes Doctrine as it's interface to the datastore. This allows GocDB to be deployed to either a Oracle, MySQL or SQLite database.
 +
 
 +
Oracle:
 +
 
 +
*Required database: Oracle 10g or higher (note: Oracle 10g and 11g XE Express Editions, which come with free licenses are perfectly suitable)
 +
*Required space: 150 MB Dowload free Oracle XE from the following link and follow the installation instructions: http://www.oracle.com/technetwork/database/express-edition/overview/index.html
 +
*For gocdb admin tasks, we also recommend the SQL Developer tool.
  
 
<br>  
 
<br>  
  
 +
MySQL:
 +
 +
*Required database: Any version of MySQL will work including the free MySQL Community Server edition
 +
*Required space: See MySQL install guide:http://dev.mysql.com/doc/refman/5.7/en/installing.html
 +
 +
<br>
 +
 +
SQLite:
 +
 +
*Required database: SQLite 3.x.x or higher. SQLite is produced as an open source database and all versions are free to use.
 +
*Required: See the SQLite documentation: www.sqlite.org/docs.html
 +
<br>
 
==== Web frontend  ====
 
==== Web frontend  ====
  
Line 55: Line 73:
 
=== Database preparation  ===
 
=== Database preparation  ===
  
For Dave&nbsp;:)
+
GocDB v5 comes with deploy script which will setup the schema required for GocDB. The only preperation is that you have setup a database in your chosen database provider and have the user access details which are required later in the installation when configuring GocDB for deployment.&nbsp;
 +
 
 +
<br>
  
 
=== GOCDB file system  ===
 
=== GOCDB file system  ===
Line 146: Line 166:
 
=== Deploying GOCDB  ===
 
=== Deploying GOCDB  ===
  
To deploy GOCDB execute the deploy file for your database found in the deploy folder.
+
To deploy GocDB can be deployed as a blank instance ready for use of as a sample instance with a small set of example data to demonstrate GocDB. There are three deploy scripts provided for each database supported, these can be found in the ''/lib/Doctrine/deploy'' folder:<br>
<pre>gocDBSrc/lib/Doctrine/deploy/oracleDeploy.sh
+
 
gocDBSrc/lib/Doctrine/deploy/mysqlDeploy.sh
+
<pre>oracleDeploy.sh
gocDBSrc/lib/Doctrine/deploy/sqlite.sh
+
mysqlDeploy.sh
</pre>  
+
sqliteDeploy.sh
Within the source code you will also find a set of sample data to deploy with GOCDB. To deploy this data specify the location of the sample data folder when deploying:
+
</pre>
<pre>$./oracleDeploy.sh sampleData/
+
 
</pre>  
+
By supplying a flag when executing the script you can deploy either a new empty database or a sample database eg:
This will begin the process of deploying the database scheme and data if provided to your database.
+
 
 +
<pre>
 +
$ ./oracleDeploy.sh -s
 +
 
 +
Deploying GocDB with sample data
 +
</pre>
 +
 
 +
or
 +
<pre>
 +
$ ./oracleDeploy.sh -n
 +
 
 +
Deploying new empty GocDB instance
 +
</pre>
  
 
=== Apache Configuration  ===
 
=== Apache Configuration  ===

Revision as of 12:41, 8 November 2013

Main EGI.eu operations services Support Documentation Tools Activities Performance Technology Catch-all Services Resource Allocation Security


GOC DB menu: Home Documentation Index


Contents

This page is the main install documentation for GOCDB Version 5 

Download

LATEST VERSION: GOCDBv5

  • Install docs for V5 comming soon.
  • A packaged V5 release will also be made available for download soon.
  • In the meantime, early adopters can check out the v5 src from svn:
svn checkout https://www.sysadmin.hep.ac.uk/svn/grid-monitoring/branches/gocdb/Doctrine%20Web%20Portal 

Note, if you are asked to authenticate with a client certificate as below, you can dismiss by pressing Enter

Authentication realm: https://www.sysadmin.hep.ac.uk:443
Client certificate filename: <ENTER to dismiss>


OLD v4.4 Install doc has been relocated