Skip to content

Add gateway mode support and custom nginx configuration to OPEA nginx…#1087

Merged
lianhao merged 5 commits into
opea-project:mainfrom
devpramod:feature/custom-nginx-template
Jun 19, 2025
Merged

Add gateway mode support and custom nginx configuration to OPEA nginx…#1087
lianhao merged 5 commits into
opea-project:mainfrom
devpramod:feature/custom-nginx-template

Conversation

@devpramod

Copy link
Copy Markdown
Contributor

Nginx Helm Chart

Description

This PR enhances the nginx helm chart to support gateway mode functionality while maintaining backward
compatibility. The changes enable nginx to act as a central API gateway/router for multiple OPEA services,
providing unified access through a single endpoint.

Key changes:

  • Added custom nginx configuration template support via nginxConfig parameter
  • Added custom container startup commands via customCommand parameter
  • Added volume mounts for nginx configuration templates
  • Added ingress and ServiceMonitor templates for external access and monitoring
  • Added gateway-values.yaml for easy gateway mode deployment
  • Updated README

Issues

n/a

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • [X ] New feature (non-breaking change which adds new functionality)
  • Breaking change (fix or feature that would break existing design and interface)

Dependencies

List the newly introduced 3rd party dependency if exists.

Tests

Describe the tests that you ran to verify your changes.

  • Verified existing simple proxy mode deployments continue to work unchanged
  • Tested gateway mode deployment using gateway-values.yaml

@poussa
poussa self-requested a review June 3, 2025 05:02
@poussa

poussa commented Jun 3, 2025

Copy link
Copy Markdown
Member

Nothing wrong with the PR but I would like us to explore a different approach. That is, to use K8s Gateway APIs. With Gateway APIs we can define the routing. In addition, we can select the backend from the growing number servers that supports Gateway APIs including Nginx, Envoy, APISIX and many others.

Comment thread helm-charts/common/nginx/templates/configmap.yaml
@lianhao

lianhao commented Jun 4, 2025

Copy link
Copy Markdown
Collaborator

@poussa agreed we can explore the gateway API approach. But in the meanwhile, I think we should not block this PR since @devpramod is contributing their existing deployment patches back to community.

@poussa poussa left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please address @lianhao comments and my approval is valid.

Comment thread helm-charts/common/nginx/README.md Outdated
Comment thread helm-charts/common/nginx/gateway-values.yaml Outdated
Comment thread helm-charts/common/nginx/gateway-values.yaml Outdated
@poussa
poussa requested review from lianhao and poussa June 13, 2025 09:39
@poussa
poussa requested a review from mkbhanda June 13, 2025 09:50
Comment thread helm-charts/common/nginx/gateway-values.yaml Outdated
… chart

Signed-off-by: devpramod <pramod.pai@intel.com>
…, updating example configurations, and streamlining values and templates to better support gateway deployments while removing unnecessary service and UI settings.

Signed-off-by: devpramod <pramod.pai@intel.com>
@devpramod
devpramod force-pushed the feature/custom-nginx-template branch from ff96ebb to ade7534 Compare June 17, 2025 18:58
Comment thread helm-charts/common/nginx/gateway-values.yaml Outdated
Comment thread helm-charts/common/nginx/gateway-values.yaml Outdated
Comment thread helm-charts/common/nginx/gateway-values.yaml Outdated
…aml as it is an example values file

Signed-off-by: devpramod <pramod.pai@intel.com>
@devpramod
devpramod force-pushed the feature/custom-nginx-template branch from 882598c to 110c9d9 Compare June 18, 2025 14:01

@lianhao lianhao left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once we make the doc CI task happy, this is ready to go

Comment thread helm-charts/common/nginx/README.md Outdated
Signed-off-by: devpramod <pramod.pai@intel.com>
@devpramod
devpramod force-pushed the feature/custom-nginx-template branch from 22f7fe2 to fa164bf Compare June 19, 2025 01:19
@lianhao
lianhao merged commit ca4fcd8 into opea-project:main Jun 19, 2025
10 checks passed
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.

4 participants