Skip to content

Docs: update storage-gke deployment instructions#5338

Merged
shubpal07 merged 1 commit into
GoogleCloudPlatform:developfrom
shubpal07:shubham/friction/storage-gke
Mar 11, 2026
Merged

Docs: update storage-gke deployment instructions#5338
shubpal07 merged 1 commit into
GoogleCloudPlatform:developfrom
shubpal07:shubham/friction/storage-gke

Conversation

@shubpal07

@shubpal07 shubpal07 commented Mar 11, 2026

Copy link
Copy Markdown
Contributor

This PR updates the examples/README.md to clarify the deployment process for the storage-gke.yaml blueprint.

Changes Made

  • Added a Requirements section containing links to the Cluster Toolkit dependency installation and environment setup guides.
  • Added a Deployment Instructions section detailing the required variables that must be configured in vars (project_id, deployment_name, region, zone, and authorized_cidr).
  • Removed the redundant standalone Terraform version requirement from the blueprint description, as it is already covered in the main dependency instructions.

Related Issues

  • Resolves friction encountered by users during storage-gke deployments.

Submission Checklist

NOTE: Community submissions can take up to 2 weeks to be reviewed.

Please take the following actions before submitting this pull request.

  • Fork your PR branch from the Toolkit "develop" branch (not main)
  • Test all changes with pre-commit in a local branch #
  • Confirm that "make tests" passes all tests
  • Add or modify unit tests to cover code changes
  • Ensure that unit test coverage remains above 80%
  • Update all applicable documentation
  • Follow Cluster Toolkit Contribution guidelines #

@shubpal07
Update readme for examples/storage-gke.yaml
8bd9ddf 
Change-Id: Ia931ec7d8e53b40d2bcb9951f64b0ca6a0f535db
@shubpal07 shubpal07 self-assigned this Mar 11, 2026
@shubpal07 shubpal07 requested review from a team and samskillman as code owners March 11, 2026 09:13
@shubpal07 shubpal07 added the release-chore To not include into release notes label Mar 11, 2026
@gemini-code-assist

gemini-code-assist Bot commented Mar 11, 2026

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 significantly improves the user experience for deploying the storage-gke blueprint by providing comprehensive and clear documentation. It addresses previous friction points by centralizing setup requirements and detailing variable configurations, ensuring users can successfully deploy the blueprint with minimal confusion.

Highlights

  • Documentation Clarity: Enhanced the examples/README.md to provide clearer deployment instructions for the storage-gke blueprint.
  • Requirements Section: Introduced a new "Requirements" section with links to Cluster Toolkit dependency installation and environment setup guides.
  • Deployment Instructions: Added a "Deployment Instructions" section detailing the necessary vars configurations, including project_id, deployment_name, region, zone, and authorized_cidr.
  • Redundancy Removal: Eliminated the standalone Terraform version requirement from the blueprint description, as this information is already covered in the main dependency instructions.
Changelog
  • examples/README.md
    • Added a "Requirements" section with links to Cluster Toolkit setup guides.
    • Included a "Deployment Instructions" section outlining required vars for storage-gke.yaml.
    • Removed redundant mention of Terraform version.
Activity
  • No human activity has been recorded for this pull request yet.
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. ↩

gemini-code-assist[bot]
gemini-code-assist Bot reviewed Mar 11, 2026
View reviewed changes

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 updates the documentation for the storage-gke.yaml example, adding requirements and deployment instructions. The changes are helpful and improve the user experience. While the initial review suggested some refactorings for clarity and structure, these have been omitted to maintain formatting consistency across the repository as per established guidelines.

Note: Security Review has been skipped due to the limited scope of the PR.

@shubpal07 shubpal07 merged commit 3ebf170 into GoogleCloudPlatform:develop Mar 11, 2026
14 of 77 checks passed
scaliby pushed a commit to scaliby/cluster-toolkit that referenced this pull request Mar 17, 2026
@shubpal07 @scaliby
Docs: update storage-gke deployment instructions (GoogleCloudPlatform…
0f9455d 
…#5338)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@agrawalkhushi18 agrawalkhushi18 agrawalkhushi18 approved these changes

@samskillman samskillman Awaiting requested review from samskillman

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@shubpal07 shubpal07

Labels

release-chore To not include into release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@shubpal07 @agrawalkhushi18