Documentation

No results
    gitHub

    Amazon RDS or Aurora

    Amazon RDS (Relational Database Service) offers two options to run the PostgreSQL database engine in the Cloud: the RDS is a managed service that simplifies PostgreSQL database setup and management, offering basic scalability and automated backups. Or Aurora for PostgreSQL, a high-performance, cloud-native version of PostgreSQL built on a distributed storage system, designed to provide better performance and availability with features like faster recovery and automated scaling. RDS is ideal for simpler workloads with moderate scaling needs, while Aurora is suited for high-demand applications requiring faster performance, auto-scaling, and greater fault tolerance.

     

    Hackolade Studio can perform modeling for both options, using the PostgreSQL plugin while connecting securely, using SSL/TLS (full-verify SSL mode.)  RDS instances are sometimes set up to be only accessible using SSH over a EC2 instance (SSH tunneling).

     

    Before you're able to connect to an AWS RDS instance with Hackolade Studio, you'll need to gather relevant information and files, which will then be referenced in the Hackolade Studio connection parameters.

     

    There are many parameters in the setup of a Postgres instance.  The connection setup depends greatly on whether or not access is public or using an EC2 bastion instance.

     

    RDS - public access choice

     

    We cover both cases below.

    Public access

    With public access, it is much easier to set up the connection.

     

    Database endpoint and Port

    In the RDS instance screen, the tab "Connectivity & security" confirms the public accessibility, and shows the Endpoint and Port to be used (by default 5432.)

     

    RDS - public connectivity and security

     

    In the Hackolade connection settings dialog, give a meaningful name to the connection, then set the the endpoint host and port, and an optional database name if you wish to limit the scope of the discovery.  

    RDS - public connection host and port setting

     

    Authentication

    In the Authentication tab, you must provide the credentials given by your database administrator, created according to these instructions.

    Image

     

     

    SSL certificate bundle 

    Finally, it is now required to download from AWS, then reference an official certificate bundle for RDS.  It is possible to get a bundle specific to the region of your instance (smaller file), or to get the global certificate bundle for all AWS regions.  You must download the Privacy Enhanced Mail (PEM) bundle, and place it on your local system in a place where Hackolade Studio can access it.  Make sure to choose the SSL option "Verify Full":

     

    Image

     

    You may now save your entry and connect to the RDS instances.

     

     

    No public access

    The process is documented by AWS, and we summarize here the parts that are relevant to connect with Hackolade Studio.

     

    The architecture, courtesy of Amazon, looks like this:

    Image

     

     

    Perform all steps above for the public acces, plus this additional and critical last step...

    SSH certificate of the EC2 server 

    If your RDS instance does not have a public IP address, then access is allowed through a secure EC2 "bastion" server.  That EC2 instance must be in the same VPC as the RDS database. This can be either an existing EC2 instance, or one that is created just for this purpose.  The Security group must include the following three rules:

    - Allow SSH from your IP address

    - Allow HTTPS traffic from anywhere

    - Allow HTTP traffic from anywhere

     

    You can find this information in the EC2 details screen 

     

    RDS - EC2 Bastion instance info

     

     

     

    You also need to find out which SSH user name to reference.  To that effect, you need to know the type of platform that is running your EC2 instance (Amazon Linux, Ubuntu, ...).  In general when your instance runs Ubuntu the user will be '''ubuntu''' but otherwise it's most of the time '''ec2-user'''.

     

    RDS - EC2 Bastion instance details

     

    Finally, you need to get from your administrator the Privacy Enhanced Mail (PEM).  Note that this is second PEM file specifically for the EC2 bastion server to be used in the context of SSH -- not to be confused with the PEM bundle used for SSL in the previous step.

     

    During the setup of RDS with private access through the EC2 bastion server, there was a step to create and save the PRM

    RDS - private SSH key pair PEM creation

     

     

     

    Setup the SSH tunneling using your EC2 instance connection details, using the SSH Address, port 22 by default, the SSH user name ("ec2-user" for Amazon Linux, or "ubuntu"), then select the auth method "private key", and reference the path to the key pair (.pem).

     

    Image

     

    You should now be able to connect to your EC2 instance to tunnel to your RDS instance.