• Administrators
• Time
• Network
• Network Security
• Storage
• Serviceability
• Authentication
• Kerberos
• Registration
• Summary

1. Connect to the Delphix Engine at http://<Delphix Engine>/login/index.html#serverSetup.
   The Delphix Setup application will launch when you connect to the server.
   Enter your sysadmin login credentials, which initially defaults to the username sysadmin, with the initial default password of sysadmin.  On first login, you will be prompted to change the initial default password.
2. Click Next.

1. Enter your Support Username and Support Password.
2. Click Register.

If external connectivity is not immediately available, you must perform manual registration.

1. Copy the Delphix Engine registration code in one of two ways:
   
   1. Manually highlight the registration code and copy it to clipboard. Or,
   2. Click Copy Registration Code to Clipboard.
2. Transfer the Delphix Engine's registration code to a workstation with access to the external network Internet. For example, you could e-mail the registration code to an externally accessible e-mail account.
3. On a machine with access to the external Internet, please use your browser to navigate to the Delphix Registration Portal at http://register.delphix.com.
4. Login with your Delphix support credentials (username and password).
5. Paste the Registration Code.
6. Click Register.

The Delphix Engine must be able to connect to the source environment in case of the Delphix Initiated and External backups in order to discover running databases and to orchestrate the backup functionality.  For external backups (native or Commvault), a single environment can be used as both source and target.

General Source Host Requirements

• HANA database must be installed and running. This is true even for an external backup scenario.
• There must be an operating system user which has HANA administrative user privileges  <sid>adm:
• The Delphix Engine must be able to make an SSH connection to the source environment using the operating system user.
• The operating system user must have read and execute privileges on the HANA binaries installed on the source environment.
• The operating system user must have read, write, and execute access to the HANA data directories on the source environment.
• A plugin directory must exist on the source host. The directory must have the following properties:
• be writable by the operating system user described above.
• have at least 256 MB of available storage.
• TCP/IP connectivity to and from the source environment must be configured as described in General Network and Connectivity Requirements.
• Hostname and IP address must be correctly configured. 

Source Requirements for External Backups

• A directory path on the source environment which contains customer backups must exist which terminates with a subdirectory called "BACKUP”.

<some_dir>/BACKUP

where the BACKUP directory will contain the customer prepared HANA backup files of the source tenant database. Contents of the BACKUP directory will be copied to the Delphix Engine using rsync.

The full path to the directory which contains the "BACKUP" directory is specified by the user during the process of adding the dSource (ie: .../BACKUP is implied, the user does not include.../BACKUP when specifying the path in the UI).

• The operating system user must have read privileges on the BACKUP directory.

Source Requirements for Commvault Backups

• Source hosts must be registered with a single, common Commvault backup system deployment.
• Commvault integration must be pre-configured on all relevant source HANA instances.
• Log Archiving on source must be enabled by the customer for any source wishing to use archived logs during provisioning, and the resultant archived logs must be stored in Commvault, for use by Delphix during recovery and provisioning of ROOT VDBs
• A source database must have all backups and archive logs that Delphix needs on one Commvault server (CommServe) only.
• Commvault SAP HANA Data Agent should be installed on both the source host(Commvault’s requirement).
• The absolute path of the Commvault binaries on the Source host must be part of the PATH system variable.
• As per the commvault recommendation, below soft link should have been created at /hana/shared/<SID>/global/hdb/opt location via root user:-

  
  

  cd /usr/sap/<SID>/SYS/global/hdb/opt
  ln -s /opt/commvault/iDataAgent/backint hdbbackint
  
  In the same manner, a soft link should be created for the param file as well:-
  
  cd /usr/sap/<SID>/SYS/global/hdb/opt#
  
  mkdir hdbconfig
  
  ln -s /opt/commvault2/iDataAgent/param param

