Port Overrides

Last modified on October 7, 2022

By default, all resources of a given type share the same port on the client side. This port is usually the default port used by that database type, such as port 3306 for MySQL or port 5432 for Postgres. If the port is already taken on the client, it auto-increments instead.

To connect to a different resource of the same type, disconnect from the first resource and connect to the second. You can use a port override when connecting to resources of the same type simultaneously.

Port Overrides

Port overrides are enabled by default. If they were disabled by your organization, you can turn them on in the Admin UI > Settings > Port Overrides section. You can specify port overrides for all resource types, including SSH servers and Kubernetes clusters.

Port override values 49152 to 65535 are not allowed to be used.

Port overrides for Kubernetes

Port overrides on Kubernetes clusters require updating the kubectl configuration in order to access the clusters successfully.

Please do the following:

  1. In the Admin UI, go to Settings > Port Overrides and specify the port override number for your Kubernetes cluster.
  2. Check that your cluster is connected.
  3. Update the kubectl configuration.
    1. If using the desktop app, go to the Account menu and select Update kubectl configuration.

    2. If using the CLI, run the following command with the force option:

      sdm k8s update-config --force
      

Now you can successfully access the resource again.

Bind Interface

Resource configuration dialogs include the read-only Bind Interface field, which displays the IP address to which the port override of the resource is bound.

The bind interface is automatically generated for all datasource, server, and cluster resources after they are created.

You can optionally overwrite the generated bind interface value with your own preferred bind interface value by clicking edit and entering the new value.

Example Showing How to Edit the Bind Interface
Example Showing How to Edit the Bind Interface

Note the following limitations if you specify a different bind interface value:

  • The combination of both the bind interface value and the port override value must be unique.
  • The bind interface value must be in the 127.0.0.1 to 127.255.255.255 IP address range or else there is an error.
  • Using addresses other than 127.0.0.1 may also require configuration on client host machines. If not done, that may affect users’ ability to connect to those resources. Please consult with your Customer Success Manager or Customer Engineer if you are considering changing the default bind interface value.

End-User Experience

Port overrides ensure that users automatically have ports assigned for each resource and can connect to multiple resources of the same type concurrently.

Port Overrides On
Port Overrides On
Top