Service 'archive'

enaio® 11.0

Über die Konfiguration des Services 'archive' werden Verbindungen zu folgenden Archivierungssystemen eingerichtet und konfiguriert:

iCAS / iCAS FS S3 / HCP-Archive / Cloudian Hyperstore / Dell ECS S3 / Dell EMC ECS / Amazon S3 / Netapp StorageGRID S3 / enaio® cloud-archive

Die Konfiguration erfolgt über Profile in der Konfigurationsdatei application-storage.yml aus dem Verzeichnis \services\service-manager\config\.

Konfigurationswerte wie Benutzername und Passwort können in der Konfigurationsdatei verschlüsselt angegeben werden.

Die mitinstallierte Konfigurationsdatei enthält Beispiel-Profile mit Profil-Parameter für unterstützte Archivierungssysteme.

Nach Änderungen an der Konfigurationsdatei application-storage.yml muss der Service 'archive' über enaio® services-admin neu gestartet werden.

Profil für iCAS / iCAS FS:

storage:

profiles:

iternity:

<Profilname>:

Name des Profils.

Der Profilname wird bei der Konfiguration des virtuellen Archivs in enaio® enterprise-manager angegeben.

Sie können mehrere Profile anlegen.

userName:

Name des Benutzers mit entsprechenden Rechten für das Archiv.

userPassword:

Password des Benutzers.

endpoint:

URL des Webservices von iCAS / iCAS FS.

cscMode

Speicher-Modus für Dokumente und Indexdaten.

Der Speicher-Modus wird mit einer Folge von vier Parametern angegeben:

Dokument		Indexdaten
Kompression	Verschlüsselung	Kompression	Verschlüsselung
S (ohne)	N (ohne)	S (ohne)	N (ohne)
L (mit)	S (Standard)	L (mit)	S (Standard)
	A (AES 256)		A (AES 259)

Beispiel:

LSSN

Das Dokument wird komprimiert (L) und mit der Standard-Methode verschlüsselt (S), die Indexdaten werden nicht komprimiert(S) und nicht verschlüsselt (N).

maxCreateCscSize

Bestimmt, bis zu welcher Größe die Container mit der Schreibmethode 'CreateCsc' erzeugt werden.

Die Angabe erfolgt in Byte. Default: 10MB.

maxCreateCscFile

Bestimmt, bis zu welcher maximalen Anzahl von Dokumenten die Container mit der Schreibmethode 'CreateCsc' erzeugt werden.

Default: 1000 Dateien.

maxCreateCscSingleFileLimit

Bestimmt das einzelne Größenlimit eines Dokuments. Bis zu diesem Limit wird die Schreibmethode 'CreateCsc' verwendet.

Die Angabe erfolgt in Byte. Default: 4MB.

Wird das Limit überschritten, wird die Schreibmethode 'AddToWork' verwendet, die weniger speicherintensiv ist und die Container über mehrere Chunks erstellt.

maxWorkChunkSize

Bestimmt, wie groß ein einzelner Chunk für die Schreibmethode 'AddToWork' maximal sein darf.

Die Angabe erfolgt in Byte. Default: 5MB

clientSslTrustStore:

Optional: Ressourcenpfad zu einem Zertifikat-Trust-Store für die verschlüsselte Kommunikation mit iCAS.

Der Pfad zur Zertifikatsdatei wird mit 'file'-Protokoll angegeben.

Beispiel: clientSslTrustStore: file:D:\s-m\zertifikate\cert_icas.PFX

clientSslTrustStorePassword:

Optional: Passwort für den Zertifikat-Trust-Store.

defaultRetentionInDays:

Retentionszeit in Tagen, Default: 0 (Keine Retentionszeit übermitteln)

Für Dokumente mit geplanter Retentionszeit hat diese gegenüber einer hier angegebenen Vorrang.

Profil für iCAS FS S3:
storage:
profiles:
iternity_s3:
<Profilname>:	Name des Profils. Der Profilname wird bei der Konfiguration des virtuellen Archivs in enaio® enterprise-manager angegeben. Sie können mehrere Profile anlegen.
access-key:	Zugriffsschlüssel
secret-key:	Passwort
url:	URL zu S3
bucket:	Bezeichnung des Buckets im Storage-System für die Ablage.
defaultRetentionInDays:	Retentionszeit in Tagen, Default: 0 (Keine Retentionszeit übermitteln) Für Dokumente mit geplanter Retentionszeit hat diese gegenüber einer hier angegebenen Vorrang.
region:	Optional: Standort des Datenzentrums an, in dem neue Buckets erstellt werden. Ohne Angabe wird der Wert über die S3-'Methode GetBucketLocation' ermittelt.
objectLock:	Optional: Boolescher Wert, der bestimmt, ob die archivinterne Retention (objectLock) für den entsprechenden Bucket erforderlich (true) oder optional (false) ist. true (Default): Buckets, die automatisch vom Service 'archive' erstellt werden, haben aktiviertes ObjectLocking. Dokumente, mit gesetzter Retention (enaio:rm_expirationDate oder defaultRetentionInDays) können nur in Buckets mit aktiviertem ObjectLocking gespeichert werden. false: Buckets, die automatisch vom Service 'archive' erstellt werden, haben deaktiviertes ObjectLocking. Für Dokumente, die in Buckets mit deaktiviertem ObjectLocking gespeichert sind, wird keine archivinterne native Retention festgelegt. Damit können Dokumente zwar vor Manipulationen überenaio®‑Endpunkte geschützt werden, nicht aber vor Manipulationen durch direkten Speicherzugriff.
pathTemplate:	Optional: Dieser Parameter kann verwendet werden, um Objekte in bestimmten Verzeichnissen innerhalb eines Buckets zu speichern.
retentionMode:	Optional: Parameter zur Auswahl eines retention mode for S3 Object Lock. COMPLIANCE (Default) Objekte mit Retention können weder geändert noch gelöscht werden, auch nicht von einem Speicheradministrator. GOVERNANCE Objekte mit Retention können von einem Speicheradministrator mit bestimmten Berechtigungen geändert und gelöscht werden.

Profil für Hitachi Content Platform:
storage:
profiles:
hcp_s3:
<Profilname>:	Name des Profils. Der Profilname wird bei der Konfiguration des virtuellen Archivs in enaio® enterprise-manager angegeben. Sie können mehrere Profile anlegen.
access-key:	Zugriffsschlüssel
secret-key:	Passwort
url:	URL zu HCP
bucket:	Bezeichnung des Buckets im Storage-System für die Ablage.
defaultRetentionInDays:	Retentionszeit in Tagen, Default: 0 (Keine Retentionszeit übermitteln) Für Dokumente mit geplanter Retentionszeit hat diese gegenüber einer hier angegebenen Vorrang.

Profil für Cloudian HyperStore:

Für die Konfiguration des Cloudian Hyperstore Archivs sind folgende S3-relevante Parameter zu konfigurieren.

storage:
profiles:
cloudian_s3:
<Profilname>:	Name des Profils. Der Profilname wird bei der Konfiguration des virtuellen Archivs in enaio® enterprise-manager angegeben. Sie können mehrere Profile anlegen.
access-key:	Zugriffsschlüssel
secret-key:	Passwort
url:	URL zu Cloudian HyperStore
bucket:	Bezeichnung des Buckets im Storage-System für die Ablage.
defaultRetentionInDays:	Retentionszeit in Tagen, Default: 0 (Keine Retentionszeit übermitteln) Die in den Index-Daten des Objekts während des Imports vom Aufrufer gesetzte Retention (enaio:rm_expirationDate) hat Vorrang vor der hier angegebenen Retentionszeit. Ein Administrator mit Zugang zum Speicher kann die Objekte löschen, wenn der Speicher nicht mit aktivem ObjectLocking konfiguriert ist.
region:	Optional: Standort des Datenzentrums an, in dem neue Buckets erstellt werden. Ohne Angabe wird der Wert über die S3-'Methode GetBucketLocation' ermittelt.
objectLock:	Optional: Wert, der angibt, ob die archivinterne Retention (objectLock) für den entsprechenden Bucket erforderlich oder optional ist. true Buckets, die automatisch vom Service 'archive' erstellt werden, haben aktiviertes ObjectLocking. Binäre Content-Dateien mit gesetzter Retention - enaio:rm_expirationDate oder defaultRetentionInDays - können nur in Buckets mit aktiviertem ObjectLocking gespeichert werden. false Buckets, die automatisch vom Service 'archive' erstellt werden, haben deaktiviertes ObjectLocking. Für binäre Content-Dateien, die in Buckets mit aktiviertem ObjectLocking gespeichert werden, wird eine archivinterne native Retention festgelegt. Für binäre Content-Dateien, die in Buckets mit deaktiviertem ObjectLocking gespeichert werden, wird keine archivinterne native Retention festgelegt. Damit können binäre Content-Dateien zwar vor Manipulationen über enaio®-Endpunkte geschützt werden, nicht aber vor Manipulationen durch direkten Speicherzugriff. Default: true
retentionMode:	Optional: Parameter zur Auswahl eines retention mode for S3 Object Lock. COMPLIANCE (Default) Objekte mit Retention können weder geändert noch gelöscht werden, auch nicht von einem Speicheradministrator. GOVERNANCE Objekte mit Retention können von einem Speicheradministrator mit bestimmten Berechtigungen geändert und gelöscht werden.
pathTemplate	Optional: Parameter, um Objekte in angegebenen Verzeichnissen innerhalb eines Buckets zu speichern.

Profil für Dell ECS S3:
storage:
profiles:
ecs_s3:
<Profilname>:	Name des Profils. Der Profilname wird bei der Konfiguration des virtuellen Archivs in enaio® enterprise-manager angegeben. Sie können mehrere Profile anlegen.
access-key:	Zugriffsschlüssel
secret-key:	Passwort
url:	URL zu Dell ECS S3
bucket:	Bezeichnung des Buckets im Storage-System für die Ablage.
defaultRetentionInDays:	Retentionszeit in Tagen, Default: 0 (Keine Retentionszeit übermitteln) Die in den Index-Daten des Objekts während des Imports vom Aufrufer gesetzte Retention (enaio:rm_expirationDate) hat Vorrang vor der hier angegebenen Retentionszeit. Ein Administrator mit Zugang zum Speicher kann die Objekte löschen, wenn der Speicher nicht mit aktivem ObjectLocking konfiguriert ist.
region:	Optional: Standort des Datenzentrums an, in dem neue Buckets erstellt werden. Ohne Angabe wird der Wert über die S3-'Methode GetBucketLocation' ermittelt.
objectLock:	Optional: Wert, der angibt, ob die archivinterne Retention (objectLock) für den entsprechenden Bucket erforderlich oder optional ist. true Buckets, die automatisch vom Service 'archive' erstellt werden, haben aktiviertes ObjectLocking. Binäre Content-Dateien mit gesetzter Retention - enaio:rm_expirationDate oder defaultRetentionInDays - können nur in Buckets mit aktiviertem ObjectLocking gespeichert werden. false Buckets, die automatisch vom Service 'archive' erstellt werden, haben deaktiviertes ObjectLocking. Für binäre Content-Dateien, die in Buckets mit aktiviertem ObjectLocking gespeichert werden, wird eine archivinterne native Retention festgelegt. Für binäre Content-Dateien, die in Buckets mit deaktiviertem ObjectLocking gespeichert werden, wird keine archivinterne native Retention festgelegt. Damit können binäre Content-Dateien zwar vor Manipulationen über enaio®-Endpunkte geschützt werden, nicht aber vor Manipulationen durch direkten Speicherzugriff. Default: true
pathTemplate:	Optional: Dieser Parameter kann verwendet werden, um Objekte in bestimmten Verzeichnissen innerhalb eines Buckets zu speichern.
retentionMode:	Optional: Parameter zur Auswahl eines retention mode for S3 Object Lock. COMPLIANCE (Default) Objekte mit Retention können weder geändert noch gelöscht werden, auch nicht von einem Speicheradministrator. GOVERNANCE Objekte mit Retention können von einem Speicheradministrator mit bestimmten Berechtigungen geändert und gelöscht werden.

Profil für Dell EMC ECS:

Für Dell EMC ECS sind Anpassungen notwendig.

storage:
profiles:
ecs-cas:
<Profilname>:	Name des Profils. Der Profilname wird bei der Konfiguration des virtuellen Archivs in enaio® enterprise-manager angegeben. Sie können mehrere Profile anlegen.
access-key:	Benutzername
password:	Passwort
clusterId	Nummer des Clusters, auf den zugegriffen wird.
url:	URL zu Dell EMC ECS
bucket:	Bezeichnung des Buckets, er im Health-Check angezeigt werden soll.
defaultRetentionInDays	Retentionszeit in Tagen, Default: 0 (Keine Retentionszeit übermitteln) Für Dokumente mit geplanter Retentionszeit hat diese gegenüber einer hier angegebenen Vorrang.
calculateDigestMetadata	Default: false, Optional: Es kann notwendig sein, ein Digests in der getMetadata-Abfrage zu berechnen.
calculateDigestContent	Default: false, Optional: Es kann notwendig sein, ein Digests in der getContent-Abfrage zu berechnen. Der Digest wird im Content-hash-HTTP-Header mitgesendet.

Anpassungen für Dell EMC ECS

Folgende Anpassungen sind für Dell EMC ECS notwendig:

