Enstore Configuration Keys

Common Keys (for all servers)

All mandatory common keys must be defined in all servers and movers configurations

Key	Description	Presence	Default
host	server host name	Mandatory	None
hostip	server host IP address	Mandatory	None
port	server port number	Mandatory	None
logname	server name in the log	Mandatory	None
inq_ignore	if present the inquisitor will not monitor corresponding server	Optional	None
norestart	if present inq will not restart corresponding server/mover	Optional	None
noupdown	'enstore system' process will not look at the corresponding server when generating the SAAG page, and will not use the information in deciding to turn the ball red	Optional	None
use_tcp_log_client	if present and True send log messages over TCP/IP	Optional	None

Priority

Key	Description	Presence	Default
priority	priority of incoming requests	Optional	None

Discipline -restrict requests coming from certain (set of) host(s)

Key	Description	Presence	Default
discipline	library_manager_1: # as described in configuration {1: # first entry 'host': host1, # rule applies to this host (regex) 'function': discipline_function, # restrict_host_access 'args':[host1, # rule applies to this host (max_allowed, # maximal concurrent requests addtl_read, # additional reads for bound volumes addtl_write) # additional writes for bound volumes ], 'action': action}, # ignore, noread, nowrite 2: {.... } library_manager_2: { ...}	Optional	None

Log Server Keys

Key	Description	Presence	Default
log_file_path	Directory for log files.	Mandatory	None
msg_type_logs	log extractions based on the log type pattern	Optional	None
max_queue_size	Maximum size of the incoming message buffering queue.	Optional	200000
use_raw_input	Use buffer to pull out requests from UDP buffer as fast as possible.	Optional	False

Library Manager Keys

Key	Description	Presence	Default
allow	allow host access on a per storage group.	Optional	None
lock	if specified LM will start in this state. Allowed values: lock - reject encp requests, give out works in the pending queue to movers unlocked ignore - do not put encp requests into pending queue, but return ok to encp pause - same as ignore, but also do not give out works in the pending moverlock - reject mover requests nowrite - locked for write requests noread - locked for read requests	Optional	unlocked
max_suspect_movers	if number of suspect movers on which a given volume failed >= of max_suspect_movers, this volume will be set to NOACCESS state	Optional	3
suspect_volume_expiration_time	remove entry from suspect volume list after this period of time	Optional	None
min_file_size	minimal file size	Optional	0
max_file_size	maximal size of the file allowed by this library	Optional	2GB-2kB
max_in_active	maximal time allowed for the transfer to be in ACTIVE state	Optional	7200(s)
max_in_other	maximal time allowed for the transfer or mover to be in other than ACTIVE state	Optional	2000(s)
blank_error_increment	do not set volume to NOACCESS in case of FTT_EBLANK error until the number of erros exceeds max_suspect_movers+blank_error_increment	Optional	5
legal_encp_version	minimal encp version number allowed to acess enstore	Optional	None
CleanTapeVolumeFamily	volume family for cleaning tapes	Optional	None
storage_group_limits	Minimal amount of drives that can be used by a certain storage group (fair share) when different storage groups compete for tape drives	Optional	None
max_requests	Maximal amount of requests in the queue. The rest will be ignored (and retried later by encp)	Optional	3000 (No restart)
mover_port	Movers will communucate with library manager on this port if specified.	Optional	None
encp_port	Clents (encp) will communucate with library manager on this port if specified.	Optional	None
use_raw_input	Use buffer to pull out requests from UDP buffer as fast as possible.	Optional	False
volume_clerk_timeout	Receive TO for volume clerk requests	Optional	10 (s)
volume_clerk_retry	Number of retries for volume clerk requests	Optional	0
use_threads	Use separate threads for every mover request (shows problems during testing, avoid setting to True).	Optional	False
use_LMD	for SFA clients use this Library Manager Director	Optional	None

Mover Keys