• Below changes should have been made in the global.ini file to reflect that the system has to now start creating the backint backups:-
  

 [backup]

          data_backup_parameter_file = /hana/shared/<SID>/global/hdb/opt/hdbconfig/param

          log_backup_parameter_file = /hana/shared/<SID>/global/hdb/opt/hdbconfig/param

          log_backup_using_backint = true

          [multidb] mode = multidb

          database_isolation = low

          [persistence]

          basepath_logbackup = /usr/sap/<SID>/HDB00/backup/log

          basepath_databackup = /usr/sap/<SID>/HDB00/backup/data

          enable_auto_log_backup = yes

          log_backup_timeout_s = 900

          log_mode = normal

          basepath_datavolumes = /hana/data/<SID>

          basepath_logvolumes = /hana/log/<SID>

A target environment is where virtualized databases run. A target environment must have a HANA instance installed and configured. The VDB will become a tenant on the target database instance.  

In the case of the Commvault based ingestion mechanism, a target environment can be used as a source as well.

Target Environment Requirements

1. The operating system of the target environment must match the source environment.
2. The SAP HANA installation on the target environment must have the same or higher version than the source environment.
3. There must be an operating system user with the following privileges:
1. The Delphix Engine must be able to make an SSH connection to the target environment using the operating system user.
2. The operating system user must have read and execute privileges on the HANA binaries installed on the target environment.
3. The operating system user must have permission to run mount and unmount as the superuser via sudo with neither a password nor a TTY. See Sudo Requirements for the HANA 2.0 Plugin.
4. Prior to the discovery, a plugin directory on the target environment must exist with the following properties:
1. The plugin directory must be writable by the operating system user mentioned above.
2. The plugin directory must have at least 256 MB of available storage.
5. There must be a mount point directory (for example, /mnt) that will be used as the base for mount points that are created when provisioning a VDB with the following properties:
1. The mount point directory must be writable by the operating system user mentioned above.
2. The mount point directory should be empty.
6. The following two directories must not exist or be empty: /mnt1 and /mnt2. These directories will be used where recovery is required for provision. These directories are not required when provision is from a root VDB.
7. TCP/IP connectivity to and from the source environment must be configured as described in General Network and Connectivity Requirements.
8. The hostname and IP address must be correctly configured.

Additional Target Requirements: Commvault Backups

• Target hosts must be registered with a single, common Commvault backup system deployment.
• Commvault integration must be pre-configured on all relevant Target HANA instances.
• Commvault SAP HANA Data Agent should be installed on Target host.
• A Single Target host can be used for both the dSource and VDB operations as well.
• The absolute path of the commvault binaries on the Target host must be part of the PATH system variable. For eg- If the Commvault binaries are present under /opt/commvault/Base then the PATH variable should include this path.
• Commavault user password should be stored in a file that should be accessible by the hdbadm user. The password here needs to be stored in an encrypted format.  Below is an example representing the same:-./SIMCallWrapper -optype 100 -enc Password -output /opt/input

          Here SIMCallWrapper is a binary located in the location where commvault binary files have been downloaded.

          Password:- Password to connect to Commvault.

          /opt/input:- input here is a file that needs to be created before the time when this command has been run. /opt here refers to the directory where the input file has been kept.

