In this guide, we will walk through deploying a Delphix Engine, starting with configuring Source, Staging (aka Validated Sync), and Target database environments. We will then create a dSource, and provision a VDB. It assumes that you are working in a Lab/Dev setting and attempting to quickly test Delphix functionality. It assumes you will use the VMware Hypervisor.
Deploy OVA on VMware
Use the Delphix-supplied OVA file to install the Delphix Engine. The OVA file is configured with many of the minimum system requirements and deploys to one 300GB hard disk with 8 vCPUs and 64GB RAM. The underlying storage for the install is assumed to be redundant SAN storage.
Download the OVA file from https://download.delphix.com . You will need a support login from your sales team or a welcome letter.
Navigate to "Virtual Appliance" and download the appropriate OVA. If you are unsure, use the HWv8_Standard type.
Login using the vSphere client to the vSphere server (or vCenter Server) where you want to install the Delphix Engine.
In the vSphere Client, click File .
Select Deploy OVA Template .
Browse to the OVA file.
Click Next .
Select a hostname for the Delphix Engine.
This hostname will also be used in configuring the Delphix Engine network.
Select the data center where the Delphix Engine will be located.
Select the cluster and the ESX host .
Select one (1) datastore for the Delphix OS . This datastore can be thin-provisioned and must have enough free space to accommodate the 300GB comprising the Delphix operating system.
Select four (4) or more datastores for Database Storage for the Delphix Engine. The Delphix Engine will stripe all of the Database Storage across these VMDKs, so for optimal I/O performance, each VMDK must be equal in size and be configured Thick Provisioned - Lazy Zeroed . Additionally, these VMDKs should be distributed as evenly as possible across all four SCSI I/O controllers.
Select the virtual network you want to use.
If using multiple physical NICs for link aggregation, you must use vSphere NIC teaming. Do not add multiple virtual NICs to the Delphix Engine itself. The Delphix Engine should use a single virtual network. For more information, see Optimal Network Architecture for the Delphix Engine .
Click Finish .
The installation will begin and the Delphix Engine will be created in the location you specified.
Setup Network Access to the Delphix Engine
Power on the Delphix Engine and open the Console.
Wait for the Delphix Management Service and Delphix Boot Service to come online.
This might take up to 10 minutes during the first boot. Wait for the large orange box to turn green.
Press any key to access the sysadmin console.
- Enter sysadmin@SYSTEM for the username and sysadmin for the password.
You will be presented with a description of available network settings and instructions for editing.
Delphix Engine Network Setup To access the system setup through the browser, the system must first be configured for networking in your environment. From here, you can configure the primary interface, DNS, hostname, and default route. When DHCP is configured, all other properties are derived from DHCP settings. To see the current settings, run "get." To change a property, run "set <property>=<value>." To commit your changes, run "commit." To exit this setup and return to the standard CLI, run "discard." defaultRoute IP address of the gateway for the default route -- for example, "188.8.131.52." dhcp Boolean value indicating whether DHCP should be used for the primary interface. Setting this value to "true" will cause all other properties (address, hostname, and DNS) to be derived from the DHCP response dnsDomain DNS Domain -- for example, "delphix.com" dnsServers DNS server(s) as a list of IP addresses -- for example, "184.108.40.206,220.127.116.11." hostname Canonical system hostname, used in alert and other logs -- for example, "myserver" primaryAddress Static address for the primary interface in CIDR notation -- for example, "18.104.22.168/22" Current settings: defaultRoute: 192.168.1.1 dhcp: false dnsDomain: example.com
Configure the hostname. If you are using DHCP you can skip this step.
delphix network setup update *> set hostname=<hostname>Use the same hostname you entered during the server installation.
Configure DNS. If you are using DHCP, you can skip this step.
delphix network setup update *> set dnsDomain=<domain> delphix network setup update *> set dnsServers=<server1-ip>[,<server2-ip>,...]
Configure either a static or DHCP address.
delphix network setup update *> set dhcp=true
delphix network setup update *> set dhcp=false delphix network setup update *> set primaryAddress=<address>/<prefix-len>The static IP address must be specified in CIDR notation (for example, 192.168.1.2/24)
Configure a default gateway. If you are using DHCP, you can skip this step.
delphix network setup update *> set defaultRoute=<gateway-ip>
Commit your changes. Note that you can use the get command prior to committing to verify your desired configuration.
delphix network setup update *> commit Successfully committed network settings. Further setup can be done through the browser at: http://<address> Type "exit" to disconnect, or any other commands to continue using the CLI.
Check that you can now access the Delphix Engine through a Web browser by navigating to the displayed IP address, or hostname if using DNS.
Setting Up the Delphix Engine
Once you setup the network access for Delphix Engine, navigate to the Delphix Engine URL in your browser for server setup.
The setup procedure uses a wizard process to take you through eight configuration screens:
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 the first login, you will be prompted to change the initial default password.
The Delphix Engine supports two types of administrators:
- System Administrator ( sysadmin ) - this is the engine system administrator. The sysadmin password is defined here .
Engine Administrator ( admin) - this is typically a DBA who will administer all the data managed by the engine.The default domain user created on Delphix Engines is now admin instead of delphix_admin. When engines created before 5.3.1 are upgraded to 5.3.1 or later they will retain their old username 'delphix_admin'. To avoid complications Delphix recommends creating users with an admin role and then Disabling delphix_admin.
Choose your option to setup system time in this section.
For a Quick Start, simply set the time and your timezone. You can change this later.
The initial out-of-the-box network configuration in the OVA file is set to use a single VMXNET3 network adapter.
You have already configured this in the initial configuration. Delphix supports more advanced configurations, but you can enable those later.
You should see the data storage VMDKs or RDMs you created during the OVA installation. Click Next to configure these for data storag e.
Choose your options to configure serviceability settings.
For a Quick Start, accept the defaults. You can change this later.
If the Delphix Engine has access to the external Internet (either directly or through a web proxy), then you can auto-register the Delphix Engine:
- Enter your Support Username and Support Password .
- Click Register.
If external connectivity is not immediately available, you must perform manual registration.
- Copy the Delphix registration code in one of two ways:
- Manually highlight the registration code and copy it to the clipboard. Or,
- Click Copy Registration Code to Clipboard .
- 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 email account.
- 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 .
- Login with your Delphix support credentials (username and password).
- Paste the Registration Code .
- Click Register .
To regenerate the registration code for a Delphix Engine please refer to, Regenerating the Delphix Engine Registration Code. Delphix strongly recommends that you regenerate this code and re-register the engine regularly to maximize the Support Security of the Delphix Engine. Delphix recommends doing this every six months.
The final summary tab will enable you to review your configurations for System Time, Network, Storage, Serviceability, and Authentication.
- Click the Back button to go back and to change the configuration for any of these server settings.
- If you are ready to proceed, then click Submit .
- Click Yes to confirm that you want to save the configuration.
- Click Setup to acknowledge the successful configuration.
- There will be a wait of several minutes as the Delphix Engine completes configuration.
Source and Target Environment Requirements
Each DB2 Source host (master) must meet these requirements:
- IBM DB2 installed and an instance created on the machine
- HADR settings for each database to be used with the standby server should be preset before the linking process begins
Requirements for DB2 Staging and Target Hosts and Instances
- The staging environment that the Delphix Engine uses must have access to an existing full backup of the source database on disk to create the first full copy. Delphix recommends using compressed backups as that will reduce storage needs and speed up ingest.
- The staging and target DB2 instances that you wish to use must already exist on the host and contain no existing databases.
- The available instances on each host can be verified by going to the databases tab for the environment in question.
Additional Environment Requirements
There must be an operating system user ( delphix_os ) with these privileges:
Ability to login to the target environment via SSH
Ability to run mount, umount, mkdir, and rmdir as a super-user. If the target host is an AIX system, permission to run the nfso command as a super-user. See Sudo Privilege Requirements for DB2 Environments for further explanation of the commands and Sudo File Configuration Examples for DB2 Environments for examples of the /etc/sudoers file on different operating systems.
There must be a directory on the staging and target environment where you can install the Delphix Engine Toolkit – for example, /var/opt/delphix/toolkit .
The delphix_os user must own the directory.
The directory must have permissions -rwxrwx--- (0770), but you can also use more permissive settings.
If delphix os user and instance users (responsible for DE operations such as linking and provisioning) are not sharing any common group, then toolkit directory must have -rwxrwxrwx (0777) permissions.
The delphix_os user must have read and execute permissions on each directory in the path leading to the toolkit directory. For example, when the toolkit is stored in /var/opt/delphix/toolkit, the permissions on /var, /var/opt, and /var/opt/delphix should allow read and execute for "others," such as -rwxr-xr-x.
The directory should have 1.5GB of available storage: 400MB for the toolkit and 400MB for the set of logs generated by each DB2 instance that runs on the host.
In DB2 Toolkit: toolkit directory space will be used as the base location for the mount point.
The Delphix Engine must be able to initiate an SSH connection to the target environment
NFS client services must be running on the target environment
Instance User Requirements
- The instance owner of each instance you wish to use within a staging or a target host must be added as an environment user within the Delphix engine. See Managing DB2 Users and Instance Owners .
- For HADR synced dSources the staging instance owner must be able to "read" the ingested database contents as Delphix will check the validity of the database by querying tables before each dSource snapshot.
Database Container Requirements
- All DB2 database containers types are fully supported with the exception of DB2 raw containers. NOTE: If a container is added or deleted, the dSource will have to be resynced.
Instance level configuration values such as the bufferpool value will need to be managed by the customer independent of Delphix. The instances used for staging and target environments must be compatible with the source DB2 instance. The Delphix DB2 DB Level toolkit supports managing dSources with database level granularity.
Sudo Privilege Requirements for DB2 Environments
This topic describes the rationale behind specific sudo privilege requirements for virtualizing the DB2 Databases.
|Privilege||Sources||Targets and Staging||Rationale|
|mkdir/rmdir||Not Required||Required||Delphix dynamically makes and removes directories under the provisioning directory during VDB operations. This privilege is optional, provided the provisioning directory permissions allow the delphix os user to make and remove directories.|
|mount/umount||Not Required||Required||Delphix dynamically mounts and unmounts directories under the provisioning directory during VDB operations. This privilege is required because mount and umount are typically reserved for superuser.|
It is required to specify the NOPASSWD qualifier within the "sudo" configuration file, as shown here: Sudo File Configuration Examples for DB2 Environments . This ensures that the "sudo" command does not demand the entry of a password, even for the "display permissions" (i.e. "sudo -l") command.
Delphix issues "sudo -l" in some scripts to detect if the operating system user has the correct sudo privileges. If it is unable to execute this command, some actions may fail and Delphix will raise an alert suggesting it does not have the correct sudo permissions. Restricting the execution of "sudo -l" by setting “listpw=always” in the “/etc/sudoers” file when the Delphix operating system user is configured to use public key authentication will cause the Delphix operating system user to be prompted for a password which will fail certain Delphix actions. Use a less restrictive setting for listpw than "always" when the Delphix operating system user is using public key authentication.
Adding a DB2 Environment
Make sure that the staging environment in question meets the requirements described in Requirements for DB2 Hosts and Databases.
- Login to the Delphix Management application.
- Click Manage .
- Select Environments .
- Next, to Environments , click the Actions (...) menu and select Add Environment .
- In the Add Environment dialog, select Unix/Linux in the menu.
- Select Standalone Host .
- Click Next .
- Enter a Name for the environment.
- Enter the Host IP address or hostname .
- Enter the SSH port .
- The default value is 22.
- Enter an OS Username for the environment. For more information about the environment user requirements, see Requirements for DB2 Hosts and Databases .
- Select Login Type.
- For Password, enter the password associated with the user in step 9.
- Using Public Key Authentication:
- If you want to use public key encryption for logging into your environment:
- Select Public Key for the Login Type.
- Click View Public Key.
- Copy the public key that is displayed, and append it to the end of your ~/.ssh/authorized_keys file. If this file does not exist, you will need to create it.
- Run chmod 600 authorized_keys to enable read and write privileges for your user.
- Run chmod 755 ~ to make your home directory writable only by your user.
- The public key needs to be added only 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 .
- For Password Login, click Verify Credentials to test the username and password.
- Enter a Toolkit Path (make sure toolkit path does not have spaces).
- For more information about the toolkit directory requirements, see Requirements for DB2 Hosts and Databases .
- Click Submit .
As the new environment is added, you will see two jobs running in the Delphix platform Job History, one to Create and Discover an environment, and another to Create an environment. When the jobs are complete, you will see the new environment added to the list in the Environments tab. If you do not see it, click the Refresh icon in your browser.
Managing DB Instances
When you add an environment with the Delphix Management Application, all existing DB2 instances on the host are automatically discovered by Delphix. A list of all instances and databases are available to Delphix based on the environment discovery process.
- Login to the Delphix Management application.
- Click Manage .
- Select Environments .
- In the Environments panel, click on the name of the environment to you want to refresh.
- Select the Databases tab to see a list of all DB2 instances found in the environment.
Linking a Data Source (dSource)
Be sure that the source and staging instances meet the host requirements and the databases meet the container requirements described in Requirements for DB2 Hosts and Databases .
Source Database Preparation
Instance Owner Permissions
Delphix uses the DB2 instance owner account on the dSource for many things, including verifying the data inside the databases. For ingesting database on the staging server with different instance we need permissions on the source database to do restore on the staging server. For example in the source if we have an instance named auto1051 and database name delphix and if we want to create a dSource on the auto1052 instance on staging server then you must explicitly grant DBADM and SECADM to the dSource instance auto1052 on the source instance using the following steps :
- Connect to the source database as the source instance owner.
- connect to <DB_NAME> user <INSTANCE_OWNER>
- Issue database grant command.
- grant DBADM, SECADM on database to user <DSOURCE_INSTANCE_OWNER>
- Repeat step 2 for every database to be included in the dSource, on the corresponding source database.
Determine if your dSource will be a non-HADR instance, an HADR single standby instance, or an HADR multiple standby instance. Non-HADR dSources can only be updated via a full dSource resync from a newer backup file
HADR Single Standby Database
- All items in Non-HADR Database section above.
- The following database configuration settings must be set:
- update db cfg for <DB_NAME> using HADR_LOCAL_HOST <PRIMARY_IP> HADR_LOCAL_SVC <PRIMARY_PORT > immediate
- update db cfg for <DB_NAME> using HADR_REMOTE_HOST <STANDBY_IP> HADR_REMOTE_SVC <STANDBY_PORT> immediate
- update db cfg for <DB_NAME> using HADR_REMOTE_INST <STANDBY_INSTANCE_NAME> immediate
- update db cfg for <DB_NAME> using HADR_SYNCMODE SUPERASYNC immediate
- If database configuration parameter LOGINDEXBUILD is set to OFF, do the following:
- update db cfg for <DB_NAME> using LOGINDEXBUILD ON
- Force off all connections to the database and reactivate the database
- If database configuration parameter LOGARCHMETH1 is set to OFF, do the following:
- update db cfg for <DB_NAME> using LOGARCHMETH1 XXXX (must be a valid log archiving method)
- Take an offline backup
- If LOGARCHMETH1 points to a third-party backup server (i.e. TSM or Netbackup) define LOGARCHMETH2 to disk
- Log files in the directory must be available from the time of the backup until the restore has successfully completed on the dSource.
- update db cfg for <DB_NAME> using LOGARCHMETH2 DISK:<full path to archive log directory>
- db2 start hadr on db <DB_NAME> as primary by force
- Take a full online backup as defined in the "Backup Source Database" section below.
- Record the following information, as it must be entered on the Delphix Engine while creating the dSource.
- HADR Primary hostname
- HADR Primary SVC
- HADR Standby SVC (auxiliary standby port)
HADR Multiple Standby Databases
This assumes a single standby database HADR setup already exists. The existing standby will be referred to as the main standby. The new delphix standby will be referred to as the auxiliary standby.
- The following database configuration settings must be set on the primary database:
- You may have up to two auxiliary standbys defined separated by a '|'; one of which must be the delphix dSource.
- update db cfg for <DB_NAME> using HADR_SYNCMODE <SYNC MODE> immediate – set whichever sync mode you wish to use on your main standby.
- update db cfg for <DB_NAME> using HADR_TARGET_LIST "<MAIN_STANDBY_IP:MAIN_STANDBY_PORT|AUXILIARY_STANDBY_IP:AUXILIARY_STANDBY_PORT>" immediate
- stop hadr on db <DB_NAME>
- start hadr on db <DB_NAME> as primary by force
- Take a full online backup as defined in the "Backup Source Database" section below. While this backup is running, you may continue with step 5.
- The following database configuration settings must be set on the existing main standby database:
- update db cfg for <DB_NAME> using HADR_SYNCMODE <same mode as defined in 1.a above.> – It must be the same value used for primary database.
- update db cfg for <DB_NAME> using HADR_TARGET_LIST "<PRIMARY_IP:PRIMARY_PORT|MAIN_STANDBY_IP:MAIN_STANDBY_PORT>"
- stop hadr on db <DB_NAME>
- start hadr on db <DB_NAME> as standby
- Record the following information, as it must be entered on the Delphix Engine while creating the dSource (the auxiliary standby database):
- HADR Primary hostname
- HADR Primary SVC
- HADR Standby SVC (auxiliary standby port)
- HADR_TARGET_LIST <PRIMARY_IP:PRIMARY_PORT|MAIN_STANDBY_IP:MAIN_STANDBY_PORT>
Backup Source Database
Source Database with Raw DEVICE type Storage
In order to complete the linking process, the Standby dSource must have access to a full backup of the source DB2 databases on disk. This should be a compressed online DB2 backup and must be accessible to the dSource instance owner on disk. Delphix is currently not setup to accept DB2 backups taken using third-party sources such as Netbackup or TSM. Both HADR and Non-HADR backups must also include logs .
Example backup command: db2 backup database <DB_NAME> online compress include logs.
Best Practices for Taking a Backup
The following best practices can help improve backup and restore performance:
Compression should be enabled
Following parameters should be optimally configured:
Utility Heap Size (UTIL_HEAP_SZ)
No. of CPUs
No. of Table Spaces
Parallelism & Buffer configuration may be used to improve the backup performance. Parameters that should be configured are :
No. of Buffers
More information about backup best practices is available in IBM Knowledge Center
Login to the Delphix Management Application using Delphix Engine credentials or as the owner of the database from which you want to provision the dSource.
On the Databases tab of Environment Management screen, add a source config against discovered staging instance.
Then, click Manage.
Click the Plus (+) icon and select Add dSource, you’ll get a list of available source configs using which you can go for dsource creation.
In the Add dSource wizard, select the required source configuration.
If you are working with an HADR setup, please leave the HADR checkbox checked.
The database name is mandatory and must be unique for a given instance. This is the name that the database was on the instance it was restored from.
Enter the complete Backup Path where the database backup file resides. If no value is entered, the default value used is the instance home directory. If there are multiple backup files for a database on the backup path, the most current one will be used.
Enter the Log Archive Method1 you wish to use for the database. If no value is entered, the default value used is DISK:/mountpoint/dbname/arch.
Optionally, users can set the database configuration parameters during the linking operation in the Config Settings section.
If the dSource is to use HADR please enter the following fields. If it will not use HADR skip ahead to step 13. For more information about HADR please view Linking a dSource from a DB2 Database: An Overview .
a. Enter a fully qualified HADR Primary Hostname. This is a required field for HADR and must match the value set for HADR_LOCAL_HOST on the master.
b. Enter the port or /etc/services name for the HADR Primary SVC. This is a required field for HADR and uses the value set for HADR_LOCAL_SVC on the master.
c. Enter the port or /etc/services name for the HADR Standby SVC. This is a required field for HADR and uses the value set for HADR_REMOTE_SVC on the master.
Click Next .
Select a dSource Name and Database Group for the dSource.
You will get Data Management section where you need to specify the staging environment and user which will be used for dsource creation.
Set the Staging Environment to be the same as the dSource host.
Select the Staging Environment User to be the same as the instance owner of the dSource instance.
Changing the Environment UserIf you need to change or add an environment user for the dSource instance, see Managing DB2 Users and Instance Owners .
- Then, click Next and you’ll get Policies section. Set the desired Snapsync Policy for the dSource. For more information on policies see Advanced Data Management Settings for DB2 dSources .
- Click Next.
- Specify any desired pre- and post-scripts. For details on pre- and post-scripts, refer to Customizing DB2 Management with Hook Operations .
- Click Next.
- Review the dSource Configuration and Data Management information in the summary section.
- Click Submit.
The Delphix Engine will initiate two jobs to create the dSource: DB_Link and DB_Sync. You can monitor these jobs by clicking Active Jobs in the top menu bar, or by selecting System > Event Viewer. When the jobs have completed successfully, the database icon will change to a dSource icon on the Environments > Host > Databases screen, and the dSource will also appear in the list of Datasets under its assigned group.
The dSource Configuration Screen
After you have created a dSource, the dSource Configuration tab allows you to view information about it and make modifications to its policies and permissions. In the Datasets panel, select the dSource you wish to examine. You can now choose the configuration tab to see information such as the Source files, Data Management configuration, and Hook Operations. For more information, see Advanced Data Management Settings for DB2 dSources.
Provisioning a Virtual Database (VDB)
You will need to have linked a dSource from a staging instance, as described in Linking a DB2 dSource or have created a VDB from which you want to provision another VDB
You should have set up the DB2 target environment with necessary requirements as described in Requirements for DB2 Hosts and Databases
Make sure you have the required Instance Owner permissions on the target instance and environment as described in Managing DB2 Users and Instance Owners
The method for Database Permissions for Provisioned DB2 VDBs is decided before the provisioning
You can take a new snapshot of the dSource by clicking the Camera icon on the dSource card. Once the snapshot is complete you can provision a new VDB from it.
Login to the Delphix Admin application.
Select a dSource.
Select a snapshot from which you want to provision.
Click Provision VDB icon to open Provision VDB wizard.
Select a target environment from the left pane.
Select an Installation to use from the dropdown list of available DB2 instances on that environment.
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.
Provide VDB Name as database name as parameter.
Optionally, set the database configuration parameters for the VDB.
Click Next .
Select a Target Group for the VDB.
Click the green Plus icon to add a new group, if necessary.
Select a Snapshot Policy for the VDB.
Specify any desired hook operations. For details, on-hook operations, refer to Customizing DB2 Management with Hook Operations.
Click Next .
Review the Provisioning Configuration and Data Management information.
When provisioning starts, you can review the progress of the job in the Databases panel, or in the Job History panel of the Dashboard. When provisioning is complete, the VDB will be included in the group you designated and listed in the Databases panel. If you select the VDB in the Databases panel and click the Open icon, you can view its card, which contains information about the database and its Data Management settings.
Once the VDB provisioning has successfully completed, if the source and target instance ids are not the same, you may want to grant secadm and dbadm on the database to the target instance id. Refer to Database Permissions for Provisioned DB2 VDBs for more information.
Congratulations! You have provisioned your first virtual database!
Now, perform some simple functional tests with your application. You can connect your app to the VDB using standard TNS/JDBC techniques. Delphix has already registered the VDB for you on the target listener.
We suggest the following next steps:
- Drop a table and use the VDB Rewind feature to test the recovery of your VDB.
- Take a snapshot of your dSource and refresh your VDB to quickly get fresh production data.
- Provision a new VDB from your VDB to test sharing data quickly with other teams.
- Mask your new VDB to protect sensitive data. Provision new VDBs from that masked VDB to quickly provide safe data to development and QA teams.