Prerequisites

This section provides detailed information on how to get ScaleGrid Enterprise server installed on your environment. If you are looking for a simpler, less verbose guide to install ClusterControl, please have a look at our Quick Start Guide .

1. Hardware Prerequisites

Architecture: x86_64 only
RAM: >=4 GB
CPU: >=1 core
Disk space: >=100 GB
Outbound internet connection during installation or mirrored repositories are set up

2. Supported Operating System

ScaleGrid Enterprise Server currently support the following operating systems

  • Amazon Linux 64-bit

Please note the following operating systems are not yet supported -

  • AWS Linux 2

3. Supported Browsers for the Web UI

We highly recommend you use the following web browsers when accessing ScaleGrid UI, since the product is built and tested only on these browsers.

  • Google Chrome
  • Mozilla Firefox
    Other major web browsers should also work.

4. Security Configuration

It is important to secure the ScaleGrid Enterprise node(s). We recommend user to not expose their database infrastructure to the public Internet and use firewalls to lock down access.

ScaleGrid server requires ports used by the following services to be opened/enabled:

Port

Notes

TCP 443

Used for HTTPS access to the web UI. Needs to be open to all clients that wish to access the ScaleGrid UI

TCP 80
TCP 443
TCP 5671

All deployed database servers need to be able to reach back to the ScaleGrid Enterprise Server on these ports

TCP 55672
TCP 3306

These are needed only for multi node ScaleGrid controller deployements. These ports need to be open between the two controller nodes.

5 Setup input parameters

This section explains the inputs we ask for, and why. The inputs are listed in the order they’ll be prompted during installation.

Public IP as access point:

Is there a public IP assigned to the box? [y|n]:

By default, ScaleGrid Enterprise Server will use the first IP Address listed via hostname -I as the primary entry point. This is typically the private address associated with eth0. If you have more than one network interfaces, you can choose to provide a different IP address during installation. Alternately, you can also provide your public IP during installation to ensure the ScaleGrid Enterprise Server uses that as the primary entry point.

If you wish to continue with the default IP, type ‘n’ or ‘no’ here. If you type ‘y’ you will be prompted to enter the IP you wish ScaleGrid Enterprise Server to use as primary access point.

    Prompt-1a: Please enter the public IP or press enter to use the local ip as the main access point for this box. []:

This prompt is shown only if you answered ‘y’ to the previous question. You can enter the IP you want to configure as the primary access point. Please ensure the IP you enter is accessible by all your planned end users.

The IP you assign here must be a static IP - this value should not be changed after installation. Please contact ScaleGrid Support ([email protected]) if you need to change the IP after installation.

SMTP details:
Please enter SMTP details so the controller can send email notifications.

This set of prompts takes the inputs required to enable ScaleGrid Enterprise Server to send out emails. Emails may be sent for system warnings and failures, for alerts configured on particular metrics for further details on alerts) and also for notifications about database cluster actions.

    SMTP Host :
This is the hostname of the server where your email server is hosted. This must be resolve from all the ScaleGrid Enterprise Server node(s)

    SMTP User :
The username through which ScaleGrid Enterprise Server can authenticate with your email server. We recommend creating a separate user for ScaleGrid Enterprise Server.

    SMTP Password:
The password for the SMTP user. If you need to change this after installation please contact ScaleGrid support ([email protected])

SSL support: Is SMTP-over-SSL enabled? [y|n]
If you answer ‘y’ or ‘yes’ to this question, all communication to your email server will be encrypted. If you answer ‘n’, all communication will be over clear-text.

Notification Alias:
Enter a email alias to which the ScaleGrid Enterprise Server can send out important system emails (e.g. Alerts, warnings etc)

Whenever a system needs to send an alert, an email will be sent to this address. This helps ScaleGrid Enterprise Server administrators take proactive action to avoid issues with your database. Please ensure this is a valid email address that is reachable from your email server.

ScaleGrid Controller backup
Enter a location on the local filesystem to store database backups or press enter to accept default location [/var/backup/scalegrid]

It is important to take regular backups of your ScaleGrid Enterprise Server. For this reason, we have setup automated backups that run every night. We strongly recommend these backups be stored on a NFS share or a different EBS volume, and not on the same volume as your root file system.

You can choose to accept the default path by hitting enter, or enter the absolute path to the folder where you wish to store the backup. If the path does not exist, the installation script will create the folder hierarchy.

DNS details:

ScaleGrid Enterprise Server uses AWS Route53 to automatically assign DNS names to your database servers. We need the following details of the Route53 setup you plan to use.

  • "DNS Zone ID: "
  • "DNS Suffix: "
  • "DNS IAM user API Key: "
  • "DNS IAM Secret Key: "

Setting up a subdomain in Route53

Here are the steps to setup a subdomain in AWS Route53. Typically you setup a subdomain of your main domain to use with your database servers. E.g. scalegridservers..com

  1. Navigate to the Route53 tab in the AWS console
  1. Create a “Hosted Zone” in Route53 by choosing a name for the subdomain
  1. Once the zone is created note down the ID of the zone and the 4 dns servers associated with your zone
  1. Now add a NS record to your main DNS server to point the subdomain to the four DNS servers for the zone hosted in AWS
  2. Add a dummy DNS record to the new zone and make sure it resolves

Creating an IAM user to edit the newly created DNS subdomain

Create an IAM user with the following policy. This policy gives the user full access to edit only this subdomain

{
    "Version": "2018-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "route53:*"
            ],
            "Resource": "arn:aws:route53:::hostedzone/<zoneid>"
        },
        {
            "Effect": "Allow",
            "Action": [
                "route53:GetChange"
            ],
            "Resource": "arn:aws:route53:::change/*"
        }
    ]
}

Download the IAM keys of the user and enter Access and Secret key when prompted by ScaleGrid setup

6 Locating the logs

The logs are located under the root-user’s home directory. The path is printed at the start of installation - in case of any error, please raise a support request ([email protected]) and attach this log. By default the path would be /root/scalegrid-server-install.log.