• Below are the set of pre-configuration required to be done before using Commvault based Ingestion:
  • The SAP HANA database expects the backup agent executable (hdbbackint) to be at the below path:

    /usr/sap/<SID>/SYS/global/hdb/opt

    Please note: This is the standard location as per Commvault recommendation. Thereafter, create a symbolic link for hdbbackint executable provided by the third party tool as below:

    ln -s <SAP_Data_Agent_Installation_Directory>/iDataAgent/backint  /usr/sap/HDB/SYS/global/hdb/opt/hdbbackint 

    Please note: "/opt/commvault" is the default software installation path.

    The customer will have to set the value of the commvault binaries' absolute path in the PATH variable.

  • The SAP HANA parameter file is a must in order to use the Backint API interface on the target instance. The file must exist. The file must be named “param” and located under the iDataAgent directory under the install path. For example: /opt/commvault/iDataAgent/param.

    This file contains parameters to perform cross-machine restore as well as perform a restore. The name of the parameter is srcCrossClient. This parameter will contain the name of the source client name on Commvault. Below is the text which needs to be added at the last of the param file.

    srcCrossClient
    comm-src

  • Check for  hdbconfig directory at below path:
    

    /usr/sap/<SID>/SYS/global/hdb/opt/hdbconfig

    • Check for symbolic link for the param file at above path as below:

    ln -s /opt/commvault/iDataAgent/param /usr/sap/<SID>/SYS/global/hdb/opt/hdbconfig/param

    • Assign the file to group sapsys that the sid user owns

    • Assign the read-write permission (664) to the file.

  • Check the global.ini file to use Backint Interface at location - /usr/sap/HDB/SYS/global/hdb/custom/config

    [backup]

    catalog_backup_using_backint = true 

    catalog_backup_parameter_file = /usr/sap/<SID>/SYS/global/hdb/opt/hdbconfig/param

    backint_response_timeout = 1800 (how long backint process waits to acquire the Commvault resources for log backup)

    log_backup_using_backint = true

Prerequisites

• Make sure that the HANA environment in question meets the requirements described in Requirements for HANA Source Hosts and Databases and Requirements for HANA Target Hosts and Databases.

Procedure

1. Login to the Delphix Management application.
2. Click Manage.
3. Select Environments.
4. Next to Environments, click the Actions (...) menu and select Add Environment.
5. In the Add Environment dialog, In the Host OS select Unix/Linux on the menu.
6. In Server Type, select Standalone Host.
7. Click Next.
8. Enter  Name for the environment.
9. Enter the Host IP address or fully qualified hostname.
10. Enter the SSH port.

The default value is 22.

1. Enter an OS Username for the environment which should be ‘<sidadm>’.
2. Select Login Type.
3. For Password, enter the password associated with the user in step 11.
4. Using Public-Key Authentication:

1. Select ‘Username and Public Key’ for the Login Type.
2. Click View Public Key.
3. Copy the public key that is displayed, and append it to the end of the ~/.ssh/authorized_keys file of the new user being added. If this directory or file does not exist, you will need to create it.

1. Run chmod 600 ~/.ssh/authorized_keys to enable read and write privileges only for your user.
2. Run chmod 755 ~ to secure the user's home directory.

Add the public once per user and per environment.

You can also add public key authentication to an environment user's profile by using the command-line interface, as explained in the topic CLI Cookbook: Setting Up SSH Key Authentication for UNIX Environment Users.

1. For Password Login, click ‘Validate’ to test the username and password.
2. Enter a Plugin Path. The location specified must be a string without spaces. Ensure this directory path exists on the host in question. Environment discovery will fail if the directory does not exist on the host.
3. To provide your own Oracle Java select the Provide my own JDK checkbox and click Next.
4. In the Java Development Kit tab enter the absolute path to your Oracle JDK and click Next. For more information, see Providing Your Own Oracle Java.
5. Click Submit. On success, the new environment will be added to the list in the Environments tab.
6. Select the “Databases” tab to view discovered HANA databases:

The steps required to link a HANA database are dependent on whether a customer chooses:

• Delphix Initiated Backups. Backups on the source tenant database will be created and transferred to the Delphix Engine during the dSource linking process.

OR

• External Backups. The customer will provide a “Backup Path” containing FULL and Incremental backups. These files will be copied to the Delphix Engine during the dSource linking process. In this scenario the Delphix Engine will not require any credentials of source database; operating system credentials will be required to effect file transfer via rsync.

OR

• Commvault Backups: The customer will provide Commserve details. Source Backups available at the Commserve will be ingested into the Delphix Engine during the Provisioning process (VDB creation). Delphix will use the pre-existing backups on the commvault server to perform a restore on the target database.

Prerequisites

