application-storage.yml
Configuration file containing parameters and archive profiles used by the ARCHIVE and REPOSITORY service in order to connect external archives.
Characteristics
| Configuration File Name | application-storage.yml |
|---|---|
| Referenced by Services | archive,repository |
| Storage Location | Git root directory |
File Structure
The file application-storage.yml is structured as follows:
storage:
repositories:
<repositoryId>:
profiles: ['<archiveProfile>']
<parameter>: <value>
profiles:
<archiveDriverName>:
<archiveProfile>:
<parameter>: <value>
Define your repositories via repositoryId. For each of them, specify an archive profile and thus define the type of archive driver for the corresponding repository. Set the parameters url and useDiscovery as described below.
For each type of archive driver identified by archiveDriverName, define one or more archive profiles. The name of each archive profile must be unique within the configuration file. Depending on the archive type, specific configuration parameters have to be set as described below too.
Parameters
| Parameter | Description | Example | |
|---|---|---|---|
storage.repositories | Configurations of repositories for by the REPOSITORY service. The | s3:
profiles: ['s3profile1']
default: true
netapp:
profiles: ['netapplike']
url: http://archive/api/profiles/{profile}/dms/objects
useDiscovery: true
| |
profiles | A list of archive profile names, each of them referencing an archive profile defined in the Note: Only the first list entry will be considered whereas further list entries will be ignored. | ||
url | Address of the repository accessible via the ARCHIVE service. The archive profile can be referenced as dynamic component in curly brackets (e.g., Not required for a repository of type | ||
useDiscovery | Boolean value specifying if the given url contains a reference and should be interpreted via the discovery (true) or if an absolute address is specified (false). | ||
storage.profiles | Archive profiles for each archive driver. Multiple profiles can be defined for each archive driver. The name of each profile is defined via the corresponding key (e.g., The parameters for the configuration of an archive profile depend on the archive driver indicated by the corresponding | s3:
s3profile1:
access-key: 'MGMWCOYTDUSLNCFE'
secret-key: 'changeme'
url: 'http://minio.infrastructure:9000'
bucket: 'dmscloudrepodocker'
netapp:
netapplike:
# use mountpoint of the persistent volume claim that provides the netapp storage
# must be the same in the deployment of the archive app
volume: '/var/lib/netapp/data'
defaultRetentionInDays: 10
| |
The values for the parameters can be modified as described here.
>> Configuring Services using Profiles.
Parameters in Archive Profiles
Depending on the archive driver, the archive profiles have to be configured with specific parameters.
The defaultRetentionInDays parameter can be set in all following archive profiles and is only relevant for the ARCHIVE service. This value is used as retention time for objects that do not have a retention time specified within their metadata during their import. If defaultRetentionInDays is set to 0 which is also the default value, no retention will be set for those objects.
Parameters for S3 Archive Profiles
Use s3 as value for archiveDriverName.
| Parameter | Description | Default Value |
|---|---|---|
access-key | Access key | - |
secret-key | Password | - |
url | URL for S3 | - |
bucket | Name of the bucket in the archive system for filing. | - |
| Retention time in days. To transmit no retention time, set the value For objects with a scheduled retention time, this has priority over any times specified here. | 0 |
Parameters for NetApp Archive Profiles
Use netapp as value for archiveDriverName.
| Parameter | Description | Default Value |
|---|---|---|
volume | Archive location for the data to be saved. | - |
| Optional: Retention time in days. To transmit no retention time, set the value For objects with a scheduled retention time, this has priority over any times specified here. | 0 |
enableReadOnly | Optional: Defines whether the drivers of the archive should define data to be read-only. | true |
Parameters for iCAS Archive Profiles
Use iternity as value for archiveDriverName.
| Parameter | Description | Default Value | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userName | Name of the user with the appropriate rights for the archive. | - | ||||||||||||||||||||
userPassword | The user's password. | - | ||||||||||||||||||||
endpoint | URL of the iCAS web service. | - | ||||||||||||||||||||
cscMode | Storage mode for objects and meta data. The storage mode is specified with a sequence of four parameters:
Example:
The binary content file is compressed (L) and encrypted with the standard method (S); the metadata is not compressed (S) and not encrypted (N). | - | ||||||||||||||||||||
maxCreateCscSize | Determines the maximum size of containers. The information is specified in bytes. | 10000000 | ||||||||||||||||||||
maxCreateCscFile | Determines the maximum number of objects for the containers. | 1000 | ||||||||||||||||||||
maxCreateCscSingleFileLimit | Determines the individual size limit of an object. | 4000000 | ||||||||||||||||||||
maxWorkChunkSize | Determines the maximum size of a single chunk. The information is specified in bytes. | 5000000 | ||||||||||||||||||||
| Optional: Resource path to a certificate trust store for encrypted communication with the web service. | - | ||||||||||||||||||||
| Optional: Password for the certificate trust store. | - | ||||||||||||||||||||
| Retention time in days. To transmit no retention time, set the value For objects with a scheduled retention time, this has priority over any times specified here. | 0 | ||||||||||||||||||||
Parameters for Hitachi Content Platform Archive Profiles
Use hcp_s3 as value for archiveDriverName.
| Parameter | Description | Default Value |
|---|---|---|
access-key | Access key | - |
secret-key | Password | - |
url | URL for HCP | - |
bucket | Name of the bucket in the archive system for filing. | - |
| Retention time in days. To transmit no retention time, set the value For objects with a scheduled retention time, this has priority over any times specified here. | 0 |
Parameters for Cloudian HyperStore Archive Profiles
The Cloudian Hyperstore Content Platform provides an AWS-S3-compatible rest API with few extensions used by the ARCHIVE service. In order to configure the Cloudian Hyperstore archive, you need to configure the following (S3-relevant) parameters.
Use cloudian_s3 as value for archiveDriverName.
| Parameter | Description | Default Value |
|---|---|---|
access-key | Access key | - |
secret-key | Password | - |
url | URL for Cloudian HyperStore | - |
bucket | Name of the bucket in the archive system for filing. | - |
| Retention time in days. To transmit no retention time, set the value For objects with a scheduled retention time, this has priority over any times specified here. | 0 |
pathTemplate | Optional: This parameter can be used to store objects in specific directories (paths) within a bucket. | - |
Parameters for Dell EMC ECS Archive Profiles
Use ecs_cas as value for archiveDriverName.
| Parameter | Description | Default Value |
|---|---|---|
access-key | User name | - |
password | Password | - |
clusterId | Number of the cluster that is being accessed. | - |
url | URL to Dell EMC ECS | - |
bucket | Name of the bucket to be displayed in the health check. | - |
defaultRetentionInDays | Retention time in days. To transmit no retention time, set the value For objects with a scheduled retention time, this has priority over any times specified here. | 0 |
calculateDigestMetadata | Optional: It may be necessary to compute a digest in the getMetadata query. | false |
calculateDigestContent | Optional: It may be necessary to compute a digest in the getContent query. The digest is sent in the Content-hash-HTTP header. | false |