Skip to content

Update OpenBao docs #1844

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

Merged
merged 3 commits into from
Aug 20, 2025
Merged

Update OpenBao docs #1844

merged 3 commits into from
Aug 20, 2025

Conversation

jackhodgkiss
Copy link
Contributor

  • Fix issue with code-block no rendering
  • Update walled garden no proxy configuration
  • Update OpenBao docs to mention the need for no_proxy configuration

OpenBao requires that `no_proxy` is configured to include the IP address
of the first controller to allow for successful deployment.
@jackhodgkiss jackhodgkiss requested a review from a team as a code owner August 20, 2025 13:29
Copy link

@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.

Summary of Changes

Hello @jackhodgkiss, 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 updates the OpenBao documentation to improve clarity and address critical configuration requirements, particularly for environments with proxy settings. It fixes a rendering issue with code blocks, enhances the walled garden no_proxy configuration, and explicitly guides users on configuring no_proxy for OpenBao HA setups.

Highlights

  • Documentation Rendering Fix: Corrected the syntax for code-block directives in doc/source/configuration/openbao.rst to ensure proper rendering of code examples.
  • OpenBao HA Configuration Guidance: Added a new step in the OpenBao HA setup documentation (doc/source/configuration/openbao.rst) to explicitly guide users on configuring no_proxy for the first controller's internal network IP, especially in walled garden environments.
  • Walled Garden Proxy Configuration Update: Updated the doc/source/configuration/walled-garden.rst file to include the first controller's internal network IP in the no_proxy list, ensuring proper communication within the walled garden setup.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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

@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 updates the OpenBao documentation, fixing rendering issues with code blocks and adding necessary configuration details for no_proxy in walled garden setups. The changes are generally good and improve the documentation's clarity and correctness. I've provided a couple of suggestions: one to improve the phrasing of a new instruction and another to restore a section on environment-specific commands that appears to have been accidentally removed. Addressing these points will make the documentation more complete and easier to follow.

@Alex-Welsh Alex-Welsh merged commit e810107 into stackhpc/2025.1 Aug 20, 2025
21 checks passed
@Alex-Welsh Alex-Welsh deleted the openbao-proxy-docs branch August 20, 2025 13:48
@seunghun1ee
Copy link
Member

Thanks

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