Migrate gsutil usage to gcloud storage #13721
Conversation
|
Hi @JonWayne, Can we get your review on this PR? Thanks! |
product-auto-label
bot
added
samples
Summary of ChangesHello @bhandarivijay-png, 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 systematically updates existing 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request automatically migrates gsutil commands to their gcloud storage equivalents in startup-script.sh. The migration is correct and follows the recommended mappings from the migration guide. I've provided a couple of suggestions to improve the script's robustness. My main suggestion is to make the bucket creation step idempotent by checking for the bucket's existence before creating it. I've also recommended quoting shell variables, which is a general best practice to prevent potential issues.
|
|
||
| # Create a Google Cloud Storage bucket. | ||
| gsutil mb gs://$CS_BUCKET | ||
| gcloud storage buckets create gs://$CS_BUCKET |
There was a problem hiding this comment.
The gcloud storage buckets create command will fail if the bucket already exists. This can happen if the startup script runs again on an instance that was restarted, or if the bucket was created through other means. To make the script more robust and idempotent, consider checking for the bucket's existence before attempting to create it. The suggestion also includes quoting the variable, which is a shell scripting best practice (as recommended by tools like ShellCheck and style guides like Google's) to prevent word splitting and globbing issues.
| gcloud storage buckets create gs://$CS_BUCKET | |
| gcloud storage ls "gs://$CS_BUCKET" &>/dev/null || gcloud storage buckets create "gs://$CS_BUCKET" |
| # Store the image in the Google Cloud Storage bucket and allow all users | ||
| # to read it. | ||
| gsutil cp -a public-read output.png gs://$CS_BUCKET/output.png | ||
| gcloud storage cp --predefined-acl=public-read output.png gs://$CS_BUCKET/output.png |
There was a problem hiding this comment.
It's a good practice to quote variables in shell scripts to prevent potential issues with word splitting or globbing. While GCS bucket names have a restricted character set that makes issues unlikely in this specific case, adopting this practice improves script robustness and is a good habit, as recommended by tools like ShellCheck and style guides like Google's.
| gcloud storage cp --predefined-acl=public-read output.png gs://$CS_BUCKET/output.png | |
| gcloud storage cp --predefined-acl=public-read output.png "gs://$CS_BUCKET/output.png" |
1 participant
Automated: Migrate {target_path} 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:
[email protected]We appreciate your partnership in this important migration effort!
#gsutil-migration