This topic describes how to set up the initial system configuration for the Delphix Engine, including system time, storage, web proxy, SMTP server, email to Delphix Support, and LDAP authentication. 

The setup procedure uses a wizard process to take you through a set of configuration screens:
  • 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.

Welcome

The Welcome tab asks users to select the engine type for setup. You can select from Virtualization or Masking.

  1. Select the engine type to setup.
  2. Click Next.

Delphix Engine Setup Screen


To configure Masking-specific settings please refer to Configuring Masking.


Administrators

Delphix is installed with the following administrator accounts:

  • System Administrator - "sysadmin" with a password that users can define. This will be the system administrator for the instance.
  • Engine Administrator - "admin" with a password that users can define. This is typically a DBA who will administer all the data managed by the instance.
  • Masking Administrator - "admin"  with the password you defined. This will be the Masking administrator responsible for setting up users and other administrative actions in Masking. (Only available if Masking was selected)
  1. Enter the email address and password for each Admin.
  2. Click Next.

Time

  1. Select an option for maintaining the system time.

    OptionNotes
    Set NTP Server

    After selecting this option, select an NTP server from the list, or click Add NTP Server to manually enter a server.


    Be aware that you can highlight more than one NTP Server entry in order to select more than one.

    When configuring a Delphix Engine on VMware, be sure to configure the NTP client on the host to use the same servers that you enter here. On a vSphere client, the NTP client is set in the Security Profile section of the configuration process.

    Manually Select Time and DateClick Use Browser Time and Date to set the system time, or select the date and time by using the calendar and clock displays. Then select the Time Zone.

    If you select Use Browser Time and Date, the date and time will persist as your local time, even if you change the time zone.

    Snapshots from dSources and VDBs reflect the time zone of the source or target environment, not that of the Delphix Engine.
  2. Be sure to choose the appropriate time zone for the Delphix Server, using the drop-down list in the lower left-hand corner of this page.
  3. Click Next.


Network

The initial out-of-the-box network configuration in the OVA file is set to use a VMXNET3 network adapter.

  1. Under Network Interfaces, click Settings.
  2. The first Network Interface is Enabled by default.
  3. Select DHCP or Static network addressing.
    For Static addressing, enter an IP Address and Subnet Mask.

  4. Select whether to use Jumbo Frames.
    VMXNET3 supports Ethernet jumbo frames, which can be used to maximize throughput and minimize CPU utilization.
  5. Click Save.
  6. Repeat for any other interfaces you have added to the virtual machine (VM) that you wish to configure. They will not be enabled by default.
  7. Under Routing, enter a Default Gateway.
  8. Under DNS Services, enter a DNS Domain Name and DNS Server.
  9. Click Next.

Network Security

Delphix installs certificates signed by the Engines Certificate Authority.  Users have the ability to manage their own certificates for HTTPS and DSP (Delphix Session Protocol) connections to and from the Delphix Engine. Certificates can be managed via the Network Security section of the system administration dashboard.


When you update the Certificate Authority certificate, your HTTPS and DSP certificates will be automatically updated.

For more information please refer to Certificate Management

Storage

The Delphix Engine automatically discovers and displays storage devices. 

You can associate additional storage devices with the Delphix Engine after initial configuration, as described in Adding and Expanding Storage Devices.

Storage Disk Usage Assignment Options

The following options are available for storage disk usage assignment:

Data
Once you set the storage unit assignment for a disk to Data and save the configuration, you cannot change it again.

Unassigned

This disk can be configured later to add capacity for existing data disks.

The Minimum Number of Storage Disks

Configure at least four disks for the storage of user data. This makes the Delphix Engine storage manager function more efficiently since duplicated metadata can be distributed across multiple disks.

Serviceability

Web Proxy

If a Web Proxy Server is necessary for your environment, select Configure web proxy and enter the required information.

Phone Home Service

If you want the Delphix Engine to send information to the Delphix Support site periodically over https (SSL), select Phone Home Service enabled. This feature requires a connection to the internet and will use the Web Proxy Server configuration.

