-
Notifications
You must be signed in to change notification settings - Fork 228
Migrate gsutil usage to gcloud storage #4321
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
Migrate gsutil usage to gcloud storage #4321
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 various Google Cloud Storage command-line operations from the 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
|
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 migrates gsutil commands to gcloud storage in several notebook files. The changes primarily involve replacing gsutil with gcloud storage and updating command-line arguments to match the gcloud storage syntax. I have identified some opportunities to improve the accuracy of the migrated commands, and to ensure the bucket names are correctly formatted.
| "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.
The gcloud storage buckets create command requires the bucket name to be specified as a URI (e.g., gs://my-bucket). It's crucial to ensure that $BUCKET_NAME includes the gs:// prefix. If $BUCKET_NAME does not include the gs:// prefix, the command will fail.
Consider adding the gs://$BUCKET_NAME to ensure the bucket name is correctly formatted.
! 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.
gsutil mb -l $REGION $BUCKET_NAME
Creating gs://vijay-bucket11/...
gcloud storage buckets create --location=$REGION $BUCKET_NAME
Creating gs://vijay-bucket9999/...
command is correct..
gcloud storage buckets create --location=$REGION gs://$BUCKET_NAME
ERROR: (gcloud.storage.buckets.create) "gcloud storage buckets create" only accepts bucket URLs.
Hence Gemini incorrect ..
| "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.
The gcloud storage buckets create command requires the bucket name to be specified as a URI (e.g., gs://my-bucket). It's crucial to ensure that $BUCKET_NAME includes the gs:// prefix. If $BUCKET_NAME does not include the gs:// prefix, the command will fail.
Consider adding the gs:// prefix to $BUCKET_NAME to ensure the bucket name is correctly formatted.
! 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.
bhandarivijay@bhandarivijay:$BUCKET_NAME=my-bucket232
bhandarivijay@bhandarivijay:$ REGION=asia-southeast1
bhandarivijay@bhandarivijay:$ ! gcloud storage buckets create --location=$REGION gs://$BUCKET_NAME
Creating gs://my-bucket232/...
command is correct
| "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.
The gcloud storage buckets create command requires the bucket name to be specified as a URI (e.g., gs://my-bucket). It's crucial to ensure that $BUCKET_URI includes the gs:// prefix. If $BUCKET_URI does not include the gs:// prefix, the command will fail.
Consider adding the gs:// prefix to $BUCKET_URI to ensure the bucket name is correctly formatted.
! gcloud storage buckets create --location $REGION gs://$BUCKET_URI
| " BUCKET_NAME = \"/\".join(BUCKET_URI.split(\"/\")[:3])\n", | ||
| " ! gsutil mb -l {REGION} {BUCKET_URI}\n", | ||
| "else:\n", | ||
| " ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n", "else:\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 gcloud storage buckets create command requires the bucket name to be specified as a URI (e.g., gs://my-bucket). It's crucial to ensure that $BUCKET_URI includes the gs:// prefix. If $BUCKET_URI does not include the gs:// prefix, the command will fail.
Consider adding the gs:// prefix to $BUCKET_URI to ensure the bucket name is correctly formatted.
! gcloud storage buckets create --location={REGION} {BUCKET_URI}
| " BUCKET_NAME = \"/\".join(BUCKET_URI.split(\"/\")[:3])\n", | ||
| " ! gsutil mb -l {REGION} {BUCKET_URI}\n", | ||
| "else:\n", | ||
| " ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n", "else:\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 gcloud storage buckets create command requires the bucket name to be specified as a URI (e.g., gs://my-bucket). It's crucial to ensure that $BUCKET_URI includes the gs:// prefix. If $BUCKET_URI does not include the gs:// prefix, the command will fail.
Consider adding the gs:// prefix to $BUCKET_URI to ensure the bucket name is correctly formatted.
! 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.
The gcloud storage buckets create command requires the bucket name to be specified as a URI (e.g., gs://my-bucket). It's crucial to ensure that {BUCKET_URI} includes the gs:// prefix. If {BUCKET_URI} does not include the gs:// prefix, the command will fail.
Consider adding the gs:// prefix to {BUCKET_URI} to ensure the bucket name is correctly formatted.
! 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.
PROJECT_ID=storage-sdk-vendor
BUCKET_URI=gs://vijay-bucket-090909
LOCATION=asia-southeast1
bhandarivijay@bhandarivijay:~/GoogleProjectone/vertex-ai-samples$ gcloud storage buckets create --location=$LOCATION --project=$PROJECT_ID $BUCKET_URI
Creating gs://vijay-bucket-090909/...
command is correct
| " if tf.io.gfile.exists(EXECUTE_OUTPUT):\n", | ||
| " ! gsutil cat $EXECUTE_OUTPUT\n", | ||
| " return EXECUTE_OUTPUT\n", | ||
| " ! gcloud storage cat $EXECUTE_OUTPUT\n", " return EXECUTE_OUTPUT\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.
This command is using gcloud storage cat to read the contents of a file, but it's missing a newline character at the end. This could cause issues when parsing the output, especially if the file is large or if the parsing logic relies on complete lines.
Consider adding a newline character (\n) to the end of the gcloud storage cat command to ensure that the output is properly formatted.
Changes for 4321
removed changes for model garden GoogleCloudPlatform#4321
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