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

Add ClientSettingsPolicy CRD #1793

Merged

Conversation

kate-osborn
Copy link
Contributor

Proposed changes

Add ClientSettingsPolicy CRD.

Problem: Users need a way to configure the behavior between the downstream client and NGF. For example, be able to set the client max body size.

Solution: Add the ClientSettingsPolicy CRD, which provides a way to configure this behavior. Note: this PR contains the CRD only. A subsequent PR will add the implementation.

Testing: Verified CRD can be installed and tested the OpenAPI schema validation.

This PR also adds the category nginx-gateway-fabric to the NginxGateway CRD. This allows users to look up all the api-resources related to our controller.

kubectl api-resources --categories=nginx-gateway-fabric 
NAME                     SHORTNAMES   APIVERSION                   NAMESPACED   KIND
clientsettingspolicies   cspolicy     gateway.nginx.org/v1alpha1   true         ClientSettingsPolicy
nginxgateways                         gateway.nginx.org/v1alpha1   true         NginxGateway

Closes #1759

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

@kate-osborn kate-osborn requested a review from a team as a code owner April 1, 2024 19:15
@github-actions github-actions bot added enhancement New feature or request helm-chart Relates to helm chart labels Apr 1, 2024
apis/v1alpha1/clientsettingspolicy_types.go Outdated Show resolved Hide resolved
apis/v1alpha1/clientsettingspolicy_types.go Outdated Show resolved Hide resolved
apis/v1alpha1/clientsettingspolicy_types.go Outdated Show resolved Hide resolved
apis/v1alpha1/clientsettingspolicy_types.go Outdated Show resolved Hide resolved
apis/v1alpha1/clientsettingspolicy_types.go Outdated Show resolved Hide resolved
apis/v1alpha1/clientsettingspolicy_types.go Show resolved Hide resolved
@kate-osborn kate-osborn requested a review from a team as a code owner April 4, 2024 00:05
@kate-osborn kate-osborn force-pushed the enh/client-settins-policy-crd branch 2 times, most recently from 1ba2028 to e858bb5 Compare April 4, 2024 00:19
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 4, 2024
@kate-osborn kate-osborn force-pushed the enh/client-settins-policy-crd branch from c01f006 to d7e06b1 Compare April 4, 2024 19:46
@github-actions github-actions bot removed the helm-chart Relates to helm chart label Apr 4, 2024
@kate-osborn kate-osborn merged commit 556ebaa into nginxinc:main Apr 4, 2024
40 checks passed
@kate-osborn kate-osborn mentioned this pull request May 8, 2024
6 tasks
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 New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add API for ClientSettingsPolicy
5 participants