Skip to content
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

Gateway Settings Enhancement Proposal #1776

Merged
merged 4 commits into from
Apr 5, 2024

Conversation

sjberman
Copy link
Contributor

@sjberman sjberman commented Mar 25, 2024

Problem: We want a design for GatewayClass level settings that applies to all Gateways, such as otel_exporter.

Solution: Add enhancement proposal introducing the NginxProxy CRD, which will contain the Gateway settings.

Enhancement Proposal: #1775

Closes #1660

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

NONE

@sjberman sjberman requested review from a team as code owners March 25, 2024 21:15
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 25, 2024
@sjberman sjberman added enhancement-proposal Enhancement Proposal issue and removed documentation Improvements or additions to documentation labels Mar 25, 2024
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Show resolved Hide resolved
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 27, 2024
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
docs/proposals/gateway-settings.md Outdated Show resolved Hide resolved
@sjberman sjberman force-pushed the docs/proposals/gateway-settings branch 2 times, most recently from 4207c42 to fab4caf Compare March 29, 2024 17:36
@sjberman sjberman force-pushed the docs/proposals/gateway-settings branch 2 times, most recently from 42f104e to 24faed2 Compare April 3, 2024 19:35
@sjberman sjberman force-pushed the docs/proposals/gateway-settings branch from 24faed2 to 338e82d Compare April 5, 2024 14:23
@sjberman
Copy link
Contributor Author

sjberman commented Apr 5, 2024

@pleshakov @kate-osborn Due to issues with singular/plural resource names, should this be renamed to GatewayConfig and GatewayConfigs?

@kate-osborn
Copy link
Contributor

@pleshakov @kate-osborn Due to issues with singular/plural resource names, should this be renamed to GatewayConfig and GatewayConfigs?

Good catch. We should rename it, but now I wonder if having Gateway in the name is confusing since it is referenced in the GatewayClass.

@sjberman
Copy link
Contributor Author

sjberman commented Apr 5, 2024

I wonder if having Gateway in the name is confusing since it is referenced in the GatewayClass.

Even though it's defined on the class, since it's technically set on each Gateway, is it really that confusing?

@kate-osborn
Copy link
Contributor

I wonder if having Gateway in the name is confusing since it is referenced in the GatewayClass.

Even though it's defined on the class, since it's technically set on each Gateway, is it really that confusing?

Perhaps not

@sjberman
Copy link
Contributor Author

sjberman commented Apr 5, 2024

Although I've always thought Config is a redundant term for a CRD, because all CRDs are config. I could see the confusion when saying GatewayConfig vs a Gateway config.

Maybe there's a better name we can come up with here...

@kate-osborn
Copy link
Contributor

Although I've always thought Config is a redundant term for a CRD, because all CRDs are config. I could see the confusion when saying GatewayConfig vs a Gateway config.

Maybe there's a better name we can come up with here...

Since we named the control plane CRD NginxGateway, we could call this NginxProxy or NginxDataplane

@sjberman
Copy link
Contributor Author

sjberman commented Apr 5, 2024

NginxProxy seems good to me. @pleshakov?

It mimics our original data plane CRD name.

@pleshakov
Copy link
Contributor

@sjberman

NginxProxy seems good to me. @pleshakov?

It mimics our original data plane CRD name.

👍

Problem: We want a design for GatewayClass level settings that applies to all Gateways, such as `otel_exporter`.

Solution: Add enhancement proposal introducing the `NginxProxy` CRD, which will contain the Gateway settings.

Enhancement Proposal: nginxinc#1775
@sjberman sjberman force-pushed the docs/proposals/gateway-settings branch from 338e82d to 2432d57 Compare April 5, 2024 18:48
@sjberman
Copy link
Contributor Author

sjberman commented Apr 5, 2024

@kate-osborn @pleshakov If you two wouldn't mind making sure my name change looks good before I merge, that would be much appreciated.

@kate-osborn
Copy link
Contributor

@kate-osborn @pleshakov If you two wouldn't mind making sure my name change looks good before I merge, that would be much appreciated.

LGTM @sjberman

@sjberman sjberman merged commit f29eddb into nginxinc:main Apr 5, 2024
40 checks passed
@sjberman sjberman deleted the docs/proposals/gateway-settings branch April 5, 2024 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement-proposal Enhancement Proposal issue
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Design Gateway Settings for OpenTelemetry Traces
3 participants