User-click Analytics

User-click Analytics (a lightweight method to capture how users interact with Delphix product user interfaces) allows Delphix to collect browser-based, user-click analytics data. Essentially, Delphix selectively tracks actions that a user takes in the product UI. Delphix does not collect, transmit or store any personally identifiable information (PII) which for Enterprise customers includes information such as email address, IP address, username, etc. This features setting matches an Engine’s Phone Home Service setting:

  • If the Phone Home Service is enabled on an Engine, then this feature will be enabled by default.  
  • If the Phone Home Service is disabled on an Engine, then this feature will be disabled by default.

If you want to opt-out please see these CLI instructions - Disabling User-click Analytics. The opt-out is not currently available in the GUI. Please note that we would like to encourage our customers to share this non-PII data with us. Please be aware that the Phone Home Service only sends occasional support log bundles outbound from the Delphix Engine to Delphix Support website.  There is no way to enable inbound access to the Delphix Engine.

SMTP

Select Use an SMTP Server and enter the required information to enable email notifications for events and alerts.

 


When a critical fault occurs with the Delphix Engine, it will automatically send an email alert to the admin user. Make sure that you configure the SMTP server so that alert emails can be sent to this user. See System Faults for more information.

Authentication Service

To avoid configuration issues, consult with your lightweight directory access protocol (LDAP) administrator before attempting to set up LDAP authentication of users for the Delphix Engine.

  1. Select Use LDAP to enable LDAP authentication of users.
  2. Enter the LDAP Server IP address or hostname, and Port number.
  3. Select the Authentication method.
  4. Select whether you want to Protect LDAP traffic with SSL/TLS.
    If you select this option, you must import the server certificate.
  5. When you are done with the LDAP configuration, click Test Connection.

  6. To enable SAML/SSO, set the Audience Restriction (SP entity ID, Partner’s Entity ID) in the identity provider to be the Engine UUID 564d184b-e217-ed35-b0dc-002f1bd08ea7.
  7. Select Use SAML/SSO.
  8. IdP metadata is an XML document which must be exported from the application created in your IdPCopy and pasted in the IdP Metadata field.
  9. Click Next.

LDAP Authentication When Adding Users

If LDAP has been set up as the authentication service for the Delphix Engine, you must add new users with LDAP as their authentication mechanism. For more information, see Adding Delphix Users and Privileges. Note that you can only add individual LDAP users, not groups.

Kerberos

A Kerberos step has been added to the setup wizard allowing users to use Kerberos authentication.
If a user enters data on the Kerberos form and then unchecks the Use Kerberos authentication checkbox, the information remains on the form. The entered information will remain even if the user checks the Use Kerberos authentication checkbox again.
  1. Select the Use Kerberos authentication checkbox.

  2. Complete the following fields:

    • Realm
    • Principal
    • Keytab
  3. Then select Next.


Registration

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:
  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.

While your Delphix Engine will work without registration, we strongly recommend that you register each Delphix Engine as part of setup. Failing to register the Delphix Engine will impact its supportability.

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.

Summary

The final summary tab will enable you to review your configurations for System Time, Network, Storage, Serviceability, and Authentication. 

  1. Click the Back button to go back and to change the configuration for any of these server settings.
  2. If you are ready to proceed, then click Submit.
  3. Click Yes to confirm that you want to save the configuration.
  4. Click Setup to acknowledge the successful configuration.
  5. There will be a wait of several minutes as the Delphix Engine completes configuration.

Post-Requisites

  • After configuration is complete, the Delphix Engine will restart and launch the browser-based Delphix Management application. The URL for this will be http://<Delphix Engine>/login/index.html#delphixAdmin.
  • After the Delphix Management application launches, the admin can login using the initial default username admin and the initial default password delphix.  On first login, you will be prompted to change the initial password.
  • You can access the DelphixSetup interface at any time by navigating to http://<Delphix Engine>/login/index.html#serverSetup and entering the sysadmin credentials.