• Backup files must meet the required file naming convention, prior to linking using the External Backup option. The naming convention is:

    <file_name>_UTC_<UTC_END_TIME>

  For example:

    complete_database_backup_prd_0_1_UTC_2018-12-10TSTMP12:18:19.327000000

  The UTC_END_TIME of any backup is available by querying the catalog of a tenant database. For example, the following SQL query will return all possible values for the tenant:

    select ENTRY_ID,ENTRY_TYPE_NAME,BACKUP_ID,UTC_END_TIME from M_BACKUP_CATALOG order by ENTRY_ID desc;

• Optionally, users can choose to manually adjust file names or automate this using scripting. The plugin includes a script designed to work remotely in source environments, see HANA 2.0 Plugin Tools.
• When a dSource will be linked using Delphix Initiated Backups, access to the system database user on the source must be available, the HANA system must be running and the source tenant must be online.
• When using Commvault Backup as Ingestion method, below steps needs to be performed for "Commserve Password Encrypted File Path"
  1. Create an empty file(any name) in a directory where the OS user (for eg -hdbadm) has read-write permissions.
  2. Encrypt the password using "SIMCallWrapper" utility located under CommVault Binary Path. SIMCallWrapper -optype 100 -enc <password> -output <Empty File Path created in step 1>
• Ensure that the source and target host and database both meet the requirements set out in Requirements for HANA Source Hosts and Database. and Requirements for HANA Target Hosts and Databases

Procedure

1. Login to the Delphix Management application.
2. Select Manage > Environments. Then select the Datasets tab.
   
   
3. Create a source configuration on which to build the dSource. You can do this by clicking on the + symbol. The Source configuration can have any name.
4. In the Add dSource wizard, select the required source configuration.
5. After selecting the source, below are the details required to create the dsource for the three approaches:

   1. Delphix Initiated Backups:

      Select the checkbox Allow Delphix to initiate backup operations on the source database.

      The following parameters are required to create the dsource:

      • SAP HANA Source Tenant Database Name
      • Source SystemDB User Name
      • Source SystemDB Password
      • Source Tenant Database User Name
      • Source Tenant Database Password

      Select Next.

   2. External Backups:

      Enter the backup location. This represents the path to the location of the customer provided backup files. The path entered should exclude the final directory in the hierarchy which must be “BACKUP”.

      • For example, external backups have been generated and placed in the following location:

          /usr/sap/HDB/HDB00/SAP_BACKUP/BACKUP    

               In this example, the backup path entered in the User Interface should be

         /usr/sap/HDB/HDB00/SAP_BACKUP

      Important: file transfer during dSource linking relies on rsync against all directories at the same level as the “BACKUP” directory. To prevent the transfer of unneeded files (which extends the duration of linking and may cause recovery failure during provision) avoid creating directories at the same level in the directory hierarchy as the “BACKUP” directory itself. If this situation can not be avoided, use the exclude path option during dSource creation.

      Select Next.

   3. CommVault Backups: Check(select) the flag Enable CommVault Integrated Backups icon and click on the ADD button.

      The following parameters are required to create the dsource:

      • Commserve Host Address
      • Commserve User Name
      • Path to Encrypted Commserve Password - Check the Prerequisites section above for details.
      • Source Database SID
      • Client Name - Source Unix/Linux Client name with which it is registered in Commvault
      • Registered Commserve Psuedo Client Name - Source SAP HANA Client(pseudoclient) name with which the HANA SID is registered in Commvault.
      • RPO Offset(minutes) - Recovery Point Object to ensure consistent recovery. The RPO offset back-dates the VDB recovery point for a dSource Snapshot. For more details please refer to section RPO offset under the page Commvault - HANA Integration
        
6. Enter a name and select a group for your dSource.
   Adding a dSource to a dataset group lets you set Delphix Domain user permissions for that database and its objects, such as snapshots. See the topics under Users and Groups for more information.
7. Configure the SnapSync and Retention Policy. The SnapSync policy can be set to ‘None’ for customers who wish not to run a scheduled SnapSync job.
8. Optionally, users can provide the bash script as a plugin defined hook. Both Pre-Snapshot and Post-SnapShot hooks can be used Select Next.
9. At the end of the workflow, review the dSource Configuration in the Summary pane as shown below:

