feat: add option to specify the clusterIP of OpenFGA service #264

Khayet · 2025-10-10T08:16:55Z

Adds the option to specify the ClusterIP of the OpenFGA service. This allows running OpenFGA as a "headless service" (see https://kubernetes.io/docs/concepts/services-networking/service/#headless-services).

What problem is being solved?

We want to run OpenFGA as a headless service, so we can do client-side load balancing of our gRPC connection (which requires discovering the IPs of the individual replicas).

How is it being solved?

Adds service.clusterIP entry to values.yaml and sets the service specification accordingly.

What changes are made to solve it?

New clusterIP setting in values.yaml
If clusterIP is set, the service specification uses it

References

closes Add the option to run OpenFGA as a headless service #263

Review Checklist

I have clicked on "allow edits by maintainers".
I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above] -> no additional documentation necessary
The correct base branch is being used, if not main
[] I have added tests to validate that the change in functionality is working as expected -> I don't see where I would add an automated test but I have tested it locally.

Summary by CodeRabbit

New Features
- Service now supports configurable clusterIP; when unspecified, defaults to a headless Service (clusterIP: None) to improve compatibility with stateful/discovery setups.
Chores
- Minor YAML formatting cleanup for the HTTP port name with no functional impact.

linux-foundation-easycla · 2025-10-10T08:16:59Z

The committers listed above are authorized under a signed CLA.

✅ login: rhamzeh / name: Raghd Hamzeh (e816aba)

coderabbitai · 2025-10-10T08:17:29Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Added optional Service clusterIP templating in Helm and set default service.clusterIP to None in values, making the Service headless. Minor port name formatting adjustment.

Changes

Cohort / File(s)	Summary
Service templating `charts/openfga/templates/service.yaml`	Add conditional `spec.clusterIP: {{ .Values.service.clusterIP
Chart values `charts/openfga/values.yaml`	Introduce `service.clusterIP: None` default to enable headless Service.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

Add the option to run OpenFGA as a headless service #263 — Implements headless Service support by adding service.clusterIP and defaulting to None.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title clearly and succinctly describes the primary change of adding a configurable clusterIP option for the OpenFGA service, directly reflecting the modifications to values.yaml and the service template. It avoids unnecessary detail while remaining specific about the feature being introduced. This phrasing enables teammates to understand the pull request’s main intent at a glance.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e693a7a and 2b57cfc.

📒 Files selected for processing (2)

charts/openfga/templates/service.yaml (1 hunks)
charts/openfga/values.yaml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: lint-test

charts/openfga/values.yaml

Khayet · 2025-10-10T09:02:11Z

@coderabbitai review

coderabbitai · 2025-10-10T09:02:37Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

HannesHerrmannAA · 2025-10-13T07:43:48Z

Anything blocking for merging this and release a new version of the helm chart?
Perhaps @rhamzeh ?

rhamzeh

Thanks @Khayet - approving!

(sorry for the delays)

Copilot

Pull request overview

This pull request adds support for configuring the clusterIP field of the OpenFGA Kubernetes service, enabling users to run OpenFGA as a headless service for client-side load balancing of gRPC connections. The implementation allows users to specify service.clusterIP in their values configuration, which is then applied to the service manifest.

Key Changes:

Added conditional rendering of clusterIP field in service.yaml template
Fixed trailing whitespace in the http port name definition

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-11T02:53:41Z

charts/openfga/templates/service.yaml

+  {{- if .Values.service.clusterIP }}
+  clusterIP: {{ .Values.service.clusterIP }}
+  {{- end }}


The service template references .Values.service.clusterIP but this field has not been added to the values.yaml file. Users will not be able to configure this setting without adding it to the values.yaml file. Add a clusterIP field under the service section in values.yaml with appropriate documentation.

Copilot · 2025-12-11T02:53:42Z

charts/openfga/templates/service.yaml

+  {{- if .Values.service.clusterIP }}
+  clusterIP: {{ .Values.service.clusterIP }}
+  {{- end }}


The new clusterIP field should be documented in the values.schema.json file to provide schema validation and documentation for users. Add a schema definition for the clusterIP property under the service object in values.schema.json, including a description that explains it can be set to "None" for headless services or a specific IP address.

@Khayet I agree with the bot here, it would be nice to add this to values.schema.json so that it is more visible to users - would you mind doing that?

Khayet requested review from a team as code owners October 10, 2025 08:16

Khayet force-pushed the add-option-to-set-clusterip-none branch from 1776c38 to e5353b6 Compare October 10, 2025 08:20

Khayet closed this Oct 10, 2025

Khayet reopened this Oct 10, 2025

feat: add option to specify the clusterIP of OpenFGA service

2b57cfc

Khayet force-pushed the add-option-to-set-clusterip-none branch from e5353b6 to 2b57cfc Compare October 10, 2025 08:23

coderabbitai bot reviewed Oct 10, 2025

View reviewed changes

charts/openfga/values.yaml Outdated Show resolved Hide resolved

HannesHerrmannAA reviewed Oct 10, 2025

View reviewed changes

charts/openfga/values.yaml Outdated Show resolved Hide resolved

fix: do not set clusterIP by default

782ca95

rhamzeh approved these changes Dec 11, 2025

View reviewed changes

Merge branch 'main' into add-option-to-set-clusterip-none

e816aba

Copilot AI review requested due to automatic review settings December 11, 2025 02:50

Copilot started reviewing on behalf of rhamzeh December 11, 2025 02:50 View session

Copilot AI reviewed Dec 11, 2025

View reviewed changes

feat: add option to specify the clusterIP of OpenFGA service #264

Are you sure you want to change the base?

feat: add option to specify the clusterIP of OpenFGA service #264

Uh oh!

Conversation

Khayet commented Oct 10, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What problem is being solved?

How is it being solved?

What changes are made to solve it?

References

Review Checklist

Summary by CodeRabbit

Uh oh!

linux-foundation-easycla bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Estimated code review effort

Possibly related issues

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Khayet commented Oct 10, 2025

Uh oh!

coderabbitai bot commented Oct 10, 2025

Uh oh!

HannesHerrmannAA commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rhamzeh left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

rhamzeh Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Khayet commented Oct 10, 2025 •

edited by coderabbitai bot

Loading

linux-foundation-easycla bot commented Oct 10, 2025 •

edited

Loading

coderabbitai bot commented Oct 10, 2025 •

edited

Loading

HannesHerrmannAA commented Oct 13, 2025 •

edited

Loading

rhamzeh left a comment •

edited

Loading