From 171da2cb03aede50ffd3fb4f2ca8638ca1d1c169 Mon Sep 17 00:00:00 2001 From: Fokko Driesprong Date: Fri, 28 Jun 2024 11:45:54 +0200 Subject: [PATCH 1/2] Update GCS configuration --- mkdocs/docs/configuration.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md index f8a69119c8..0e3bfecf5e 100644 --- a/mkdocs/docs/configuration.md +++ b/mkdocs/docs/configuration.md @@ -131,17 +131,17 @@ For the FileIO there are several configuration options available: | Key | Example | Description | | -------------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| gcs.project-id | my-gcp-project | Configure Google Cloud Project for GCS FileIO. | -| gcs.oauth.token | ya29.dr.AfM... | Configure method authentication to GCS for FileIO. Can be the following, 'google_default', 'cache', 'anon', 'browser', 'cloud'. If not specified your credentials will be resolved in the following order: gcloud CLI default, gcsfs cached token, google compute metadata service, anonymous. | -| gcs.oauth.token-expires-at | 1690971805918 | Configure expiration for credential generated with an access token. Milliseconds since epoch | -| gcs.access | read_only | Configure client to have specific access. Must be one of 'read_only', 'read_write', or 'full_control' | -| gcs.consistency | md5 | Configure the check method when writing files. Must be one of 'none', 'size', or 'md5' | -| gcs.cache-timeout | 60 | Configure the cache expiration time in seconds for object metadata cache | -| gcs.requester-pays | False | Configure whether to use requester-pays requests | -| gcs.session-kwargs | {} | Configure a dict of parameters to pass on to aiohttp.ClientSession; can contain, for example, proxy settings. | -| gcs.endpoint | http://0.0.0.0:4443 | Configure an alternative endpoint for the GCS FileIO to access (format protocol://host:port) If not given, defaults to the value of environment variable "STORAGE_EMULATOR_HOST"; if that is not set either, will use the standard Google endpoint. | -| gcs.default-location | US | Configure the default location where buckets are created, like 'US' or 'EUROPE-WEST3'. | -| gcs.version-aware | False | Configure whether to support object versioning on the GCS bucket. | +| gcs.project-id | my-gcp-project | Configure Google Cloud Project for GCS FileIO. | +| gcs.oauth2.token | ya29.dr.AfM... | Configure method authentication to GCS for FileIO. Can be the following, 'google_default', 'cache', 'anon', 'browser', 'cloud'. If not specified your credentials will be resolved in the following order: gcloud CLI default, gcsfs cached token, google compute metadata service, anonymous. | +| gcs.oauth2.token-expires-at | 1690971805918 | Configure expiration for credential generated with an access token. Milliseconds since epoch | +| gcs.access | read_only | Configure client to have specific access. Must be one of 'read_only', 'read_write', or 'full_control' | +| gcs.consistency | md5 | Configure the check method when writing files. Must be one of 'none', 'size', or 'md5' | +| gcs.cache-timeout | 60 | Configure the cache expiration time in seconds for object metadata cache | +| gcs.requester-pays | False | Configure whether to use requester-pays requests | +| gcs.session-kwargs | {} | Configure a dict of parameters to pass on to aiohttp.ClientSession; can contain, for example, proxy settings. | +| gcs.endpoint | http://0.0.0.0:4443 | Configure an alternative endpoint for the GCS FileIO to access (format protocol://host:port) If not given, defaults to the value of environment variable "STORAGE_EMULATOR_HOST"; if that is not set either, will use the standard Google endpoint. | +| gcs.default-location | US | Configure the default location where buckets are created, like 'US' or 'EUROPE-WEST3'. | +| gcs.version-aware | False | Configure whether to support object versioning on the GCS bucket. | From 18c6d89bb1afc71fbd58a7ed12ef49870fadefc0 Mon Sep 17 00:00:00 2001 From: Fokko Date: Fri, 28 Jun 2024 18:00:33 +0200 Subject: [PATCH 2/2] Make the linter happy --- mkdocs/docs/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md index 0e3bfecf5e..f583e77351 100644 --- a/mkdocs/docs/configuration.md +++ b/mkdocs/docs/configuration.md @@ -129,8 +129,8 @@ For the FileIO there are several configuration options available: -| Key | Example | Description | -| -------------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Key | Example | Description | +| --------------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | gcs.project-id | my-gcp-project | Configure Google Cloud Project for GCS FileIO. | | gcs.oauth2.token | ya29.dr.AfM... | Configure method authentication to GCS for FileIO. Can be the following, 'google_default', 'cache', 'anon', 'browser', 'cloud'. If not specified your credentials will be resolved in the following order: gcloud CLI default, gcsfs cached token, google compute metadata service, anonymous. | | gcs.oauth2.token-expires-at | 1690971805918 | Configure expiration for credential generated with an access token. Milliseconds since epoch |