open-vault/website/content/docs/configuration/storage/mssql.mdx

83 lines
2.3 KiB
Plaintext
Raw Normal View History

2017-04-06 13:33:49 +00:00
---
layout: docs
page_title: MSSQL - Storage Backends - Configuration
description: >-
The MSSQL storage backend is used to persist Vault's data in a Microsoft SQL
Server.
2017-04-06 13:33:49 +00:00
---
# MSSQL Storage Backend
The MSSQL storage backend is used to persist Vault's data in a Microsoft SQL Server.
- **No High Availability** the MSSQL storage backend does not support high
availability.
- **Community Supported** the MSSQL 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 "mssql" {
server = "localhost"
port = 1433
2017-04-06 13:33:49 +00:00
username = "user1234"
password = "secret123!"
database = "vault"
table = "vault"
appname = "vault"
schema = "dbo"
connectionTimeout = 30
logLevel = 0
}
```
## `mssql` Parameters
- `server` `(string: <required>)` host or host\instance.
- `port` `(int: 1433)` Specifies the port of the MSSQL host.
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
- `username` `(string: "")` - enter the SQL Server Authentication user id or
the Windows Authentication user id in the DOMAIN\User format.
2017-04-06 13:33:49 +00:00
On Windows, if user id is empty or missing Single-Sign-On is used.
2017-04-06 13:33:49 +00:00
- `password` `(string: "")` specifies the MSSQL password to connect to
the database.
- `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.
2017-04-06 13:33:49 +00:00
- `schema` `(string: "dbo")` Specifies the name of the schema. If the schema
does not exist, Vault will attempt to create it.
- `appname` `(string: "Vault")` the application name.
- `connectionTimeout` `(int: 30)` in seconds (default is 30).
- `logLevel` `(int: 0)` logging flags (default 0/no logging, 63 for full logging) .
- `max_parallel` `(string: "128")` Specifies the maximum number of concurrent
requests to MSSQL.
2017-04-06 13:33:49 +00:00
## `mssql` Examples
### Custom Database, Table and Schema
This example shows configuring the MSSQL backend to use a custom database and
table name.
```hcl
storage "mssql" {
database = "my-vault"
table = "vault-data"
schema = "vlt"
username = "user1234"
password = "pass5678"
}
```