At what port and address do my users and applications access data repositories through Cyral?

Q: I have a user or application that needs to access a data repository protected by Cyral. What host name and port number do they use?


A: Users and applications that connect to a repository will connect at the sidecar host/port address. This address is also known as the sidecar load balancer address because the sidecar runs as a highly available, load-balanced cluster. The Cyral administrator sets this address and port when they assign the sidecar to the repository. For help looking up the sidecar host/port address, see the next section.


Finding the host and port number where users can connect to a repository

To find the host and port where data users and applications can connect to a data repository, do this:

  1. In the Cyral management console, open the Access Data Repositories panel by clicking the Your Access Token button or by navigating to your Cyral access portal address.
  2. Find your repository in the Access Data Repositories list.
  3. Click the Connect button. 
  4. Find the sidecar you wish to use. Connection details are shown for each sidecar that offers access to this repository. Use the copy button to copy the details to your clipboard.

See Connect to a repository for more details.


Finding a repository's native address

As explained above, data users connect to data repositories through the Cyral sidecar address, also known as the sidecar load balancer address. As an administrator, you may also need to know the native address where the actual repository is running. Generally, you will not share this address with users. 


As a Cyral administrator, you can find the data repository's native address as shown here:

  1. In the Cyral management console, click Data Repos and click the name of your repository in the list. 
  2. The repository's native address and port are shown near the top of the window.


Finding all sidecar details for a repository

To find the user connection details for a repository as well as full details about the sidecars through which data users connect to that repository, do this:

  1. In the Cyral management console, click Data Repos and click the name of your repository in the list. 
  2. In the SIDECARS section, note the name of the sidecar through which users connect. (There may be more than one sidecar for the repository.)
  3. Click Sidecars in the menu on the left. Find the sidecar whose name you just noted. Use search if needed. Click the sidecar's name.
  4. In the Data Repositories list, find the repository you wish to inspect. Its host and port are shown in the Sidecar Endpoint column. This is the address where data users and applications can connect to the repository. In the Instances tab, you can see health and location details for the sidecar.


Example scenario

Suppose you have a PostgreSQL repository hosted at mypg-database.us-east-1.rds.aws.com:5432 and a sidecar running at mysidecar.us-east-1.aws.com. When you attach this PostgreSQL repository to the sidecar in Cyral, you can choose to expose a different port to the user (for this example, we'll use port 5434). Configured in this way, data users and applications connect at host mysidecar.us-east-1.aws.com and port 5434. When a user makes a request to this address, the sidecar redirects the request to the actual database running at mypg-database.us-east-1.rds.aws.com on port 5432.


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.