Calvin Leung Huang 9fd39a0681 Mongodb plugin (#2698 )

* WIP on mongodb plugin

* Add mongodb plugin

* Add tests

* Update mongodb.CreateUser() comment

* Update docs

* Add missing docs

* Fix mongodb docs

* Minor comment and test updates

* Fix imports

* Fix dockertest import

* Set c.Initialized at the end, check for empty CreationStmts first on CreateUser

* Remove Initialized check on Connection()

* Add back Initialized check

* Update docs

* Move connProducer and credsProducer into pkg for  mongodb and cassandra

* Chage parseMongoURL to be a private func

* Default to admin if no db is provided in creation_statements

* Update comments and docs

2017-05-11 17:38:54 -04:00

1.9 KiB

Raw Blame History

layout	page_title	sidebar_current	description
api	PostgreSQL Database Plugin - HTTP API	docs-http-secret-databases-postgresql	The PostgreSQL plugin for Vault's Database backend generates database credentials to access PostgreSQL servers.

PostgreSQL Database Plugin HTTP API

The PostgreSQL Database Plugin is one of the supported plugins for the Database backend. This plugin generates database credentials dynamically based on configured roles for the PostgreSQL database.

Configure Connection

In addition to the parameters defined by the Database Backend, this plugin has a number of parameters to further configure a connection.

Method	Path	Produces
`POST`	`/database/config/:name`	`204 (empty body)`

Parameters

connection_url (string: <required>) - Specifies the PostgreSQL DSN.
max_open_connections (int: 2) - Specifies the maximum number of open connections to the database.
max_idle_connections (int: 0) - Specifies the maximum number of idle connections to the database. A zero uses the value of max_open_connections and a negative value disables idle connections. If larger than max_open_connections it will be reduced to be equal.
max_connection_lifetime (string: "0s") - Specifies the maximum amount of time a connection may be reused. If <= 0s connections are reused forever.

Sample Payload

{
  "plugin_name": "postgresql-database-plugin",
  "allowed_roles": "readonly",
  "connection_url": "postgresql://root:root@localhost:5432/postgres",
  "max_open_connections": 5,
  "max_connection_lifetime": "5s",
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    https://vault.rocks/v1/database/config/postgresql

1.9 KiB Raw Blame History