2017-07-23 12:54:33 +00:00
|
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
|
layout: docs
|
|
|
|
|
page_title: CockroachDB - Storage Backends - Configuration
|
|
|
|
|
description: >-
|
|
|
|
|
The CockroachDB storage backend is used to persist Vault's data in a
|
|
|
|
|
CockroachDB
|
|
|
|
|
|
2017-07-23 12:54:33 +00:00
|
|
|
|
server or cluster.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# CockroachDB Storage Backend
|
|
|
|
|
|
|
|
|
|
The CockroachDB storage backend is used to persist Vault's data in a
|
|
|
|
|
[CockroachDB][cockroachdb] server or cluster.
|
|
|
|
|
|
|
|
|
|
- **No High Availability** – the CockroachDB storage backend does not support
|
|
|
|
|
high availability.
|
|
|
|
|
|
|
|
|
|
- **Community Supported** – the CockroachDB storage backend is supported by the
|
2020-01-18 00:18:09 +00:00
|
|
|
|
community. While it has undergone development and review by HashiCorp
|
2017-07-23 12:54:33 +00:00
|
|
|
|
employees, they may not be as knowledgeable about the technology.
|
|
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
|
storage "cockroachdb" {
|
|
|
|
|
connection_url = "postgres://user123:secret123!@localhost:5432/vault"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
**Note** - CockroachDB is compatible with the PostgreSQL database driver and
|
2017-07-23 12:54:33 +00:00
|
|
|
|
uses that driver to interact with the database.
|
|
|
|
|
|
|
|
|
|
## `cockroachdb` Parameters
|
|
|
|
|
|
|
|
|
|
- `connection_url` `(string: <required>)` – Specifies the connection string to
|
|
|
|
|
use to authenticate and connect to CockroachDB. 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
|
2021-07-09 21:30:21 +00:00
|
|
|
|
which to write Vault data. If this table does not exist Vault will attempt to create it.
|
2017-07-23 12:54:33 +00:00
|
|
|
|
|
|
|
|
|
- `max_parallel` `(string: "128")` – Specifies the maximum number of concurrent
|
|
|
|
|
requests to CockroachDB.
|
|
|
|
|
|
|
|
|
|
## `cockroachdb` Examples
|
|
|
|
|
|
2019-06-04 07:28:44 +00:00
|
|
|
|
This example shows connecting to a PostgreSQL cluster using full SSL
|
2017-07-23 12:54:33 +00:00
|
|
|
|
verification (recommended).
|
|
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
|
storage "cockroachdb" {
|
|
|
|
|
connection_url = "postgres://user:pass@localhost:5432/database?sslmode=verify-full"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To disable SSL verification (not recommended), replace `verify-full` with
|
|
|
|
|
`disable`:
|
|
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
|
storage "cockroachdb" {
|
|
|
|
|
connection_url = "postgres://user:pass@localhost:5432/database?sslmode=disable"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
[cockroachdb]: https://www.cockroachlabs.com/
|
|
|
|
|
[pglib]: https://godoc.org/github.com/lib/pq#hdr-Connection_String_Parameters
|