rolekit.roles.databaseserver man page

rolekit.roles.databaseserver — rolekit Database Server Role Documentation


The Database Server role provides a scalable database powered by the PostgreSQL project.


The Database Server role can be deployed using the rolectl command-line utility or through the rolekit D-BUS API. When using the rolectl tool, a settings file must be created in the JSON format.

Mandatory Settings

These settings must always be present or the deployment will be unable to complete.

All settings for the Database Server Role are optional.

Optional Settings

This section provides a list of optional settings for deployment.


Specify the name of the database to be created

Default: The name of the role instance. If the role name begins with a non-alphabetic character (such as when the name was auto-generated), it will be prefixed with "db_".


Specify the name of the user to be created to own this database.

Default: db_owner


The password for the owner of the database.

For new owners, a random password will be generated if one was not specified. This generated password can be retrieved via the D-BUS API. If the owner already exists in the database, this must be left blank. Passwords for pre-existing users or provided on deployment will not be retrievable by the API.

Example Settings.JSON

    "database": "example_db",
    "owner": "example_owner"

See Also

rolekit(1), rolectl(1), roled(5), rolekit.dbus(5), rolekit.roles(5), rolekit.roles.databaseserver(5), rolekit.roles.domaincontroller(5)


rolekit home page at


Thomas Woerner <>


Stephen Gallagher <>


Miloslav Trmač <>


Nils Philippsen <>


Referenced By

rolectl(1), roled(1), rolekit(5), rolekit.dbus(5), rolekit.roles(5), rolekit.roles.domaincontroller(5), rolekit.roles.memcache(5).

rolekit 0.5.2 rolekit.roles.databaseserver