Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update google-cloud-storage backend documentation #14455

Merged
merged 6 commits into from
Aug 26, 2022
Merged

Update google-cloud-storage backend documentation #14455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
494b156
Update google-cloud-storage backend documentation
andrea-berling Mar 10, 2022
99151a1
Add changelog file
andrea-berling Mar 11, 2022
2ba2bab
Fix some typos
andrea-berling Mar 11, 2022
038faf2
Update website/content/docs/configuration/storage/google-cloud-storag…
andrea-berling Mar 16, 2022
4098d51
Update website/content/docs/configuration/storage/google-cloud-storag…
andrea-berling Mar 16, 2022
873f3f7
Update website/content/docs/configuration/storage/google-cloud-storag…
andrea-berling Mar 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelog/14455.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```
19 changes: 14 additions & 5 deletions website/content/docs/configuration/storage/google-cloud-storage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,19 @@ https://www.googleapis.com/auth/devstorage.read_write
## `gcs` Parameters

- `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
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
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.
256), since it will reduce the amount of memory Vault uses. Alternatively, this parameter
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
operations to take place.
Expand All @@ -112,8 +117,12 @@ https://www.googleapis.com/auth/devstorage.read_write

- `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"
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

### High Availability
Expand Down