mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-23 15:41:07 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
85 lines
2.8 KiB
Plaintext
85 lines
2.8 KiB
Plaintext
---
|
||
layout: docs
|
||
page_title: MSSQL configuration
|
||
description: >-
|
||
Configure Vault backend storage to use Microsoft SQL Server.
|
||
---
|
||
|
||
> [!IMPORTANT]
|
||
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
||
|
||
# Microsoft SQL Server configuration for Vault backend storage
|
||
|
||
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
|
||
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.
|
||
|
||
- `username` `(string: "")` - enter the SQL Server Authentication user id or
|
||
the Windows Authentication user id in the DOMAIN\User format.
|
||
On Windows, if user id is empty or missing Single-Sign-On is used.
|
||
|
||
- `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.
|
||
|
||
- `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.
|
||
|
||
## `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"
|
||
}
|
||
```
|