Fork me on GitHub

Dynamic Database Registration


Dynamic database registration is available starting from Teleport 8.0.

Dynamic database registration allows Teleport administrators to register new databases (or update/unregister existing ones) without having to update the static configuration and restarting the database agents.

To enable dynamic registration, include a resources section in your database agent configuration with a list of resource label selectors you'd like this agent to monitor:

  enabled: "yes"
  - labels:
      "*": "*"

You can use a wildcard selector to monitor all database resources in the cluster, or provide a specific set of labels to monitor a subset:

- labels:
    "env": "prod"
    "engine": "postgres"
- labels:
    "env": "test"
    "engine": "mysql"

Next define a database resource:

kind: db
version: v3
  name: example
  description: "Example database"
    env: prod
    engine: postgres
  protocol: "postgres"
  uri: "localhost:5432"

See the full database resource spec reference.

To create a database resource, run:

tctl create database.yaml

After the resource has been created, it will appear among the list of available databases (in tsh db ls or UI) as long as at least one database agent picks it up according to its label selectors.

To update an existing database resource, run:

tctl create -f database.yaml

If the updated resource's labels no longer match a particular database agent, it will unregister and stop proxying it.

To delete a database resource, run:

tctl rm db/example
Have a suggestion or can’t find something?