Difference between revisions of "MCP Basic Configuration"

From Archivematica
Jump to navigation Jump to search
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
[[Main Page]] > [[Development]] > [[:Category:Development documentation|Development documentation]] > [[MCPServer]] > Editing MCP Basic Configuration
 +
 +
<div style="padding: 10px 10px; border: 1px solid black; background-color: #F79086;">This page is no longer being maintained and may contain inaccurate information. Please see the [https://www.archivematica.org/docs/latest/ Archivematica documentation] for up-to-date information. </div> <p>
 +
 
<div class="status">
 
<div class="status">
 
<div>
 
<div>
Line 5: Line 9:
 
This page proposes a new feature and reviews design options
 
This page proposes a new feature and reviews design options
 
</div>
 
</div>
</div><div class="active">
+
</div><div>
 
Development
 
Development
 
<div class="description">
 
<div class="description">
 
This page describes a feature that's in development
 
This page describes a feature that's in development
 
</div>
 
</div>
</div><div>
+
</div><div class="active">
 
Documentation
 
Documentation
 
<div class="description">
 
<div class="description">
Line 17: Line 21:
 
</div>
 
</div>
 
</div>
 
</div>
 +
 +
{| class="wikitable" style="background-color:#ffcccc; font-size: 120%; font-weight: bold; " cellpadding="10"
 +
| This page is deprecated. For Archivematica 1.5+, see [[MCPServer#Config File | MCPServer documentation]]
 +
|}
  
 
==Server==
 
==Server==
 
===Configurations===
 
===Configurations===
 
====Server ConfigFile====
 
====Server ConfigFile====
/etc/archivematica/MCPServer/ServerConfig.conf
+
/etc/archivematica/MCPServer/serverConfig.conf
  
 
====Workflow Configurations====
 
====Workflow Configurations====
Please see [[MCP_Configuration]]
+
Please see [[Creating_Custom_Workflows]]
  
===File Names Section===
+
===MCP Server Section===
 +
 
 +
====File Names====
 
These shouldn't be changed.
 
These shouldn't be changed.
 
#File Names
 
#File Names
DublinCore="dublincore.xml"
 
 
checksumsNoExtention="checksum"
 
checksumsNoExtention="checksum"
fileUUIDSHumanReadable="FileUUIDs.log"
 
  
===MCP Server Section===
 
#MCP Server
 
This section allows for general configuration of the server.
 
moduleConfigDir: The directory of the xml configuration files.
 
moduleConfigDir="/etc/archivematica/MCPServer/mcpModulesConfig"
 
  
MCPArchivematicaServerInterface: specifies the interface to listen on.
+
====Gearman Server====
To only listen for connections from the same host(computer) as the MCPServer, set to "localhost"
 
MCPArchivematicaServerInterface="localhost"
 
To listen to connections from anywhere set to ""
 
MCPArchivematicaServerInterface=""
 
  
MCPArchivematicaServerPort: the TCP port to listen to archivematica client Machines
+
MCPArchivematicaServer  =  localhost:4730
  MCPArchivematicaServerPort="8002"
+
  GearmanServerWorker = localhost:4730
  
archivematicaProtocol:specifies where the protocol file is. This is used to control MCP flow.
+
Note: to set the gearman process to listen on more interfaces than localhost, set it in '/etc/default/gearman-job-server'. I think you can set this to 1.1.1.1 for all interfaces.
archivematicaProtocol="/etc/archivematica/MCPServer/archivematicaProtocol"
 
  
 +
====Other====
 
watchDirectoryPath: Directory containing the directories watched by the MCP.
 
watchDirectoryPath: Directory containing the directories watched by the MCP.
 
  watchDirectoryPath="/var/archivematica/sharedDirectory/watchedDirectories/"
 
  watchDirectoryPath="/var/archivematica/sharedDirectory/watchedDirectories/"
Line 63: Line 62:
 
  AIPsStore="${sharedDirectory}AIPsStore/"
 
  AIPsStore="${sharedDirectory}AIPsStore/"
  
MCPArchivematicaXML: To approve jobs and and other functions an rpc protocol has been implemented using the python rpc xml tool.
+
The database access settings for the shared database:
MCPArchivematicaXMLClients: As above, specify the interface and port to listen on.
+
  /etc/archivematica/archivematicaCommon/dbsettings
  MCPArchivematicaXMLClients="localhost"
+
<pre>
MCPArchivematicaXMLPort="8000"
+
[client]
 +
user=demo
 +
password="demo"
 +
host=localhost
 +
</pre>
  
 
==Client==
 
==Client==
 
===Supported Modules===
 
===Supported Modules===
[http://code.google.com/p/archivematica/source/browse/trunk/src/MCPClient/etc/archivematicaClientModules Supported modules]
+
/etc/archivematica/archivematicaClient/clientConfig.conf
 +
<br>[http://code.google.com/p/archivematica/source/browse/trunk/src/MCPClient/etc/archivematicaClientModules Supported modules]
 
<br/>/etc/archivematica/MCPClient/archivematicaClientModules
 
<br/>/etc/archivematica/MCPClient/archivematicaClientModules
 
<br/>It's highly recommended only the MCP server host machine client support the upload and store tasks.
 
<br/>It's highly recommended only the MCP server host machine client support the upload and store tasks.
<br/>Comment them out on other machines by prefacing the lines with a '#':
+
<br/>Change the in theLoadSupportedCommandsSpecial in clientConfig.conf on other machines
 
<pre>
 
<pre>
#upload-qubit_v0.0="upload-qubit "
+
LoadSupportedCommandsSpecial = False
#storeAIP_v0.0="%clientScriptsDirectory%storeAIP.sh "
 
...
 
 
</pre>
 
</pre>
  
Line 83: Line 85:
 
/etc/archivematica/MCPClient/clientConfig.conf
 
/etc/archivematica/MCPClient/clientConfig.conf
 
Server to connect to. Specify hostname/IP and port.
 
Server to connect to. Specify hostname/IP and port.
  MCPArchivematicaServer="localhost"
+
  MCPArchivematicaServer = localhost:4730
MCPArchivematicaServerPort="8002"
 
The matching protocol file to the MCP server
 
archivematicaProtocol="/etc/archivematica/MCPClient/archivematicaProtocol"
 
 
Where the shared directory on the MCP Server is mounted:
 
Where the shared directory on the MCP Server is mounted:
 
  sharedDirectoryMounted="/var/archivematica/sharedDirectory/"
 
  sharedDirectoryMounted="/var/archivematica/sharedDirectory/"
The maximum number of thread the MCP is allowed to run on this host.
+
The maximum number of tasks the MCP is allowed to run on this host.
maxThreads="2"
+
* numberOfTasks is no longer used. The client will detect the number of cores on the machine, and use that number of threads. This can be overridden by changing the number to something other than 0.
The location of the client modules. These specify which modules this host supports.
+
<pre>numberOfTasks=0</pre>
 +
<br>The location of the client modules. These specify which modules this host supports.
 
  archivematicaClientModules="/etc/archivematica/MCPClient/archivematicaClientModules"
 
  archivematicaClientModules="/etc/archivematica/MCPClient/archivematicaClientModules"
 
The location of the client scripts.
 
The location of the client scripts.
 
  clientScriptsDirectory="/usr/lib/archivematica/MCPClient/clientScripts/"
 
  clientScriptsDirectory="/usr/lib/archivematica/MCPClient/clientScripts/"
 +
The database access settings for the shared database:
 +
/etc/archivematica/archivematicaCommon/dbsettings
 +
<pre>
 +
[client]
 +
user=demo
 +
password="demo"
 +
host=localhost
 +
</pre>
 +
The supportedCommandsSpecial listed in the archivematicaClientModules should only be run on one machine. This is a mechanism to limit/control processing to a single instance. This should be enabled on one, and only one client in a distributed processing system.
 +
<pre>LoadSupportedCommandsSpecial = True</pre>
  
===Client Organization Setting===
 
/usr/lib/archivematica/MCPClient/clientScripts/createXmlEventsAssist.py
 
yourAgentIdentifierType="repository code"
 
yourAgentIdentifierValue="ORG"
 
yourAgentName="Your Organization Name Here"
 
yourAgentType="organization"
 
 
<agent>
 
<agentIdentifier>
 
<agentIdentifierType>repository code</agentIdentifierType>
 
<agentIdentifierValue>ORG</agentIdentifierValue>
 
</agentIdentifier>
 
<agentName>Your Organization Name Here</agentName>
 
<agentType>organization</agentType>
 
</agent>
 
  
 
[[Category:Development documentation]]
 
[[Category:Development documentation]]

Latest revision as of 15:55, 11 February 2020

Main Page > Development > Development documentation > MCPServer > Editing MCP Basic Configuration

This page is no longer being maintained and may contain inaccurate information. Please see the Archivematica documentation for up-to-date information.

Design

This page proposes a new feature and reviews design options

Development

This page describes a feature that's in development

Documentation

This page documents an implemented feature

This page is deprecated. For Archivematica 1.5+, see MCPServer documentation

Server[edit]

Configurations[edit]

Server ConfigFile[edit]

/etc/archivematica/MCPServer/serverConfig.conf

Workflow Configurations[edit]

Please see Creating_Custom_Workflows

MCP Server Section[edit]

File Names[edit]

These shouldn't be changed.

  1. File Names

checksumsNoExtention="checksum"


Gearman Server[edit]

MCPArchivematicaServer  =  localhost:4730
GearmanServerWorker = localhost:4730

Note: to set the gearman process to listen on more interfaces than localhost, set it in '/etc/default/gearman-job-server'. I think you can set this to 1.1.1.1 for all interfaces.

Other[edit]

watchDirectoryPath: Directory containing the directories watched by the MCP.

watchDirectoryPath="/var/archivematica/sharedDirectory/watchedDirectories/"

sharedDirectory: directory shared on the network with MCP clients. Containing the processing directory.

sharedDirectory="/var/archivematica/sharedDirectory/"

processingDirectory: Directory SIPs reside in while they are actively being processed.

processingDirectory="${sharedDirectory}.currentlyProcessing/"

AIPsStore: Directory to store the AIPs when finished processing. This can be a mounted directory on an external storage device.

AIPsStore="${sharedDirectory}AIPsStore/"

The database access settings for the shared database:

/etc/archivematica/archivematicaCommon/dbsettings
[client]
user=demo
password="demo"
host=localhost

Client[edit]

Supported Modules[edit]

/etc/archivematica/archivematicaClient/clientConfig.conf
Supported modules
/etc/archivematica/MCPClient/archivematicaClientModules
It's highly recommended only the MCP server host machine client support the upload and store tasks.
Change the in theLoadSupportedCommandsSpecial in clientConfig.conf on other machines

LoadSupportedCommandsSpecial = False

Client ConfigFile[edit]

/etc/archivematica/MCPClient/clientConfig.conf Server to connect to. Specify hostname/IP and port.

MCPArchivematicaServer = localhost:4730

Where the shared directory on the MCP Server is mounted:

sharedDirectoryMounted="/var/archivematica/sharedDirectory/"

The maximum number of tasks the MCP is allowed to run on this host.

  • numberOfTasks is no longer used. The client will detect the number of cores on the machine, and use that number of threads. This can be overridden by changing the number to something other than 0.
numberOfTasks=0


The location of the client modules. These specify which modules this host supports.

archivematicaClientModules="/etc/archivematica/MCPClient/archivematicaClientModules"

The location of the client scripts.

clientScriptsDirectory="/usr/lib/archivematica/MCPClient/clientScripts/"

The database access settings for the shared database:

/etc/archivematica/archivematicaCommon/dbsettings
[client]
user=demo
password="demo"
host=localhost

The supportedCommandsSpecial listed in the archivematicaClientModules should only be run on one machine. This is a mechanism to limit/control processing to a single instance. This should be enabled on one, and only one client in a distributed processing system.

LoadSupportedCommandsSpecial = True