Once the dSource linking job is submitted it is possible to monitor progress by selecting “Active Jobs” in the top menu bar. On successful completion of the new dSource will be visible in the list of Datasets under its assigned group.

Prerequisites

• The provision requires a linked a dSource built off a physical source tenant, as described in Linking a HANA dSource, or a VDB.
• The HANA target environment should adhere to Requirements for HANA Hosts and Databases.
• Operating system users and database users should be configured 

Procedure

1. Login to the Delphix Management application.
2. Click Manage.
3. Select Datasets.
4. Select a dSource.
5. Select a snapshot from which you want to provision.
6. Click Provision vFiles icon to open Provision VDB wizard.
7. Select a target environment from the left pane.
8. The HANA 2.0 Plugin supports one installation on the same host, hence the value in the Installation dropdown will be already populated. Multiple drop-down options should not be available.
9. Set the Environment User to be the Instance Owner. Note: The picking of instance owner is only possible if you have multiple environment users set on that host.
10. Click Next.
11. In the Target Configuration pane you will need to specify:

    1. Mount Path: This will be populated automatically and can be changed as per requirement by a user. Delphix recommends setting the trailing directory to match the VDB name to delineate mount points and support administration and troubleshooting. In the example shown, the VDB Mount Path is /mnt/provision/dev where dev matches the Target Tenant Database Name.

    2. SAP HANA Target Tenant Database Name: This refers to the target tenant database name which will be created upon VDB creation.

    3. Target SystemDB User Name: This refers to the SystemDB username in the target database.

    4. Target SystemDB Password: This refers to the SystemDB password in the target database.

    5. Target Tenant Database User Name: This refers to the username of the tenant System user.

    6. Target Tenant Database Password: This refers to the password of the tenant System user.

12. Click Next.

    • If the SYSTEM user credentials for the systemDB match the tenant credentials, then filling in the Target Tenant Database Username and Password is optional. The Plugin will copy the systemDB fields when the last two (tenant) fields are empty.
    • The SYSTEM username and password derived from the physical source database should be entered in steps (v) and (vi) during the provision of a root VDB because those credentials will be recovered during provision.
    • If provision succeeds and the Tenant SYSTEM username and password have been specified, then the password can be corrected following the steps outlined in Steps to modify HANA dSource Properties.
    • If a provision of a child VDB succeeds and the SYSTEM username has been specified, but the password does not match the root VDB (source), then the new password specified during provision will overwrite the older password from the root VDB.
13. In the configuration section,
    1. Set the vFile Name or accept the default, which is a random string. Delphix strongly recommends applying a consistent naming convention. We suggest this name should match the Target Tenant Name from the previous pane. Maintaining a consistent naming convention will support administration and troubleshooting activities. In the example shown, the vFile Name “dev” matches the actual tenant name and mount point from the previous pane.
    2. Select a Target Group for the VDB.
       Click the Add Dataset Group icon to add a new group if required.
    3. Set Auto vFiles Restart option to automatically restart the VDB, where the target host is rebooted. Delphix recommends enabling this setting.
14. Click Next.
15. VDB Snapshot Policy. Select the Snapshot policy if an automated VDB snapshot schedule is required. Optionally, the Snapshot policy may be disabled by selecting “None”.
16. Click Next.
17. Masking. This page offers the opportunity to link the provision job to a masking job. At this time, Delphix Masking does not support HANA. Please do not use this option. “Mask this VDB” should remain deselected.
18. Hooks. Run a customized shell script via a hook operation at a particular moment in the provision operation.
19. Click Next.
20. Summary. Presents an opportunity to review all the information as a part of the initial provision workflow.
21. Click Submit.
    Once a provision job is submitted it is possible to monitor its progress by selecting “Active Jobs” in the top menu bar. On successful completion, VDB will be visible in the list of Datasets under its assigned group.