Skip to main content
Skip table of contents

Yugabyte host environment requirements

Staging/target host requirements


Host Compatibility Check

The Operating System and architecture of the target host must match the source environment. 

It is required that the source and the target environments should have identical OS and hardware configurations.

There must be a directory on the staging/target host where the Yugabyte connector support files can be installed (for example, /var/tmp) with the following properties:

  1. The directory must be writable by the Operating System user mentioned above.

  2. The directory must have at least 1.5 GB of available storage.

This path is called the “Toolkit Path” in the Environment creation UI page.

YugabyteDB Installation and Compatibility Check

There must be an installation of YugabyteDB on the target host that is compatible with the installation of YugabyteDB on the source host.

The YugabyteDB binary version on the target must be identical to the source side.

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.

Hostname and IP must be correctly set in /etc/hosts file.

The output of the hostname -i command should produce the correct result as the IP address of the server.

For example:

[root@source ~]# hostname -i

Required Utilities and Tools

Ensure the expect utility is installed on the target host.

YugabyteDB connector runs password sensitive commands by making use of expect utility.

Checking if the expect utility is installed with:

which expect

Storage Requirement

  1. The staging host must have enough storage space to hold the source backup file OR NFS mount source backup filesystem.

  2. An empty folder on the staging host to hold the Delphix Toolkit (approximately 2GB free space).

Sudo privileges for the environment OS user

The Delphix Continuous Data Engine connects to the target host (via SSH) to majorly perform the following operations: 

  1. Delphix Continuous Data Engine dynamically mounts and unmounts directories for linking and provisioning operations. This privilege is required because mount and unmount are typically reserved for superusers.

  2. Delphix Continuous Data Engine dynamically creates and removes directories for linking and provisioning operations.

The operations (1) and (2) will require sudo privileges for the OS user. 

Configuring sudo access on target environments (as root user):

  1. The sudo configuration exists in the /etc/sudoers file. The file can be edited directly or a utility called visudo can be used to add the privilege.

    vi /etc/sudoers
    # Or
  2. Adding the privileges

    Defaults:delphix_os !requiretty
    delphix_os ALL=NOPASSWD: /bin/mount,/bin/umount,/bin/mkdir,/bin/rmdir, /bin/ps
    delphix_os ALL=(Yugabyte) NOPASSWD: ALL

 The following examples are for illustrative purposes and the sudo file configuration options are subject to change.

Requiretty settings

Delphix Continuous Data Engine requires that the requiretty setting be disabled for all the Delphix Continuous Data Engine users with sudo privileges.

It is required to specify the NOPASSWD qualifier within the "sudo" configuration file. This ensures that the "sudo" command does not demand the entry of a password, even for the "display permissions" (i.e. "sudo -l") command.

  • Additionally, Delphix OS user should be,

    • Regular o/s user - e.g., delphix_os.

    • Add OS user to Yugabyte OS group.

    • Must have access to backup files of the source database stored on the staging host.

    • Must have access to the path create and modify files in /opt/yugabyte/var/lib/yugabyte.

    • Empty folder on host to hold Delphix toolkit (approximate 2GB free space).

    • Empty folder on host to mount NFS filesystem. This is just an empty folder with no space requirements and acts as a base folder for NFS mounts.

    • Sudo privileges for mount and umount. See the sample below assuming delphix_os is used as a Delphix user.

  • Ensure any login banners similar to the one in the image below must be disabled on the staging host.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.