Close
logodocs

Add a Datasource

A Datasource is a combination of a specific database and the credentials to access it.

Prerequisites

It is a relatively simple process to add a Datasource in the Admin UI if you've met all of the relevant prerequisites.

  1. You must have a properly configured account (i.e., have a username and password) on the Datasource you'll be adding. If you choose to store credentials for the Datasource with strongDM, you must have those credentials handy. If not, you must have set up Secret Stores and be able to enter the location of the secrets required to access the Datasource.

  2. The hostname or endpoint you enter for your Datasource must be accessible by at least one Gateway or Relay. To verify this, log in to the Gateway or Relay, and use Netcat: nc -zv <YOUR_HOSTNAME> <YOUR_PORT> (in this example, nc -zv testdb-01.fancy.org 3306). If your Gateway server can connect to this hostname, proceed.

    Netcat is an easy tool for checking various hostnames and ports by either sending data (a ping) or checking for listeners on the ports. The commands above use -z to check for listeners without sending data and -v to show verbose output. If you don't have Netcat, you can install the netcat package with whatever package manager you are using, such as apt-get install netcat.

Add the Datasource

  1. Log in to the Admin UI and select Datasources from the left-hand navigation.

  2. In the upper right-hand section of the screen, click add datasource. You'll be presented with a dialog like the one shown.

    Add Datasource Dialog
    Add Datasource Dialog

  3. Use this dialog to configure how your Gateways or Relays will connect to the Datasource. Set the following basic properties, along with any other properties specific to your selected Datasource:

    1. Display Name: Enter a meaningful name for the Datasource. This name will be displayed in the Admin UI and local clients.
    2. Datasource Type: Select the type of Datasource from the list of available types.
    3. Hostname: Enter the hostname.
    4. Port: When you select the Datasource type, the Port field will be automatically filled with that resource's default port for connectivity. If you know that your resource is set to connect on a different port, enter that port here now.
    5. Port Override: This field provides an organization-wide standard port for users to connect to this Datasource via their client. In most organizations, this field will automatically populate. You can optionally overwrite it with your own preferred port.
    6. Database: Enter the name of the database you'll be connecting to with this Datasource.
    7. Username: Enter the username of the user that will be used for this Datasource.
    8. Password: Enter the password of the user that will be used for this Datasource.
    9. Secret Store: This field lets you specify where the credentials for this resource will be stored (i.e., strongDM, AWS Secrets Manager, Vault Secret Store, or GCP Secrets Manager). Note that this field is only displayed if secret store integration is configured in the Admin UI.
    10. Override Database: By default, for PostgreSQL and its derivative database management systems (DBMS), such as Greenplum, strongDM will limit all connections to the configured database. If you would like to change that, uncheck this option.
    11. Resource Tags: Assign tags to the Datasource by entering key-value pairs in the format <KEY>=<VALUE> (e.g., env=dev).
  4. Click create.

View Datasource Status

After the Datasource has been created, the Admin UI will update and show the new Datasource with a yellow icon while it runs initial healthchecks.

Datasource Not Ready
Datasource Not Ready

Eventually, you should see the icon turn gray and then green, which means it's ready.

Datasource Ready
Datasource Ready

If it does not turn green, check the Diagnostics tab for errors.

To create multiple Datasources, repeat this process for each Datasource.

If any errors occur, please copy them into an email and send to support@strongdm.com.

Previous
Datasources
Next
Amazon DocumentDB