-
Notifications
You must be signed in to change notification settings - Fork 201
Migrate gsutil usage to gcloud storage #4340
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.
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
base: main
Are you sure you want to change the base?
Migrate gsutil usage to gcloud storage #4340
Conversation
Summary of ChangesHello @googlyrahman, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request automates the migration of legacy Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Hi @holtskinner, Can we get your review on this PR? Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request automates the migration of gsutil commands to their gcloud storage equivalents across several Jupyter notebooks. The changes are mostly correct, but I've identified a few issues. There are inconsistencies in the use of the --location flag, a critical JSON formatting error in one of the notebooks that will prevent it from loading, and a potential bug in another notebook where a grep command will fail due to a case-sensitivity issue after the migration. I've provided suggestions to fix these issues.
| ! gcloud storage ls $folder/prediction*\n", "\n", | ||
| ! gcloud storage cat $folder/prediction*\n", " break\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The automated migration has corrupted this cell's source code. The leading " and indentation have been removed from these lines, which breaks the JSON structure of the notebook and will cause it to fail to load. Please restore the correct formatting.
" ! gcloud storage ls $folder/prediction*\n",
"\n",
" ! gcloud storage cat $folder/prediction*\n",
" break\n",
| " shell_output = ! gsutil ls -Lb {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", | ||
| " bucket_region = shell_output[0].strip().lower()\n", | ||
| "# Note: The format of the full listing output is different. gcloud storage uses a title case for keys and will not display a field if its value is \"None\".\n", | ||
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", " bucket_region = shell_output[0].strip().lower()\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The grep command is case-sensitive and will fail to find the location constraint. The output of gcloud storage ls --full uses "Location Constraint:" (title case), whereas the old gsutil ls -Lb command used "Location constraint:" (sentence case). Please update the grep pattern to match the new output format.
shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep "Location Constraint:" | sed "s/Location Constraint://"
| "source": [ | ||
| "! gsutil mb -l $REGION $BUCKET_NAME" | ||
| ] | ||
| "! gcloud storage buckets create --location $REGION $BUCKET_NAME" ] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with other files in this PR and for better script clarity, it's recommended to use --location=$REGION instead of --location $REGION. While gcloud might handle both, using the equals sign is more explicit and less prone to parsing errors in shell scripts.
"! gcloud storage buckets create --location=$REGION $BUCKET_NAME"
| "source": [ | ||
| "! gsutil mb -l $REGION gs://$BUCKET_NAME" | ||
| ] | ||
| "! gcloud storage buckets create --location $REGION gs://$BUCKET_NAME" ] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with other files in this PR and for better script clarity, it's recommended to use --location=$REGION instead of --location $REGION. While gcloud might handle both, using the equals sign is more explicit and less prone to parsing errors in shell scripts.
"! gcloud storage buckets create --location=$REGION gs://$BUCKET_NAME"
| "source": [ | ||
| "! gsutil mb -l $REGION $BUCKET_URI" | ||
| ] | ||
| "! gcloud storage buckets create --location $REGION $BUCKET_URI" ] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with other files in this PR and for better script clarity, it's recommended to use --location=$REGION instead of --location $REGION. While gcloud might handle both, using the equals sign is more explicit and less prone to parsing errors in shell scripts.
"! gcloud storage buckets create --location=$REGION $BUCKET_URI"
| "source": [ | ||
| "! gsutil mb -l {LOCATION} -p {PROJECT_ID} {BUCKET_URI}" | ||
| ] | ||
| "! gcloud storage buckets create --location {LOCATION} --project {PROJECT_ID} {BUCKET_URI}" ] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with other files in this PR and for better script clarity, it's recommended to use --location={LOCATION} instead of --location {LOCATION}. While gcloud might handle both, using the equals sign is more explicit and less prone to parsing errors in shell scripts.
"! gcloud storage buckets create --location={LOCATION} --project {PROJECT_ID} {BUCKET_URI}"
Automated: Migrate paths from gsutil to gcloud storage
This CL is part of the on going effort to migrate from the legacy
gsutiltool to the new and improvedgcloud storagecommand-line interface.gcloud storageis the recommended and modern tool for interacting with Google Cloud Storage, offering better performance, unified authentication, and a more consistent command structure with othergcloudcomponents. 🚀Automation Details
This change was generated automatically by an agent that targets users of
gsutil.The transformations applied are based on the gsutil to gcloud storage migration guide.
While we have based the automation on the migration guide, every use case is unique.
It is crucial that you thoroughly test these changes in environments appropriate to your use-case before merging.
Be aware of potential differences between
gsutilandgcloud storagethat could impact your workflows.For instance, the structure of command output may have changed, requiring updates to any scripts that parse it. Similarly, command behavior can differ subtly; the
gcloud storage rsynccommand has a different file deletion logic thangsutil rsync, which could lead to unintended file deletions.Our migration guides can help guide you through a list of mappings and some notable differences between the two tools.
Standard presubmit tests are run as part of this CL's workflow. If you need to target an additional test workflow or require assistance with testing, please let us know.
Please verify that all your Cloud Storage operations continue to work as expected to avoid any potential disruptions in production.
Support and Collaboration
The
GCS CLIteam is here to help! If you encounter any issues, have a complex use case that this automated change doesn't cover, or face any other blockers, please don't hesitate to reach out.We are happy to work with you to test and adjust these changes as needed.
Contact:
gcs-cli-hyd@google.comWe appreciate your partnership in this important migration effort!
cc: @sushantkhanna