From 7b7e590d3e5e321ec9f043a56c4d38a97824b6c8 Mon Sep 17 00:00:00 2001 From: andrea-berling Date: Fri, 26 Aug 2022 16:59:40 +0200 Subject: [PATCH] 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> --- changelog/14455.txt | 3 +++ .../storage/google-cloud-storage.mdx | 19 ++++++++++++++----- 2 files changed, 17 insertions(+), 5 deletions(-) create mode 100644 changelog/14455.txt diff --git a/changelog/14455.txt b/changelog/14455.txt new file mode 100644 index 000000000..e8e7f744e --- /dev/null +++ b/changelog/14455.txt @@ -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 +``` diff --git a/website/content/docs/configuration/storage/google-cloud-storage.mdx b/website/content/docs/configuration/storage/google-cloud-storage.mdx index 59c648311..2317d1de1 100644 --- a/website/content/docs/configuration/storage/google-cloud-storage.mdx +++ b/website/content/docs/configuration/storage/google-cloud-storage.mdx @@ -96,14 +96,19 @@ https://www.googleapis.com/auth/devstorage.read_write ## `gcs` Parameters - `bucket` `(string: )` – 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. @@ -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