Activity One: Import the OVA file for Delphix Reporting into a VM guest

  1. Using the vSphere client, login to the vSphere server where you want to install Delphix Reporting.

  2. Click File.

  3. Select Deploy OVA Template.

  4. Select the Delphix Reporting OVA file.

Alternative: Setup for Cloudstack

If your organization uses Cloudstack instead of VMWare, you can still use Delphix Reporting. After locating the qcow2 image on the Delphix download site, follow the steps below to configure Delphix Reporting:

  1. Launch the Cloudstack user interface.

  2. Create a new template (Register Template) with the following parameters:

    1. Name: <any name>

    2. Description: <any description>

    3. URL: <url_to_the_qcow2_image>

    4. Zone: <any name>

    5. Hypervisor: KVM

    6. Format: QCOW2

    7. OS Type: CentOS 6.5 (64-bit)

  3. Wait for the template to be downloaded and installed into the appropriate zone(s) and for the status to be Ready.

  4. In Instances, click Add Instance.

  5. Select a Zone in which to run Delphix Reporting.

  6. Click Template.

  7. Select the template you just created.

  8. Choose a Compute Offering.

    The Compute Offering should have at least 2 CPU cores with 4GB of memory.

  9. For Disk Offering, do not add any additional disks.

  10. Select any affinity groups to which you want this VM to belong.

  11. Select a security group.

  12. Give the new instance a name.

  13. Launch the VM.

  14. The Delphix Reporting web application should be accessible via the assigned IP.

Add Delphix Reporting to the Network

By default, Delphix Reporting is configured to use DHCP to acquire an IP address. If this is acceptable within your organization, then Delphix Reporting should be immediately accessible at the IP hostname assigned to the VM guest within vSphere.

However, many organizations do not support the use of DHCP by servers on their network. In that case, you will need to log into Delphix Reporting as root via the console provide by vSphere, and work with your network administrator to perform the following actions to set up a static IP address on the VM guest.
  1. Connect to the VM guest (running a stripped-down version of Linux) as root. The initial default password is delphix.
    1. Change this password as soon as possible.
  2. Run the Linux command ifconfig -a | grep -i hwaddr.
    1. Record the HwAddr output for later use. This should be six hexadecimal numbers delimited by colons, such as 0A:1B:2C:4D:5E:6F.
  3. Change to the directory /etc/sysconfig/network-scripts.
  4. Edit the ifcfg-eth0 file to make the following changes:
    1. Copy the existing ifcfg-eth0 file to another name like ifcfg-eth0.save.
    2. Change bootproto=dhcp to bootproto=static.
    3. Using the HwAddr value saved from step #2 above, add a line reading HWADDR=<hwaddr-value-captured-above>.
    4. Using an available IP address value obtained from your network administrator, add a line reading IPADDR=<available-IP-address>.
    5. Using an IP netmask value obtained from your network administrator, add a line reading NETMASK=<netmask-spec>.
    6. Save the changes.
  5. Make sure that output from the hostname command matches the value set within vSphere.
    1. If the output does not match, use the Linux command hostname <short-IP-hostname-value> to set it.
  6. Create a default gateway route for the static IP address assigned above.
    1. Typically, the default gateway address has the fourth digit of ".1" for the IP address of the server.
      1. The server at IP address 192.168.7.10 might have a gateway of 192.168.7.1.
      2. Obtain the gateway IP address from your network administrator.
    2. Use the Linux command route add default gw <gateway-IP-address>.
  7. Make sure that the contents of the /etc/resolv.conf file are set appropriately to permit DNS name resolution.
    1. Ensure that the line that specifies the IP domain name is correct for your network. For example, for servers within Delphix, the line reads domain delphix.com.
    2. Ensure that at least one (and preferably two or more) DNS nameserver IP addresses are specified and that they are reachable via "ping." For example, each line should read nameserver <DNS-nameserver-IP-address>. Running the Linux command ping <DNS-nameserver-IP-address> should complete successfully.
  8. Once you have made all of these changes, restart network services on the Linux OS.
    1. Run the Linux command service network restart and ensure that it completes successfully.

Logging In

  1. Access Delphix Reporting by opening a web browser using the IP address or DNS qualified host name. Delphix Reporting does not currently support SSL connections, so you should use http, not https.

  2. Delphix Reporting ships with one generic Delphix Admin User. The User ID is delphix_admin and the password is delphix.

Once logged in as the Delphix Admin User, change your password. You can find instructions to do this in the Change a User Password section below.

Navigating the Delphix Reporting Toolbar and User Interface

The Delphix Reporting Toolbar appears after logging into Delphix Reporting. The navigation bar enables you to analyze, manage, and configure data reporting for a Delphix deployment. The View Report drop-down menu appears on the left-hand side of the toolbar. The configuration, help, and login buttons appear on the right-hand side of the toolbar. Below is a screenshot of the toolbar as well as a brief summary of the functionality available.

Delphix ReportingToolbar

Viewing Reports

The View Reports functionality provides aggregated data across all connected Delphix Engines and presents it as a set of different reports. You can select these reports from the drop-down menu. Delphix Reporting has automated features that check for updates across all Delphix Engine and sync these updates into reports every 10 minutes. To refresh the currently displayed report manually, click Refresh.

 

Reports menu

Interactive reports such as Storage Breakdown and History display interactive graphical representations of historical and current storage usage across all Delphix Engines you are monitoring. These visualizations of storage and disk capacity enable you to analyze and mediate storage across Delphix Engine from multiple perspectives.

Graphs tab



Configuring Delphix Reporting

Clicking the configuration icon in the upper right-hand corner of the screen brings up four configuration tabs: Reports, Engines, Users, and System. Read below for more details.

Configure Reports

The Reports tab is the central place to configure settings, create scripts, and email reports in Delphix Reporting. There are three sections: Report scripts, Script configuration (tunables), and Email reports. The documentation below describe how to navigate and work in each of these sections.

To navigate to the Report configuration tab:

  1. On the right-hand side of the toolbar, click the configuration icon.  

  2. Click Reports.  


Report Scripts

You can use report scripts to:
  • Enable/disable individual reports to determine which ones are available in the reports drop-down menu

  • Delete reports

    Deleted reports are no longer generated in Delphix Reporting

  • Upload new reports

    This is an experimental feature. Please contact Delphix if you are interested in customizing existing reports or creating new ones.

Script Configuration

To configure tunable parameters for specific reports, click the field in the value column to make it editable.

Report Scripts Section 

Email Reports  

You can configure Delphix Reporting to:
  • Send email reports which automatically send tabular data to any number of email addresses

  • Send emails on daily, weekly, or monthly schedules

  • Customize the way the data is presented in emails by choosing the sort column and limiting the number of rows.

 To access the Email Reports section:

  1. On the right-hand side of the toolbar, click the configuration icon.

  2. Click Reports.   

  3. Scroll down to Email Reports.

     

Email Reports Configuration

Activity Two: Configure, Automate, and Email Delphix Reporting Reports

This activity will walk you through the system and report configuration and automation features that facilitate emailing Delphix Reporting reports in the Email Reports configuration section. To begin, you will need to navigate the the configuration icon and select system configurations first in order to enable system connections such as the SMTP server.
  1. On the right-hand side of the toolbar, click the configuration icon.   
  2. Click System
  3. Scroll down to Email.
  4. Click Edit Settings.
     
      Delphix Reporting Configuring Email System  
  5. Populate all the fields in the Edit Email Settings as seen below.
  6. Click Save changes.
     
       Delphix Reporting Email Settings 
  7. Now that SMTP has been configured, navigate to the Reports Configuration page and scroll down to Email reports.
  8. Follow and complete the three-step process as illustrated below to begin automating and emailing Delphix Reporting reports.  

  

    Delphix Reporting Email Reports Configuration Window 

 Required: Click Add Email Report. A series of fields will appear to help guide the configuration and automation of emailing selected Delphix Reporting reports. The following is a description of each of these fields. 

  • The Report field provides a selection of the specific Delphix Reporting report you would like to use for the Email Report function.

    Only tabular reports are available for email.

     

  • Sort by Selection provides a drop-down of the column you wish to sort by, which varies based on the report you have selected above, and whether the results should be ascending or descending.     
  • In the Limit the Report To fields, a selection choice appears allowing you to run and email a report with all data rows or to enter the number of data rows you would like included in the report.
  • In the Schedule field, fields are provided to select the scheduled day and time that you want the report to be sent. 
  • In the Send to field, enter the email addresses to which you want to send the report.  

    Use a comma to separate email addresses.


Once you have configured all of the fields above, save the information by clicking Add Email Report. The newly added report will appear. You will then have access to additional features to edit, send a report now, or click the X button to delete the report.  

 Optional:  Click the Edit button when you need to change or enter new information into any of the configuration fields found in the Add Email Report functionality.  

 Optional: Click the Send Now button to either:

  • Send a test email report during the process of configuring an email report in order to verify the report settings or design. 
    Or
  • Send a one-off email outside of an automated and scheduled email report.

Configure Engines

To navigate to the Engines screen, as seen below:
  1. On the right-hand side of the toolbar, click the configuration icon.  

  2. Click Engines.  

The Engines tab lists all Delphix Engines that you have added to Delphix Reporting. The Status column shows whether Delphix Reporting is connected to each platform; it will prompt a specific error message if it is unable to connect. To remove an engine from Delphix Reporting:

  1. Click the X icon next to the engine you want to delete.

  2. In the confirmation dialog, click OK.

 

Configure Engines Tab 

Configure Users

To navigate to the Users screen, as seen below.
  1. On the right-hand side of the toolbar, click the configuration icon. 

  2. Click Users.   

The Users tab displays the set of user accounts that have permission to access Delphix Reporting. You can assign tags to auditor users to restrict which Delphix Engines and containers they can see. For more information, see the How to Assign Tags activity below.

Users Tab 


Activity Three: Add Delphix Engines to Delphix Reporting

  1. Access Delphix Reporting with a supported web browser using its I P address or DNS qualified host name. Supported web browsers include Chrome 37, IE 11, Safari 7, and Firefox 32.

  2. Click the Engines tab in the Delphix Reporting Toolbar.

  3. Click Add Engine.

  4. In the Hostname field, enter the Delphix Engine's  IP address or hostname.

  5. Enter a username and password.

    The user must have at least an auditor role on the target Delphix Engine.


Adding a Delphix Engine

Activity Four: Add Users

  1. On the right-hand side of the toolbar, click the configuration icon.  

  2. Click Users.    

  3. Click Add user.

  4. Enter a username and password. 

  5. Select auditor or admin.

  6. Inform the newly created user of their user ID and password login credentials.


Activity Five: Change a User Password

  1. On the right-hand side of the toolbar, click the configuration icon.

  2. Click Users.  

  3. In the upper right-hand corner, click the username, for which you need to change password.

  4. Click Change password.

Related Links