From 423c588c71ee4a840b00e4c4ae18ca0f9ead6c42 Mon Sep 17 00:00:00 2001 From: Dilip Pednekar Date: Tue, 7 Nov 2023 21:47:29 -0800 Subject: [PATCH] Add credentials information for shim (#1756) * Add credentials information for shim * Address review comment --- gslib/addlhelp/shim.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/gslib/addlhelp/shim.py b/gslib/addlhelp/shim.py index e1e38c6f8..250e00689 100644 --- a/gslib/addlhelp/shim.py +++ b/gslib/addlhelp/shim.py @@ -30,6 +30,15 @@ transition to this new CLI, gsutil provides a shim that translates your gsutil commands to gcloud storage commands if an equivalent exists, and falls back to gsutil's usual behavior if an equivalent does not exist. + + PREREQUISITES + +You should be running gsutil binary installed via Cloud SDK tool. +To verify this, run ``gsutil ver -l`` and you should be able to see +``pass cloud sdk credentials to gsutil: True``. If it is ``False``, +try running ``gcloud config set pass_credentials_to_gsutil True``. +If you do not have ``gcloud`` installed, follow the +`Cloud SDK installation instructions. `_. TO ENABLE @@ -220,6 +229,9 @@ Configuration found in the boto file is mapped 1:1 to gcloud environment variables where appropriate. + Important: The ``gs_oauth2_refresh_token`` and ``gs_service_key_file`` fields + are ignored by the shim and authentication is taken care by ``gcloud``. + [Credentials] ------------------------