Skip to content

Conversation

@googlyrahman
Copy link
Member

Automated: Migrate paths from gsutil to gcloud storage

This CL is part of the on going effort to migrate from the legacy gsutil tool to the new and improved gcloud storage command-line interface. gcloud storage is the recommended and modern tool for interacting with Google Cloud Storage, offering better performance, unified authentication, and a more consistent command structure with other gcloud components. 🚀

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.

⚠️ Action Required: Please Review and Test Carefully

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 gsutil and gcloud storage that 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 rsync command has a different file deletion logic than gsutil 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 CLI team 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.com

We appreciate your partnership in this important migration effort!

cc: @sushantkhanna

@googlyrahman googlyrahman requested a review from a team as a code owner October 16, 2025 07:28
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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 several Jupyter notebooks to replace deprecated gsutil commands with their modern gcloud storage counterparts. The primary goal is to align these examples and workflows with Google Cloud's recommended practices for interacting with Cloud Storage, which offers improved performance and a more consistent user experience. While the changes are automated, the PR description and inline comments stress the importance of thorough testing to ensure functional parity and address any subtle behavioral shifts between the two command-line tools.

Highlights

  • Migration to gcloud storage: This pull request automates the migration of gsutil commands to their gcloud storage equivalents across multiple Jupyter notebooks. This is part of an ongoing effort to standardize and modernize interactions with Google Cloud Storage using the recommended gcloud command-line interface.
  • Command Replacements: Common gsutil commands such as mb (make bucket), ls (list), rm (remove), cp (copy), and iam ch (IAM change) have been replaced with their respective gcloud storage commands like buckets create, ls, rm --recursive, cp, and buckets add-iam-policy-binding.
  • Behavioral Differences Noted: The automated changes include inline comments in the notebooks highlighting potential behavioral differences between gsutil and gcloud storage, particularly concerning iam ch command migration and the output format of stat operations, emphasizing the need for careful review and testing.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 gcloud storage across several Jupyter notebooks. The automated changes are mostly correct and follow the migration guide.

However, I've found a critical issue in several notebooks where the automation script appears to have corrupted the JSON structure by incorrectly merging lines in the source cells. This will likely prevent the notebooks from loading and needs to be fixed.

I've also pointed out a minor inconsistency in the use of flags for the gcloud storage buckets create command.

Please address the critical JSON corruption issues to ensure the notebooks remain valid.

" 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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

This automated change has corrupted the notebook's JSON structure. This line is not valid JSON, as it appears to be two string literals without a comma in between. This will likely prevent the notebook from loading correctly.

This issue appears in multiple places in this file (e.g., lines 166, 191, etc.). Please fix the automation to ensure it generates valid JSON.

When fixing, please also add an equals sign to the --location flag for consistency with other notebooks in this PR (--location={REGION}).

Suggested change
" ! gcloud storage buckets create --location {REGION} {BUCKET_URI}\n", "else:\n",
" ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n",
"else:\n",

Copy link
Contributor

@gurusai-voleti gurusai-voleti Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Resolved] fixed formatting

"! gsutil iam ch serviceAccount:{SERVICE_ACCOUNT}:roles/storage.objectViewer "
]
"# 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 --member=serviceAccount:{SERVICE_ACCOUNT} --role=roles/storage.objectCreator \n", "! gcloud storage buckets add-iam-policy-binding --member=serviceAccount:{SERVICE_ACCOUNT} --role=roles/storage.objectViewer " ]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

This automated change has corrupted the notebook's JSON structure. It seems to have incorrectly merged multiple lines of the source array into one, resulting in invalid JSON. This will likely prevent the notebook from loading correctly.

This issue appears in multiple places in this file (e.g., lines 726-734, 741). Please fix the automation to ensure it generates valid JSON.

        "! gcloud storage buckets add-iam-policy-binding --member=serviceAccount:{SERVICE_ACCOUNT} --role=roles/storage.objectCreator  \n",
        "! gcloud storage buckets add-iam-policy-binding --member=serviceAccount:{SERVICE_ACCOUNT} --role=roles/storage.objectViewer  "

Copy link
Contributor

@gurusai-voleti gurusai-voleti Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Resolved] fixed formatting and removed note

"else:\n",
" shell_output = ! gsutil ls -Lb {BUCKET_URI} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n",
" bucket_region = shell_output[0].strip().lower()\n",
" ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n", "else:\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

This automated change has corrupted the notebook's JSON structure. It seems to have incorrectly merged multiple lines of the source array into one, resulting in invalid JSON. This will likely prevent the notebook from loading correctly.

This issue appears in multiple places in this file. Please fix the automation to ensure it generates valid JSON.

Suggested change
" ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n", "else:\n",
" ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n",
"else:\n",

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Resolved] fixed formatting

" 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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

This automated change has corrupted the notebook's JSON structure. It seems to have incorrectly merged multiple lines of the source array into one, resulting in invalid JSON. This will likely prevent the notebook from loading correctly.

This issue appears in multiple places in this file. Please fix the automation to ensure it generates valid JSON.

Suggested change
" ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n", "else:\n",
" ! gcloud storage buckets create --location={REGION} {BUCKET_URI}\n",
"else:\n",

Copy link
Contributor

@gurusai-voleti gurusai-voleti Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Resolved] fixed formatting

"! gsutil iam ch serviceAccount:{SERVICE_ACCOUNT}:roles/storage.objectViewer $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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

This automated change has corrupted the notebook's JSON structure. It seems to have incorrectly merged multiple lines of the source array into one, resulting in invalid JSON. This will likely prevent the notebook from loading correctly. Please fix the automation to ensure it generates valid JSON.

        "! gcloud storage buckets add-iam-policy-binding $BUCKET_URI --member=serviceAccount:{SERVICE_ACCOUNT} --role=roles/storage.objectCreator\n",
        "\n",

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Resolved] fixed formatting and removed note

"source": [
"! gsutil mb -l $REGION $BUCKET_URI"
]
"! gcloud storage buckets create --location $REGION $BUCKET_URI" ]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with other notebooks in this pull request, please use an equals sign for the --location flag.

        "! gcloud storage buckets create --location=$REGION $BUCKET_URI"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Resolved] fixed formatting

@gericdong gericdong added this pull request to the merge queue Dec 24, 2025
Merged via the queue into GoogleCloudPlatform:main with commit 45ec1cf Dec 24, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants