Differences

This shows you the differences between two versions of the page.

--- app_store_connect:back_up_and_restore [2019/03/25 16:41] – su
+++ app_store_connect:back_up_and_restore [2023/08/30 12:50] (current) – [Safely Removing Snapshots / Purge Command] su
@@ Line 8: / Line 8: @@
 ===== Virtual Machine Snapshot =====
-If App Store Connect is installed on a Virtual Machine, snapshot is a reliable way to back-up an entire server. Refer to VM documentation for information on how to create, schedule and restore snapshots.
+If App Store Connect is installed on a Virtual Machine, snapshot is a reliable way to back-up an entire server. However, we also recommend backing up "Big Data" as well (see below).  Refer to VM documentation for information on how to create, schedule and restore snapshots.
@@ Line 30: / Line 30: @@
   * BackupUtility: c:\Program Files\Intelligent Plant\Big Data\BackupUtility\Snapshot.bat
-{{ :app_store_connect:backup01.png?nolink&600 |}}
+{{ :app_store_connect:backup01.png?600 |}}
 This creates a database restore point protecting against data corruption or accidental loss.
 The console window automatically closes after 10 seconds.
-//If BackupUtility is not present, upgrade to the latest App Store Connection//
-  * Download App Store Connect: [https://appstore.intelligentplant.com/Home/DataSources]
@@ Line 64: / Line 59: @@
 For advanced Snapshot management (create/delete/list/restore) open the BackupUtility manager: double click "BackupUtility.exe".
-{{ :app_store_connect:backup04.png?nolink&600 |}}
+{{ :app_store_connect:backup04.png?600 |}}
 List returns all available snapshots. Note the snapshot id is actually a time-stamp (format: YYYYMMddHHmmss).
@@ Line 74: / Line 69: @@
 ===== Scheduled Backup =====
-To configure a regular scheduled backup, create a Windows Scheduled Task to execute the "snapshot.bat" command.
+To configure a regular scheduled backup, create a Windows Scheduled Task to execute one of following batch files:
-Below is a sample configuration.
+  * **Snapshot.bat** - Execute a snapshot
+  * **SnapshotWithPurge.bat** - Execute a snapshot with purge (purge is explained in the Data Retention Policy section below).
+Below is a sample configuration.
 NB. Remember to specify a valid account and adjust schedule to your own preference.
@@ Line 87: / Line 86: @@
     <Date>2019-03-25T15:49:45.0817232</Date>
     <Author>Intelligent Plant</Author>
-    <Description>Daily Snapshot of Elastic</Description>
+    <Description>Daily Big Data Backup</Description>
   </RegistrationInfo>
   <Triggers>
@@ Line 126: / Line 125: @@
   <Actions Context="Author">
     <Exec>
-      <Command>"c:\Program Files\Intelligent Plant\Big Data\BackupUtility\Snapshot.bat"</Command>
+      <Command>"c:\Program Files\Intelligent Plant\Big Data\BackupUtility\SnapshotWithPurge.bat"</Command>
       <WorkingDirectory>c:\Program Files\Intelligent Plant\Big Data\BackupUtility</WorkingDirectory>
     </Exec>
@@ Line 135: / Line 134: @@
+===== Data Retention Policy =====
+Snapshot takes an incremental backup of the Big Data state. Incremental means each snapshot is dependent on the others that have gone before it, and thus may become inefficient if too many snapshots are maintained. Therefore, it is advised to have an archiving and data retention policy in place.
+===== Archiving Snapshots =====
+Snapshots are saved to a backup folder. For a typical App Store Connect installation, the location is:
+<code> C:\Program Files\Intelligent Plant\Big Data\es\backup </code>
+//For custom configuration, see [[big_data_service:modify_data_storage_location|Big Data Service: Modify Data Storage Location]]//
+Providing a Snapshot is not actively being taken, it is safe to **copy** the entire "Snapshots" folder to an achive location.
+**Do not cut or delete files from Snapshots** as this will break the incremental integrity of the files contained.
+===== Safely Removing Snapshots / Purge Command =====
+Snapshots can be removed using the Backup Utility and executing the **Purge** command. This will delete old snapshots according to the retention policy defined in the config file.
+The default snapshot retention is 14 days.
+To modify the retention policy:
+. Open the BackUp Utility config file. \\ For a default installation, the config file is located:
+<code>C:\Program Files\Intelligent Plant\Big Data\BackupUtility\BackupUtility.exe.config</code>
+. Refer to  **AppSettings** section and modify **DayRetentionPolicy** setting.
+<code>
+  <appSettings>
+    <add key="BigDataUrl" value="http://localhost:9200"/>
+    <add key="log4net.Internal.Debug" value="false"/>
+    <add key="DayRetentionPolicy" value="14"/>
+  </appSettings>
+</code>
+. Save file \\ The new setting will take effect the next time the BackupUtility is started.