PD-1617 / 25.04 / Pd 1617 create asigra tutoral update solutions article

content/TruenasApps/EnterpriseApps/AsigraApp.md

@@ -0,0 +1,206 @@
+---
+title: "Asigra"
+description: "Provides instructions to configure TrueNAS and install the Asigra DS-System app."
+weight:
+aliases:
+tags:
+- apps
+- media
+keywords:
+- nas data storage
+- software storage solutions
+---
+
+The Asigra DS-System app enables you to offer a robust, scalable service to multiple customers.
+The agentless architecture, where customers only need to install the DS-Client on one LAN computer, eliminates the need to install software on each target backup/restore computer.
+If the DS-Client is networked with the target backup/restore computers, you can browse data, back it up, and restore it as required.
+Customers can run automatic and unattended backups for data environments ranging from single-user standalone computers to enterprise-wide LANs and WANs.
+During backups, the DS-Client extracts changed data, compresses it, and encrypts the items specified for backup.
+Only new or modified data is backed up. This accelerates the backup transmission time.
+Backed-up data is transmitted to the secure off-site data center hosting the DS-System vault over the Internet, intranet, or a direct dial-up connection.
+After clearing security measures for the DS-Client, restores are performed on demand, through the same DS-Client.
+
+The TrueNAS Asigra DS-System app is the vault. An agentless DS-Client backs up data in the vault.
+The DS-Operator is the remote management software for the DS-System. 
+After installing the Asigra DS-System app, you register an account or sign in with an existing account, then log into the DS-System to:
+
+1. Launch the DS-Operator.
+2. Assign an admin role to the TrueNAS user created to serve as the administrator for the Asigra DS-System app.
+3. Configure the DS-System service with a valid Asigra License Server.
+   Enter the IP address or URL for the License server and the valid Asigra license identification number.
+   (Optional) If you have an Emergency DS-License server, make any firewall policy changes to allow the DS-System to connect to the DS-License server.
+4. Configure the DS-System with the service provider information.
+5. Configure customer accounts and DS-Clients on the DS-System.
+
+Install the DS-Operator or management console on the same local network with access to the TrueNAS system hosting the Asigra DS-System.
+
+{{< include file="/static/includes/AppsUnversioned.md" >}}
+
+## Before You Begin
+Before you install the Asigra app:
+
+* Read the [Asigra DS-System documentation]()
+  For more information on the DS-License Server, see Section 2.1 in the [Asigra DS-System User Guide](https://asigra-documentation.s3.amazonaws.com/Guides/Cloud+Backup/v14.2/DS-System_User_Guide.pdf).
+
+  For more information on creating customer accounts and DS-Client, see Section 3.1 in the [Asigra DS-System User Guide](https://asigra-documentation.s3.amazonaws.com/Guides/Cloud+Backup/v14.2/DS-System_User_Guide.pdf).
+
+  For more information on DS-Client accounts, see Section 4.1 in the [Asigra DS-System User Guide](https://asigra-documentation.s3.amazonaws.com/Guides/Cloud+Backup/v14.2/DS-System_User_Guide.pdf).
+
+{{< include file="/static/includes/apps/BeforeYouBeginStableApps.md" >}}
+
+{{< include file="/static/includes/apps/BeforeYouBeginRunAsUser.md" >}}
+
+<div style="margin-left: 33px">{{< trueimage src="/images/SCALE/Apps/AsigraAppDetailsScreen.png" alt="Asigra App Details Screen" id="Asigra App Details Screen" >}}</div>
+
+{{< include file="/static/includes/apps/BeforeYouBeginAddNewAppUser.md" >}}
+<div style="margin-left: 33px">The Asigra has two run-as user IDs, <b>0</b> for the root users and <b>999</b> for the postgres data user.
+The Asigra app also has the default user ID <b>568</b> for the user <b>apps</b>.
+If you create a new TrueNAS user to serve as the administrator user for the app, note the user ID. Add this to the ACL permissions for each dataset created for and used by the app. <!--verify if we need to add this in TrueNAS, and if we need to add this user to the app storage-->
+
+After deploying the app, create a new user in the Asigra DS-Operator to serve as the administration user. <!--verify if we need to add this in TrueNAS, and if we need to add this user to the app storage--></div>
+
+{{< include file="/static/includes/apps/BeforeYouBeginAddAppDatasets.md" >}}
+
+<div style="margin-left: 33px"><a href="https://www.truenas.com/docs/scale/scaletutorials/datasets/datasetsscale/">Create the dataset(s)</a> before beginning the app installation process.
+Asigra expects two host path dataset storage volumes, <b>data</b> and <b>postgres_data</b>.
+You can create more datasets if you want to add additional storage volumes for the app to use, but these are not required and can be added after installing the app.</div>
+
+<div style="margin-left: 33px">{{< include file="/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md" >}}</div>
+
+## Installing the Application
+{{< hint info >}}
+This basic procedure covers the required Asigra app settings.
+For optional settings, see [Understanding App Installation Wizard Settings](#understanding-app-installation-wizard-settings).
+{{< /hint >}}
+
+{{< include file="static/includes/apps/MultipleAppInstancesAndNaming.md" >}}
+
+{{< include file="/static/includes/apps/LocateAndOpenInstallWizard.md" >}}
+
+{{< trueimage src="/images/SCALE/Apps/InstallAsigraScreen.png" alt="Install Asigra DS-System Screen" id="Install Asigra DS-System Screen" >}}
+
+{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}}
+
+Enter the **Asigra Configuration** settings.
+{{< include file="/static/includes/apps/InstallWizardTimezoneSettings.md" >}}
+
+The TrueNAS app is configured with all the environment variables required to deploy the app.
+If you want to customize the container, click **Add** to the right of **Additional Environment Variables** for each to enter the variable(s) and values(s).
+
+Accept the default values in **User and Group Configuration** and **Network Configurations**.
+(Optional) If you created a new user to administer the app, enter that user ID in the user and group fields.
+See [User and Group Configuration](#user-and-group-configuration) and [Network Configuration](#network-configuration) for more details.
+Leave **Host Network** unselected.
+
+Add your **Storage Configuration** settings.
+
+For **Asigra DS-System Configuration Storage**, set the **Type** to **Host Path (Path that already exists on the system)**.
+Select **Enable ACL**, then enter or browse to and select the **config** dataset to populate the **Host Path** field.
+
+{{< trueimage src="/images/SCALE/Apps/InstallAsigraStorageDataACLandACESettings.png" alt="Add  Config Asigra Data ACL and ACE Settings" id="Add Asigra Data ACL and ACE Settings" >}}
+
+Click **Add** to the right of **ACL Entries** for each user or group entry you want to add.
+Click twice to add the **568** and **0** user IDs. Give each **FULL_CONTROL Access**.
+
+Select **Force Flag**.
+
+Next, for **Asigra DS-System Postgres Data Storage**, set **Type** to **Host Path (Path that already exists on the system)**.
+Enter or browse to select the **postgres_data** dataset to populate the **Host Path** field. Do not click **Edit ACL**!
+Select **Automatic Permissions** to set the permissions for this dataset and for the parent dataset if storage volume datasets are nested under a parent dataset. 
+
+{{< trueimage src="/images/SCALE/Apps/InstallAsigraStorageConfigPostgresDataAutoPerms.png" alt="Add  Config Asigra Postgres_Data Automatic Permissions" id="Add Asigra Postgres_Data Automatic Permissions" >}}
+
+See [Storage Configuration Settings](#storage-configuration-settings) below for more information.
+
+Accept the defaults in **Resources Configuration**, and select the GPU option if applicable.
+Select the GPU passthrough checkbox if your system has a GPU.
+
+Click **Install**. A progress dialog displays before switching to the **Installed** applications screen.
+The **Installed** screen displays with the **Asigra DS-System** app in the **Deploying** state. Status changes to **Running** when ready to use.
+
+{{\< trueimage src="/images/SCALE/Apps/AsigraAppRunning.png" alt="Asigra DS-System App Installed and Running" id="Asigra DS-System App Installed and Running" >}}
+
+Click **Register** to start the account creation process, or go to the Asigra sign-in screen to log in with your account credentials.
+
+{{< trueimage src="/images/SCALE/Apps/AsigraNewCustomerInfoScreen.png" alt="Asigra New Customer Information Screen" id="Asigra New Customer Information Screen" >}}
+
+Launch the DS-Operator, create the Asigra user, and assign it the administrator role.
+Next, assign the Asigra DS-System license in the DS-Operator.
+Add the DS-Client accounts, and complete the DS-System configuration to suit your use case.
+
+## Understanding App Installation Wizard Settings
+The following section provides more detailed explanations of the settings in each section of the **Install Asigra DS-System** installation wizard.
+
+### Application Name Settings
+
+{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}}
+
+### Asigra DS-System Configuration Settings
+{{< include file="/static/includes/apps/InstallWizardTimezoneSetting.md" >}}
+
+#### Adding Environment Variables
+{{< include file="/static/includes/apps/InstallWizardEnvironVariablesSettings.md" >}}
+
+Asigra provides information on environment variables you can add through their DS-Client.
+For more information on these variables, see Sections 5.18.2 and 5.21.2 in the [DS-Client User Guide](https://asigra-documentation.s3.amazonaws.com/Guides/Cloud+Backup/v14.2/DS-Client_User_Guide.pdf).
+
+### User and Group Configuration Settings
+
+{{< include file="/static/includes/apps/InstallWizardUserAndGroupConfig.md" >}}
+
+### Network Configuration Settings
+The TrueNAS Asigra DS-System app has three default ports:
+
+* **4401** assigned to and exposes the DS-Client
+* **4404** assigned to and exposes the DS-Operator admin interface
+* **4409** assigned to and exposes the DS-System replication interface
+
+{{< include file="/static/includes/apps/InstallWizardDefaultPorts.md" >}}
+
+### Storage Configuration Settings
+TrueNAS provides two options for storage volumes: ixVolumes and host paths.
+Asigra DS-System expects two host path storage volumes, **data** to hold app DS-System data and **postgres_data** for postgres database storage.
+
+{{< include file="/static/includes/apps/InstallAppsStorageConfig.md" >}}
+
+If you organize the **data** and **postgres_data** datasets under a parent dataset named *asigra*, you can set the permissions for the postgres and parent datasets by selecting **Automatic Permissions** under the **Asigra DS-System Postgres Data Configuration** settings.
+To show this option, set **Type** to **Host Path**. See **Setting Dataset ACL Permissions** below.
+
+You can add extra storage volumes during the app installation or edit the application after it deploys. Stop the app before editing settings.
+{{< include file="/static/includes/apps/InstallAppStorageConfig2.md" >}}
+
+#### Setting Dataset ACL Permissions
+You can configure ACL permissions for a dataset through the **Install Asigra DS-System** wizard or from the **Datasets** screen after adding the datasets.
+We recommend using the **Automatic Permissions** option found in the **Asigra DS-System Postgres Data Storage** section to set the permissions for the postgres and parent datasets.
+Setting permissions from the **Datasets** screen requires several adjustments that, if not correctly set, prevent the app from deploying.
+
+{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}}
+
+{{< expand "Adding ACL Permissions from the Datasets Screen" "v">}}
+First, select the dataset row, scroll down to the **Permissions** widget, and click **Edit** to open the **Edit ACL** screen.
+Change the **@owner** and **@group** values from **root** to the administrative user for your TrueNAS system, and click apply for each.
+Next, add an ACL entry for the run-as user **0** for **root**. You can also add the app default user **568** for **apps**.
+Save the ACL before leaving the screen.
+{{< /expand >}}
+
+{{< expand "Adding Postgres and Parent Dataset ACL Permissions" "v" >}}
+First, set **Type** to **Host Path** to show the **Automatic Permissions** option.
+Do not select **Enable ACL** as this removes the **Automatic Permissions** option.
+
+Next, enter or browse to select **postgres_data** and populate the **Host Path** field with the path to this dataset.
+Select **Automatic Permissions**. TrueNAS sets the required permissions for the postgres storage volume dataset and the parent dataset.
+{{< /expand>}}
+
+TrueNAS **Additional Storage** options include the ability to mount an SMB share inside the container pod.
+{{< include file="/static/includes/apps/InstallWizardStorageConfig2.md" >}}
+
+#### Mounting an SMB Share Storage Volume
+If adding an SMB share as an additional storage volume, create the SMB dataset and share user(s), and add the user ID for the share user(s) to the dataset ACL.
+{{< include file="/static/includes/apps/InstallWizardStorageSMBOption.md" >}}
+
+### Resources Configuration
+
+{{< trueimage src="/images/SCALE/Apps/InstallAsigraResourcesConfig.png" alt="Resources Configuration Settings" id="Resources Configuration Settings" >}}
+
+{{< include file="/static/includes/apps/InstallWizardResourceConfig.md" >}}
+{{< include file="/static/includes/apps/InstallWizardGPUPassthrough.md" >}}