Contribute: Plugins/StoragePluginsArkivum - Revision history

Gareth.brown@arkivum.com at 16:54, 12 January 2015

2015-01-12T16:54:34Z

← Older revision		Revision as of 16:54, 12 January 2015
Line 1:		Line 1:
	[[Category:Contribute]]		[[Category:Contribute]]
	[[Category:Plugins]]		[[Category:Plugins]]
			= Storage Plugin (Version 2) =

			If you are looking for information on version 2 of the EPrints/Arkivum storage plugin then please see the wiki page here: [[Files/Configuration and User Guide for version 2.1 of the EPrints/Arkivum storage plugin]]

			The rest of the documentation below is for Version 1 of the plugin.

	= Storage Plugin (Version 1) =		= Storage Plugin (Version 1) =

Gareth.brown@arkivum.com: /* Storage Plugin (Version 1): Arkivum */

2015-01-12T16:51:02Z

Storage Plugin (Version 1): Arkivum

← Older revision		Revision as of 16:51, 12 January 2015
Line 1:		Line 1:
	[[Category:Contribute]]		[[Category:Contribute]]
	[[Category:Plugins]]		[[Category:Plugins]]
	= Storage Plugin (Version 1)~~: Arkivum~~ =		= Storage Plugin (Version 1) =

	In this tutorial we will look at installing version 1 of the Arkivum Storage Plugin. This plugin allows you to use an alternative storage location and how to mount a Samba (CIFS/Windows) share to store that data.		In this tutorial we will look at installing version 1 of the Arkivum Storage Plugin. This plugin allows you to use an alternative storage location and how to mount a Samba (CIFS/Windows) share to store that data.

Gareth.brown@arkivum.com: /* Storage Plugin (Version 1): Arkivum */

2015-01-12T16:50:43Z

Storage Plugin (Version 1): Arkivum

← Older revision		Revision as of 16:50, 12 January 2015
Line 3:		Line 3:
	= Storage Plugin (Version 1): Arkivum =		= Storage Plugin (Version 1): Arkivum =

	In this tutorial we will look at installing the Arkivum Storage Plugin. This plugin allows you to use an alternative storage location and how to mount a Samba (CIFS/Windows) share to store that data.		In this tutorial we will look at installing version 1 of the Arkivum Storage Plugin. This plugin allows you to use an alternative storage location and how to mount a Samba (CIFS/Windows) share to store that data.

	The plugin uses EPrints event tasks to manage the process of copying and removing data from the A-Stor service as a background task. The process of copying or removing data from the A-Stor service is driven by two new two new screens. The first will allow a user to request a document to be copied (or a copied document removed) to the A-Stor service. The second screen allows these requests to be approved or rejected and then displays the status of the approved requests as they are processed by the background event tasks.		The plugin uses EPrints event tasks to manage the process of copying and removing data from the A-Stor service as a background task. The process of copying or removing data from the A-Stor service is driven by two new two new screens. The first will allow a user to request a document to be copied (or a copied document removed) to the A-Stor service. The second screen allows these requests to be approved or rejected and then displays the status of the approved requests as they are processed by the background event tasks.

Gareth.brown@arkivum.com at 11:25, 12 January 2015

2015-01-12T11:25:44Z

← Older revision		Revision as of 11:25, 12 January 2015
Line 1:		Line 1:
	[[Category:Contribute]]		[[Category:Contribute]]
	[[Category:Plugins]]		[[Category:Plugins]]
	= Storage Plugin : Arkivum =		= Storage Plugin (Version 1): Arkivum =

	In this tutorial we will look at installing the Arkivum Storage Plugin. This plugin allows you to use an alternative storage location and how to mount a Samba (CIFS/Windows) share to store that data.		In this tutorial we will look at installing the Arkivum Storage Plugin. This plugin allows you to use an alternative storage location and how to mount a Samba (CIFS/Windows) share to store that data.

Gareth.brown@arkivum.com: Information on how to install and use the Arkivum Plugin with Eprints

2013-06-28T14:32:18Z

Information on how to install and use the Arkivum Plugin with Eprints

