luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

Update google-cloud-storage backend documentation (#14455) 

* Update google-cloud-storage backend documentation

Add mentions the environment variables that can be used to configure the backend instead of using the stanza parameters

* Add changelog file

* Fix some typos

* Update website/content/docs/configuration/storage/google-cloud-storage.mdx

Commit suggestion #1

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>

* Update website/content/docs/configuration/storage/google-cloud-storage.mdx

Commit suggestion #2

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>

* Update website/content/docs/configuration/storage/google-cloud-storage.mdx

Commit suggestion #3

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>
This commit is contained in:
andrea-berling 2022-08-26 16:59:40 +02:00 committed by GitHub
parent 1e9d4c8e72
commit 7b7e590d3e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
changelog/14455.txt Normal file
View File

@ -0,0 +1,3 @@
```release-note:improvement
storage/gcs: Add documentation explaining how to configure the gcs backend using environment variables instead of options in the configuration stanza
```

17
website/content/docs/configuration/storage/google-cloud-storage.mdx
View File

@ -96,14 +96,19 @@ https://www.googleapis.com/auth/devstorage.read_write
## `gcs` Parameters ## `gcs` Parameters
- `bucket` `(string: <required>)` – Specifies the name of the bucket to use for - `bucket` `(string: <required>)` – Specifies the name of the bucket to use for
storage. storage. Alternatively, this parameter can be omitted and the `GOOGLE_STORAGE_BUCKET`
environment variable can be used to set the name of the bucket. If both the environment
variable and the parameter in the stanza are set, the value of the environment variable
will take precedence.
- `chunk_size` `(string: "8192")` – Specifies the maximum size (in kilobytes) to - `chunk_size` `(string: "8192")` – Specifies the maximum size (in kilobytes) to
send in a single request. If set to 0, it will attempt to send the whole send in a single request. If set to 0, it will attempt to send the whole
object at once, but will not retry any failures. If you are not storing large object at once, but will not retry any failures. If you are not storing large
objects in Vault, it is recommended to set this to a low value (minimum is objects in Vault, it is recommended to set this to a low value (minimum is
256), since it will reduce the amount of memory Vault uses. Alternatively, this parameter
256. since it will reduce the amount of memory Vault uses. can be omitted and the `GOOGLE_STORAGE_CHUNK_SIZE` environment variable can be used to set
the chunk size. If both the environment variable and the parameter in the stanza are set,
the value of the environment variable will take precedence.
- `max_parallel` `(int: 128)` - Specifies the maximum number of parallel - `max_parallel` `(int: 128)` - Specifies the maximum number of parallel
operations to take place. operations to take place.
@ -112,7 +117,11 @@ https://www.googleapis.com/auth/devstorage.read_write
- `ha_enabled` `(string: "false")` - Specifies if high availability mode is - `ha_enabled` `(string: "false")` - Specifies if high availability mode is
enabled. This is a boolean value, but it is specified as a string like "true" enabled. This is a boolean value, but it is specified as a string like "true"
or "false". or "false". Alternatively, this parameter can be omitted and the
`GOOGLE_STORAGE_HA_ENABLED` environment variable can be used to
enable or disable high availability. If both the environment variable and
the parameter in the stanza are set, the value of the environment variable will
take precedence.
## `gcs` Examples ## `gcs` Examples