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 custom annotations into GatewayClass and NginxGateway manifests #1899

Closed
wants to merge 0 commits into from

Conversation

sgavrylenko
Copy link
Contributor

Proposed changes

Add custom annotations for GatewayClass and NginxGateway objects.
It can be useful in different cases

Problem: For deploying of our service we use ArgoCD. For this we have a Helm Chart that contains multiple resources that are using CRDs, that are not managed by this helm chart. When trying to sync this application, it fails if at least one CRD is not installed in the cluster. This is expected.

Solution: To work around this problem, we want to use SkipDryRunOnMissingResource option as annotation for GatewayClass and NginxGateway objects from the nginx-gateway-fabric chart

Testing: Helm template works fine

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.


@sgavrylenko sgavrylenko requested a review from a team as a code owner April 29, 2024 16:29
@github-actions github-actions bot added helm-chart Relates to helm chart documentation Improvements or additions to documentation labels Apr 29, 2024
@sgavrylenko
Copy link
Contributor Author

Actually, do we really need GatewayClass and NginxGateway objects during the installation of operator? Can we mark them as optional and create only when we need it?

@sjberman
Copy link
Contributor

sjberman commented May 1, 2024

@sgavrylenko Thanks for the submission. Right now we do require the NginxGateway resource because we bootstrap NGF based on its contents (right now just one field, but could expand in the future).

GatewayClass though may not be necessary. Worth a discussion amongst the team at least.

charts/nginx-gateway-fabric/values.yaml Outdated Show resolved Hide resolved
charts/nginx-gateway-fabric/values.yaml Outdated Show resolved Hide resolved
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 helm-chart Relates to helm chart
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants