a3dfde5cec
* 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
88 lines
2.7 KiB
Markdown
88 lines
2.7 KiB
Markdown
---
|
||
layout: "docs"
|
||
page_title: "MySQL - Storage Backends - Configuration"
|
||
sidebar_title: "MySQL"
|
||
sidebar_current: "docs-configuration-storage-mysql"
|
||
description: |-
|
||
The MySQL storage backend is used to persist Vault's data in a MySQL server or
|
||
cluster.
|
||
---
|
||
|
||
# MySQL Storage Backend
|
||
|
||
The MySQL storage backend is used to persist Vault's data in a [MySQL][mysql]
|
||
server or cluster.
|
||
|
||
- **High Availability** – the MySQL storage backend supports high availability.
|
||
Note that due to the way mysql locking functions work they are lost if a connection
|
||
dies. If you would like to not have frequent changes in your elected leader you
|
||
can increase interactive_timeout and wait_timeout MySQL config to much higher than
|
||
default which is set at 8 hours.
|
||
|
||
- **Community Supported** – the MySQL 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
|
||
storage "mysql" {
|
||
username = "user1234"
|
||
password = "secret123!"
|
||
database = "vault"
|
||
}
|
||
```
|
||
|
||
## `mysql` Parameters
|
||
|
||
- `address` `(string: "127.0.0.1:3306")` – Specifies the address of the MySQL
|
||
host.
|
||
|
||
- `database` `(string: "vault")` – Specifies the name of the database. If the
|
||
database does not exist, Vault will attempt to create it.
|
||
|
||
- `table` `(string: "vault")` – Specifies the name of the table. If the table
|
||
does not exist, Vault will attempt to create it.
|
||
|
||
- `tls_ca_file` `(string: "")` – Specifies the path to the CA certificate to
|
||
connect using TLS.
|
||
|
||
- `max_parallel` `(string: "128")` – Specifies the maximum number of concurrent
|
||
requests to MySQL.
|
||
|
||
Additionally, Vault requires the following authentication information.
|
||
|
||
- `username` `(string: <required>)` – Specifies the MySQL username to connect to
|
||
the database.
|
||
|
||
- `password` `(string: <required>)` – Specifies the MySQL password to connect to
|
||
the database.
|
||
|
||
### High Availability Parameters
|
||
|
||
- `ha_enabled` `(string: "true")` - Specifies if high availability mode is
|
||
enabled. This is a boolean value, but it is specified as a string like "true"
|
||
or "false".
|
||
|
||
- `lock_table` `(string: "vault_lock")` – Specifies the name of the table to
|
||
use for storing high availability information. By default, this is the name
|
||
of the `table` suffixed with `_lock`. If the table does not exist, Vault will
|
||
attempt to create it.
|
||
|
||
## `mysql` Examples
|
||
|
||
### Custom Database and Table
|
||
|
||
This example shows configuring the MySQL backend to use a custom database and
|
||
table name.
|
||
|
||
```hcl
|
||
storage "mysql" {
|
||
database = "my-vault"
|
||
table = "vault-data"
|
||
username = "user1234"
|
||
password = "pass5678"
|
||
}
|
||
```
|
||
|
||
[mysql]: https://dev.mysql.com
|