open-vault/website/source/docs/configuration/storage/cassandra.html.md

96 lines
3.2 KiB
Markdown
Raw Normal View History

2017-06-09 01:41:32 +00:00
---
layout: "docs"
page_title: "Cassandra - 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: "Cassandra"
2017-06-09 01:41:32 +00:00
sidebar_current: "docs-configuration-storage-cassandra"
description: |-
The Cassandra storage backend is used to persist Vault's data in an Apache
Cassandra cluster.
---
# Cassandra Storage Backend
The Cassandra storage backend is used to persist Vault's data in an [Apache
2017-08-09 14:31:55 +00:00
Cassandra][cassandra] cluster.
2017-06-09 01:41:32 +00:00
- **No High Availability** the Cassandra storage backend does not support high
availability.
- **Community Supported** the Cassandra 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 it,
you may be referred to the original author.
```hcl
storage "cassandra" {
hosts = "localhost"
consistency = "LOCAL_QUORUM"
protocol_version = 3
}
```
The Cassandra storage backend does not automatically create the keyspace and
table. This sample configuration can be used as a guide, but you will want to
2017-08-09 14:31:55 +00:00
ensure the keyspace [replication options][replication-options]
2017-06-09 01:41:32 +00:00
are appropriate for your cluster:
```cql
CREATE KEYSPACE "vault" WITH REPLICATION = {
'class': 'SimpleStrategy',
'replication_factor': 1
};
CREATE TABLE "vault"."entries" (
bucket text,
key text,
value blob,
PRIMARY KEY (bucket, key)
) WITH CLUSTERING ORDER BY (key ASC);
```
## `cassandra` Parameters
* `hosts` `(string: "127.0.0.1")`  Comma-separated list of Cassandra hosts to
connect to.
* `keyspace` `(string: "vault")` Cassandra keyspace to use.
* `table` `(string: "entries")`  Table within the `keyspace` in which to store
data.
* `consistency` `(string: "LOCAL_QUORUM")` Consistency level to use when
reading/writing data. If set, must be one of `"ANY"`, `"ONE"`, `"TWO"`,
`"THREE"`, `"QUORUM"`, `"ALL"`, `"LOCAL_QUORUM"`, `"EACH_QUORUM"`, or
`"LOCAL_ONE"`.
* `protocol_version` `(int: 2)` Cassandra protocol version to use.
* `username` `(string: "")` Username to use when authenticating with the
Cassandra hosts.
* `password` `(string: "")` Password to use when authenticating with the
Cassandra hosts.
* `connection_timeout` `(int: 0)` - A timeout in seconds to wait until a
connection is established with the Cassandra hosts.
* `tls` `(int: 0)` If `1`, indicates the connection with the Cassandra hosts
should use TLS.
* `pem_bundle_file` `(string: "")` - Specifies a file containing a
certificate and private key; a certificate, private key, and issuing CA
certificate; or just a CA certificate.
* `pem_json_file` `(string: "")` - Specifies a JSON file containing a certificate
and private key; a certificate, private key, and issuing CA certificate;
or just a CA certificate.
* `tls_skip_verify` `(int: 0)` - If `1`, then TLS host verification
will be disabled for Cassandra. Defaults to `0`.
* `tls_min_version` `(string: "tls12")` - Minimum TLS version to use. Accepted
values are `tls10`, `tls11` or `tls12`. Defaults to `tls12`.
2017-08-09 14:31:55 +00:00
[cassandra]: http://cassandra.apache.org/
2017-06-09 01:41:32 +00:00
[replication-options]: https://docs.datastax.com/en/cassandra/2.1/cassandra/architecture/architectureDataDistributeReplication_c.html