2017-07-23 12:54:33 +00:00
|
|
|
|
---
|
|
|
|
|
|
layout: "docs"
|
|
|
|
|
|
page_title: "CockroachDB - 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: "CockroachDB"
|
2017-07-23 12:54:33 +00:00
|
|
|
|
sidebar_current: "docs-configuration-storage-cockroachdb"
|
|
|
|
|
|
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. This table must already exist (Vault will not
|
|
|
|
|
|
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 PostgresSQL 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
|