Update docs about the cert-manager dependency #32
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @mattbates, 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!
I've updated the README.md to improve clarity regarding the project's dependencies. The main goal of this change is to explicitly document the requirement for cert-manager and provide essential information for its installation and configuration, ensuring users can successfully deploy spiffe-enable with proper TLS security. Additionally, I've refined the Helm installation command example for better usability.
Highlights
- Documentation Update: I've added a new "Dependencies" section to the
README.mdfile. This section clearly states thatspiffe-enablerelies oncert-managerfor issuing TLS certificates to secure its webhook. It also provides guidance on ensuringcert-manageris installed and mentions the defaultselfsignedIssuerassumption, which is configurable. - Helm Installation Command Refinement: I've made a minor adjustment to the
helm installcommand example inREADME.mdby removing the--version v0.1.0flag. This simplifies the installation instructions, allowing users to install the latest stable version by default.
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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to include information about the cert-manager dependency. The changes are good, but the new Dependencies section should be placed before the installation command to ensure users are aware of the prerequisite. I've also suggested adding a note about pinning the Helm chart version for production environments, as the explicit version was removed from the example command.
|
SPIRE controller manager uses SPIFFE for webhook auth, so there should be a way to avoid this dependency. |
No description provided.