Key	Description	Presence	Default
do_eject	eject tape on dismount	Optional	'yes'
do_cleaning	clean tape drive by the mover request	Optional	'yes'
mc_device	media changer device as declared in the robot	Mandatory	None
min_buffer	minimal amount of memory to allocate for buffering when transferring data	Optional	8MB
max_buffer	maximal amount of memory to allocate for buffering (recommended not less than 1GB	Optional	64MB
max_rate	maximum sustained transfer rate for writes. Used to calculate optimal buffer size. Recommended to set to the max. rate of the drive	Optional	11.2MB
device	pathname to the UNIX tape device	Mandatory	None
dismount_delay	delayed dismount value to use when none specified by the client. Set to negative value to get "infinite" dismount delay	Optional	60s
mount_delay	number of seconds to wait after media changer mount completes, before trying to open device. Default is 15 for FTT driver, 0 for NULL driver	Optional	15s
max_dismount_delay	maximal dismount delay that can be set for this mover	Optional	600s
library	library(ies) that this mover serve	Mandatory	None
driver	low lewel media driver ('FTTDriver' for tape, 'NullDriver' for null mover)	Mandatory	None
max_consecutive_failures	number of any consecutive errors after which the mover goes OFFLINE	Optional	2
max_failures	Mover will go OFFLINE if this many transfers fail within failure_interval (see below)	Optional	3
failure_interval	Interval for above	Optional	3600s
send_stats	send tape drive statistics to the drivestat Data Base (defaul value 1, which means "send")	Optional	1
type	specifies the type of mover ('','Mover','DiskMover')	Optional	""
media_type	media type used for the mover. Recommended to set to the type of the media	Optional	"8MM"
log_state	if set log the state of the mover processes. Used for debugging	Optional	None
syslog_entry	expression to match in the syslog for the low level failure diagnostics	Optional	None
restart_on_error	restart mover if it went to the ERROR state. Default - do not restart	Optional	None
connect_timeout	TimeOut for mover connection to encp	Optional	15s
connect_retries	number of connection retries to encp	Optional	4
update_interval	interval for the mover to ask LM for the work. Recommended value 5 s)	Optional	15
single_filemark	if not 0 write single file mark (Default value - 0 - write 2 filemarks)	Optional	0
check_written_file	if greater than 0, then randomly check files written using this number as the mean (default value:0 - don't check)	Optional	0
check_first_written_file	Reread and check CRC on a first write after a tape mount	Optional	0
max_time_in_state	maximal time for a mover to be in any transfer state (other than IDLE or ACTIVE)	Optional	600s
max_in_state_cnt	if this counter expires Mover errors out with "Mover stuck..." message.	Optional	3
statistics_path	path to the statistics file(default - None)	Optional	None
compression	0 means no compression. Everything else means use the drive compression (default: None - use the drive compression). Set this key to 0!!!	Optional	None
get_remaining_from_stats	get remaining bytes info from drive	Optional	None
blank_error_increment	Sometimes ftt returns FTT_EBLANK for not blank tapes. To allow a tape to be in a pool and not to go to NOACCESS.	Optional	5
expected_time_factor	If time in state is more expected_time_factor * expected_transfer_time - break connection. Applies only for read requests.	Optional	50
read_crc_control	0 - calculate CRC when transferring data, 1 - calculate CRC when reading from tape (old default behavior).	Optional	0
tmp_dir	temporary place for written files (for disk mover only!)	Optional	None
remaining_factor	Factor used to calculate remaining bytes based on the capacity: (remaining = remaining_factor*capacity)	Optional	0.01
read_error_recovery_timeout	When read error happens tape drive tries to recover data. Recovery may take up to 30 min, but usually 20 min. This parameter controls recovery during read, so that mover just waits for read tape compeletion up to specified time	Optional(sec)	20*60.

Media Changer Keys

Some media changer keys are specific for different types of robotic libraries

Key	Description	Presence	Default
type	type of the media changer (currently RDD_MediaLoader - for null movers, STK_MediaLoader, AML2_MediaLoader, Manual_MediaLoader)	Mandatory	None
acls_host	host name of STK robot control machine (specific for STK Library)	Mandatory	None
acls_uname	user name to access STK robot control program (specific for STK Library)	Mandatory	None
RobotArm	robot arm in AML2 robot (specific for AML2 robotic library)	Mandatory	None
IdleTimeHome	home robot arm if it is idle and not in a home position after this period of time has expired (default 5 min, specific for AML2 robotic library)	Mandatory	None
IOBoxMedia	specifies types of media and addresses of IO box for importing/exporting tapes into the robot (specific for AML2 robotic library)	Mandatory	None
DriveCleanTime	if present, specifes the type of media, time until cleaning tape gets dismounted and number of cleaning cycles to clean a tape drive	Mandatory	None
max_work	if present, specifes the maximal number of simultaneous requests to robot.	Optional	7
tape_library	if present, suplies a name to the tape library (robot) for reporting.	Optional	SL8500

Volume Clerk Keys

Key	Description	Presence	Default
max_noaccess_cnt	if number of volumes consecutively set to NOACCES reaches this number, the corresponding library will be paused	Optional	2
max_threads	Number of threads processing requests concurrently	Optional	50
parallel_queue_size	Size of request queue processed concurrently	Optional	100000

File Clerk Keys

Key	Description	Presence	Default
max_threads	Number of threads processing requests concurrently	Optional	50
sequential_queue_size	Size of request queue processed sequentially	Optional	100000
parallel_queue_size	Size of request queue processed concurrently	Optional	100000
brand	brand for bit file id to distinguish between systems	Optional	""

Info Server Keys

Key	Description	Presence	Default
max_threads	Number of threads processing requests concurrently	Optional	50
parallel_queue_size	Size of request queue processed concurrently	Optional	100000

Database Keys

Key	Description	Presence	Default
db_dir	Aux database directory	Mandatory	None
db_dir	Directory where output of enstore backup command goes	Mandatory	None
jou_dir	enstore database journal directory	Mandatory	None
dbhost	enstore database host	Mandatory	None
dbname	enstore database name	Mandatory	None
dbport	enstore database port	Mandatory	None
dbuser	enstore database account	Mandatory	None
dbuser_reader	enstore readonly database account	Mandatory	None
dbserverowner	owner of enstore database server process	Mandatory	None
dbarea	enstore database area	Mandatory	None

Accounting Server Keys

Key	Description	Presence	Default
dbhost	accounting data base host machine	Mandatory	None
dbport	accounting database port	Mandatory	None
dbname	accounting data base name	Mandatory	None
dbuser	enstore database account	Mandatory	None
dbuser	enstore readonly database account	Mandatory	None
dbserverowner	owner of enstore database server process	Mandatory	None
dbarea	enstore database area	Mandatory	None

Drivestat Server Keys

Key	Description	Presence	Default
dbhost	drivestat database host	Mandatory	None
dbport	drivestat database port	Mandatory	None
dbname	drivestat data base name	Mandatory	None
dbuser	enstore database account	Mandatory	None
dbuser	enstore readonly database account	Mandatory	None
dbserverowner	owner of enstore database server process	Mandatory	None
dbarea	enstore database area	Mandatory	None

Web Server Keys: define httpd.conf and top level directories

Key Description Presence Default

ServerHost name of the host running http server Mandatory None

ServerName name of web server Mandatory None

DocumentRoot top level web directory Mandatory None

ScoreBoardFile ScoreBoardFile Mandatory None

PidFile full path to httpd pid file Mandatory None

CustomLog

combined full path to combined log file

referer full path to referer log file

agent full path to agent log file

Mandatory

Mandatory

Mandatory

None

None

None

ServerRoot location of httpd.conf (e.g. /etc/httpd) Mandatory None

ScriptAlias

fake e.g. /cgi-bin/

real real path to cgi scripts

Mandatory

Mandatory

None

None

Inquisitor Keys

Key	Description	Presence	Default
alive_rcv_timeout	amount of time to wait when doing a tcp transfer	Mandatory	None
alive_retries	number of times to retry a failed tcp transfer	Mandatory	None
default_alive_interval	number of seconds expected between alive messages from the event_relay	Mandatory	None
default_hung_interval	number of seconds after which if no alive message is received, the server is marked as dead	Mandatory	None
html_file	directory location of the html web area	Mandatory	None
http_log_file_path	path to log files in the as used in a url	Mandatory	None
max_encp_lines	maximum number of encps reported on the encp history page	Mandatory	None
node_write_check	set an alarm if there are writes in the library manager queue (from these nodes) and there are no active transfers from the nodes	Mandatory	None
refresh	automatic refresh rate for the web pages	Mandatory	None
user_log_dirs	dictionary specifying additional links that should be added to the log file web page under user log dirs	Mandatory	None
www_host	url description of the web host	Mandatory	None

Alarm Server Keys

Key	Description	Presence	Default
alarm_actions	dictionary describing actions to be taken when the specified alarms are received. the format is as follows: {severity_string:[[action1, action_parameters, action_parameters], ...], ...} severity_string is one of: 'A' - for a regular alarm 'E' - for an error alarm 'U' - for a User error/alarm 'W' - for a warning alarm 'I' - for an information alarm 'C' - for an e-mailable alarm - only type with currently defined actions there currently is only one supported action: send_mail send_mail first action_parameter '*' - to send e-mail for every occurance '1' - to send e-mail for just the first occurance, any additional alarms go to the alarms page send_mail second action_parameter is a dictionary of storage_group and e-mail address pairs or a string of comma seperated e-mails address {'test' : 'enstore-auto@fnal.gov', 'ssa_test' : 'ssa-group@fnal.gov,enstore-auto@fnal.gov'} 'ssa-group@fnal.gov,enstore-auto@fnal.gov'	Mandatory	None

Key

Description

Presence

Default

alarm_actions

dictionary describing actions to be taken when the specified alarms are received. the format is as follows:

{severity_string:[[action1, action_parameters, action_parameters],

...],

...}

severity_string is one of:

'A' - for a regular alarm
'E' - for an error alarm
'U' - for a User error/alarm
'W' - for a warning alarm
'I' - for an information alarm
'C' - for an e-mailable alarm - only type with currently defined actions

there currently is only one supported action:

send_mail
- '*' - to send e-mail for every occurance
- '1' - to send e-mail for just the first occurance, any additional alarms go to the alarms page
- {'test' : 'enstore-auto@fnal.gov',
  'ssa_test' : 'ssa-group@fnal.gov,enstore-auto@fnal.gov'}
- 'ssa-group@fnal.gov,enstore-auto@fnal.gov'

Mandatory

None

System Keys

Key	Description	Presence	Default
allowed_down	dictionary defining how many times a server is allowed down before it is marked with a red ball by the 'enstore system' command. each server has a list associated with it that has the followinw format - [number of consecutive times when checked and no alive message rcvd, timeout]	Mandatory	None

Encp Keys

Key	Description	Presence	Default
crc_seed	value of the initial adler32 seed. the standard says this should be one, but some institutions have decided to use zero.	Optional	1

pnfs server Keys (optional)

Key	Description	Presence	Default
host	host on which pnfs server runs.	Mandatory	None

Namespace Keys

Key

Description

Presence

Default

name

Name of namespace - any string. Enstore can support multiple namespaces. A unique name has to identify a namespace.

Mandatory

None

Key

Description

Presence

Default

master

dictionary describing connection parameters to master database

Mandatory

None

Key	Description	Presence	Default
dbhost	Host runnning namespace database	Mandatory	None
dbname	Database name	Mandatory	None
dbport	Database port	Mandatory	None
dbuser	Database user	Mandatory	None
dbuser_reader	Database read-only user	Mandatory	None

Mandatory

None

Mandatory

None

Key

Description

Presence

Default

replica

dictionary describing connection parameters to replica database

Mandatory

None

Key	Description	Presence	Default
dbhost	Host runnning namespace database	Mandatory	None
dbname	Database name	Mandatory	None
dbport	Database port	Mandatory	None
dbuser	Database user	Mandatory	None
dbuser_reader	Database read-only user	Mandatory	None

Mandatory

None

Mandatory

None

Key

Description

Presence

Default

backup

Dictionary describing database backup parameters

Mandatory

None

Key	Description	Presence	Default
host	Backup destination host	Mandatory	None
dir	Backup destination directory	Mandatory	None

Mandatory

None

Mandatory

None

Additional Keys for File Aggregation Configuration

See details in "Small Files Aggregation High Level Design" document.

Dispatcher

Key	Description	Presence	Default
queue_work	Incoming queue name	Mandatory	None
queue_reply	Reply queue name	Mandatory	None
queue_write	Migrator write queue or exchange name	Mandatory	None
queue_read	Migrator read queue or exchange name	Mandatory	None
queue_purge	Migrator purge queue or exchange name	Mandatory	None
	Migrator reply queue name	Mandatory	None
policy_file	Path to file with current policies	Mandatory	None
max_time_in_cache	Maximal time before files get purged from cache	Optional	1 hour
purge_watermarks	Tuple start purge if data space is full more than this factor stop purge if data space is full less than this factor	Optional	None
clustered_configuration	Enable clustered configuration	Optional	None (Disabled)

Library Manager Director

Key	Description	Presence	Default
queue_in	AMQP queue name on which LM director communicates with proxy server	Optional. Do not configure it not using UDP Proxy Server	None
udp_proxy_server	proxy server with which LM director communicates	Optional. encp communicates directly with LMD if proxy is not set.	None
udp_port	Define this port and set it == 'port' if not using UDP Proxy Server	Optional	None
policy_file	Path to file with current policies	Mandatory	None

Migrator

Key	Description	Presence	Default
migration_dispatcher	migration dispatcher in configuration	Mandatory	None
migrator_work	migrator work queue or exchange name on which migrator receives requests from dispatcher	Mandatory	None
data_area	disk area where (written) files are stored	Mandatory	None
archive_area	disk area where archive is created during data archiving	Mandatory	None
stage_area	disk area where archived files get staged from tape	Mandatory	None
tmp_stage_area	disk area where staged files are temporarily stored	Mandatory	None
aggregation_host	host on which aggregation (packing) is done (if defined)	Optional	None
staging_host	host on which staging (unpacking) is done (if defined)	Optional	None
packages_dir	directory in name space for packages	Mandatory	None
dismount_delay	delay for dismounting tape	Mandatory	None
delta_priority	delta priority for encp calls	Optional	10
check_written_file	if greater than 0, then randomly check files written using this number as the mean	Optional	0 - do not check
tar_blocking_factor	blocking factor for archiver (tar)	Optional	None
disk_library	disk library to which this migrator belongs	Mandatory	None
max_process	Maximum number of work processes per migrator	Optional	10
archiver	Specify archive program (tar or zip) for writing migrator	Optional	None (use tar)

SFA Stats:defines parameters for SFA monitoring plots (Optional)

Key	Description	Presence	Default
packaging_rates_data	disk area where the data for packaging rate plots is stored	Mandatory	None
unpackaging_rates_data	disk area where the data for unpackaging rate plots is stored	Mandatory	None

Last modified: Wed Dec 12 12:13:22 CST 2012