Redgate Clone

Step 1 - Installation requirements

Page last updated 12 August 2024

This page provides the requirements necessary to deploy Redgate Clone.

Embedded install steps
Step 1 - Installation requirements
Step 2 - Installation pre-requisites checks
Step 3 - Installing Redgate Clone

Contents

Requirements


We have some sample Terraform with instructions available for Azure that will create the necessary infrastructure as described below.

Virtual Machine

TypeMinimumNotes
OS

Ubuntu 22.04

RHEL 8.6, 8.8, 8.9, 9.0, 9.2

For Ubuntu, it must be:

  • Ubuntu Server 22.04 (and not Ubuntu Minimal)
  • A dedicated Ubuntu Server machine (and not Ubuntu Desktop)


For RHEL: 

  • Must be installed with LVM. This requires additional configuration of the OS disk (described in section "Note for logical volume partitions" in the next step).
User permissions


The user running the installation will need to be root or have sudo access to the machine.

RAM16GB

The memory defines how many data containers can be hosted in parallel & how many storage disks can be attached.

For a first proof of concept (POC) we recommend starting with 16GB. This will allow for a single data-image and several data-containers to be created and run in parallel.

You will need to increase RAM as you start working with more data-images and data-containers. Please see the Database Engines Support page to learn more about the default settings for each database engine.

Please also see the following FAQs:

vCPUs8
OS Disk80GB

WARNING The partition table should be labelled as GPT (GUID Partition Table) and not MBR (Master Boot Record). See the next step for more information.

When using Azure:

  • Choose a Generation 2 image, as Generation 1 images cannot use GPT for OS disks.
  • You may not be able to choose the initial size of the OS disk when creating your VM. If a disk is too small, then you should resize it after it's created. 

When using AWS: 

  • When launching a new EC2 instance, in the storage configuration, each volume has a device name.  The system device name is automatically assigned. For any extra volumes, you have the option to choose a device name. The result when the instance is up and running may not correspond to the selection you've made. Please ssh onto the instance and use the lsblk command to see the disk names.
Additional empty disks

100GB (See notes)

These disks are used to store data images and data containers (clones). Plan ahead to have enough space for your needs. 

For a first proof of concept (POC) we recommend using a small sample backup to keep the disk requirements small.

Bigger backups

When working with bigger backups, please adjust the size of the attached disk(s) depending on your needs.

As each data image will be roughly the same size as the original database, the file share must have sufficient disk space available to store them.

Any changes you make to data-containers are also stored on the attached disk(s).

For example: you may want to keep a data-image of your current backup while also enabling a data-image to be created of the latest backup when taken. In this example, you will require disks totaling 2x the size of your backup for the data-images, plus additional space for data-containers you create and changes you make to them. In this example, for a 500GB backup you should provision disks totaling 1.5TB.

WARNING You can add more disks after the initial installation but you won't be able to remove them once they start being used. Please check adding disks for more information.

Network & Firewall

Redgate Clone does not support changing the IP address of the VM once it has been installed. For this reason, Redgate Clone requires a static IP address. If your network uses a DHCP server to assign IP addresses, you should add a reservation so that your nodes' IP addresses do not change.

The following ports should be available on the host.

PortPurpose
8800Admin Console
8132Web API used by the CLI for an embedded cluster.  
443

Web API used by the CLI for an AKS cluster.  

32767-60000 (by default)

Range of ports to randomly select from for new data containers.

Can be changed in Admin Console during the set up.

Other


WhatNotesWhy
DNS

Valid (public or private) DNS Name (FQDN (Fully  Qualified  Domain  Name))

This will need to be a CNAME record that redirects to the Virtual Machine running the Redgate Clone. 

DNS name, which is resolvable publicly, or in your company's network, simplifies Using the CLI usage for your employees, and also allows us to use TLS certificate to secure comms.

TLS Certificate

You will need a  TLS Certificate  (i.e.  my-certificate.crt) and a  TLS Key  (i.e.  my-certificate.key) files.

  • TLS Certificate  - The PEM file containing the TLS certificate. The PEM file should contain the certificate itself along with any required intermediate certificates. The file should have this format:

    -----BEGIN CERTIFICATE-----
certificate 1
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
certificate 2
-----END CERTIFICATE-----
...


  • TLS Key  - The PEM file containing the TLS key. The file should have this format:

    -----BEGIN PRIVATE KEY-----
private key
-----END PRIVATE KEY-----
This allows us to ensure that all communication using Using the CLI is encrypted and secured 
Kernel configuration

The following kernel configuration values should be set:

  • fs.aio-max-nr should be at least 1048576.
  • fs.inotify.max_user_instances should be at least 512.

The typical default values for these configuration options has been known to result in errors during pod creation. See the following troubleshooting articles for more information:

License

You will need an application license that can be downloaded using the URL and the password provided as a part of the onboarding process.  You must accept and provide a license to proceed with the installation of Redgate Clone.


Where to next?

Complete the pre-requisite checks, mentioned in the Step 2 - Installation pre-requisites checks.


Embedded install steps
Step 1 - Installation requirements
Step 2 - Installation pre-requisites checks
Step 3 - Installing Redgate Clone



Didn't find what you were looking for?

Product Articles

Tips and how-to guides for Redgate products

University

Easy to follow video courses

Community Forums

Ask, discuss, and solve questions about Redgate's tools

Events & Friends

Meet us at an event, get sponsored, and join our Friends of Redgate

Simple Talk

In-depth articles and opinion from Redgate's technical journal