-
Notifications
You must be signed in to change notification settings - Fork 105
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
Ensure uniqueness and validity of generated names and labels #716
Merged
pleshakov
merged 3 commits into
nginx:main
from
pleshakov:fix/provisioner-long-selectors
Jun 6, 2023
Merged
Ensure uniqueness and validity of generated names and labels #716
pleshakov
merged 3 commits into
nginx:main
from
pleshakov:fix/provisioner-long-selectors
Jun 6, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem: Provisioner could generate an invalid name or a label for NKG static mode deployment. As a result, the provisioner would fail with an error like below: ``` {“level”:“info”,“ts”:“2023-06-05T17:26:04Z”,“logger”:“eventLoop”,“msg”:“added an event to the next batch”,“type”:“*events.UpsertEvent”,“total”:1} panic: failed to create deployment: Deployment.apps “nginx-gateway-gateway-conformance-infra-same-namespace-with-http-listener-on-8080" is invalid: [spec.selector.matchLabels: Invalid value: “nginx-gateway-gateway-conformance-infra-same-namespace-with-http-listener-on-8080”: must be no more than 63 characters, spec.selector: Invalid value: v1.LabelSelector{MatchLabels:map[string]string{“app”:“nginx-gateway-gateway-conformance-infra-same-namespace-with-http-listener-on-8080”}, MatchExpressions:[]v1.LabelSelectorRequirement(nil)}: invalid label selector] ``` Solution: Provisioner will use the following format for names and labels of Deployments: nginx-gateway-<number>, where the number if an interger >= 1. For every new Gateway resource, the provisioner will increment the number by one. This approach will break if the provisioner is restarted, but we don't support provisioner for production yet, so it is acceptable. Note: correlation between a Gateway resource and the corresponding Deployment can be found in the provisioner log. For example: ``` {"level":"info","ts":"2023-06-05T21:23:33Z","logger":"eventHandler","msg":"Created deployment","deployment":{"name":"nginx-gateway-1","namespace":"nginx-gateway"},"gateway":{"name":"same-namespace","namespace":"gateway-conformance-infra"}} ```
kate-osborn
suggested changes
Jun 6, 2023
sjberman
reviewed
Jun 6, 2023
kate-osborn
approved these changes
Jun 6, 2023
sjberman
approved these changes
Jun 6, 2023
miledxz
added a commit
to miledxz/nginx-gateway-fabric
that referenced
this pull request
Jan 14, 2025
Problem: Provisioner could generate an invalid name or a label for NKG static mode deployment. As a result, the provisioner would fail with an error like below: ``` {“level”:“info”,“ts”:“2023-06-05T17:26:04Z”,“logger”:“eventLoop”,“msg”:“added an event to the next batch”,“type”:“*events.UpsertEvent”,“total”:1} panic: failed to create deployment: Deployment.apps “nginx-gateway-gateway-conformance-infra-same-namespace-with-http-listener-on-8080" is invalid: [spec.selector.matchLabels: Invalid value: “nginx-gateway-gateway-conformance-infra-same-namespace-with-http-listener-on-8080”: must be no more than 63 characters, spec.selector: Invalid value: v1.LabelSelector{MatchLabels:map[string]string{“app”:“nginx-gateway-gateway-conformance-infra-same-namespace-with-http-listener-on-8080”}, MatchExpressions:[]v1.LabelSelectorRequirement(nil)}: invalid label selector] ``` Solution: Provisioner will use the following format for names and labels of Deployments: nginx-gateway-<number>, where the number if an interger >= 1. For every new Gateway resource, the provisioner will increment the number by one. This approach will break if the provisioner is restarted, but we don't support provisioner for production yet, so it is acceptable. Note: correlation between a Gateway resource and the corresponding Deployment can be found in the provisioner log. For example: ``` {"level":"info","ts":"2023-06-05T21:23:33Z","logger":"eventHandler","msg":"Created deployment","deployment":{"name":"nginx-gateway-1","namespace":"nginx-gateway"},"gateway":{"name":"same-namespace","namespace":"gateway-conformance-infra"}} ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem:
Provisioner could generate an invalid name or a label for NKG static mode deployment. As a result, the provisioner would fail with an error like below:
Solution:
Provisioner will use the following format for names and labels of Deployments:
nginx-gateway-<number>
, where the number if an interger >= 1. For every new Gateway resource, the provisioner will increment the number by one.This approach will break if the provisioner is restarted, but we don't support provisioner for production yet, so it is acceptable.
Note: correlation between a Gateway resource and the corresponding Deployment can be found in the provisioner log. For example:
This PR will unblock #713 (comment)
Checklist
Before creating a PR, run through this checklist and mark each as complete.