Bibliotheken einbinden
- Laden Sie das Archiv dell_ecs_cas_lib64.zip, entpacken Sie das Archiv auf dem Rechner von enaio® service-manager und erweitern Sie die Systemvariable 'Path' um den Pfad zu dem Verzeichnis.
- Stellen Sie sicher, dass die folgenden Dateien im Verzeichnis System32 bzw. Syswow64 vorhanden sind:
  
  msvcp110.dll und msvcr110.dll
  
  Falls nicht, dann können diese Dateien über das Microsoft Visual C++ 2012 Redistributable-Package installiert werden.
- Starten Sie den Rechner neu.

Profil für Amazon S3:
storage:
profiles:
s3:
<Profilname>:	Name des Profils. Der Profilname wird bei der Konfiguration des virtuellen Archivs in enaio® enterprise-manager angegeben. Sie können mehrere Profile anlegen.
access-key:	Zugriffsschlüssel
secret-key:	Passwort
url:	URL zu S3
bucket:	Bezeichnung des Buckets im Storage-System für die Ablage.
defaultRetentionInDays:	Retentionszeit in Tagen, Default: 0 (Keine Retentionszeit übermitteln) Für Dokumente mit geplanter Retentionszeit hat diese gegenüber einer hier angegebenen Vorrang.
retentionMode:	Optional: Parameter zur Auswahl eines Object Lock COMPLIANCE Objekte mit Retention können nicht geändert oder gelöscht werden, auch nicht von Speicheradministratoren. GOVERNANCE Speicherbenutzer mit bestimmten Berechtigungen können Objekte unter Aufbewahrung ändern oder löschen. Default: COMPLIANCE
region:	Optional: Gibt den Standort des Datenzentrums an, in dem neue Buckets erstellt werden sollen. Default: Ermittelt über die S3-Methode 'GetBucketLocation'.
objectLock:	Optional: Wert, der angibt, ob die archivinterne Retention (objectLock) für den entsprechenden Bucket erforderlich oder optional ist. true Buckets, die automatisch vom Service 'archive' erstellt werden, haben aktiviertes ObjectLocking. Binäre Content-Dateien mit gesetzter Retention - enaio:rm_expirationDate oder defaultRetentionInDays - können nur in Buckets mit aktiviertem ObjectLocking gespeichert werden. false Buckets, die automatisch vom Service 'archive' erstellt werden, haben deaktiviertes ObjectLocking. Für binäre Content-Dateien, die in Buckets mit aktiviertem ObjectLocking gespeichert werden, wird eine archivinterne native Retention festgelegt. Für binäre Content-Dateien, die in Buckets mit deaktiviertem ObjectLocking gespeichert werden, wird keine archivinterne native Retention festgelegt. Damit können binäre Content-Dateien zwar vor Manipulationen über enaio®-Endpunkte geschützt werden, nicht aber vor Manipulationen durch direkten Speicherzugriff. Default: true
pathTemplate:	Optional: Parameter, um Objekte in angegebenen Verzeichnissen innerhalb eines Buckets zu speichern.

Profil für Netapp StorageGRID S3
storage:
profiles:
netapp_s3:
<Profilname>:	Name des Profils. Der Profilname wird bei der Konfiguration des virtuellen Archivs in enaio® enterprise-manager angegeben. Sie können mehrere Profile anlegen.
access-key:	Zugriffsschlüssel
secret-key:	Passwort
url:	URL zu Netapp StorageGRID S3
bucket:	Bezeichnung des Buckets im Storage-System für die Ablage.
defaultRetentionInDays:	Retentionszeit in Tagen, Default: 0 (Keine Retentionszeit übermitteln) Die in den Index-Daten des Objekts während des Imports vom Aufrufer gesetzte Retention (enaio:rm_expirationDate) hat Vorrang vor der hier angegebenen Retentionszeit. Ein Administrator mit Zugang zum Speicher kann die Objekte löschen, wenn der Speicher nicht mit aktivem ObjectLocking konfiguriert ist.
region	Optional: Standort des Datenzentrums an, in dem neue Buckets erstellt werden. Ohne Angabe wird der Wert über die S3-'Methode GetBucketLocation' ermittelt.
objectLock	Optional: Wert, der angibt, ob die archivinterne Retention (objectLock) für den entsprechenden Bucket erforderlich oder optional ist. true Buckets, die automatisch vom Service 'archive' erstellt werden, haben aktiviertes ObjectLocking. Binäre Content-Dateien mit gesetzter Retention - enaio:rm_expirationDate oder defaultRetentionInDays - können nur in Buckets mit aktiviertem ObjectLocking gespeichert werden. false Buckets, die automatisch vom Service 'archive' erstellt werden, haben deaktiviertes ObjectLocking. Für binäre Content-Dateien, die in Buckets mit aktiviertem ObjectLocking gespeichert werden, wird eine archivinterne native Retention festgelegt. Für binäre Content-Dateien, die in Buckets mit deaktiviertem ObjectLocking gespeichert werden, wird keine archivinterne native Retention festgelegt. Damit können binäre Content-Dateien zwar vor Manipulationen über enaio®-Endpunkte geschützt werden, nicht aber vor Manipulationen durch direkten Speicherzugriff. Default: true
pathTemplate	Optional: Dieser Parameter kann verwendet werden, um Objekte in bestimmten Verzeichnissen innerhalb eines Buckets zu speichern.
retentionMode	Optional: Parameter zur Auswahl eines retention mode for S3 Object Lock. COMPLIANCE (Default) Objekte mit Retention können weder geändert noch gelöscht werden, auch nicht von einem Speicheradministrator. GOVERNANCE Objekte mit Retention können von einem Speicheradministrator mit bestimmten Berechtigungen geändert und gelöscht werden.

