Skip to content
Snippets Groups Projects
Commit c636dc88 authored by Jörg Sachse's avatar Jörg Sachse
Browse files

chore: use updated subapp.cfg template with Bagit-SubApp

parent 0e4e4c8b
No related branches found
No related tags found
1 merge request!1ND-1759
Show whitespace changes
Inline Side-by-side
templates/.subapp.cfg.j2
+ 90
− 23
View file @ c636dc88
### OPTIONAL PARAMETERS
###########################
### OPTIONAL PARAMETERS ###
###########################
### optional processing and log settings
# Absolute path to a file that contains a CSV list of SIPs that should be ignored by the subapp. One entry per line. You can create the file and leave it empty if you like; subapp will then act as if there was no blacklist at all and process all the SIPs.
blacklist_sip_file:/home/{{ vault_subapp_user }}/.subapp/usa_blacklist_file.csv
# Absolute path to a PID file
pid_file:/run/subapp/subapp_bagit.pid
# Log4perl log level
logger_min_level:debug
############################
### MANDATORY PARAMETERS ###
############################
### MANDATORY PARAMETERS
bookmark_file:/home/{{ vault_subapp_user }}/.subapp/usa_bookmark_file.yaml
database_file:/home/{{ vault_subapp_user }}/.subapp/subapp.db
dependency_file:/home/{{ vault_subapp_user }}/.subapp/usa_dependency_file.yaml
deposit_file_regex:^[S|s][I|i][P|p]\.xml$
# HINT: only 'METS/MODS' for now
deposit_file_type:METS/MODS
### internal working directories
# Absolute path to the directory that is used for controlling, processing and storing exports from Rosetta.
# Restore requests need to be put below directory_export/consumer_dir/.
# Restored IEs can be found in directory_export/rosetta_export/.
directory_export:/mnt/{{ ansible_hostname }}_access/
# Absolute path to the directory which is used for placing lockfiles into for SIPs when their processing commences.
directory_lock:/home/{{ vault_subapp_user }}/.subapp/lockdir/
# Absolute path to the directory which contains symlinks to the SIPs that encountered errors during the processing and are put into quarantine. These SIPs will be ignored until the error is resolved.
directory_quarantine:/home/{{ vault_subapp_user }}/.subapp/quarantine/
# Absolute path to the directory which is used for processing SIPs that contain an AIP update.
directory_shared_aipupdate:/mnt/{{ ansible_hostname }}_ingest/aipupdate/
# Absolute path to the directory producers use to upload their SIPs to.
directory_shared_import:/mnt/import/
# Absolute path to the directory that the submission application uses to put processed SIPs into for them to be fetched by Rosetta. Please note that the path to this directory needs to be accessible by Rosetta as well, and it needs to have the exact same name, so put extra attention into the naming of volumes, mount points and NFS export policy (or equivalent).
directory_shared_ingest:/mnt/{{ ansible_hostname }}_ingest/
fullname_workflow:{{ vault_subapp_vars.hosts[ansible_hostname].fullname_workflow | default("WORKFLOW_NAME_TEMPLATE") }}
general_cleanup_age_in_seconds:1209600
isarchived_file:/home/{{ vault_subapp_user }}/.subapp/usa_isarchived_file.yaml
logger_producer_email:{{ vault_subapp_vars.hosts[ansible_hostname].logger_producer_email | default("LOGGER_PRODUCER_EMAIL_TEMPLATE") }}
logger_staff_email:{{ vault_subapp_vars.hosts[ansible_hostname].logger_staff_email | default("LOGGER_STAFF_EMAIL_TEMPLATE") }}
max_allowed_SIP_size_in_bytes:100000000000
max_allowed_compressed_SIP_size_in_bytes:{{ vault_subapp_vars.hosts[ansible_hostname].max_allowed_compressed_SIP_size | default("268435456000") }}
max_allowed_single_file_size_in_bytes:{{ vault_subapp_vars.hosts[ansible_hostname].max_allowed_single_file_size | default("268435456000") }}
mdupdate_file:/home/{{ vault_subapp_user }}/.subapp/usa_mdupdate_file.yaml
mets_filegroup_to_archive:LZA
min_required_disk_space_in_bytes:{{ vault_subapp_vars.hosts[ansible_hostname].min_required_disk_space | default("268435456000") }}
owner_group_export_dir:access
### user/group settings
# Name of the Linux user that owns the subapp's ingest directory.
owner_user_ingest_dir:{{ vault_subapp_user }}
# Name of the Linux group that owns the subapp's import directory.
owner_group_import_dir:import
# Name of the Linux group that owns the subapp's ingest directory.
owner_group_ingest_dir:{{ vault_subapp_group }}
owner_user_ingest_dir:{{ vault_subapp_user }}
# Name of the Linux group that owns the subapp's access directory.
owner_group_export_dir:access
### Rosetta settings
# FQDN of a) the host that the Rosetta application with the DEP role is running on or b) the load balancer that is in front of a Rosetta application cluster
rosetta_host:{{ vault_subapp_vars.hosts[ansible_hostname].RosettaHost | default("ROSETTA_HOSTNAME_TEMPLATE") }}
# FQDN of the host that the PDS authentication server is running on
rosetta_pdshost:{{ vault_subapp_vars.hosts[ansible_hostname].PdsHost | default("PDS_HOSTNAME_TEMPLATE") }}
# name of the institution in Rosetta that the subapp will ingest its SIPs into
rosetta_institute:{{ vault_subapp_vars.hosts[ansible_hostname].Institute | default("INSTITUTE_NAME_TEMPLATE") }}
# Material Flow ID of the Material Flow that will be used for processing SIPs in Rosetta
rosetta_materialflowId:{{ vault_subapp_vars.hosts[ansible_hostname].MaterialFlowID | default("MATERIAL_FLOW_ID_TEMPLATE") }}
rosetta_password:{{ vault_subapp_vars.hosts[ansible_hostname].Rosetta_Password }}
rosetta_pdshost:{{ vault_subapp_vars.hosts[ansible_hostname].PdsHost | default("PDS_HOSTNAME_TEMPLATE") }}
# username of the user that the subapp will use for authentication against PDS/Rosetta
rosetta_user:{{ vault_subapp_vars.hosts[ansible_hostname].User | default("SUBMISSION_APPLICATION_USER_TEMPLATE") }}
# password of that user
rosetta_password:{{ vault_subapp_vars.hosts[ansible_hostname].Rosetta_Password }}
### processing configuration
# Workflow name as agreed upon in the contract between producer and archive.
fullname_workflow:{{ vault_subapp_vars.hosts[ansible_hostname].fullname_workflow | default("WORKFLOW_NAME_TEMPLATE") }}
### disk space considerations
# UNcompressed SIPs may not exceed the size in Bytes that is configured here.
max_allowed_SIP_size_in_bytes:100000000000
# COMPRESSED SIPs may not exceed the size in Bytes that is configured here.
max_allowed_single_file_size_in_bytes:{{ vault_subapp_vars.hosts[ansible_hostname].max_allowed_single_file_size | default("268435456000") }}
# Required free disk space on directory_shared_import. If the actual free disk space is below the configured value, then the submission application will not extract any further ZIPped SIPs.
min_required_disk_space_in_bytes:{{ vault_subapp_vars.hosts[ansible_hostname].min_required_disk_space | default("268435456000") }}
# time until old producer protocols are removed
general_cleanup_age_in_seconds:1209600
### email notification configuration
# notification email address for producers (high level error information)
logger_producer_email:{{ vault_subapp_vars.hosts[ansible_hostname].logger_producer_email | default("LOGGER_PRODUCER_EMAIL_TEMPLATE") }}
# notification email address for archive staff (low level error information)
logger_staff_email:{{ vault_subapp_vars.hosts[ansible_hostname].logger_staff_email | default("LOGGER_STAFF_EMAIL_TEMPLATE") }}
### database configuration
# Absolute path to SQLite database file for storing and loading message queues and SIP states
# Hints: using /tmp is not allowed by SQLite, furthermore security requires the parent directory to be set to at least '750' (drwxr-x---)
database_file:/home/processing/.subapp/subapp.db
templates/.subapp.cfg.j2_rc2020.2 deleted 100644 → 0
+ 0
− 112
View file @ 0e4e4c8b
###########################
### OPTIONAL PARAMETERS ###
###########################
### optional processing and log settings
# Absolute path to a file that contains a CSV list of SIPs that should be ignored by the subapp. One entry per line. You can create the file and leave it empty if you like; subapp will then act as if there was no blacklist at all and process all the SIPs.
blacklist_sip_file:/home/{{ vault_subapp_user }}/.subapp/usa_blacklist_file.csv
# Absolute path to a PID file
pid_file:/run/subapp/subapp_bagit.pid
# Log4perl log level
logger_min_level:debug
############################
### MANDATORY PARAMETERS ###
############################
### internal working directories
# Absolute path to the directory that is used for controlling, processing and storing exports from Rosetta.
# Restore requests need to be put below directory_export/consumer_dir/.
# Restored IEs can be found in directory_export/rosetta_export/.
directory_export:/mnt/{{ ansible_hostname }}_access/
# Absolute path to the directory which is used for placing lockfiles into for SIPs when their processing commences.
directory_lock:/home/{{ vault_subapp_user }}/.subapp/lockdir/
# Absolute path to the directory which contains symlinks to the SIPs that encountered errors during the processing and are put into quarantine. These SIPs will be ignored until the error is resolved.
directory_quarantine:/home/{{ vault_subapp_user }}/.subapp/quarantine/
# Absolute path to the directory which is used for processing SIPs that contain an AIP update.
directory_shared_aipupdate:/mnt/{{ ansible_hostname }}_ingest/aipupdate/
# Absolute path to the directory producers use to upload their SIPs to.
directory_shared_import:/mnt/import/
# Absolute path to the directory that the submission application uses to put processed SIPs into for them to be fetched by Rosetta. Please note that the path to this directory needs to be accessible by Rosetta as well, and it needs to have the exact same name, so put extra attention into the naming of volumes, mount points and NFS export policy (or equivalent).
directory_shared_ingest:/mnt/{{ ansible_hostname }}_ingest/
### user/group settings
# Name of the Linux user that owns the subapp's ingest directory.
owner_user_ingest_dir:{{ vault_subapp_user }}
# Name of the Linux group that owns the subapp's import directory.
owner_group_import_dir:import
# Name of the Linux group that owns the subapp's ingest directory.
owner_group_ingest_dir:{{ vault_subapp_group }}
# Name of the Linux group that owns the subapp's access directory.
owner_group_export_dir:access
### Rosetta settings
# FQDN of a) the host that the Rosetta application with the DEP role is running on or b) the load balancer that is in front of a Rosetta application cluster
rosetta_host:{{ vault_subapp_vars.hosts[ansible_hostname].RosettaHost | default("ROSETTA_HOSTNAME_TEMPLATE") }}
# FQDN of the host that the PDS authentication server is running on
rosetta_pdshost:{{ vault_subapp_vars.hosts[ansible_hostname].PdsHost | default("PDS_HOSTNAME_TEMPLATE") }}
# name of the institution in Rosetta that the subapp will ingest its SIPs into
rosetta_institute:{{ vault_subapp_vars.hosts[ansible_hostname].Institute | default("INSTITUTE_NAME_TEMPLATE") }}
# Material Flow ID of the Material Flow that will be used for processing SIPs in Rosetta
rosetta_materialflowId:{{ vault_subapp_vars.hosts[ansible_hostname].MaterialFlowID | default("MATERIAL_FLOW_ID_TEMPLATE") }}
# username of the user that the subapp will use for authentication against PDS/Rosetta
rosetta_user:{{ vault_subapp_vars.hosts[ansible_hostname].User | default("SUBMISSION_APPLICATION_USER_TEMPLATE") }}
# password of that user
rosetta_password:{{ vault_subapp_vars.hosts[ansible_hostname].Rosetta_Password }}
### processing configuration
# Workflow name as agreed upon in the contract between producer and archive.
fullname_workflow:{{ vault_subapp_vars.hosts[ansible_hostname].fullname_workflow | default("WORKFLOW_NAME_TEMPLATE") }}
### disk space considerations
# UNcompressed SIPs may not exceed the size in Bytes that is configured here.
max_allowed_SIP_size_in_bytes:100000000000
# COMPRESSED SIPs may not exceed the size in Bytes that is configured here.
max_allowed_single_file_size_in_bytes:{{ vault_subapp_vars.hosts[ansible_hostname].max_allowed_single_file_size | default("268435456000") }}
# Required free disk space on directory_shared_import. If the actual free disk space is below the configured value, then the submission application will not extract any further ZIPped SIPs.
min_required_disk_space_in_bytes:{{ vault_subapp_vars.hosts[ansible_hostname].min_required_disk_space | default("268435456000") }}
# time until old producer protocols are removed
general_cleanup_age_in_seconds:1209600
### email notification configuration
# notification email address for producers (high level error information)
logger_producer_email:{{ vault_subapp_vars.hosts[ansible_hostname].logger_producer_email | default("LOGGER_PRODUCER_EMAIL_TEMPLATE") }}
# notification email address for archive staff (low level error information)
logger_staff_email:{{ vault_subapp_vars.hosts[ansible_hostname].logger_staff_email | default("LOGGER_STAFF_EMAIL_TEMPLATE") }}
### database configuration
# Absolute path to SQLite database file for storing and loading message queues and SIP states
# Hints: using /tmp is not allowed by SQLite, furthermore security requires the parent directory to be set to at least '750' (drwxr-x---)
database_file:/home/processing/.subapp/subapp.db
### deposit settings - LEGACY
#
deposit_file_regex:^[S|s][I|i][P|p]\.xml$
deposit_file_type:METS/MODS
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment

DE: Impressum · Datenschutzerklärung | EN: Legal Notice · Privacy Policy