Migrate gsutil usage to gcloud storage #4318
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 systematically updates numerous Jupyter notebooks by replacing deprecated 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 automated pull request correctly migrates gsutil commands to their gcloud storage equivalents. However, the automation script has introduced critical formatting errors in all the updated Jupyter notebook files. It consistently merges lines within the source array of code cells, which breaks the JSON structure of the notebooks and renders them invalid. These formatting issues must be fixed across all files to ensure the notebooks can be loaded and executed correctly.
| "source": [ | ||
| "! gsutil mb -l $REGION -p $PROJECT_ID $BUCKET_URI" | ||
| ] | ||
| "! gcloud storage buckets create --location=$REGION --project=$PROJECT_ID $BUCKET_URI" ] |
There was a problem hiding this comment.
This line was incorrectly merged with the closing bracket of the array, which breaks the JSON structure of the notebook. It should be two separate lines. Similar formatting issues exist elsewhere in this file.
"! gcloud storage buckets create --location=$REGION --project=$PROJECT_ID $BUCKET_URI",
]
| "source": [ | ||
| "! gsutil mb -l $REGION gs://$BUCKET_NAME" | ||
| ] | ||
| "! gcloud storage buckets create --location $REGION gs://$BUCKET_NAME" ] |
There was a problem hiding this comment.
This line was incorrectly merged with the closing bracket of the array, which breaks the JSON structure of the notebook. It should be two separate lines. Similar formatting issues exist elsewhere in this file.
"! gcloud storage buckets create --location $REGION gs://$BUCKET_NAME",
]
There was a problem hiding this comment.
gcloud storage buckets create --location $REGION gs://$BUCKET_NAME
Creating gs://my-bucket232321/...
command is correct.
| " item_1 = \"gs://cloud-samples-data/language/sentiment-positive.txt\"\n", | ||
| " ! gsutil cp $item_1 gs://$BUCKET_NAME\n", | ||
| " f.write(\"gs://\" + BUCKET_NAME + \"/sentiment-positive.txt\" + \"\\n\")\n", | ||
| " ! gcloud storage cp $item_1 gs://$BUCKET_NAME\n", " f.write(\"gs://\" + BUCKET_NAME + \"/sentiment-positive.txt\" + \"\\n\")\n", |
There was a problem hiding this comment.
The automated migration has introduced multiple formatting errors in this notebook, breaking its JSON structure. For example, this line has been incorrectly merged with the following line. Each command should be on its own line within the source array. Please review the entire file for similar issues.
| " ! gcloud storage cp $item_1 gs://$BUCKET_NAME\n", " f.write(\"gs://\" + BUCKET_NAME + \"/sentiment-positive.txt\" + \"\\n\")\n", | |
| " ! gcloud storage cp $item_1 gs://$BUCKET_NAME\n", | |
| " f.write(\"gs://\" + BUCKET_NAME + \"/sentiment-positive.txt\" + \"\\n\")\n" |
| "! gsutil cp $GCS_USERS_AVRO_URI $USERS_AVRO_FN\n", | ||
| "! gsutil cp $GCS_MOVIES_AVRO_URI $MOVIES_AVRO_FN" | ||
| ] | ||
| "! gcloud storage cp $GCS_USERS_AVRO_URI $USERS_AVRO_FN\n", "! gcloud storage cp $GCS_MOVIES_AVRO_URI $MOVIES_AVRO_FN" ] |
There was a problem hiding this comment.
The automated migration has incorrectly merged multiple commands into a single line, which breaks the JSON structure of the notebook. Each command should be on its own line within the source array.
"! gcloud storage cp $GCS_USERS_AVRO_URI $USERS_AVRO_FN\n",
"! gcloud storage cp $GCS_MOVIES_AVRO_URI $MOVIES_AVRO_FN"
| "! gcloud storage buckets add-iam-policy-binding $BUCKET_URI --member=serviceAccount:{SERVICE_ACCOUNT} --role=roles/storage.objectCreator\n", "\n", | ||
| # Note: Migrating scripts using gsutil iam ch is more complex than get or set. You need to replace the single iam ch command with a series of gcloud storage bucket add-iam-policy-binding and/or gcloud storage bucket remove-iam-policy-binding commands, or replicate the read-modify-write loop. | ||
| ! gcloud storage buckets add-iam-policy-binding $BUCKET_URI --member=serviceAccount:{SERVICE_ACCOUNT} --role=roles/storage.objectViewer ] |
There was a problem hiding this comment.
The automated migration has introduced multiple issues in this cell, breaking the JSON structure of the notebook. Lines have been incorrectly merged, and one shell command is missing its enclosing quotes and ! prefix, which will cause a syntax error. Please review the entire file for similar issues.
| " 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.
This line was incorrectly merged with the next line during the automated migration, which breaks the JSON structure of the notebook. It should be two separate lines in the source array. Similar formatting issues exist elsewhere in this file.
| " ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n", "else:\n", | |
| " ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n", | |
| "else:\n" |
| " 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.
This line was incorrectly merged with the next line during the automated migration, which breaks the JSON structure of the notebook. It should be two separate lines in the source array. Similar formatting issues exist elsewhere in this file.
| " ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n", "else:\n", | |
| " ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n", | |
| "else:\n" |
| "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.
This line was incorrectly merged with the closing bracket of the array, which breaks the JSON structure of the notebook. It should be two separate lines. Similar formatting issues exist elsewhere in this file.
"! gcloud storage buckets create --location {LOCATION} --project {PROJECT_ID} {BUCKET_URI}",
]
| "! # Note: Migrating scripts using gsutil iam ch is more complex than get or set. You need to replace the single iam ch command with a series of gcloud storage bucket add-iam-policy-binding and/or gcloud storage bucket remove-iam-policy-binding commands, or replicate the read-modify-write loop.\n", | ||
| "! gcloud storage buckets add-iam-policy-binding $BUCKET_URI --member=serviceAccount:{SERVICE_ACCOUNT} --role=roles/storage.objectCreator\n", "\n", | ||
| # Note: Migrating scripts using gsutil iam ch is more complex than get or set. You need to replace the single iam ch command with a series of gcloud storage bucket add-iam-policy-binding and/or gcloud storage bucket remove-iam-policy-binding commands, or replicate the read-modify-write loop. | ||
| ! gcloud storage buckets add-iam-policy-binding $BUCKET_URI --member=serviceAccount:{SERVICE_ACCOUNT} --role=roles/storage.objectViewer ] |
There was a problem hiding this comment.
The automated migration has introduced multiple issues in this cell, breaking the JSON structure of the notebook. Lines have been incorrectly merged, and some shell commands are missing their enclosing quotes and ! prefix, which will cause syntax errors. Please review the entire file for similar issues.
| "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.
This line was incorrectly merged with the closing bracket of the array, which breaks the JSON structure of the notebook. It should be two separate lines. Similar formatting issues exist elsewhere in this file.
"! gcloud storage buckets create --location={LOCATION} --project={PROJECT_ID} {BUCKET_URI}",
]
…b624b86e34d6fb3629bfb2830c2f0 Changes for 4318
…b624b86e34d6fb3629bfb2830c2f0 removed changes for model garden:PR 4318
4 participants
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:
[email protected]We appreciate your partnership in this important migration effort!
cc: @sushantkhanna