Make the SPIFFE socket configurable #17
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!
This pull request enhances the application's adaptability by externalizing the configuration of the SPIFFE workload API socket path. This change allows the application to connect to the SPIFFE workload API using a path specified at runtime, which is crucial for environments where the default socket location may vary or needs to be overridden.
Highlights
- SPIFFE Socket Configurability: The SPIFFE workload API socket path is now configurable via the SPIFFE_ENDPOINT_SOCKET environment variable, providing greater flexibility for deployment environments.
- Default Socket Path: A default SPIFFE socket path is retained, ensuring backward compatibility and ease of use when the environment variable is not set.
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
-
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 makes the SPIFFE socket path configurable via the SPIFFE_ENDPOINT_SOCKET environment variable, with a fallback to a default value. The change is well-implemented. My feedback includes a suggestion to add logging for the socket path being used, which will improve the debuggability of this tool.
| // Get socket path from environment variable, with a fallback to the default. | ||
| // SPIFFE_ENDPOINT_SOCKET is the standard environment variable for this. | ||
| socketPath := os.Getenv("SPIFFE_ENDPOINT_SOCKET") | ||
| if socketPath == "" { | ||
| socketPath = defaultSpiffeSocket | ||
| } | ||
|
|
||
| client, err := workloadapi.New(ctx, workloadapi.WithAddr(socketPath), workloadapi.WithLogger(logger.Std)) |
There was a problem hiding this comment.
For better debuggability, it would be helpful to log which socket path is being used to connect to the SPIFFE Workload API. Since this is a debug container, having this information in the logs can be very valuable. This can be done by adding a single log line after determining the socket path.
| // Get socket path from environment variable, with a fallback to the default. | |
| // SPIFFE_ENDPOINT_SOCKET is the standard environment variable for this. | |
| socketPath := os.Getenv("SPIFFE_ENDPOINT_SOCKET") | |
| if socketPath == "" { | |
| socketPath = defaultSpiffeSocket | |
| } | |
| client, err := workloadapi.New(ctx, workloadapi.WithAddr(socketPath), workloadapi.WithLogger(logger.Std)) | |
| // Get socket path from environment variable, with a fallback to the default. | |
| // SPIFFE_ENDPOINT_SOCKET is the standard environment variable for this. | |
| socketPath := os.Getenv("SPIFFE_ENDPOINT_SOCKET") | |
| if socketPath == "" { | |
| socketPath = defaultSpiffeSocket | |
| } | |
| slog.Info("Connecting to SPIFFE Workload API", "socket_path", socketPath) | |
| client, err := workloadapi.New(ctx, workloadapi.WithAddr(socketPath), workloadapi.WithLogger(logger.Std)) |
| client, err := workloadapi.New(ctx, workloadapi.WithAddr(spiffeSocket), workloadapi.WithLogger(logger.Std)) | ||
| // Get socket path from environment variable, with a fallback to the default. | ||
| // SPIFFE_ENDPOINT_SOCKET is the standard environment variable for this. | ||
| socketPath := os.Getenv("SPIFFE_ENDPOINT_SOCKET") |
There was a problem hiding this comment.
nit: I think go-spiffe automatically reads this env var.
No description provided.