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

84 lines
3.1 KiB
Plaintext
Raw Normal View History

---
layout: docs
page_title: Swift - Storage Backends - Configuration
sidebar_title: Swift
description: |-
The Swift storage backend is used to persist Vault's data in an OpenStack
Swift Container.
---
# Swift Storage Backend
The Swift storage backend is used to persist Vault's data in an
[OpenStack Swift Container][swift].
- **No High Availability** the Swift storage backend does not support high
availability.
- **Community Supported** the Swift 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 "swift" {
auth_url = "https://..."
username = "admin"
password = "secret123!"
container = "my-storage-container"
}
```
## `swift` Parameters
- `auth_url` `(string: <required>)` Specifies the OpenStack authentication
endpoint. This can also be provided via the environment variable `OS_AUTH_URL`.
- `container` `(string: <required>)` Specifies the name of the Swift
container. This can also be provided via the environment variable
`OS_CONTAINER`.
2017-03-26 18:32:26 +00:00
- `max_parallel` `(string: "128")` The maximum number of concurrent requests.
- `password` `(string: <required>)` Specifies the OpenStack password. This can
also be provided via the environment variable `OS_PASSWORD`.
- `tenant` `(string: "")` Specifies the name of the tenant. If left blank,
this will default to the default tenant of the username. This can also be
provided via the environment variable `OS_TENANT_NAME`.
- `username` `(string: <required>)` Specifies the OpenStack account/username.
This can also be provided via the environment variable `OS_USERNAME`.
- `region` `(string: "")` Specifies the name of the region. This can also be provided via the environment variable `OS_REGION_NAME`.
- `tenant_id` `(string: "")` - Specifies the id of the tenant. This can also be provided via the environment variable `OS_TENANT_ID`.
- `domain` `(string: "")` - Specifies the name of the user domain. This can also be provided via the environment variable `OS_USER_DOMAIN_NAME`.
- `project-domain` `(string: "")` - Specifies the name of the project's domain. This can also be provided via the environment variable `OS_PROJECT_DOMAIN_NAME`.
- `trust_id` `(string: "")` - Specifies the id of the trust. This can also be provided via the environment variable `OS_TRUST_ID`.
- `storage_url` `(string: "")` - Specifies storage URL from alternate authentication. This can also be provided via the environment variable `OS_STORAGE_URL`.
- `auth_token` `(string: "")` - Specifies auth token from alternate authentication. This can also be provided via the environment variable `OS_AUTH_TOKEN`.
## `swift` Examples
### Default Example
This example shows a default configuration for Swift.
```hcl
storage "swift" {
2018-03-20 18:54:10 +00:00
auth_url = "https://os.internal/v1/auth"
container = "container-239"
username = "user1234"
password = "pass5678"
}
```
[swift]: http://docs.openstack.org/developer/swift/