← Older revision		Revision as of 14:32, 28 June 2013
Line 3:		Line 3:
	= Storage Plugin : Arkivum =		= Storage Plugin : Arkivum =

	In this tutorial we will look at installing the Arkivum Storage Plugin. This plugin allows you to use an alternative storage location and how to mount a Samba (CIFS/Windows) share to store that data.		In this tutorial we will look at installing the Arkivum Storage Plugin. This plugin allows you to use an alternative storage location and how to mount a Samba (CIFS/Windows) share to store that data.

			The plugin uses EPrints event tasks to manage the process of copying and removing data from the A-Stor service as a background task. The process of copying or removing data from the A-Stor service is driven by two new two new screens. The first will allow a user to request a document to be copied (or a copied document removed) to the A-Stor service. The second screen allows these requests to be approved or rejected and then displays the status of the approved requests as they are processed by the background event tasks.

	This plugin was designed to mount the Arkivum Storage system, but could equally be used to store data on any CIFS/Samba system		This plugin was designed to mount the Arkivum Storage system, but could equally be used to store data on any CIFS/Samba system
Line 80:		Line 82:
	= The Storage Plugin =		= The Storage Plugin =

	You can download the storage plugin from here: [http://bazaar.eprints.org/~~285~~/ http://bazaar.eprints.org/~~285~~/]		You can download the storage plugin from here: [http://bazaar.eprints.org/313/ http://bazaar.eprints.org/313/]

			Then edit the configuration file to set the mount point of your A-Stor directory:

			/opt/eprints3/lib/epm/arkivum/cfg/cfg.d/x_arkivum.xml

			<pre>
			$c->{plugins}->{"Storage::ArkivumStorage"}->{params}->{mount_path} = "/mnt/arkivum";
			</pre>

			This example would configure the Arkivum Storage Plugin to use the mounted directory /mnt/arkivum to place files you wanted to securely archive.

			= The Event Plugin =

			Before you can enable the plugin you will also need to configure the URL for the A-Stor appliance:

			/opt/eprints3/lib/epm/arkivum/cfg/cfg.d/x_arkivum.xml

			<pre>
			$c->{plugins}->{"Storage::ArkivumStorage"}->{params}->{server_url} = "https://astor-server.:8443";
			$c->{plugins}->{"Event::Arkivum"}->{params}->{server_url} = "https://astor-server:8443";
			</pre>

			This example would define the A-Stor appliance is available on the URL "https://astor-server:8833". This URL is used by both the storage and event plugin to communicate with the A-Stor appliance using the REST API.

			You can also optionally change the cron schedule used by the background astor-checker event task. To do this you will need to edit the follwoing control screen:

	~~Then edit the main file to decide your rules for using the storage plugin:~~		/opt/eprints3/lib/plugins/EPrints/Plugin/Screen/EPMC/Arkivum.pm

	~~eprints3/lib/storage/default.xml~~		and change the cron schedule in each of the entries marked:

	<pre>		<pre>
	~~<store xmlns="http~~:~~//eprints.org/ep3/storage" xmlns~~:~~epc="http~~:~~//eprints.org/ep3/control"~~>		EPrints::DataObj::EventQueue->create_unique( $repo, {
	~~<epc:choose~~>		pluginid => "Event",
	~~<epc:when test~~="~~datasetid = 'document'~~">		action => "cron",
	~~<plugin name~~="~~ArkivumR~~"/>		params => ["0,15,30,45,60 * * * *",
	~~</epc~~:~~when>~~		"Event::Arkivum",
	~~<epc~~:~~otherwise>~~		"astor_checker",
	~~<plugin name=~~"~~Local~~"/>		],
	~~</epc:otherwise>~~		});

	~~</epc:choose>~~
	~~</store>~~
	</pre>		</pre>

	~~This example would use~~ the ~~Arkivum Plugin for documents~~, and the ~~normal~~ plugin ~~for everything else~~.		In the default cron schedule shown above, the checker event will be run every 15 minutes and is set-up when the plugin is enabled and removed when the plugin is disabled.

	=Check in E-Prints=		=Check in E-Prints=

	'''If the installation is successful, you should see the ~~Akivum storage available by going~~ here:'''		'''If the installation is successful and the plugin has been enabled correctly, you should see the main event astor-checker task here:'''

	E-prints web page --> LOGIN --> ADMIN --> ~~CONFIG~~ TOOLS --> ~~STORAGE MANAGER~~		E-prints web page --> LOGIN --> ADMIN --> SYSTEM TOOLS --> STATUS --> Background Task Queue

	~~(NB: if~~ the ~~file permissions are wrong,~~ the ~~storage wont show up)~~		You will also see two additional screens. The first is available in the document management screen and is found via a new A-Stor icon. The second screen is available in the manage records screen and is available as a new menu option called A-Stor Requests.

	For more information on Astor, see [http://www.arkivum.com www.arkivum.com] including our series of articles and webinars on Research Data Management.		For more information on Astor, see [http://www.arkivum.com www.arkivum.com] including our series of articles and webinars on Research Data Management.

Gareth.brown@arkivum.com: /* Check in E-Prints */

2013-04-17T08:42:03Z

Check in E-Prints

← Older revision		Revision as of 08:42, 17 April 2013
Line 110:		Line 110:
	(NB: if the file permissions are wrong, the storage wont show up)		(NB: if the file permissions are wrong, the storage wont show up)

	For more information on Astor, see [www.arkivum.com] including our series of articles and webinars on Research Data Management.		For more information on Astor, see [http://www.arkivum.com www.arkivum.com] including our series of articles and webinars on Research Data Management.

Gareth.brown@arkivum.com: /* The Storage Plugin */

2013-04-17T08:41:34Z

The Storage Plugin

← Older revision		Revision as of 08:41, 17 April 2013
Line 80:		Line 80:
	= The Storage Plugin =		= The Storage Plugin =

	You can download the storage plugin from here: [http://bazaar.eprints.org/285/]		You can download the storage plugin from here: [http://bazaar.eprints.org/285/ http://bazaar.eprints.org/285/]

	Then edit the main file to decide your rules for using the storage plugin:		Then edit the main file to decide your rules for using the storage plugin:

Gareth.brown@arkivum.com: /* Background */

2013-04-17T08:41:07Z

Background

← Older revision		Revision as of 08:41, 17 April 2013
Line 19:		Line 19:
	Arkivum is certified to ISO27001 and is regularly audited for the integrity, confidentiality and availability of data assets in our possession. This approach makes the Arkivum service ideal for long-term storage of research data, for example to meet research council retention requirements and to ensure it is available for easy access in the future.		Arkivum is certified to ISO27001 and is regularly audited for the integrity, confidentiality and availability of data assets in our possession. This approach makes the Arkivum service ideal for long-term storage of research data, for example to meet research council retention requirements and to ensure it is available for easy access in the future.

	For more information see [www.arkivum.com] including our series of articles and webinars on Research Data Management.		For more information see [http://www.arkivum.com www.arkivum.com] including our series of articles and webinars on Research Data Management.


	= Installation =		= Installation =

Gareth.brown@arkivum.com: /* Check in E-Prints */

2013-04-17T08:40:11Z

Check in E-Prints

← Older revision		Revision as of 08:40, 17 April 2013
Line 109:		Line 109:
	E-prints web page --> LOGIN --> ADMIN --> CONFIG TOOLS --> STORAGE MANAGER		E-prints web page --> LOGIN --> ADMIN --> CONFIG TOOLS --> STORAGE MANAGER

	(NB: if the file permissions are wrong, the storage wont show)		(NB: if the file permissions are wrong, the storage wont show up)

	For more information on Astor, see [www.arkivum.com] including our series of articles and webinars on Research Data Management.		For more information on Astor, see [www.arkivum.com] including our series of articles and webinars on Research Data Management.

Gareth.brown@arkivum.com: /* Before You Start */

2013-04-17T08:38:59Z

Before You Start

← Older revision		Revision as of 08:38, 17 April 2013
Line 21:		Line 21:
	For more information see [www.arkivum.com] including our series of articles and webinars on Research Data Management.		For more information see [www.arkivum.com] including our series of articles and webinars on Research Data Management.


			= Installation =
			The A-Stor service is accessible using the SMB protocol (also known as CIFS). The A-Stor service does this through an appliance that is installed at the customer site that uses Samba to expose a network file share. This means that the A-Stor network share needs to be mounted on the server running ePrints so that the plugin to ePrints can copy files to the A-Stor network share and read files from the A-Stor network share.

			Therefore, the installation process is one of mounting the smb network share on the ePrints server, making sure permissions are set properly so ePrints can read and write files to that share, installing the plugin and then testing that the plugin is visible and functioning correctly within ePrints.

	= Before You Start =		= Before You Start =