From 494b156bb6ecde887ca16757d122b16fc3aacb15 Mon Sep 17 00:00:00 2001 From: andrea-berling Date: Thu, 10 Mar 2022 21:46:52 +0100 Subject: [PATCH 1/6] 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 --- .../storage/google-cloud-storage.mdx | 21 +++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/website/content/docs/configuration/storage/google-cloud-storage.mdx b/website/content/docs/configuration/storage/google-cloud-storage.mdx index 59c648311423..593607dea21a 100644 --- a/website/content/docs/configuration/storage/google-cloud-storage.mdx +++ b/website/content/docs/configuration/storage/google-cloud-storage.mdx @@ -96,24 +96,33 @@ 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. + operations to take place. ### High Availability Parameters - `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 From 99151a15a690331f966518efd5b85f8bcf5e04a7 Mon Sep 17 00:00:00 2001 From: andrea-berling Date: Fri, 11 Mar 2022 11:06:19 +0100 Subject: [PATCH 2/6] Add changelog file --- changelog/14455.txt | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 changelog/14455.txt diff --git a/changelog/14455.txt b/changelog/14455.txt new file mode 100644 index 000000000000..e8e7f744e200 --- /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 +``` From 2ba2bab4b73f0b706218ad5f99500ecadb31ad0b Mon Sep 17 00:00:00 2001 From: andrea-berling Date: Fri, 11 Mar 2022 11:08:31 +0100 Subject: [PATCH 3/6] Fix some typos --- .../docs/configuration/storage/google-cloud-storage.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/content/docs/configuration/storage/google-cloud-storage.mdx b/website/content/docs/configuration/storage/google-cloud-storage.mdx index 593607dea21a..03963f0b7ada 100644 --- a/website/content/docs/configuration/storage/google-cloud-storage.mdx +++ b/website/content/docs/configuration/storage/google-cloud-storage.mdx @@ -105,13 +105,13 @@ https://www.googleapis.com/auth/devstorage.read_write 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. Alternatively, this parameter + 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. + operations to take place. ### High Availability Parameters From 038faf2933f63ecbefa95bd27d1703568774dfda Mon Sep 17 00:00:00 2001 From: andrea-berling Date: Wed, 16 Mar 2022 10:21:19 +0100 Subject: [PATCH 4/6] Update website/content/docs/configuration/storage/google-cloud-storage.mdx Commit suggestion #1 Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> --- .../content/docs/configuration/storage/google-cloud-storage.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/configuration/storage/google-cloud-storage.mdx b/website/content/docs/configuration/storage/google-cloud-storage.mdx index 03963f0b7ada..85713b99eca8 100644 --- a/website/content/docs/configuration/storage/google-cloud-storage.mdx +++ b/website/content/docs/configuration/storage/google-cloud-storage.mdx @@ -98,7 +98,7 @@ https://www.googleapis.com/auth/devstorage.read_write - `bucket` `(string: )` – Specifies the name of the bucket to use for 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 + 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 From 4098d51e03630213e6e1682d9e361ae749e5fe1e Mon Sep 17 00:00:00 2001 From: andrea-berling Date: Wed, 16 Mar 2022 10:21:50 +0100 Subject: [PATCH 5/6] Update website/content/docs/configuration/storage/google-cloud-storage.mdx Commit suggestion #2 Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> --- .../content/docs/configuration/storage/google-cloud-storage.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/configuration/storage/google-cloud-storage.mdx b/website/content/docs/configuration/storage/google-cloud-storage.mdx index 85713b99eca8..bfac80443a47 100644 --- a/website/content/docs/configuration/storage/google-cloud-storage.mdx +++ b/website/content/docs/configuration/storage/google-cloud-storage.mdx @@ -107,7 +107,7 @@ https://www.googleapis.com/auth/devstorage.read_write 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 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 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 From 873f3f72d65681ec18111b39e0ac2f10baee3c2e Mon Sep 17 00:00:00 2001 From: andrea-berling Date: Wed, 16 Mar 2022 10:21:58 +0100 Subject: [PATCH 6/6] Update website/content/docs/configuration/storage/google-cloud-storage.mdx Commit suggestion #3 Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> --- .../content/docs/configuration/storage/google-cloud-storage.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/configuration/storage/google-cloud-storage.mdx b/website/content/docs/configuration/storage/google-cloud-storage.mdx index bfac80443a47..2317d1de12f0 100644 --- a/website/content/docs/configuration/storage/google-cloud-storage.mdx +++ b/website/content/docs/configuration/storage/google-cloud-storage.mdx @@ -120,7 +120,7 @@ https://www.googleapis.com/auth/devstorage.read_write 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 + the parameter in the stanza are set, the value of the environment variable will take precedence. ## `gcs` Examples