Profil für enaio® cloud-archive

Für enaio® cloud-archive muss ein Plugin eingebunden werden.

Profil für enaio® cloud-archive
storage:
profiles:
enaio-cloud-archive:
<Profilname>:	Name des Profils. Der Profilname wird bei der Konfiguration des virtuellen Archivs in enaio® enterprise-manager angegeben. Sie können mehrere Profile anlegen.
url:	URL
tenant:	Tenant
username:	Benutzername
password:	Passwort
silo:	Wert, um Daten zu kategorisieren und darüber leichter aufzufinden. Für die Angabe von Silo-Werten sind keine Konfigurationen in enaio® cloud-archive notwendig.
defaultRetentionInDays:	Retentionszeit in Tagen, Default: 0 (Keine Retentionszeit übermitteln) Für Dokumente mit geplanter Retentionszeit hat diese gegenüber einer hier angegebenen Vorrang.
connectionTimeoutInMillis:	Timeout für die Verbindung in Millisekunden Default: 5000
readTimeoutInMillis:	Timout für das Lesen von Dateien in Millisekunden Default: 1800000

Plugin für enaio® cloud-archive

Für enaio® cloud-archive wird ein Plugin benötigt. Das Plugin enaio-cloud-archive.zip ist Bestandteil der Installationsdaten im Verzeichnis \Backend\Service-Manager-Update\Plugins.

Über die Datei application-storage.yml im Verzeichnis \config\ von enaio® service-manager müssen Plugins aktiviert werden und das Verzeichnis für das Plugin muss angegeben werden.

storage:
  plugins:
    enabled: true
    directory: "c:\enaio\data\plugins"
                                                            

Das Plugin muss in das angegebene Verzeichnis kopiert werden, im Beispiel C:\enaio\data\plugins.

Das Plugin enaio-cloud-archive.zip ist nicht in die Aktualisierung durch enaio_services_versionfix.exe eingebunden und muss bei Bedarf durch Kopieren in das angegebene Plugin-Verzeichnis manuell aktualisiert werden.

Danach muss der Service 'archive' neu gestartet werden. enaio-cloud-archive.zip wird dabei in einen Unterordner mit gleichem Namen entpackt. Aktualisierungen des Plugins werden nur durchgeführt, wenn vorher der Unterordner mit dem entpackten Plugin gelöscht wird.

Weitere Konfigurationen zum Einbinden des Plugins sind nicht notwendig.

Die Daten für die Konfiguration – URL, Tenant, Benutzername und Passwort – erhalten Sie von OPTIMAL SYSTEMS, einschließlich der Informationen zum Ändern von Benutzername und Passwort.

Verschlüsselung von Konfigurationswerten

Die Konfigurationswerte der Datei application-storage.yml im Verzeichnis \config\ von enaio® service-manager können verschlüsselt werden:

Öffnen Sie die Eingabeaufforderung als Administrator und wechseln Sie in das Verzeichnis \service-manager\tools\encryption\.
Führen Sie folgenden Befehl aus: encode.bat "value" -W

Der verschlüsselte Wert wird mit führendem 'ENC' und in runden Klammern angezeigt: ENC(encryptedvalue)
Kopieren Sie den verschlüsselten Wert mit führendem 'ENC' und mit den runden Klammern und tragen Sie diesen in die Konfigurationsdatei ein.
Speichern Sie die Konfigurationsdatei und starten Sie den Service gegebenenfalls neu.

Wenn der zu verschlüsselnde Wert Anführungszeichen enthält oder mit einem Backslash endet, dann müssen diese Zeichen durch einen Backslash maskiert werden.
Beispiel: encode.bat "passwordwith\"quotation\"marks" -W