open-vault/website/content/docs/configuration/storage/cockroachdb.mdx
Thor db9edf519b
cockroachdb: Fix either incorrect or outdated info (#11512)
The documentation stated that Vault would not create the table
if it doesn't exist. But Vault does attempt to create the table if
it doesn't exist.

Ref:
https://github.com/hashicorp/vault/blob/master/physical/cockroachdb/cockroachdb.go#L84
2021-07-09 14:30:21 -07:00

67 lines
2 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
layout: docs
page_title: CockroachDB - Storage Backends - Configuration
description: >-
The CockroachDB storage backend is used to persist Vault's data in a
CockroachDB
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
community. While it has undergone development and review by HashiCorp
employees, they may not be as knowledgeable about the technology.
```hcl
storage "cockroachdb" {
connection_url = "postgres://user123:secret123!@localhost:5432/vault"
}
```
**Note** - CockroachDB is compatible with the PostgreSQL database driver and
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
which to write Vault data. If this table does not exist Vault will attempt to create it.
- `max_parallel` `(string: "128")` Specifies the maximum number of concurrent
requests to CockroachDB.
## `cockroachdb` Examples
This example shows connecting to a PostgreSQL cluster using full SSL
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