2017-03-08 02:47:23 +00:00
|
|
|
|
---
|
|
|
|
|
layout: "docs"
|
|
|
|
|
page_title: "PostgreSQL - Storage Backends - Configuration"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
|
sidebar_title: "PostgreSQL"
|
2017-03-08 02:47:23 +00:00
|
|
|
|
sidebar_current: "docs-configuration-storage-postgresql"
|
|
|
|
|
description: |-
|
|
|
|
|
The PostgreSQL storage backend is used to persist Vault's data in a PostgreSQL
|
|
|
|
|
server or cluster.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# PostgreSQL Storage Backend
|
|
|
|
|
|
|
|
|
|
The PostgreSQL storage backend is used to persist Vault's data in a
|
|
|
|
|
[PostgreSQL][postgresql] server or cluster.
|
|
|
|
|
|
|
|
|
|
- **No High Availability** – the PostgreSQL storage backend does not support
|
|
|
|
|
high availability.
|
|
|
|
|
|
|
|
|
|
- **Community Supported** – the PostgreSQL storage backend is supported by the
|
|
|
|
|
community. While it has undergone review by HashiCorp employees, they may not
|
|
|
|
|
be as knowledgeable about the technology. If you encounter problems with them,
|
|
|
|
|
you may be referred to the original author.
|
|
|
|
|
|
|
|
|
|
```hcl
|
2017-03-08 14:17:00 +00:00
|
|
|
|
storage "postgresql" {
|
2017-03-08 02:47:23 +00:00
|
|
|
|
connection_url = "postgres://user123:secret123!@localhost:5432/vault"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2017-07-23 12:54:33 +00:00
|
|
|
|
The PostgreSQL storage backend does not automatically create the table. Here is
|
2017-03-08 02:47:23 +00:00
|
|
|
|
some sample SQL to create the schema and indexes.
|
|
|
|
|
|
|
|
|
|
```sql
|
|
|
|
|
CREATE TABLE vault_kv_store (
|
|
|
|
|
parent_path TEXT COLLATE "C" NOT NULL,
|
|
|
|
|
path TEXT COLLATE "C",
|
|
|
|
|
key TEXT COLLATE "C",
|
|
|
|
|
value BYTEA,
|
|
|
|
|
CONSTRAINT pkey PRIMARY KEY (path, key)
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
CREATE INDEX parent_path_idx ON vault_kv_store (parent_path);
|
|
|
|
|
```
|
|
|
|
|
|
2017-04-04 16:29:54 +00:00
|
|
|
|
If you're using a version of PostgreSQL prior to 9.5, create the following function:
|
|
|
|
|
|
|
|
|
|
```sql
|
|
|
|
|
CREATE FUNCTION vault_kv_put(_parent_path TEXT, _path TEXT, _key TEXT, _value BYTEA) RETURNS VOID AS
|
|
|
|
|
$$
|
|
|
|
|
BEGIN
|
|
|
|
|
LOOP
|
|
|
|
|
-- first try to update the key
|
|
|
|
|
UPDATE vault_kv_store
|
|
|
|
|
SET (parent_path, path, key, value) = (_parent_path, _path, _key, _value)
|
|
|
|
|
WHERE _path = path AND key = _key;
|
|
|
|
|
IF found THEN
|
|
|
|
|
RETURN;
|
|
|
|
|
END IF;
|
|
|
|
|
-- not there, so try to insert the key
|
|
|
|
|
-- if someone else inserts the same key concurrently,
|
|
|
|
|
-- we could get a unique-key failure
|
|
|
|
|
BEGIN
|
|
|
|
|
INSERT INTO vault_kv_store (parent_path, path, key, value)
|
|
|
|
|
VALUES (_parent_path, _path, _key, _value);
|
|
|
|
|
RETURN;
|
|
|
|
|
EXCEPTION WHEN unique_violation THEN
|
|
|
|
|
-- Do nothing, and loop to try the UPDATE again.
|
|
|
|
|
END;
|
|
|
|
|
END LOOP;
|
|
|
|
|
END;
|
|
|
|
|
$$
|
|
|
|
|
LANGUAGE plpgsql;
|
|
|
|
|
```
|
|
|
|
|
|
2017-03-08 02:47:23 +00:00
|
|
|
|
## `postgresql` Parameters
|
|
|
|
|
|
|
|
|
|
- `connection_url` `(string: <required>)` – Specifies the connection string to
|
|
|
|
|
use to authenticate and connect to PostgreSQL. A full list of supported
|
|
|
|
|
parameters can be found in [the pq library documentation][pglib]. For example
|
|
|
|
|
connection string URLs, see the examples section below.
|
|
|
|
|
|
|
|
|
|
- `table` `(string: "vault_kv_store")` – Specifies the name of the table in
|
|
|
|
|
which to write Vault data. This table must already exist (Vault will not
|
|
|
|
|
attempt to create it).
|
|
|
|
|
|
2017-07-17 17:04:49 +00:00
|
|
|
|
- `max_parallel` `(string: "128")` – Specifies the maximum number of concurrent
|
|
|
|
|
requests to PostgreSQL.
|
|
|
|
|
|
2017-03-08 02:47:23 +00:00
|
|
|
|
## `postgresql` Examples
|
|
|
|
|
|
|
|
|
|
### Custom SSL Verification
|
|
|
|
|
|
2017-07-23 12:54:33 +00:00
|
|
|
|
This example shows connecting to a PostgreSQL cluster using full SSL
|
2017-03-08 02:47:23 +00:00
|
|
|
|
verification (recommended).
|
|
|
|
|
|
|
|
|
|
```hcl
|
2017-03-08 14:17:00 +00:00
|
|
|
|
storage "postgresql" {
|
2017-03-08 02:47:23 +00:00
|
|
|
|
connection_url = "postgres://user:pass@localhost:5432/database?sslmode=verify-full"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To disable SSL verification (not recommended), replace `verify-full` with
|
|
|
|
|
`disable`:
|
|
|
|
|
|
|
|
|
|
```hcl
|
2017-03-08 14:17:00 +00:00
|
|
|
|
storage "postgresql" {
|
2017-03-08 02:47:23 +00:00
|
|
|
|
connection_url = "postgres://user:pass@localhost:5432/database?sslmode=disable"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
[postgresql]: https://www.postgresql.org/
|
|
|
|
|
[pglib]: https://godoc.org/github.com/lib/pq#hdr-Connection_String_Parameters
|