Couchbase
Last modified on September 17, 2024
Overview
A datasource consists of a database resource and the credentials used to access it. This guide describes how to add a Couchbase database as a datasource in the StrongDM Admin UI.
Prerequisites
To add a datasource, make sure you have met the following prerequisites:
- Properly configure an account for your database resource. If you choose to store credentials for the resource with StrongDM, have those credentials ready. When not using StrongDM, set up a Secret Store integration and be able to enter the location of the secrets required to access the resource.
- The hostname or endpoint you enter for your resource must be accessible by at least one gateway or relay. To verify this, log in to the gateway or relay and use the
nc -zv <YOUR_HOSTNAME> <YOUR_PORT>Netcat command. For example, usenc -zv testdb-01.fancy.org 5432. If your gateway server can connect to this hostname, you can proceed.
-z flag to check for listeners without sending data and the -v flag to show verbose output. If you do not have Netcat, you can use a package manager such as APT (Advanced Package Tool) to install it. On Linux-based distributions, run apt-get install netcat.Add a Datasource
To add your new Couchbase database as a StrongDM datasource, use the following steps.
- Log in to the Admin UI.
- Go to Infrastructure > Datasources.
- Click Add datasource.
- Select Couchbase as the Datasource Type and set other configuration properties for your new database resource.
- Complete all required fields.
- Click Create to save the resource.
- Click the resource name to view status, diagnostic information, and setting details.
Resource properties
Configuration properties are visible when you add a datasource or when you click to view its settings. The following table describes the settings available for your Couchbase database.
| Property | Requirement | Description |
|---|---|---|
| Display Name | Required | Meaningful name to display the resource throughout StrongDM; exclude special characters like quotes (") or angle brackets (< or >) |
| Datasource Type | Required | Select Couchbase |
| Hostname | Required | Hostname for your Couchbase database resource; must be accessible to a gateway or relay |
| Port | Optional | Port to use when connecting to your Couchbase database; default port value is 11210 |
| Bind Interface | Read only | Automatically generated IP address value in the 127.0.0.1 to 127.255.255.254 IP address range; default is 127.0.0.1; preferred bind interface value can be modified later under Settings > Port Overrides |
| Port Override | Read only | Automatically generated with a value between 1024-59999 as long as that port is not used by another resource; preferred port can be modified later under Settings > Port Overrides |
| Secret Store | Optional | Credential store location; defaults to Strong Vault; learn more about Secret Store options |
| Username | Required | Username to utilize when connecting to this datasource; displays when Secret Store integration is not configured for your organization or when StrongDM serves as the Secret Store type |
| Password | Required | Password for the user connecting to this datasource; displays when Secret Store integration is not configured for your organization or when StrongDM serves as the Secret Store type |
| Username (path) | Required | Path to the secret in your secret store location, if using a secret store that is not Strong Vault (for example, path/to/credential?key=optionalKeyName where key argument is optional); required when using a non-Strong Vault secret store type |
| Password (path) | Required | Path to the secret in your secret store location (for example, path/to/credential?key=optionalKeyName where key argument is optional); required when using a non-Strong Vault secret store type |
| TLS Required | Optional | When selected, requires TLS for connections to this Couchbase resource |
| N1QL Port | Required | Port number for N1QL queries; default HTTP is 8093; default HTTPS is 18093 |
| Resource Tags | Optional | Datasource tags consisting of key-value pairs <KEY>=<VALUE> (for example, env=dev) |
Secret Store options
By default, datasource credentials are stored in StrongDM. However, these credentials can also be saved in a secrets management tool.
Non-StrongDM options appear in the Secret Store dropdown if they are created under Network > Secret Stores. When you select another Secret Store type, its unique properties display. For more details, see Configure Secret Store Integrations.
Resource status
After a resource is created, the Admin UI displays that resource as unhealthy until the health checks run successfully. When the resource is ready, the Health icon indicates a positive, green status.
When the resource does not display a positive status, click the resource name to go to the Diagnostics tab and check for errors.